[As I peruse the docker man pages, I'll just add typos/errors I find here.] $ man docker-search: ... snip ... Search Docker Hub for the term 'fedora' and only display automated images ranked 1 or higher: docker search -s 1 -t fedora ... snip ... There is no mention of a "-t" option to this command in the man page, or in the output of "docker search --help". Is that supposed to be a short form for "--automated"? Also, the SYNOPSIS for docker-search doesn't mention "--no-index." Should it?
Looking at man page for "docker pull", the SYNOPSIS suggests an argument of: ... NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG] Doesn't that second (longer) pattern subsume the earlier one? That is, is the pattern "NAME[:TAG]" not already matched by the second pattern?
Yes but is this any benefit for clarity of the user. From a REGEx point of view you are right, but as a user of man pages, I am not sure this makes it clearer. First comment should be fixed though.
A few more nitpicky observations: "man docker-run" ... --net="bridge" ... 'container:': ^ ??? extraneous colon? "man docker-rmi" "removing and [sic] image" "man docker-tag" "To push an image to an [sic] private registry ..."
Sent a pull request upstream for a couple of these https://github.com/docker/docker/pull/14587 The others are caused by our patches.
In "man docker-run", here's the explanation of the "-p" option: -p, --publish=[] Publish a container's port, or range of ports, to the host. format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort Both hostPort and containerPort can be specified as a range of ports. When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. (e.g., -p 1234-1236:1234-1236/tcp) First, what means the prefix "ip:" in the first couple formats? Is that supposed to represent the IP protocol? Since the final example using ranges shows "/tcp" being used as a *suffix*, which is not mentioned in the format earlier.
https://github.com/docker/docker/pull/14587 merged so at least those fixes will be in docker-1.8
I notice that the docker-related man pages have the EXAMPLES section rendered as, for example: EXAMPLES.SH Search Docker Hub for ranked images What's with the ".SH" bit? Is that supposed to be a section heading directive that is somehow being rendered as plain text? It's in quite a number of man pages.
"man docker-ps" "By default this show [sic] only ..." ... snip ... --before="" Show only container[s] created "man docker-search" "Search Docker Hub for an image with [sic] that matches ..." "man docker-pull" [Seems to be missing line break before "--help", at least on my F22 system] OPTIONS -a, --all-tags=true|false Download all tagged images in the repository. The default is false. --help Print usage statement That should do it for now.
"man docker-inspect" The format examples shown don't appear to represent valid go templates; eg. docker inspect --format='.NetworkSettings.IPAddress' 1eb5fabf5a03 Pretty sure that should be: docker inspect --format='{{.NetworkSettings.IPAddress}}' 1eb5fabf5a03 A quick test on my fedora image shows the difference: sh-4.3# docker inspect --format='.Architecture' fedora .Architecture sh-4.3# docker inspect --format='{{.Architecture}}' fedora amd64
https://bugzilla.redhat.com/show_bug.cgi?id=1240714#c10 docker inspect --format='{{.NetworkSettings.IPAddress}}' 1eb5fabf5a03 is a bug in the tool used to generate the man pages. Looks like it is fixed here. https://github.com/cpuguy83/go-md2man/issues/13
Notes on "man docker" page: --exec-root="" Path to use as the root of the Docker execdriver. ^^^^^^^^^^ "exec driver" General note: Are the "Options:" listed when you run "docker --help" supposed to match exactly the options relevant for invoking the daemon that are listed on the "docker" man page under "OPTIONS"? Discrepancies: --default-ulimit not listed on man page --dns-search not listed on man page --insecure-registry not listed on man page --tlscacert, --tlscert, --tlskey not listed on man page "If --fixed-cidr-v6 is set. IPv6 forwarding will be activated, too." ^ should be comma -s, --storage-driver="" Force the Docker runtime to use a specific storage driver. In the above, would it not be useful to list the available storage drivers, as other options list *their* possible values? (e.g., devicemapper) Under COMMANDS, the "rename" command seems to be missing. dm.loopmetadatasize Specifies the size to use when creating the loopback file for the "metadadata" device ... ?????????? "When udev sync support is false, a race condition occurs between thedevicemapper ... ^ missing space EXEC DRIVER OPTIONS Use the --exec-opt flags to specify options to the exec-driver. The only driver that accepts this flag is the native (libcontainer) driver. As a result, you must also specify -s=native for this option to have effect. ^^^^^^^^^ But as I mentioned earlier, there is no list of valid "-s" options for the reader, so the reader won't understand what "-s=native" means, or even that "native" is a valid choice for that option. I think that's it for now.
Yes. Missing options in man pages are bugs. You could also submit pull requests on github.com/rhatdan/docker https://github.com/rhatdan/docker This bugzilla is becoming very difficult to use since some have been fixed and others not. Either we need to move to pull requests or we need separate bugzillas, to help us track fixes.
Since, in a lot of cases, I don't *know* what the fix is, I'll start submitting separate bugzillas, but I'll try to at least collect a few related things in each report.
Yes grouping them together would be fine. But each time you find a new group open a new bugzilla. BTW Thanks for this work.
I'm going through this to determine what is/isn't fixed. I've submitted https://github.com/docker/docker/pull/15257 (merged) and https://github.com/docker/docker/pull/15259 (pending) to add missing options in 'man docker'.
One nitpick: the second submission added a help entry for the option "--tlsacert", should be "--tlscacert".
(In reply to Robert P. J. Day from comment #17) > One nitpick: the second submission added a help entry for the option > "--tlsacert", should be "--tlscacert". fixed that, thanks.
Have we fixed all of the problems in this bug report. I would like to close it and work on individual bugzilla's for each issue.
I think with this PR, all problems in this report have been addressed: https://github.com/docker/docker/pull/17024 submitted
added clarity to man/docker-run -p option https://github.com/docker/docker/pull/17024 merged
Fixed in docker-1.9