Commit Graph

7 Commits

Author SHA1 Message Date
d83ba877bb Document valid chars in image name and tag
- Add link to valid image name and tag formats in referenced files
- Per review comments, updated docs to remove reference to `USERNAME` and
`REGISTRYHOST`.
- Per review comment, removed links from man page.
- Per review comment, added and updated examples on `docker tag`

Signed-off-by: Subhajit Ghosh <isubuz.g@gmail.com>
Upstream-commit: ea98cf74aad3c2633268d5a0b8a2f80b331ddc0b
Component: engine
2016-05-21 19:49:19 +01:00
b51b5af287 Fix man and commandline docs
- missing help option in `docs/reference/commandline/*.md` (some files
  have it, the other I fixed didn't)
- missing `[OPTIONS]` in Usage description
- missing options
- formatting
- start/stop idempotence

Signed-off-by: Antonio Murdaca <amurdaca@redhat.com>
Upstream-commit: 14e8898648909379f37049828e103ba1c97f253b
Component: engine
2015-10-04 21:22:27 +02:00
cc1d2ef1b9 fix format man-commit
Signed-off-by: Sally O'Malley <somalley@redhat.com>
Upstream-commit: ab9e71b6167e636c01c7a82726f1de4e74a48607
Component: engine
2015-08-19 10:07:32 -04:00
72d80b3764 Modify man pages for image-naming
This PR adds recommendations in man pages to use only [a-z0-9-_.] when
naming and tagging images.  The purpose of this is to add consistency
and to make image naming caps rules seem less arbitrary.

This PR addresses confusion with:
1. BaseImage:Tagged (not allowed)
2. baseimage:Tagged (allowed)
3. baseimage/tagged:V1 (allowed)
4. baseimage/Tagged:V1 (not allowed)

Signed-off-by: Sally O'Malley <somalley@redhat.com>
Upstream-commit: 05a86905a2e476ec9261db9107101da77a7e49f4
Component: engine
2015-07-13 15:49:41 -04:00
5b5bcdcb21 Align 'docker commit' docs with the code
It was missing some variants and 'maintainer' isn't actually supported.
Also sorted the list of allowed cmds in the code just to make it easier
to diff with the docs.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 0bf0e5a6efb6d4718f18db11084295aaba2062e3
Component: engine
2015-07-09 13:17:47 -07:00
d49aa7e5dc Update docker commit man page re: volumes
Update the man page for 'docker commit' to make explicit the fact that
'commit' does not save data in volumes.

Addresses comments in #7583

Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
Upstream-commit: a9747895375a27e0f4d46d9cf8f501815e5b2642
Component: engine
2015-07-06 10:16:21 -04:00
84b8fc6fe1 Moving man pages out of docs
Adding in other areas per comments
Updating with comments; equalizing generating man page info
Updating with duglin's comments
Doug is right here again;fixing.

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: eacae64bd89ccc95a6db7bda76d36014e71e70ac
Component: engine
2015-06-10 13:43:35 -07:00