containers/podman

podman commit --include-volumes does only work with value true documentation needs to reflect that

Open

#15,387 opened on Aug 19, 2022

View on GitHub
 (29 comments) (1 reaction) (0 assignees)Go (3,107 forks)batch import
ContribfestGood First Issuekind/bugkind/featurevolunteers-wanted

Repository metrics

Stars
 (31,686 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

/kind bug

Description documentation at https://docs.podman.io/en/latest/markdown/podman-commit.1.html reads:

--include-volumes

Include in the committed image any volumes added to the container by the --volume or --mount OPTIONS to the podman create and podman run commands. The default is false.

Steps to reproduce the issue:

  1. podman commit --include-volumes [options] container [image]

  2. podman run --name [name] [options] [image]

  3. podman exec -it [options] [container] /bin/ls path-to-volume

  4. is not altered

Describe the results you received:

using the option does not include the altered volumes

Describe the results you expected:

does include altered volumes, or throws error because of value not specified

OR at least:

documentation should read

--include-volumes=bool (true/false)

Include in the committed image any volumes added to the container by the --volume or --mount OPTIONS to the podman create and podman run commands. The default is false.

like documentation at https://docs.podman.io/en/latest/markdown/podman-run.1.html

--cgroupns=mode

Set the cgroup namespace mode for the container.

host: use the host’s cgroup namespace inside the container. container:id: join the namespace of the specified container. private: create a new cgroup namespace. ns:path: join the namespace at the specified path. If the host uses cgroups v1, the default is set to host. On cgroups v2, the default is private.

Contributor guide