opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-07-15 03:02:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

[CI:DOCS] Add restriction to option README

Browse Source 
Add a note about the restriction of the use of
thre back-ticks in the md files in the options directory.
If this is not done properly, it can quietly corrupt
the compliled man pages.

[NO NEW TESTS NEEDED]
Signed-off-by: tomsweeneyredhat <tsweeney@redhat.com>
This commit is contained in:
tomsweeneyredhat
2023-02-17 16:29:52 -05:00
parent ed03493487
commit e74f60deea
1 changed files with 16 additions and 0 deletions
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).
This makes the `pod-id-file` man page more useful. To get the full
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
\`\`\`