Red Hat Bugzilla – Bug 1252161
Various tweaks to "atomic" subcommand man pages
Last modified: 2016-07-19 16:12:21 EDT
* subcommands listed under OPTIONS missing line breaks so all crunched together, also -r, --reboot options not mentioned in SYNOPSIS.
* SYNOPSIS should refer to both -h and --help as options, since --help is listed under OPTIONS. This inconsistency seems to occur in a number of "atomic" subcommand man pages.
If the container image has a LABEL RUN instruction like the following:
LABEL RUN /usr/bin/docker run -t -i --rm \$OPT1 --cap-add=SYS_ADMIN --net=host -v \$LOGDIR:/var/log -v
\$DATADIR:/var/lib --name \$NAME \$IMAGE \$OPT2 run.sh \$OPT3
but there's no "if" part after this ... it just goes on to the next sentence:
"If this field does not exist ..."
Also, that man page is confusing in terms of which command will be run. Early on, says that if LABEL RUN does not exist, "atomic run defaults to the following: /usr/bin/docker run -t -i --rm -v $LOGDIR:/var/log -v $DATADIR:/var/lib --name $NAME $IMAGE"
But at the *bottom* of the "atomic-run" man page:
"The image will run with the following command:
/usr/bin/docker run -t -i --rm --privileged -v /:/host -v /run:/run --net=host --ipc=host --pid=host -e HOST=/host -e
NAME=$NAME -e IMAGE=$IMAGE --name $NAME $IMAGE"
So which is it?
"If the container image has a LABEL STOP instruction like the following:
"CLABEL STOP /usr/bin/docker kill -s HUP --name $NAME $IMAGE
^ ??? "CLABEL"? Is that correct?
"... if this field does not exists [sic]"
"atomic update will pull the latest update of the image from the repository If ..."
^ Missing period.
"If a previously [sic] container based on this image exists, ..."
"atomic upload will upload of [sic] the image to the repository"
"If the tool finds a [sic] out of date image ..."
List of options missing line breaks, crunched together.
Also SYNOPSIS, "[-r], [--recurse]" should probably be just "[-r, --recurse]".
As a general rule, the "atomic" subcommand man pages should be structured with an OPTIONS section followed by a separate COMMANDS section, the same way it's done with, say, "man docker."
For an example of this *not* being done, see "man atomic-host", where the OPTIONS section simply runs into talking about subcommands (unless that's simply a typo or formatting glitch).
I'll probably have one more set of notes on the atomic-related man pages shortly, then I'll leave it at that.
Last set of notes on various "atomic" man pages.
atomic host status|upgrade|rollback <-- should be bold, no?
I'm intrigued that "atomic images" has a --prune option to delete dangling images, but "docker images" doesn't. Any reason for that?
In OPTIONS section, seems like line breaks are missing after each option. That is,
-o|--options OPTIONS Specify options to be passed ...
should be rendered as:
Specify options to be passed ...
In SYNOPSIS, "[-f][--force]" should be "[-f|--force]", no? Also, further down in OPTIONS section, "-f --force" should be "-f|--force". Or is it "-f,--force"? What's the standard?
In SYNOPSIS, "[-f][--force]" -> "[-f|--force]"
In OPTIONS, "-f --force" -> "-f,--force" (or whatever)
Same issue with "-p", "--pulp" as in previous note.
I'm going to leave it at that.
I think I covered them all!
In the update to docs/atomic-update.1.md, I see new line 10:
That doesn't look right.
(In reply to Robert P. J. Day from comment #5)
> In the update to docs/atomic-update.1.md, I see new line 10:
> That doesn't look right.
thanks :) fixed it
Fixed in atomic-1.3
Lokesh can you build a new version of atomic for Fedora.
This package has changed ownership in the Fedora Package Database. Reassigning to the new owner of this component.
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.