Files
podman/docs/source/markdown/podman-umount.1.md
Ed Santiago c6090c290e Docs: consistency between man / --help
New functionality in hack/man-page-checker: start cross-
referencing the man page 'Synopsis' line against the
output of 'podman foo --help'. This is part 1, flag/option
consistency. Part 2 (arg consistency) is too big and will
have to wait for later.

flag/option consistency means: if 'podman foo --help'
includes the string '[flags]' in the Usage message,
make sure the man page includes '[*options*]' in its
Synopsis line, and vice-versa. This found several
inconsistencies, which I've fixed.

While doing this I realized that Cobra automatically
includes a 'Flags:' subsection in its --help output
for all subcommands that have defined flags. This
is great - it lets us cross-check against the
usage synopsis, and make sure that '[flags]' is
present or absent as needed, without fear of
human screwups. If a flag-less subcommand ever
gets extended with flags, but the developer forgets
to add '[flags]' and remove DisableFlagsInUseLine,
we now have a test that will catch that. (This,
too, caught two instances which I fixed).

I don't actually know if the new man-page-checker
functionality will work in CI: I vaguely recall that
it might run before 'make podman' does; and also
vaguely recall that some steps were taken to remedy
that.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-24 10:39:10 -06:00

1.5 KiB

% podman-umount(1)

NAME

podman-umount - Unmount a working container's root filesystem

SYNOPSIS

podman umount [options] container [...]

podman container umount [options] container [...]

podman container unmount [options] container [...]

podman unmount [options] container [...]

DESCRIPTION

Unmounts the specified containers' root file system, if no other processes are using it.

Container storage increments a mount counter each time a container is mounted. When a container is unmounted, the mount counter is decremented and the container's root filesystem is physically unmounted only when the mount counter reaches zero indicating no other processes are using the mount. An unmount can be forced with the --force flag.

OPTIONS

--all, -a

All of the currently mounted containers will be unmounted.

--force, -f

Force the unmounting of specified containers' root file system, even if other processes have mounted it.

Note: This could cause other processes that are using the file system to fail, as the mount point could be removed without their knowledge.

--latest, -l

Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods.

The latest option is not supported on the remote client.

EXAMPLE

podman umount containerID

podman umount containerID1 containerID2 containerID3

podman umount --all

SEE ALSO

podman(1), podman-mount(1)