Merge pull request #9856 from Luap99/fix-longflag

[CI:DOCS] Fix long option format on docs.podman.io
containers · Mar 29, 2021 · 00792f8 · 00792f8
2 parents 5e156c8 + bc48211
commit 00792f8
Show file tree

Hide file tree

Showing 113 changed files with 960 additions and 962 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,13 +29,9 @@
 # ones.
 extensions = [
     "sphinx_markdown_tables",
+    "recommonmark"
 ]
 
-source_parsers = {
-    ".md": "recommonmark.parser.CommonMarkParser",
-}
-
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/docs/source/markdown/podman-attach.1.md b/docs/source/markdown/podman-attach.1.md
@@ -14,24 +14,24 @@ or name, either to view its ongoing output or to control it interactively.
 
 You can detach from the container (and leave it running) using a configurable key sequence. The default
 sequence is `ctrl-p,ctrl-q`.
-Configure the keys sequence using the **--detach-keys** option, or specifying
+Configure the keys sequence using the **\-\-detach-keys** option, or specifying
 it in the **containers.conf** file: see **containers.conf(5)** for more information.
 
 ## OPTIONS
-#### **--detach-keys**=*sequence*
+#### **\-\-detach-keys**=*sequence*
 
 Specify the key sequence for detaching a container. Format is a single character `[a-Z]` or one or more `ctrl-<value>` characters where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. Specifying "" will disable this feature. The default is *ctrl-p,ctrl-q*.
 
-#### **--latest**, **-l**
+#### **\-\-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. (This option is not available with the remote Podman client)
 
-#### **--no-stdin**
+#### **\-\-no-stdin**
 
 Do not attach STDIN. The default is false.
 
-#### **--sig-proxy**=*true*|*false*
+#### **\-\-sig-proxy**=*true*|*false*
 
 Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
 

diff --git a/docs/source/markdown/podman-auto-update.1.md b/docs/source/markdown/podman-auto-update.1.md
@@ -34,7 +34,7 @@ Podman ships with a `podman-auto-update.service` systemd unit.  This unit is tri
 
 ## OPTIONS
 
-#### **--authfile**=*path*
+#### **\-\-authfile**=*path*
 
 Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
 If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`.