diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2022-09-01 23:41:53 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-01 23:41:53 +0200 |
commit | 475cac4432a72052a000e9be91cd721d03e01eb8 (patch) | |
tree | 9609877167e03e29a8be9d09e605ba970d0cacd7 | |
parent | d0d1af338a500f2ad00d5ce0638901465602817d (diff) | |
parent | c63830166c31e7760f5bf4120cd774dda6683c60 (diff) | |
download | podman-475cac4432a72052a000e9be91cd721d03e01eb8.tar.gz podman-475cac4432a72052a000e9be91cd721d03e01eb8.tar.bz2 podman-475cac4432a72052a000e9be91cd721d03e01eb8.zip |
Merge pull request #15601 from edsantiago/docs_dedup_name
[CI:DOCS] Man pages: refactor common options: --name
-rw-r--r-- | docs/source/markdown/options/name.container.md | 14 | ||||
-rw-r--r-- | docs/source/markdown/podman-create.1.md.in | 14 | ||||
-rw-r--r-- | docs/source/markdown/podman-run.1.md.in | 15 |
3 files changed, 16 insertions, 27 deletions
diff --git a/docs/source/markdown/options/name.container.md b/docs/source/markdown/options/name.container.md new file mode 100644 index 000000000..0c3df6ef1 --- /dev/null +++ b/docs/source/markdown/options/name.container.md @@ -0,0 +1,14 @@ +#### **--name**=*name* + +Assign a name to the container. + +The operator can identify a container in three ways: + +- UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”); +- UUID short identifier (“f78375b1c487”); +- Name (“jonah”). + +Podman generates a UUID for each container, and if a name is not assigned +to the container with **--name** then it will generate a random +string name. The name is useful any place you need to identify a container. +This works for both background and foreground containers. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 10f0f7f56..987f10181 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -299,19 +299,7 @@ This option is currently supported only by the **journald** log driver. @@option mount -#### **--name**=*name* - -Assign a name to the container - -The operator can identify a container in three ways: -UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”) -UUID short identifier (“f78375b1c487”) -Name (“jonah”) - -podman generates a UUID for each container, and if a name is not assigned -to the container with **--name** then it will generate a random -string name. The name is useful any place you need to identify a container. -This works for both background and foreground containers. +@@option name.container #### **--network**=*mode*, **--net** diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index b63c37e6f..64affa238 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -327,20 +327,7 @@ system's page size (the value would be very large, that's millions of trillions) @@option mount -#### **--name**=*name* - -Assign a name to the container. - -The operator can identify a container in three ways: - -- UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”); -- UUID short identifier (“f78375b1c487”); -- Name (“jonah”). - -Podman generates a UUID for each container, and if a name is not assigned -to the container with **--name** then it will generate a random -string name. The name is useful any place you need to identify a container. -This works for both background and foreground containers. +@@option name.container #### **--network**=*mode*, **--net** |