containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #17561 from TomSweeneyRedHat/dev/tsweeney/optionreadme 

[CI:DOCS] Add restriction to option README
This commit is contained in:
OpenShift Merge Robot 2023-02-19 20:56:58 +01:00 committed by GitHub
parent 7c15d8e16f e74f60deea
commit 2e0ee6ed50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/source/markdown/options/README.md
View File

@ -45,3 +45,19 @@ This allows the shared use of examples in the option file:
As a special case, `podman-pod-X` becomes just `X` (the "pod" is removed). As a special case, `podman-pod-X` becomes just `X` (the "pod" is removed).
This makes the `pod-id-file` man page more useful. To get the full This makes the `pod-id-file` man page more useful. To get the full
subcommand including 'pod', use `<<fullsubcommand>>`. subcommand including 'pod', use `<<fullsubcommand>>`.
Restrictions
============
There is a restriction for having a single text line with three
back-ticks in the front and the end of the line. For instance:
\`\`\`Some man page text\`\`\`
This is currently not allowed and will cause a corruption of the
compiled man page. Instead, put the three back-ticks on separate
lines like:
\`\`\`
Some man page text
\`\`\`