Red Hat Bugzilla – Bug 1257492
Various pedantic docker man page tweaks.
Last modified: 2016-07-19 16:13:13 EDT
(Not sure if I've reported any of these before so ... enjoy.)
docker attach [--help]/ ...
^ ??? (what's with the slash?)
docker commit [-a|--author[=AUTHOR]] [--help] [-c|--change[= ]] [-m|--message[=MESSAGE]] ...
- you lose the proper bolding starting at "-m|--message", just verify
proper font/rendering of entire SYNOPSIS
Print usage statement -o, --output=""
Write to a file, instead of STDOUT
- formatting of above is screwed up, and that option is not mentioned
in the SYNOPSIS
- SYNOPSIS missing -H|--human option
- weird stuff going on with SYNOPSIS, then OPTIONS, then DESCRIPTION, then
back to OPTIONS. Also bolding issue in SYNOPSIS.
- In NAME line, there's a reference to".bzip" tarballs; pretty sure you
mean .bz2, no? Or maybe .zip?
- Entire -r,--remote section under OPTIONS has broken formatting.
- Under EXAMPLES, "where image name [conflict] sic"
More a question -- does rename work for both running and non-running
containers? That would be useful to mention.
##Removing a container using its ID##
^^ font issue, this line and further down
If you force the removal of the image for a running container, what happens
to the container? That might be useful to mention here.
SYNOPSIS is missing --no-index option.
SYNOPSIS is missing --no-stream option.
List of OPTIONS is missing --help. Wait, why are there two OPTIONS
sections, both mentioning -f,--force?
That should do for now.
Let me throw in one more bit of nitpickery here -- from:
$ man docker-search
Only displays with at least x stars
For consistency with other man pages, that might read:
Only display with at least X stars. The default is zero.
Otherwise, the reference to "x" is kind of hanging out there all
by its lonesome.
Hang on, not sure I've reported this before but still with:
$ man docker-search
the second example claims:
Search Docker Hub for automated images
Search Docker Hub for the term 'fedora' and only display automated
images ranked 1 or higher:
$ docker search -s 1 fedora
Pretty sure that command needs an "--automated" option, no?
Sally can you fix this one ^^
Sally does that mean all of these are fixed now?
Can we mark this modified and fixed in docker-1.9?
(In reply to Daniel Walsh from comment #5)
> Sally does that mean all of these are fixed now?
> Can we mark this modified and fixed in docker-1.9?
I'll check that they are all resolved...
This PR addresses the rest of the issues in this bug except:
1) man/docker-search - deprecated --no-index? no longer there
2) man/docker-rmi - force remove image of running container - no change bc an informative error msg is displayed when one tries to do this.
> 1) man/docker-search - deprecated --no-index? no longer there
This is RHEL only, never made it to upstream.
Ok as long as we have the --no-index in the package and the man page for RHEL and Fedora packages. we are good.
Robert I am going to close this bug as modified/fixed in docker-1.9 If you get a chance to review the changes their that would be great.
BTW Thanks for all the work you have done to clean up the man pages.
Putting this ON_QA so we can close it out soon. The updates with this fix are already in stable. We have 1.10.1 in testing repos right now.
Fedora 22 changed to end-of-life (EOL) status on 2016-07-19. Fedora 22 is
no longer maintained, which means that it will not receive any further
security or bug fix updates. As a result we are closing this bug.
If you can reproduce this bug against a currently maintained version of
Fedora please feel free to reopen this bug against that version. If you
are unable to reopen this bug, please file a new report against the
current release. If you experience problems, please add a comment to this
Thank you for reporting this bug and we are sorry it could not be fixed.