Commit Graph

481 Commits

Author SHA1 Message Date
Dan Walsh 6042a6f9a4 add docs for commit --change
Docker-DCO-1.1-Signed-off-by: Daniel, Dao Quang Minh <dqminh89@gmail.com> (github: dqminh)

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
2017-06-02 00:06:47 +00:00
Sven Dowideit 10560b0a8f a little re-writing
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:47 +00:00
Vincent Bernat e49fa872b4 zsh: update zsh completion for docker command
zsh completion is updated with the content of
felixr/docker-zsh-completion.

ef4a3fce0437 Update completion for `wait' as per 1.5.0
ace5aa9c1282 Add completion for `stats'
91f112834865 Update completion for `search' as per 1.5.0
a5e4febe4bf6 Update completion for `save' as per 1.5.0
1cdbdb18a384 Add completion for `rename'
2f004bb724b9 Update completion for `pull' as per 1.5.0
773b88e0885b Update completion for `logs' as per 1.5.0
c57e5d5c4551 Update completion for `load' to favor archive files
9af7d12b487e Update completion for `images` as per 1.5.0
0d59e66aff30 update completion for `exec' to complete on commands
46b6c66760d7 Update completion for `events' as per 1.5.0
307e0bdc4c34 Update completion for `commit' as per 1.5.0
c4b331f38cc4 Update completion for `build' as per 1.5.0

Also added myself in the `MAINTAINERS` file.

Signed-off-by: Vincent Bernat <vincent@bernat.im>
2017-06-02 00:06:47 +00:00
Ahmet Alp Balkan b67b89f4cd cli: Add server OS/Arch info to 'version' cmd
Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2017-06-02 00:06:47 +00:00
Brian Goff 209f3889e0 Remove CLI doc entry related to API-only function
Closes #10278

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2017-06-02 00:06:47 +00:00
André Martins d73a9d48f5 Fixes #10457-Pause-and-unpause-accept-multi-containers
Applied multi parameters to pause and unpause.
Created a new test file dedicated for pause commands.
Created a new utility function to get a slice of paused containers.
Updated documentation

Signed-off-by: André Martins <martins@noironetworks.com>
2017-06-02 00:06:47 +00:00
Colm Hally 6ecd6bb069 Group published and exposed ports by contiguous ranges
Signed-off-by: Colm Hally <colmhally@gmail.com>
2017-06-02 00:06:47 +00:00
Bradley Cicenas f99a52dc6c add logpath to docker inspect.
Signed-off-by: Bradley Cicenas <bradley.cicenas@gmail.com>
2017-06-02 00:06:47 +00:00
Ahmet Alp Balkan ee1b138b2b Shorten help messages for docker cmd flags
In order to fit printed messages to fit 80 chars,
rewording messages for `-H` and `--tls` flags.

Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2017-06-02 00:06:47 +00:00
Mike Dillon ceee2175bd Add bash completion for `docker rename`
Signed-off-by: Mike Dillon <mike@embody.org>
2017-06-02 00:06:47 +00:00
Harald Albers 3bb3eae782 Fix bash completion for docker run -d
Signed-off-by: Harald Albers <github@albersweb.de>
2017-06-02 00:06:47 +00:00
Doug Davis f91ddd939f Fix 'docker stats' help message
Closes #10771

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:47 +00:00
Jessica Frazelle 16b4b98c34 Removes the feature to pull all image aliases.
It didn't work on v2 anyways. And an image with a lot of aliases was slow to
fetch.

Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle)
2017-06-02 00:06:47 +00:00
Doug Davis 3820b31267 Use newer help out for 'docker' and 'docker run'
Closes #10828

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:47 +00:00
Peter Salvatore e2ac0fc917 Clean up explanation of doc branches.
Signed-off-by: Peter Salvatore <peter@psftw.com>
2017-06-02 00:06:47 +00:00
Arnaud Porterie 8c6610787a Update docs for HTTP_PROXY
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2017-06-02 00:06:46 +00:00
Coenraad Loubser 01187a4030 Update docker.fish
Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <jess@docker.com> (github: jfrazelle)

Signed-off-by: Coenraad Loubser <coenraad@wish.org.za>
2017-06-02 00:06:46 +00:00
Sven Dowideit 2202790fcd Documentation on boolean flags is wrong #10517
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:46 +00:00
Michael A. Smith 95fe3a1a93 Distinguish ENV from setting environment inline
It's ambiguous to say that `ENV` is _functionally equivalent to prefixing the command with `<key>=<value>`_. `ENV` sets the environment for all future commands, but `RUN` can take chained commands like `RUN foo=bar bash -c 'echo $foo' && bash -c 'echo $foo $bar'`. Users with a solid understanding of `exec` may grok this without confusion, but less experienced users may need this distinction.

Signed-off-by: Michael A. Smith <msmith3@ebay.com>

Improve Environment Handling Descriptions

- Link `ENV` and `Environment Replacement`
- Improve side-effects of `ENV` text
- Rearrange avoiding side effects text

Signed-off-by: Michael A. Smith <msmith3@ebay.com>
2017-06-02 00:06:46 +00:00
Alexander Morozov 74279772e5 Fix example about ps and linked containers
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2017-06-02 00:06:46 +00:00
Katie McLaughlin 2fedce8411 Format `awsconfig` sample config correctly
Reflow change in commit 195f3a3f removed newlines in the config format.

This change reverts the sample config to the original formatting, which
matches the actual config format of a `awsconfig` file.

Signed-off-by: Katie McLaughlin <katie@glasnt.com>
2017-06-02 00:06:46 +00:00
Qiang Huang c03b0700a4 update docs for memory and memoryswap
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2017-06-02 00:06:46 +00:00
Sven Dowideit e52b4ad35c For now, docker stats appears to be libcontainer only
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:46 +00:00
Harald Albers 063a4f574a Bash completion for docker kill
Signed-off-by: Harald Albers <github@albersweb.de>
2017-06-02 00:06:46 +00:00
Sven Dowideit aa33ee11d0 Fix a small spelling error in the dm.blkdiscard docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:46 +00:00
Sven Dowideit 89e02d9d88 Docker attach documentation didn't make sense to me
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:46 +00:00
Doug Davis 130c0bf094 Pretty the help text
This modifies the "docker help" text so that it is no wider than 80 chars
and each description fits on one line. This will also try to use ~ when
possible

Added a test to make sure we don't go over 80 chars again.
Added a test to make sure we use ~

Applied rules/tests to all docker commands - not just main help text

Closes #10214

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:46 +00:00
Sven Dowideit c995dee4c1 Spelling mistake in dockerlinks
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:46 +00:00
Chen Hanxiao 2627488a27 docs: change events --since to fit RFC3339Nano
PR6931 changed time format to RFC3339Nano.
But the example in cli.md does not changed.

Signed-off-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com>
2017-06-02 00:06:46 +00:00
Doug Davis 37fd964edb Fix docs so WORKDIR mentions it works for COPY and ADD too
The docs around COPY/ADD already mentioned that it will do a relative
copy/add based on WORKDIR, so that part is already ok.  Just needed to
tweak the WORKDIR section since w/o mentioning COPY/ADD it can be misleading.

Noticed by @phemmer

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:46 +00:00
Arnaud Porterie dc7a9b9c0e Update fish completion for 1.5.0
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2017-06-02 00:06:46 +00:00
Jessica Frazelle e6158378b5 Add completion for stats.
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
2017-06-02 00:06:46 +00:00
Harald Albers 0dafe480ab Add bash completions for daemon flags, simplify with extglob
Implementing the deamon flags the traditional way introduced even more
redundancy than usual because the same list of options with flags
had to be added twice.

This can be avoided by using variables in the case statements when
using the extglob shell option.

Signed-off-by: Harald Albers <github@albersweb.de>
2017-06-02 00:06:46 +00:00
Doug Davis 642218cefa Docker run -e FOO should erase FOO if FOO isn't set in client env
See #10141 for more info, but the main point of this is to make sure
that if you do "docker run -e FOO ..." that FOO from the current env
is passed into the container.  This means that if there's a value, its
set.  But it also means that if FOO isn't set then it should be unset in
the container too - even if it has to remove it from the env.  So,
   unset HOSTNAME
   docker run -e HOSTNAME busybox env
should _NOT_ show HOSTNAME in the list at all

Closes #10141

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:45 +00:00
Michael Crosby 3296ada2ed Update to docker stats documentation
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-06-02 00:06:45 +00:00
Michael Crosby 9da6238f41 Add documentation for stats feature
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-06-02 00:06:45 +00:00
Sven Dowideit ff12640c2b An initial quick import of documentation from Compose, Machine and Swarm
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2017-06-02 00:06:45 +00:00
Jessica Frazelle f870b2c6f5 Add docs for `--memory-swap`.
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
2017-06-02 00:06:45 +00:00
Lei Jitang ca57d01f87 Update the docs for --link accept container id
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2017-06-02 00:06:45 +00:00
Doug Davis 6f56148726 Add the list of possible values for --log-level to help text
Closes #10034

Signed-off-by: Doug Davis <dug@us.ibm.com>
2017-06-02 00:06:45 +00:00
Sebastiaan van Stijn 7c63b49df6 Document that ENV vars are not automatically updated
Unlike the entries in `/etc/hosts`, environment-variables for linked
containers are not automatically updated if the linked container is
restarted.

This adds a note to the documentation in;
https://docs.docker.com/userguide/dockerlinks/#environment-variables
and
https://docs.docker.com/reference/run/#env-environment-variables

To make users aware that this is the case and recommends them to use
the `/etc/hosts` entries in stead.

I added this change because users were expecting environment variables
to be updated automatically as well (https://github.com/docker/docker/issues/10164).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-06-02 00:06:45 +00:00
Arnaud Porterie 4939c04b28 Add documentation for HTTP proxies
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2017-06-02 00:06:45 +00:00
Arnaud Porterie 776f4e478e Support whitespaces in ADD and COPY continued
Add tests and documentation for this new feature.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
2017-06-02 00:06:45 +00:00
Liang-Chi Hsieh da1720cca2 Fix typo.
Signed-off-by: Liang-Chi Hsieh <viirya@gmail.com>
2017-06-02 00:06:45 +00:00
Sven Dowideit 11c19fc0f3 Add build --pull and evenets --filter flags to the docs for 1.4
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2017-06-02 00:06:45 +00:00
Phil Estes 74b009e816 Add backing filesystem info to `docker info` command where applicable
Fixes #9960

This adds the output of a "Backing Filesystem:" entry to `docker info`
to overlay, aufs, and devicemapper graphdrivers. The default list
includes a fairly complete list of common filesystem names from
linux/include/uapi/linux/magic.h, but if the backing filesystem is not
recognized, the code will simply show "<unknown>"

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-06-02 00:06:45 +00:00
Sebastiaan van Stijn 72aae7c046 Docs: Add note that export doesn't include volume data.
The documentation on `docker export` doesn't mention that
data in volumes is not included in the export.

This adds a note that volumes are not part of the export
and refers to the "Backup, restore, or migrate data volumes"
to give the user some pointers.

Relates to https://github.com/docker/docker/issues/10095

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-06-02 00:06:45 +00:00
Nathan Hsieh 40ee6737ea changed format of cli note
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
2017-06-02 00:06:45 +00:00
Nathan Hsieh 1c6f4dc7fb added note to man & cli docs on search limit
Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
2017-06-02 00:06:45 +00:00
Michael Crosby 221cd67e25 Add --readonly for read only container rootfs
Add a --readonly flag to allow the container's root filesystem to be
mounted as readonly.  This can be used in combination with volumes to
force a container's process to only write to locations that will be
persisted.  This is useful in many cases where the admin controls where
they would like developers to write files and error on any other
locations.

Closes #7923
Closes #8752

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
2017-06-02 00:06:45 +00:00