Skip to content

Commit

Permalink
Merge pull request #17561 from TomSweeneyRedHat/dev/tsweeney/optionre…
Browse files Browse the repository at this point in the history
…adme

[CI:DOCS] Add restriction to option README
  • Loading branch information
openshift-merge-robot authored Feb 19, 2023
2 parents 7c15d8e + e74f60d commit 2e0ee6e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/source/markdown/options/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
\`\`\`

0 comments on commit 2e0ee6e

Please sign in to comment.