From e74f60deeacb3bf66b7f25b5bd02893db2f318ca Mon Sep 17 00:00:00 2001 From: tomsweeneyredhat Date: Fri, 17 Feb 2023 16:29:52 -0500 Subject: [PATCH] [CI:DOCS] Add restriction to option README 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 --- docs/source/markdown/options/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/source/markdown/options/README.md b/docs/source/markdown/options/README.md index d8b608fb7e..783f7bcf95 100644 --- a/docs/source/markdown/options/README.md +++ b/docs/source/markdown/options/README.md @@ -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 `<>`. + +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 +\`\`\`