691f30bc72
Fixed wrong apostrophe character
...
Changed unexpected Unicode character 0x1fbf GREEK PSILI that was standing in as an imposter for an apostrophe: an _impostrophe_.
Signed-off-by: Chad Faragher <wyckster@hotmail.com >
Upstream-commit: b59823c784
Component: cli
2018-08-01 11:06:07 -04:00
08fd30fe8f
Update --compose-file flag description to mention stdin
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: 2c7822b036
Component: cli
2018-07-19 14:55:48 +02:00
ae87d856f8
For docker/docker.github.io/issues/6987
...
Signed-off-by: Peter Kehl <peter.kehl@gmail.com >
Upstream-commit: 249c8652a2
Component: cli
2018-07-05 14:12:47 -07:00
871e21254e
Merge pull request #1145 from Vimal-Raghubir/590-Add-missing-option
...
Add: Add missing option
Upstream-commit: da59ccb601
Component: cli
2018-06-29 17:16:25 +02:00
5be6ded435
Add: Add missing option
...
Signed-off-by: Vimal-Raghubir <vraghubir0418@gmail.com >
Upstream-commit: a205aecb80
Component: cli
2018-06-26 22:20:01 -04:00
fad2548681
Merge pull request #1138 from seemethere/env_experimental
...
Add env variable option for experimental
Upstream-commit: 61e53fc88a
Component: cli
2018-06-25 14:47:16 +02:00
138db9c689
Add env variable option for experimental
...
Signed-off-by: Eli Uriegas <eli.uriegas@docker.com >
Upstream-commit: e3bb62ed51
Component: cli
2018-06-24 21:15:02 +00:00
763b3149b8
Remove shorthand -k option from docker version
...
The `-k` shorthand was alreaady removed from other
commands, so best to be consistent.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: f0a8598b8d
Component: cli
2018-06-21 23:33:55 -07:00
61fded22bf
Update command usage and documentation
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: 0f07b9ffc7
Component: cli
2018-06-21 23:16:27 -07:00
ea934f5313
Add --init option to docker service create
...
Signed-off-by: Timothy Higinbottom <timhigins@gmail.com >
Signed-off-by: Vincent Demeester <vincent@sbr.pm >
Upstream-commit: ff13f03def
Component: cli
2018-06-14 13:50:12 +02:00
a76ed6f917
YAML docs: add os_type property on flags and (sub)commands
...
This patch adds an `os_type` property in the generated YAML docs, both for
commands, and for flags;
Note that the ostype annotation on flags can have multiple values set,
however, multiple values are currently not used (and unlikely will).
To simplify usage of the os_type property in the YAML, and for consistency with
the same property for commands, we're only using the first ostype that's set.
```yaml
command: docker checkpoint create
short: Create a checkpoint from a running container
long: Create a checkpoint from a running container
usage: docker checkpoint create [OPTIONS] CONTAINER CHECKPOINT [flags]
pname: docker checkpoint
plink: docker_checkpoint.yaml
options:
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: leave-running
value_type: bool
default_value: "false"
description: Leave the container running after checkpoint
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
min_api_version: "1.25"
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: windows
```
```yaml
command: docker container start
short: Start one or more stopped containers
long: Start one or more stopped containers
usage: docker container start [OPTIONS] CONTAINER [CONTAINER...] [flags]
pname: docker container
plink: docker_container.yaml
options:
- option: attach
shorthand: a
value_type: bool
default_value: "false"
description: Attach STDOUT/STDERR and forward signals
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: checkpoint
value_type: string
description: Restore from this checkpoint
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: linux
- option: checkpoint-dir
value_type: string
description: Use a custom checkpoint storage directory
deprecated: false
experimental: true
experimentalcli: false
kubernetes: false
swarm: false
os_type: linux
- option: detach-keys
value_type: string
description: Override the key sequence for detaching a container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: interactive
shorthand: i
value_type: bool
default_value: "false"
description: Attach container's STDIN
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
```
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: be035a0272
Component: cli
2018-05-31 22:31:31 +02:00
b8ca625f10
Add filter support for stack ps and services with Kubernetes
...
Signed-off-by: Mathieu Champlon <mathieu.champlon@docker.com >
Upstream-commit: 1f7aa1c036
Component: cli
2018-05-23 18:27:27 +02:00
274de24328
Merge pull request #1070 from taiji-tech/master
...
Update document links of help and comments to make it up-to-date
Upstream-commit: fd6165399d
Component: cli
2018-05-22 16:00:10 +02:00
98885f36d7
Update document links and title.
...
Signed-off-by: taiji-tech <csuhqg@foxmail.com >
Upstream-commit: 5119c4d8ef
Component: cli
2018-05-22 21:13:41 +08:00
31fc695941
Hide [flags] in usage output
...
This patch hides the [flags] in the usage output of commands, using the
new `.DisableFlagsInUseLine` option, instead of the temporary workaround
added in 8e600e10f7
Before this change:
docker run
"docker run" requires at least 1 argument.
See 'docker run --help'.
Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] [flags]
Run a command in a new container
After this change:
docker run
"docker run" requires at least 1 argument.
See 'docker run --help'.
Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
Run a command in a new container
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: 00d080269a
Component: cli
2018-05-19 02:51:55 +02:00
48d3d7fdc0
Merge pull request #1063 from nkwangleiGIT/master
...
Update some document links of help markdown files
Upstream-commit: 3c45963646
Component: cli
2018-05-18 11:34:17 +02:00
7fa75adc44
Document that reserved namespaces org.docker.*, io.docker.*, and
...
org.dockerproject.* in engine labels are now deprecated.
Signed-off-by: Ying Li <ying.li@docker.com >
Upstream-commit: 7470d460f6
Component: cli
2018-05-16 14:06:37 -07:00
6f83cf6fa8
Developer Certificate of Origin
...
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: nkwangleiGIT <nkwanglei@126.com >
Upstream-commit: b6def77c55
Component: cli
2018-05-16 20:16:08 +08:00
be4eb540c9
Merge pull request #1045 from ieugen/ieugen/patch-1
...
Added description about pids count.
Upstream-commit: fdf94de537
Component: cli
2018-05-14 13:32:47 +02:00
f151bd57f8
Add namespace column for docker stack ls command while targeting Kubernetes orchestrator
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com >
Upstream-commit: 65526a201f
Component: cli
2018-05-09 17:33:16 +02:00
daa5cc4d8f
Added description about pids count.
...
Documentation in response to issue docker/for-linux#192
Signed-off-by: Ioan Eugen Stan <eu@ieugen.ro >
Upstream-commit: 966de2a5f9
Component: cli
2018-05-08 22:16:15 +03:00
8f43102f04
Allow user to specify default address pools for docker networks
...
This is separate commit for CLI files to address PR 36054
Signed-off-by: selansen <elango.siva@docker.com >
Upstream-commit: 75c7b95e7a
Component: cli
2018-05-05 19:46:28 -04:00
4502df9e25
Merge pull request #1028 from nstapelbroek/feature/exec-die-event
...
Add exec_die to the list of known container events
Upstream-commit: 8103326311
Component: cli
2018-04-30 12:26:28 +02:00
2ff7c2ca43
Add an orchestrator column in the docker stack ls command
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com >
Upstream-commit: 13d0c9c695
Component: cli
2018-04-30 12:04:02 +02:00
340f40eb39
Add exec_die to the list of known container events
...
Signed-off-by: Nico Stapelbroek <nstapelbroek@gmail.com >
Upstream-commit: 4d91812b88
Component: cli
2018-04-29 14:52:08 +02:00
e92b784d10
Cleaning some manifest documentation typos
...
Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com >
Upstream-commit: 55c5e7aa88
Component: cli
2018-04-24 15:00:39 +02:00
f1112e0539
Merge pull request #999 from perlun/patch-1
...
build.md: Document --build-arg without value
Upstream-commit: 771ccaf4ed
Component: cli
2018-04-17 10:39:20 -07:00
8037d00abb
docker load: Typofix in examples
...
Remove the double "docker docker" from example
Signed-off-by: Henry Ne <henrynmail-github@yahoo.de >
Upstream-commit: 79c489d812
Component: cli
2018-04-16 16:39:54 +02:00
e4e0816835
build.md: Document --build-arg without value
...
This use case is currently _working correctly_, which is nice, but there is no documentation to be found about it. This PR fixes that.
Signed-off-by: Per Lundberg <perlun@gmail.com >
Upstream-commit: 82c23208ee
Component: cli
2018-04-16 07:52:13 +03:00
a95dfe42a3
Merge pull request #970 from cowlinator/temp2
...
Clarify --build-arg documentation
Upstream-commit: e5980c541a
Component: cli
2018-04-13 18:54:16 -07:00
0166969766
Merge pull request #988 from anusha-ragunathan/plugin_doc
...
Update examples to reflect docker-runc's runtime root for plugins.
Upstream-commit: 3d0fc8d309
Component: cli
2018-04-11 21:32:02 -07:00
a5ee15c5ef
Merge pull request #978 from bogdananton/fix-manifest-docs-typo
...
[docs] Fix typo in manifest command docs: updated `MANFEST` to `MANIFEST`.
Upstream-commit: 066fd62e37
Component: cli
2018-04-09 13:25:37 -07:00
5d0f671bd1
Update examples to reflect docker-runc's runtime root for plugins.
...
Signed-off-by: Anusha Ragunathan <anusha.ragunathan@docker.com >
Upstream-commit: 5fd9eab3d0
Component: cli
2018-04-05 12:14:59 -07:00
77bb3ea6e7
Fix docker stack deploy reference flag
...
Signed-off-by: Vincent Demeester <vincent@sbr.pm >
Upstream-commit: 2ee9635b1e
Component: cli
2018-04-03 10:11:52 +02:00
6a9a060b45
Merge pull request #979 from joaofnfernandes/docs-secrets-6294
...
Use printf, not echo when creating secrets
Upstream-commit: 17aaad6f06
Component: cli
2018-04-03 09:45:11 +02:00
74a9225ea5
Fix --format example for docker history
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: 2f7bf40e73
Component: cli
2018-04-02 16:07:40 -07:00
15ef970018
Use printf, not echo when creating secrets
...
Update the docs so that users don't use `echo` when creating
secrets from STDIN. `echo` adds a trailing new line, so users
will probably be confused when their passwords don't work.
Signed-off-by: Joao Fernandes <joao.fernandes@docker.com >
Upstream-commit: 5238f3e93e
Component: cli
2018-04-02 15:15:19 -07:00
5392f72ea0
[docs] Fix typo in manifest command docs: updated MANFEST to MANIFEST.
...
Signed-off-by: Bogdan Anton <contact@bogdananton.ro >
Upstream-commit: 9fa6bd4174
Component: cli
2018-04-01 17:40:31 +03:00
6493e53acd
Update build.md
...
Explicitly stated that you must add --build-arg for each build argument.
Added multiple arguments to example of `--build-arg` usage.
Fix for https://github.com/docker/docker.github.io/issues/6248
Signed-off-by: Preston Cowley <cowlinator@gmail.com >
Upstream-commit: ad44e2d45e
Component: cli
2018-03-26 14:28:49 -07:00
40d437f5bc
Clarify behaviour of restart policy in run ref doc
...
This clarifies that the behaviour of `unless-stopped` will restart the container on daemon start. This was implied before, but now the restart-on-daemon-start behaviour is mentioned directly.
Signed-off-by: David Beitey <david@davidjb.com >
Upstream-commit: 8ca237054f
Component: cli
2018-03-26 00:21:40 +10:00
e2458dab76
Docs touch-ups for "autoremove" and broken anchor
...
`--rm` moved to the daemon, so is now also supported
when combined with `-d`.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: e9ce688d6e
Component: cli
2018-03-21 19:00:11 +01:00
b97b29bfcb
update doc
...
Signed-off-by: Victor Vieux <victorvieux@gmail.com >
Upstream-commit: 09ec6d4ad9
Component: cli
2018-03-13 16:50:56 -07:00
5e391186a8
Refactor content_trust cli/flags handling
...
Remove the global variable used. Allows easier unit testing.
Signed-off-by: Vincent Demeester <vincent@sbr.pm >
Upstream-commit: 6e21829af4
Component: cli
2018-03-08 15:00:43 -05:00
63f4daf361
Update run.md --restart to include unless-stopped
...
Update --restart option to include unless-stopped to be consistent with https://docs.docker.com/config/containers/start-containers-automatically/#use-a-restart-policy
Signed-off-by: Lydell Manganti <lydell.manganti@gmail.com >
Upstream-commit: d281b72a98
Component: cli
2018-02-28 21:05:30 +10:00
faa59fb288
docs: mention sctp
...
Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp >
Upstream-commit: b85d87b8ab
Component: cli
2018-02-26 15:27:11 +09:00
9963a034b3
Merge pull request #896 from thaJeztah/templated-configs-secrets
...
Add --template-driver option for secrets/configs
Upstream-commit: ef7d8be86c
Component: cli
2018-02-22 09:44:16 +01:00
acea77d537
Merge pull request #843 from sepich/docs-for-pr33130
...
Document long form of --network and --network-add
Upstream-commit: 84c7dd6057
Component: cli
2018-02-21 23:26:39 +01:00
3b6356337c
Add --template-driver option for secrets/configs
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: d11b5ccdfa
Component: cli
2018-02-21 23:22:32 +01:00
81f2f8b4a0
Merge pull request #885 from thaJeztah/node-engine-version
...
Add Engine version to docker node ls
Upstream-commit: 1e8530bc34
Component: cli
2018-02-20 18:45:36 +01:00
bf0c1bd1d9
Update docker kill reference docs
...
- explain the either "name" or "id" can be used to reference a container
- explain that signals can be sent by name or number
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
Upstream-commit: 0c085c2a77
Component: cli
2018-02-20 14:58:55 +01:00