Commit Graph

19 Commits

Author SHA1 Message Date
W. Trevor King f2462ca59e docs: Follow man-pages(7) suggestions for SYNOPSIS
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.

[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: W. Trevor King <wking@tremily.us>

Closes: #1027
Approved by: rhatdan
2018-07-04 09:40:37 +00:00
TomSweeneyRedHat 89af35175d Add cap-add and cap-drop to build man page
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #968
Approved by: mheon
2018-06-22 14:55:32 +00:00
umohnani8 6bdf023aea Vendor in latest projectatomic/buildah
Adds --rm and --force-rm to podman build.

Signed-off-by: umohnani8 <umohnani@redhat.com>

Closes: #945
Approved by: rhatdan
2018-06-14 19:24:37 +00:00
Daniel J Walsh be217caa38 Vendor in latest buildah code
This will add --layers support.
Also add missing information in man pages on podman build features.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #938
Approved by: umohnani8
2018-06-13 12:49:32 +00:00
TomSweeneyRedHat 9b72746f9a Touchups for registries.conf across a few man pages
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #927
Approved by: rhatdan
2018-06-11 20:38:37 +00:00
TomSweeneyRedHat 2b372e6ac9 Touch up whitespace issue in build man
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
2018-06-07 11:22:09 -04:00
TomSweeneyRedHat b1ebad93b4 Add disable-content flag info to man page for build
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #916
Approved by: rhatdan
2018-06-06 20:15:06 +00:00
Daniel J Walsh 71487466fb Cleanup man pages
Format md files to work properly when converted to man pages.
Add sed command to cleanup table in podman man page.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #842
Approved by: mheon
2018-05-30 13:49:45 +00:00
Daniel J Walsh 915364034f Update podman build to match buildah bud functionality
Add --label, --annotations, --idfile, --squash

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #824
Approved by: TomSweeneyRedHat
2018-05-23 22:38:17 +00:00
Joe Doss c1efde20e0 Clarify using podman build with a URL, Git repo, or archive.
Signed-off-by: Joe Doss <joe@solidadmin.com>

Closes: #822
Approved by: rhatdan
2018-05-23 17:40:25 +00:00
Daniel J Walsh 9fcc475d03 Support pulling Dockerfile from http
Currently podman build http://remote.com/Dockerfile does not work.
podman always treats this file as an Archive.

Vendoring in the latest buildah code fixes this issue.  Also updated
the man pages to better explain the syntax.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #775
Approved by: TomSweeneyRedHat
2018-05-16 14:39:55 +00:00
TomSweeneyRedHat 40da888274 Add iidfile parame to build and commit man pages
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #693
Approved by: mheon
2018-04-30 21:31:46 +00:00
TomSweeneyRedHat d7d0e13837 Add isolation note to build man page
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #677
Approved by: rhatdan
2018-04-26 14:11:12 +00:00
TomSweeneyRedHat 042139673e Add buildah bud options from common.go
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #453
Approved by: rhatdan
2018-03-06 23:55:46 +00:00
umohnani8 fff9a1ee20 Change default certs dir to /etc/containers/certs.d
Updated man pages to reflect the change

Signed-off-by: umohnani8 <umohnani@redhat.com>
2018-02-06 17:10:10 -05:00
TomSweeneyRedHat 03cfe5ebbe Add authfile, cert-dir and creds params to build
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #280
Approved by: mheon
2018-02-01 14:43:54 +00:00
Daniel J Walsh 099b5fb6f6 Ran spell checker through all man pages
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #269
Approved by: TomSweeneyRedHat
2018-01-29 15:21:34 +00:00
TomSweeneyRedHat 67f06cf1cf Touchup build to add missing -q flag
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #247
Approved by: rhatdan
2018-01-20 05:41:24 +00:00
TomSweeneyRedHat ea5620182f Initial podman build
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>

Closes: #162
Approved by: rhatdan
2017-12-23 11:47:33 +00:00