mesos git commit: Fixed double dashes typos, highlighting, and bullet points in containerizer documentation.

[mp...@apache.org]

Repository: mesos
Updated Branches:
  refs/heads/master 19f14d06b -> 30c111a97


Fixed double dashes typos, highlighting, and bullet points in
containerizer documentation.

Review: https://reviews.apache.org/r/39451


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/30c111a9
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/30c111a9
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/30c111a9

Branch: refs/heads/master
Commit: 30c111a9735bd0257c95428d8c05cbe2778f0858
Parents: 19f14d0
Author: Gilbert Song <gi...@mesoshere.io>
Authored: Mon Oct 19 15:33:47 2015 -0700
Committer: Michael Park <mp...@apache.org>
Committed: Mon Oct 19 15:33:47 2015 -0700

----------------------------------------------------------------------
 docs/containerizer.md        |  8 +++++---
 docs/docker-containerizer.md | 24 +++++++++++++-----------
 2 files changed, 18 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/30c111a9/docs/containerizer.md
----------------------------------------------------------------------
diff --git a/docs/containerizer.md b/docs/containerizer.md
index ea19558..87f145c 100644
--- a/docs/containerizer.md
+++ b/docs/containerizer.md
@@ -20,7 +20,7 @@ filesystem.
 
 The modifications are specified in the ContainerInfo included in the
 ExecutorInfo, either by a framework or by using the
---default\_container\_info slave flag.
+`--default_container_info` slave flag.
 
 ContainerInfo specifies Volumes which map parts of the shared
 filesystem (host\_path) into the container's view of the filesystem
@@ -34,8 +34,8 @@ must exist) in the shared filesystem.
 
 The primary use-case for this isolator is to selectively make parts of
 the shared filesystem private to each container. For example, a
-private "/tmp" directory can be achieved with host\_path="tmp" and
-container\_path="/tmp" which will create a directory "tmp" inside the
+private "/tmp" directory can be achieved with `host_path="tmp"` and
+`container_path="/tmp"` which will create a directory "tmp" inside the
 executor's work directory (mode 1777) and simultaneously mount it as
 /tmp inside the container. This is transparent to processes running
 inside the container. Containers will not be able to see the host's
@@ -45,9 +45,11 @@ inside the container. Containers will not be able to see the host's
 
 The Pid Namespace isolator can be used to isolate each container in
 a separate pid namespace with two main benefits:
+
 1. Visibility: Processes running in the container (executor and
    descendants) are unable to see or signal processes outside the
    namespace.
+
 2. Clean termination: Termination of the leading process in a pid
    namespace will result in the kernel terminating all other processes
    in the namespace.

http://git-wip-us.apache.org/repos/asf/mesos/blob/30c111a9/docs/docker-containerizer.md
----------------------------------------------------------------------
diff --git a/docs/docker-containerizer.md b/docs/docker-containerizer.md
index 091a3ac..5f8a1a9 100644
--- a/docs/docker-containerizer.md
+++ b/docs/docker-containerizer.md
@@ -14,7 +14,7 @@ The following sections will describe the API changes along with Docker support,
 
 To run the slave to enable the Docker Containerizer, you must launch the slave with "docker" as one of the containerizers option.
 
-Example: mesos-slave --containerizers=docker,mesos
+Example: `mesos-slave --containerizers=docker,mesos`
 
 Each slave that has the Docker containerizer should have Docker CLI client installed (version >= 1.0.0).
 
@@ -38,17 +38,19 @@ Note that the Docker image is expected to launch up as a Mesos executor that wil
 
 ## What does the Docker Containerizer do?
 
-The Docker Containerizer is translating Task/Executor Launch and Destroy calls to Docker CLI commands.
+The Docker Containerizer is translating Task/Executor `Launch` and `Destroy` calls to Docker CLI commands.
 
 Currently the Docker Containerizer when launching as task will do the following:
 
-1, Fetch all the files specified in the CommandInfo into the sandbox.
-2, Pull the docker image from the remote repository.
-3, Run the docker image with the Docker executor, and map the sandbox directory into the Docker container and set the directory mapping to the MESOS_SANDBOX environment variable.
-   The executor will also stream the container logs into stdout/stderr files in the sandbox.
+1. Fetch all the files specified in the CommandInfo into the sandbox.
+
+2. Pull the docker image from the remote repository.
+
+3. Run the docker image with the Docker executor, and map the sandbox directory into the Docker container and set the directory mapping to the MESOS_SANDBOX environment variable. The executor will also stream the container logs into stdout/stderr files in the sandbox.
+
 4. On container exit or containerizer destroy, stop and remove the docker container.
 
-The Docker Containerizer launches all containers with the "mesos-" prefix plus the slave id (ie: mesos-slave1-abcdefghji), and also assumes all containers with the "mesos-" prefix is managed by the slave and is free to stop or kill the containers.
+The Docker Containerizer launches all containers with the `mesos-` prefix plus the slave id (ie: `mesos-slave1-abcdefghji`), and also assumes all containers with the `mesos-` prefix is managed by the slave and is free to stop or kill the containers.
 
 When launching the docker image as an Executor, the only difference is that it skips launching a command executor but just reaps on the docker container executor pid.
 
@@ -58,20 +60,20 @@ The containerizer also supports optional force pulling of the image, and if disa
 
 ## Private Docker repository
 
-To run a image from a private repository, one can include the uri pointing to a .dockercfg that contains login information. The .dockercfg file will be pulled into the sandbox the Docker Containerizer
+To run a image from a private repository, one can include the uri pointing to a `.dockercfg` that contains login information. The `.dockercfg` file will be pulled into the sandbox the Docker Containerizer
 set the HOME environment variable pointing to the sandbox so docker cli will automatically pick up the config file.
 
 ## CommandInfo to run Docker images
 
 A docker image currently supports having an entrypoint and/or a default command.
 
-To run a docker image with the default command (ie: docker run image), the CommandInfo's value must not be set. If the value is set then it will override the default command.
+To run a docker image with the default command (ie: `docker run image`), the CommandInfo's value must not be set. If the value is set then it will override the default command.
 
 To run a docker image with an entrypoint defined, the CommandInfo's shell option must be set to false.
-If shell option is set to true the Docker Containerizer will run the user's command wrapped with /bin/sh -c which will also become parameters to the image entrypoint.
+If shell option is set to true the Docker Containerizer will run the user's command wrapped with `/bin/sh -c` which will also become parameters to the image entrypoint.
 
 ## Recover Docker containers on slave recovery
 
 The Docker containerizer supports recovering Docker containers when the slave restarts, which supports both when the slave is running in a Docker container or not.
 
-With the docker_mesos_image flag enabled, the Docker containerizer assumes the containerizer is running in a container itself and modifies the mechanism it recovers and launches docker containers accordingly.
+With the `--docker_mesos_image` flag enabled, the Docker containerizer assumes the containerizer is running in a container itself and modifies the mechanism it recovers and launches docker containers accordingly.