瀏覽代碼

Merge pull request #2526 from metalivedev/2074-AddKnownIssues

Add Known Issue
Andy Rothfusz 11 年之前
父節點
當前提交
67b0b97a8f
共有 4 個文件被更改,包括 33 次插入4 次删除
  1. 12 0
      docs/sources/commandline/cli.rst
  2. 5 1
      docs/sources/conf.py
  3. 6 3
      docs/sources/contributing/contributing.rst
  4. 10 0
      docs/sources/use/builder.rst

+ 12 - 0
docs/sources/commandline/cli.rst

@@ -480,6 +480,12 @@ Insert file from github
 
 
 The main process inside the container will be sent SIGKILL.
 The main process inside the container will be sent SIGKILL.
 
 
+Known Issues (kill)
+~~~~~~~~~~~~~~~~~~~
+
+* :issue:`197` indicates that ``docker kill`` may leave directories
+  behind and make it difficult to remove the container.
+
 .. _cli_login:
 .. _cli_login:
 
 
 ``login``
 ``login``
@@ -588,6 +594,12 @@ The main process inside the container will be sent SIGKILL.
     Remove one or more containers
     Remove one or more containers
         -link="": Remove the link instead of the actual container
         -link="": Remove the link instead of the actual container
 
 
+Known Issues (rm)
+~~~~~~~~~~~~~~~~~~~
+
+* :issue:`197` indicates that ``docker kill`` may leave directories
+  behind and make it difficult to remove the container.
+
 
 
 Examples:
 Examples:
 ~~~~~~~~~
 ~~~~~~~~~

+ 5 - 1
docs/sources/conf.py

@@ -40,7 +40,11 @@ html_additional_pages = {
 
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinxcontrib.httpdomain']
+extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.extlinks']
+
+# Configure extlinks
+extlinks = { 'issue': ('https://github.com/dotcloud/docker/issues/%s',
+	               'Issue ') }
 
 
 # Add any paths that contain templates here, relative to this directory.
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 templates_path = ['_templates']

+ 6 - 3
docs/sources/contributing/contributing.rst

@@ -10,13 +10,16 @@ Want to hack on Docker? Awesome!
 The repository includes `all the instructions you need to get
 The repository includes `all the instructions you need to get
 started <https://github.com/dotcloud/docker/blob/master/CONTRIBUTING.md>`_.
 started <https://github.com/dotcloud/docker/blob/master/CONTRIBUTING.md>`_.
 
 
-The developer environment `Dockerfile <https://github.com/dotcloud/docker/blob/master/Dockerfile>`_
+The `developer environment Dockerfile
+<https://github.com/dotcloud/docker/blob/master/Dockerfile>`_
 specifies the tools and versions used to test and build Docker.
 specifies the tools and versions used to test and build Docker.
 
 
 If you're making changes to the documentation, see the
 If you're making changes to the documentation, see the
 `README.md <https://github.com/dotcloud/docker/blob/master/docs/README.md>`_.
 `README.md <https://github.com/dotcloud/docker/blob/master/docs/README.md>`_.
 
 
-The documentation environment `Dockerfile <https://github.com/dotcloud/docker/blob/master/docs/Dockerfile>`_
+The `documentation environment Dockerfile
+<https://github.com/dotcloud/docker/blob/master/docs/Dockerfile>`_
 specifies the tools and versions used to build the Documentation.
 specifies the tools and versions used to build the Documentation.
 
 
-Further interesting details can be found in the `Packaging hints <https://github.com/dotcloud/docker/blob/master/hack/PACKAGERS.md>`_.
+Further interesting details can be found in the `Packaging hints
+<https://github.com/dotcloud/docker/blob/master/hack/PACKAGERS.md>`_.

+ 10 - 0
docs/sources/use/builder.rst

@@ -116,6 +116,16 @@ core concepts of Docker where commits are cheap and containers can be
 created from any point in an image's history, much like source
 created from any point in an image's history, much like source
 control.
 control.
 
 
+Known Issues (RUN)
+..................
+
+* :issue:`783` is about file permissions problems that can occur when
+  using the AUFS file system. You might notice it during an attempt to
+  ``rm`` a file, for example. The issue describes a workaround.
+* :issue:`2424` Locale will not be set automatically.
+
+
+
 3.4 CMD
 3.4 CMD
 -------
 -------