diff options
author | Brad King <brad.king@kitware.com> | 2013-10-29 20:18:29 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-30 14:26:29 (GMT) |
commit | 450b515ad0e94155061e3a9d43fcbab53bf7ac80 (patch) | |
tree | 58c6a7d30990ea5bef642fab16e7eaef9cedba34 /Help | |
parent | 6e900fbe6970981f8c73500581df99fa6b955fa1 (diff) | |
download | CMake-450b515ad0e94155061e3a9d43fcbab53bf7ac80.zip CMake-450b515ad0e94155061e3a9d43fcbab53bf7ac80.tar.gz CMake-450b515ad0e94155061e3a9d43fcbab53bf7ac80.tar.bz2 |
cmRST: Add support for the note and productionlist directives
Simply print out the lines as normal paragraph text. Teach the
CMakeLib.testRST test to cover this syntax. Update the
cmake-developer.7 manual to document support for the directives.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-developer.7.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index ee2016f..5d20c54 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -68,11 +68,21 @@ literal block after ``::`` space. We prefer the ``::`` to appear at the end of a paragraph line instead of as its own line. +``note`` directive + Call out a side note. The command-line help processor prints the + block content as if the lines were normal paragraph text with + interpretation. + ``parsed-literal`` directive Add a literal block with markup interpretation. The command-line help processor prints the block content without the leading directive line and with common indentation replaced by one space. +``productionlist`` directive + Render context-free grammar productions. The command-line help + processor prints the block content as if the lines were normal + paragraph text with interpretation. + ``replace`` directive Define a ``|substitution|`` replacement. The command-line help processor requires a substitution replacement |