Browse code

Merge pull request #2526 from metalivedev/2074-AddKnownIssues

Add Known Issue

Andy Rothfusz authored on 2013/11/09 05:14:04
Showing 4 changed files
... ...
@@ -480,6 +480,12 @@ Insert file from github
480 480
 
481 481
 The main process inside the container will be sent SIGKILL.
482 482
 
483
+Known Issues (kill)
484
+~~~~~~~~~~~~~~~~~~~
485
+
486
+* :issue:`197` indicates that ``docker kill`` may leave directories
487
+  behind and make it difficult to remove the container.
488
+
483 489
 .. _cli_login:
484 490
 
485 491
 ``login``
... ...
@@ -588,6 +594,12 @@ The main process inside the container will be sent SIGKILL.
588 588
     Remove one or more containers
589 589
         -link="": Remove the link instead of the actual container
590 590
 
591
+Known Issues (rm)
592
+~~~~~~~~~~~~~~~~~~~
593
+
594
+* :issue:`197` indicates that ``docker kill`` may leave directories
595
+  behind and make it difficult to remove the container.
596
+
591 597
 
592 598
 Examples:
593 599
 ~~~~~~~~~
... ...
@@ -40,7 +40,11 @@ html_additional_pages = {
40 40
 
41 41
 # Add any Sphinx extension module names here, as strings. They can be extensions
42 42
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43
-extensions = ['sphinxcontrib.httpdomain']
43
+extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.extlinks']
44
+
45
+# Configure extlinks
46
+extlinks = { 'issue': ('https://github.com/dotcloud/docker/issues/%s',
47
+	               'Issue ') }
44 48
 
45 49
 # Add any paths that contain templates here, relative to this directory.
46 50
 templates_path = ['_templates']
... ...
@@ -10,13 +10,16 @@ Want to hack on Docker? Awesome!
10 10
 The repository includes `all the instructions you need to get
11 11
 started <https://github.com/dotcloud/docker/blob/master/CONTRIBUTING.md>`_.
12 12
 
13
-The developer environment `Dockerfile <https://github.com/dotcloud/docker/blob/master/Dockerfile>`_
13
+The `developer environment Dockerfile
14
+<https://github.com/dotcloud/docker/blob/master/Dockerfile>`_
14 15
 specifies the tools and versions used to test and build Docker.
15 16
 
16 17
 If you're making changes to the documentation, see the
17 18
 `README.md <https://github.com/dotcloud/docker/blob/master/docs/README.md>`_.
18 19
 
19
-The documentation environment `Dockerfile <https://github.com/dotcloud/docker/blob/master/docs/Dockerfile>`_
20
+The `documentation environment Dockerfile
21
+<https://github.com/dotcloud/docker/blob/master/docs/Dockerfile>`_
20 22
 specifies the tools and versions used to build the Documentation.
21 23
 
22
-Further interesting details can be found in the `Packaging hints <https://github.com/dotcloud/docker/blob/master/hack/PACKAGERS.md>`_.
24
+Further interesting details can be found in the `Packaging hints
25
+<https://github.com/dotcloud/docker/blob/master/hack/PACKAGERS.md>`_.
... ...
@@ -116,6 +116,16 @@ core concepts of Docker where commits are cheap and containers can be
116 116
 created from any point in an image's history, much like source
117 117
 control.
118 118
 
119
+Known Issues (RUN)
120
+..................
121
+
122
+* :issue:`783` is about file permissions problems that can occur when
123
+  using the AUFS file system. You might notice it during an attempt to
124
+  ``rm`` a file, for example. The issue describes a workaround.
125
+* :issue:`2424` Locale will not be set automatically.
126
+
127
+
128
+
119 129
 3.4 CMD
120 130
 -------
121 131