github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-29 16:57:18 +00:00
Code Issues Projects Releases Wiki Activity

doc: Fix markdown

Browse Source 
Resolve a number of syntax issues that were lurking in the markdown.

Fixes: #1564.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
This commit is contained in:
James O. D. Hunt 2019-04-18 15:36:03 +01:00
parent 1a0a4bc049
commit 82d105f759
2 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
virtcontainers/documentation/Developers.md
View File

@ -52,5 +52,5 @@ This will:
# Submitting changes # Submitting changes
For details on the format and how to submit changes, refer to the For details on the format and how to submit changes, refer to the
[Contributing](CONTRIBUTING.md) document. [Contributing](../../CONTRIBUTING.md) document.

36
virtcontainers/documentation/api/1.0/api.md
View File

@ -16,7 +16,7 @@ semantics strictly follow the
The sandbox API allows callers to [create](#createsandbox), [delete](#deletesandbox), The sandbox API allows callers to [create](#createsandbox), [delete](#deletesandbox),
[start](#startsandbox), [stop](#stopsandbox), [run](#runsandbox), [pause](#pausesandbox), [start](#startsandbox), [stop](#stopsandbox), [run](#runsandbox), [pause](#pausesandbox),
[resume](resumesandbox) and [list](#listsandbox) VM (Virtual Machine) based sandboxes. [resume](#resumesandbox) and [list](#listsandbox) VM (Virtual Machine) based sandboxes.
To initially create a sandbox, the API caller must prepare a To initially create a sandbox, the API caller must prepare a
[`SandboxConfig`](#sandboxconfig) and pass it to either [`CreateSandbox`](#createsandbox) [`SandboxConfig`](#sandboxconfig) and pass it to either [`CreateSandbox`](#createsandbox)
@ -43,10 +43,10 @@ sandbox lifecycle through the rest of the [sandbox API](#sandbox-functions).
* [NetworkConfig](#networkconfig) * [NetworkConfig](#networkconfig)
* [NetInterworkingModel](#netinterworkingmodel) * [NetInterworkingModel](#netinterworkingmodel)
* [Volume](#volume) * [Volume](#volume)
* [ContainerConfig](#containerconfig) * [Sandbox ContainerConfig](#sandbox-containerconfig)
* [Cmd](#cmd) * [Sandbox Cmd](#sandbox-cmd)
* [Mount](#mount) * [Sandbox Mount](#sandbox-mount)
* [DeviceInfo](#deviceinfo) * [Sandbox DeviceInfo](#sandbox-deviceinfo)
* [VCSandbox](#vcsandbox) * [VCSandbox](#vcsandbox)
#### `SandboxConfig` #### `SandboxConfig`
@ -298,7 +298,7 @@ type Volume struct {
} }
``` ```
##### `ContainerConfig` ##### Sandbox `ContainerConfig`
```Go ```Go
// ContainerConfig describes one container runtime configuration. // ContainerConfig describes one container runtime configuration.
type ContainerConfig struct { type ContainerConfig struct {
@ -325,7 +325,7 @@ type ContainerConfig struct {
} }
``` ```
###### `Cmd` ###### Sandbox `Cmd`
```Go ```Go
// Cmd represents a command to execute in a running container. // Cmd represents a command to execute in a running container.
type Cmd struct { type Cmd struct {
@ -367,7 +367,7 @@ type Cmd struct {
} }
``` ```
###### `Mount` ###### Sandbox `Mount`
```Go ```Go
// Mount describes a container mount. // Mount describes a container mount.
type Mount struct { type Mount struct {
@ -388,7 +388,7 @@ type Mount struct {
} }
``` ```
###### `DeviceInfo` ###### Sandbox `DeviceInfo`
```Go ```Go
// DeviceInfo is an embedded type that contains device data common to all types of devices. // DeviceInfo is an embedded type that contains device data common to all types of devices.
type DeviceInfo struct { type DeviceInfo struct {
@ -541,7 +541,7 @@ As a virtcontainers container is always linked to a sandbox, the entire containe
API always takes a sandbox ID as its first argument. API always takes a sandbox ID as its first argument.
To create a container, the API caller must prepare a To create a container, the API caller must prepare a
[`ContainerConfig`](#containerconfig) and pass it to [`ContainerConfig`](#sandbox-containerconfig) and pass it to
[`CreateContainer`](#createcontainer) together with a sandbox ID. Upon successful [`CreateContainer`](#createcontainer) together with a sandbox ID. Upon successful
container creation, the virtcontainers API will return a container creation, the virtcontainers API will return a
[`VCContainer`](#vccontainer) interface back to the caller. [`VCContainer`](#vccontainer) interface back to the caller.
@ -556,17 +556,17 @@ to manage the container lifecycle through the rest of the
### Container Structures ### Container Structures
* [ContainerConfig](#containerconfig-1) * [Container ContainerConfig](#container-containerconfig)
* [Cmd](#cmd-1) * [Container Cmd](#container-cmd)
* [Mount](#mount-1) * [Container Mount](#container-mount)
* [DeviceInfo](#deviceinfo-1) * [Container DeviceInfo](#container-deviceinfo)
* [Process](#process) * [Process](#process)
* [ContainerStatus](#containerstatus) * [ContainerStatus](#containerstatus)
* [ProcessListOptions](#processlistoptions) * [ProcessListOptions](#processlistoptions)
* [VCContainer](#vccontainer) * [VCContainer](#vccontainer)
#### `ContainerConfig` #### Container `ContainerConfig`
```Go ```Go
// ContainerConfig describes one container runtime configuration. // ContainerConfig describes one container runtime configuration.
type ContainerConfig struct { type ContainerConfig struct {
@ -593,7 +593,7 @@ type ContainerConfig struct {
} }
``` ```
##### `Cmd` ##### Container `Cmd`
```Go ```Go
// Cmd represents a command to execute in a running container. // Cmd represents a command to execute in a running container.
type Cmd struct { type Cmd struct {
@ -635,7 +635,7 @@ type Cmd struct {
} }
``` ```
##### `Mount` ##### Container `Mount`
```Go ```Go
// Mount describes a container mount. // Mount describes a container mount.
type Mount struct { type Mount struct {
@ -656,7 +656,7 @@ type Mount struct {
} }
``` ```
##### `DeviceInfo` ##### Container `DeviceInfo`
```Go ```Go
// DeviceInfo is an embedded type that contains device data common to all types of devices. // DeviceInfo is an embedded type that contains device data common to all types of devices.
type DeviceInfo struct { type DeviceInfo struct {