From 4194617bfe1e29bae2c2515aefbed5f1f2a1ebc1 Mon Sep 17 00:00:00 2001 From: Andy Rothfusz Date: Wed, 23 Oct 2013 19:04:03 -0700 Subject: [PATCH 1/2] Add known issues to sections via new "issues" extension. --- docs/sources/conf.py | 6 +++++- docs/sources/use/builder.rst | 10 ++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/sources/conf.py b/docs/sources/conf.py index 7aa27c7b84..0ccd4a4ed5 100644 --- a/docs/sources/conf.py +++ b/docs/sources/conf.py @@ -40,7 +40,11 @@ html_additional_pages = { # Add any Sphinx extension module names here, as strings. They can be extensions # 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. templates_path = ['_templates'] diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst index d1747c3fb3..a1fd85df91 100644 --- a/docs/sources/use/builder.rst +++ b/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 control. +Known Issues +............ + +* :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. + + + + 3.4 CMD ------- From 5a9adfe9fb5bc988185ef41ca637fbeee73e947c Mon Sep 17 00:00:00 2001 From: Andy Rothfusz Date: Fri, 1 Nov 2013 16:06:46 -0700 Subject: [PATCH 2/2] Add known issues. Fix build warnings. --- docs/sources/commandline/cli.rst | 12 ++++++++++++ docs/sources/contributing/contributing.rst | 9 ++++++--- docs/sources/use/builder.rst | 6 +++--- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/sources/commandline/cli.rst b/docs/sources/commandline/cli.rst index 8f778c32de..ab622bff54 100644 --- a/docs/sources/commandline/cli.rst +++ b/docs/sources/commandline/cli.rst @@ -408,6 +408,12 @@ Insert file from github 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: ``login`` @@ -516,6 +522,12 @@ The main process inside the container will be sent SIGKILL. Remove one or more containers -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: ~~~~~~~~~ diff --git a/docs/sources/contributing/contributing.rst b/docs/sources/contributing/contributing.rst index 3cdb0b6f14..3b3b3f8f88 100644 --- a/docs/sources/contributing/contributing.rst +++ b/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 started `_. -The developer environment `Dockerfile `_ +The `developer environment Dockerfile +`_ specifies the tools and versions used to test and build Docker. If you're making changes to the documentation, see the `README.md `_. -The documentation environment `Dockerfile `_ +The `documentation environment Dockerfile +`_ specifies the tools and versions used to build the Documentation. -Further interesting details can be found in the `Packaging hints `_. +Further interesting details can be found in the `Packaging hints +`_. diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst index a1fd85df91..e48f3f2a48 100644 --- a/docs/sources/use/builder.rst +++ b/docs/sources/use/builder.rst @@ -116,13 +116,13 @@ core concepts of Docker where commits are cheap and containers can be created from any point in an image's history, much like source control. -Known Issues -............ +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.