Also do some minor re-formatting of the `LIMITATIONS` section. Reducing
the line-length, and formatting each paragraph into a bullet-item.
Signed-off-by: Chris Evich <cevich@redhat.com>
Run 'buildah --help', recursively against all subcommands,
then cross-reference the results against docs/buildah*.md.
Report differences in subcommands and/or flags.
The majority of the changes in this PR are trivial (see
below) but a handful may be controversial and require
careful review:
* Making 'bud' the default output of 'buildah help',
with 'build-using-dockerfile' as an alias. This is
the inverse of the situation until now: buildah
would list build-using-dockerfile as the primary
name. The man page, OTOH, lists 'bud'. The source
file name is 'bud'. I suspect that most people
type 'bud'. So, for consistency, I choose to make
'bud' the default visible command.
* add --encryption-key and --encrypt-layer documentation
to buildah-commit.md, and --encrypt-layer to -push.md.
Please double-check the wording here.
* remove --notruncate from buildah-images.md. The option
does not exist (although there is a TODO comment in
the code). If it should exist, it is left to the
reader to implement. I would humbly suggest that this
is a good idea, for consistency with buildah containers.
* remove --shm-size from buildah-pull.md. The option
does not exist, and I suspect this was a copy-paste error.
* remove --security-opt from run.go. It was unimplemented
and undocumented.
* remove --userns-[gu]id-map from buildah-bud.md. These
are global options, not bud options, and are documented
well enough in buildah.bud.
Trivial (IMO) changes:
* split options in man pages, from '**--foo, -f**'
to '**--foo**, **-f**'. This conforms with the style
used in podman man pages.
* add missing one-letter aliases (usually "-q", "-a")
* add missing man page entries for some easy options
* sort out-of-order subcommand listings in man pages
Finally, do note that this is a copy-and-alter duplicate of the
original script in podman, and that is horrible. In an ideal
world I would've been able to refactor the podman version into
something usable on both repos (and then more). It turns out the
differences in man page format and in special-case handling are
too broad to let me do a clean refactor.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Fix man page instances of 'registries.conf(5)' et al.
The correct man page is containers-registries.conf(5).
Found via:
$ for i in registries.conf storage.conf policy.json ; do grep $i.5 docs/*.md | grep -v containers-$i;done
In buildah.md, I simply removed the storage.conf line from
the 'Commands' table because it's not a command.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Closes: #2068
Approved by: TomSweeneyRedHat
When deleting all images, ignore read/only images.
If user attempts to remove a read/only image, report an error.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Closes: #1732
Approved by: @TomSweeneyRedHat
man-pages(7) has [1]:
> For commands, this shows the syntax of the command and its arguments
> (including options); boldface is used for as-is text and italics are
> used to indicate replaceable arguments. Brackets ([]) surround
> optional arguments, vertical bars (|) separate choices, and ellipses
> (...) can be repeated.
I've adjusted our SYNOPSIS entries to match that formatting, and
generally tried to make them more consistent with the precedent set by
the man-pages project. Outside of the SYNOPSIS entry, I prefer using
backticks for literals, although in some places I've left the **
bolding to keep things visually similar to a nearby SYNOPSIS entry.
I've also simplified a few placeholders, e.g. "containerID" ->
"container", because I didn't think the additional bit was providing
much additional context. If there is ambiguity about the
representation, it should be addressed in the DESCRIPTION instead of
with an "ID" or "Name" suffix.
[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #839
Approved by: rhatdan
Extend util.ResolveName() to prepend "localhost" to the list of
registries, and teach util.FindImage(), util.ExpandNames(), and
util.AddImageNames() to use util.ResolveName().
Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
Closes: #648
Approved by: rhatdan
This fixes an issue where if you did
man -k buildah-bud
buildah-bud (1) - (unknown subject)
Now you will see
man -k buildah-bud
buildah-bud (1) - Build an image using instructions from Dockerfiles.
More importantly
man -k Dockerfile
buildah-bud (1) - Build an image using instructions from Dockerfiles.
docker-build (1) - Build an image from a Dockerfile
docker-image-build (1) - Build an image from a Dockerfile
Dockerfile (5) - automate the steps of creating a Docker image
podman-build (1) - Build a container image using a Dockerfile.
Will now list buildah-d
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Closes: #638
Approved by: TomSweeneyRedHat
I noticed when you look at the man pages with man ./doc/buildah.1 that the
headings were not showing up. go-md2man wanted to have a primary header
in order to format them correctly. Removing the first # from the first line
fixes the issue.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Closes: #521
Approved by: rhatdan
Allows rmi to remove all dangling images (images without a tag and without a child image)
Add new test case
Signed-off-by: Arthur Mello <amello@redhat.com>
Closes: #418
Approved by: rhatdan
Chris Evich
Kye Shi
Ed Santiago
Daniel J Walsh
TomSweeneyRedHat
W. Trevor King
Nalin Dahyabhai
Arthur Mello
Ryan Cole
TomSweeneyRedHat