Commit Graph

134 Commits

Author SHA1 Message Date
7428c89c95 docs: cli.md; document docker version output
Commit 3cec63d56f9de6332aa3f33502695283d4feb054 changed the output of
docker version. Updating docs accordingly.

Docker-DCO-1.1-Signed-off-by: Jonathan McCrohan <jmccrohan@gmail.com> (github: jmccrohan)
Upstream-commit: 4052a81830e57c9f1d7d567ba9e53813945c9810
Component: engine
2014-05-20 02:00:31 +01:00
96be0f9c84 Merge pull request #5832 from stevenburgess/documentation_cli_fix
Refactor b.tar -> busybox.tar
Upstream-commit: 4dabca90464f572f5a9ebeae3bdba8e77f6a353b
Component: engine
2014-05-17 09:42:20 +01:00
811e26ec97 Refactor b.tar -> busybox.tar
The file was saved as busybox.tar, but the ls commands named it b.tar.

Docker-DCO-1.1-Signed-off-by: Steven Burgess <steven.a.burgess@hotmail.com> (github: stevenburgess)
Upstream-commit: ddb99054bc9c04cce4ca761f9f0d822d67d614c4
Component: engine
2014-05-15 22:33:28 -04:00
98235fb032 Update the cli.md docs with the output of the docker command
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: d35330bb7aa8473b92f6f45718aa6c38863cccc7
Component: engine
2014-05-16 10:00:20 +10:00
3f28a1f79c Merge pull request #5762 from SvenDowideit/pr_out_add_some_more_specific_help_for_dockerfile_build_contexts
Add some more specific help for Dockerfile build contexts.
Upstream-commit: 8887e0063014228dbf3ff85083019adca4537ec0
Component: engine
2014-05-15 11:03:22 +10:00
d3d3386204 Add some more specific help for Dockerfile build contexts.
I've copy and pasted the error message so its googlable.

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: ed703fc8be652eee65319a774ffbe95a07a03242
Component: engine
2014-05-15 09:41:05 +10:00
4926e35bb1 Add cpuset cpus support for docker
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: adbe3096e8c8572925dbae5f19ac2ce2dc84fb1c
Component: engine
2014-05-13 18:17:12 -07:00
9f2043420a update the docs to reflect the nice \n handling
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: cfb232cff27da2dd46ec04a5bf6699ab1d1df91c
Component: engine
2014-05-07 09:40:49 +10:00
65cf6af87c Update the run --net cli help to include the 'host' option
and then add that to the run and cli docs

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 9eeff6d099a951c3a3e45d63ce2f8cb158aaeb6c
Component: engine
2014-05-06 20:26:44 +10:00
429d160907 Merge pull request #5568 from felixrabe/patch-6
cli.md: More typos
Upstream-commit: f33298024ba1f3bbcc9f51faefa16ee4de84f429
Component: engine
2014-05-03 12:50:57 +01:00
e52ce63fdc Merge pull request #5564 from felixrabe/patch-4
cli.md: sudo at the right place
Upstream-commit: d0c97d5bd2ae3565736dabe4c44958f68e2b2355
Component: engine
2014-05-03 12:36:31 +01:00
7886f3a367 Merge pull request #5551 from felixrabe/patch-1
cli.md: Fix up Markdown formatting by adding one `
Upstream-commit: b2268d1ac0e98440b0145040b13b99c3a0ac9c58
Component: engine
2014-05-03 21:02:25 +10:00
57e3f2c8d8 cli.md: More typos
I've seen one other missing space that I addressed in another PR already.
I don't know whether that is a common occurrence in the docs.

About the second diff chunk, it looks like some copy-paste mistake to me.

Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: 015a2abafa92ecc61fe5828a285a1e6dcfa07693
Component: engine
2014-05-03 00:52:48 +02:00
554600b198 Merge pull request #5563 from felixrabe/patch-3
cli.md: Add space
Upstream-commit: cefb0d12775c92ed0ae439b126008bcedd7b2ce0
Component: engine
2014-05-02 23:33:48 +01:00
5f23d92b72 cli.md: sudo at the right place
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: e318af6fb097ce5157b6766d8dfe921403858756
Component: engine
2014-05-02 23:58:05 +02:00
6ac22e7613 cli.md: Add another sudo
Upstream-commit: 4706a1ad76ed9bc6c0555499d0bd8b8eea3b3604
Component: engine
2014-05-02 23:13:28 +02:00
0275c825eb cli.md: Add space
Upstream-commit: 12a4b376fd42931d959cd925983243e94c981de4
Component: engine
2014-05-02 22:56:35 +02:00
d4a39f6488 cli.md: Fix up Markdown formatting by adding one `
Upstream-commit: 877ad96d89093af8b16112c3534f4ceceaf1b7b3
Component: engine
2014-05-02 16:53:59 +02:00
0f91626b0e Merge pull request #5524 from ostezer/docs-fix-codeblocks
Improve code/comment/output markings & display consistency
Upstream-commit: edab1bd5e5b3b179ea91e675cff6199de109558b
Component: engine
2014-05-01 19:39:06 -04:00
6a260a1e42 Timestamps for docker logs.
Fixes #1165
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
Upstream-commit: d1297feef8b124e69efc99a58294f498ecb8c022
Component: engine
2014-05-01 20:40:36 +04:00
3db0ad0993 Improve code/comment/output markings & display consistency
This PR aims to increase the consistency across the docs for
code blocks and code/comment/output markings.

Rule followed here is "what's visible on the screen should be reflected"

Issue:

 - Docs had various code blocks showing: comments, commands & outputs.
 - All three of these items were inconsistently marked.

Some examples as to how this PR aims to introduce improvements:

1. Removed `> ` from in front of the "outputs". Eg,
`    > REPOSITORY                 TAG       ID              CREATED` replaced with:
`    REPOSITORY                 TAG       ID              CREATED`.

2. Introduced `$` for commands. Eg,
`    sudo chkconfig docker on` replaced with:
`    $ sudo chkconfig docker on`

3. Comments:
`    > # ` replaced with:
`    # `.

> Please note:
> Due to a vast amount of items reviewed and changed for this PR, there
> might be some individually incorrect replacements OR patterns of incorrect
> replacements. This PR needs to be reviewed and if there is anything missing,
> it should be improved or amended.

Closes:
https://github.com/dotcloud/docker/issues/5286

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: f87a97f7df838742a602f1984f4552b803e3f92d
Component: engine
2014-05-01 17:52:01 +03:00
549ce4c50e remove rst/sphinx documentation
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: adf04681b4bd7293675b77b2397d87a5361b383b
Component: engine
2014-05-01 15:31:58 +10:00
20f9d39967 Add cli flag to docs for selinux support
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: 64d0f7e39b395a3fc52f441a53f188a19bd53cf3
Component: engine
2014-04-29 03:40:06 -07:00
4821b84026 Addressed regression of private repository documentation.
This adds back in the references to private repositories and
provides some refactoring to the Working with repositories
documentation including updating references to the "Central"
registry to Docker.io.

It also:

* Fixes some links and references to Central Index
* Fixes anchors in other files to updated titles in Working with Repositories.
* Renamed Central Index in the remaining places.
* Updated terms documentation to reflect Docker.io
* Updated some Docker Index naming to be consistent.
* Updates menu labels and hyperlinks.

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: a8871b93b95d1220c860987ae1da4e49c943bfea
Component: engine
2014-04-28 16:08:55 -04:00
75bef1c9a4 Merge pull request #5372 from SvenDowideit/docs-tweaks-to-socket-options
Docs tweaks to socket options
Upstream-commit: 1083b6d2ecc3dd5b71d285954aa6d101a5847db3
Component: engine
2014-04-25 09:08:22 +10:00
b6080f6f5b Looking into some broken links, I noticed that we don't need to use
relative paths, and also fixed some broken images.

There are still more todo - next PR I think :)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ada86fc5b736d8b3209429c584384fd9974a148a
Component: engine
2014-04-24 22:20:04 +10:00
772ac62a9b Docs auto-conversion fixes and MD marking and structure improvements.
- Remove redundant chars and all errors caused by RST->MD conversion.
   e.g. [/#, /\, \<, />, etc.]
 - Fix broken inter-document links
 - Fix outbound links no-longer active or changed
 - Fix lists
 - Fix code blocks
 - Correct apostrophes
 - Replace redundant inline note marks for code with code marks
 - Fix broken image links
 - Remove non-functional title links
 - Correct broken cross-docs links
 - Improve readability

Note: This PR does not try to fix/amend:

 - Grammatical errors
 - Lexical errors
 - Linguistic-logic errors etc.

It just aims to fix main structural or conversion errors to serve as
a base for further amendments that will cover others including but
not limited to those mentioned above.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)

Update:

 - Fix backtick issues

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: c932667cd26f00bb64ddf0c1a7c7de3ac95aa4be
Component: engine
2014-04-24 22:19:32 +10:00
84cddc3f87 add a reference to multiple -H options, and update the other example of -H option
and copy changes to the cli.md file

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: b2c87fe08b71523eb20fed63e5da3bef30b756ec
Component: engine
2014-04-24 11:24:58 +10:00
5742188cb8 - unix://path/to/socket should read unix:///path/to/socket like the rest of the documentation (a slash was missing)
- Mention that [] options may be specified multiple times on the Usage page

Docker-DCO-1.1-Signed-off-by: Mike MacCana <mike.maccana@gmail.com> (github: mikemaccana)

Docker-DCO-1.1-Signed-off-by: Mike MacCana <mike.maccana@gmail.com> (github: SvenDowideit)
Upstream-commit: e62efb266fd878453b8562e60b06a3e579fe571a
Component: engine
2014-04-24 11:11:51 +10:00
e0138ab848 Introducing spīritus lēnis to fix code highlighting issues due to apostrophe.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 2d6324e06a1e2ea8bb2236472a99c3dc4b5f66d1
Component: engine
2014-04-19 03:35:45 +03:00
1bbbedd397 Fixed #5283 - literal leftover from cutover
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 2f3cb370dfaca1f1c41bbd7af5f064f70ad8267b
Component: engine
2014-04-17 18:58:02 -04:00
4e25aa80e6 Fix for broken in-document links which got scrambled during conversion.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 1ff66d27b5b35b9782d6d6cdd5fc5ec95bdda07d
Component: engine
2014-04-17 18:09:08 +03:00
c4684e29f0 now, with shiney markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ac999a9cb2b0976e021aeb8825bb051df6bd0976
Component: engine
2014-04-16 11:04:14 +10:00
5c2b3f3f64 move the documentation to markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: a777ebcee6326bed2f7e99eedf6edbb922175e2d
Component: engine
2014-04-16 11:04:01 +10:00
a6fc08c279 Merge pull request #4821 from jimenez/3903-add_event_end_timestamp-feature
Adding timestamp end to events endpoint. Modifying api docs.
Upstream-commit: a521388863502014bdea80585b7272a854191244
Component: engine
2014-04-10 20:54:53 +03:00
825d583586 Adding timestamp end to events endpoint. Modifying api docs.
Docker-DCO-1.1-Signed-off-by: Isabel Jimenez <contact@isabeljimenez.com> (github: jimenez)
Upstream-commit: 66dd4ea4e280e4acc133872401bf8a79c80510f3
Component: engine
2014-04-10 10:43:21 -07:00
ed316755af add some more text to the cli docs
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: e625cee28dc62d7fbc5172e0e9c01708e2bd7fc4
Component: engine
2014-04-10 12:52:46 +00:00
904747ba78 Early deprecation warning for 'docker commit --run'
Warn users of the planned deprecation of 'docker commit --run', and hide
it from the docs and usage message. The option continues to work.

Note that an alternative to 'commit --run' is being implemented but is
not yet available. We are printing the warning anyway because on
the basis that it never hurts to give more advance warning.

The 'commit --run' flag is a leftover from the very early days of Docker,
and has several problems:

1) It is very user unfriendly. You have to pass a literal json dict
which is poorly documented and changes regularly (see PortSpecs vs
ExposedPorts). The merge behavior is not clear and also changes
regularly. it's not possible to unset a value.

2) It overlaps with the Dockerfile syntax. There are 2 ways to set
a default command, expose a port or change an env variable. Some
things can be done in a Dockerfile but not in --run. Some things
can be done in --run but not in a Dockerfile. It would be better
to push a single syntax, allow using it both in a file and via
the command line, and make improvements in a single place.

3) It exposes data structures which should not be publicly exposed.
There are several planned improvements to Docker which require moving
around the content and schema of the various Config, Image and Container
structures. The less of those we expose in public interfaces, the easier
it is to move things around without a reverse compatibility nightmare.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 168f8aba74d9c2996acec6fe1b93a2301523e305
Component: engine
2014-04-08 12:10:47 -07:00
dbddde5f2d intermediate image layers are used for more than the build
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 87ea27e80b131ca11d74c89446d4992af0f6c5b9
Component: engine
2014-04-07 18:37:52 +10:00
bc3cbf9f38 Merge pull request #5005 from shykes/deprecate-insert
Deprecate 'docker insert'
Upstream-commit: 09aa28eca049320f53300f9d7ba9bc28c1033d3b
Component: engine
2014-04-03 17:16:25 -07:00
96808698c3 Deprecate 'docker insert'
'docker insert' is an old command which predates 'docker build'. We no
longer recommend using it, it is not actively maintained, and can be
replaced with the combination of 'docker build' and 'ADD'.

This removes the command from usage and documentation, and prints a
warning when it is called.

The command still works but it will be removed in a future version.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 615ac8feb27b2b3db0c06b37ecd87b710eabffef
Component: engine
2014-04-03 23:52:09 +00:00
14694d6df5 Deprecate 'docker images --tree' and 'docker images --viz'
* The commands are no longer listed or documented.
* The commands still work but print a deprecation warning.
* The commands should be removed in a future version.

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 7c3b955b907c33238c1c155ae8860b2cec929c8b
Component: engine
2014-04-03 22:03:23 +00:00
e3d229211f docs: explain what docker run -a does
This adds a bit of documentation for the `-a` flag for docker run.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 63c7941172376e81c5e17206f39d7c78c0e95b69
Component: engine
2014-04-02 16:23:01 +03:00
99eaa02040 Update docs. Make PULL up to date, remove deprecated falg and update PUSH
Docker-DCO-1.1-Signed-off-by: Guillaume J. Charmes <guillaume@charmes.net> (github: creack)
Upstream-commit: b8d660d946c5f0be3a4f01867b11f26a4f303293
Component: engine
2014-04-01 11:17:54 -07:00
7fc896339a --env-file: simple line-delimited
match dock functionality, and not try to achieve shell-sourcing compatibility

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: ff4ac7441ba582c8c339b25b400c6756d9646ff1
Component: engine
2014-03-31 14:45:13 -04:00
745a00084d env-file: update functionality and docs
Multiple flags allowed. Order prescribed. Examples provided. Multiline
accounted for.

Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 33dde1f7288781a3a36951309f963e6040a1a0f5
Component: engine
2014-03-31 14:45:13 -04:00
654ceecb5b Fixing doc references to --env-file
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: bcba5246f993a74eece36aa4b25df5b5e486e15b
Component: engine
2014-03-31 14:44:32 -04:00
d6e8571af8 --env-file instead of --envfile
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: 586e6c5eb9cd21a95d4bbba051249c4b05b2011e
Component: engine
2014-03-31 14:44:32 -04:00
2d9f166bda support for docker run environment variables file
Docker-DCO-1.1-Signed-off-by: Vincent Batts <vbatts@redhat.com> (github: vbatts)
Upstream-commit: cd51ac92bdf1ce0a1245f5b4565995631512ba64
Component: engine
2014-03-31 14:44:32 -04:00
0b1efc836d Fix daemon's documentation for -bip flag
Upstream-commit: 36dfa0c4ec90404f76a6ec73c89d199e279ee96c
Component: engine
2014-03-28 18:02:17 -04:00