diff options
| author | Michael Scott <michael.scott250@gmail.com> | 2015-06-04 21:51:22 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-08 20:28:31 (GMT) |
| commit | c3f40f4fd98388a2fd31c707e7225d33a7fc76f6 (patch) | |
| tree | 4b76a32ab9bf416fe1b5d5bd60bc68e1f267b3a7 /Help/command/get_filename_component.rst | |
| parent | d17aa60659a1a69f9101c61a149eca5842291226 (diff) | |
| download | CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.zip CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.gz CMake-c3f40f4fd98388a2fd31c707e7225d33a7fc76f6.tar.bz2 | |
Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
Diffstat (limited to 'Help/command/get_filename_component.rst')
| -rw-r--r-- | Help/command/get_filename_component.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index 5eec792..60488da 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -7,7 +7,7 @@ Get a specific component of a full filename. get_filename_component(<VAR> <FileName> <COMP> [CACHE]) -Set <VAR> to a component of <FileName>, where <COMP> is one of: +Set ``<VAR>`` to a component of ``<FileName>``, where ``<COMP>`` is one of: :: @@ -21,7 +21,7 @@ Set <VAR> to a component of <FileName>, where <COMP> is one of: Paths are returned with forward slashes and have no trailing slahes. The longest file extension is always considered. If the optional -CACHE argument is specified, the result variable is added to the +``CACHE`` argument is specified, the result variable is added to the cache. :: @@ -30,8 +30,8 @@ cache. PROGRAM [PROGRAM_ARGS <ARG_VAR>] [CACHE]) -The program in FileName will be found in the system search path or -left as a full path. If PROGRAM_ARGS is present with PROGRAM, then -any command-line arguments present in the FileName string are split -from the program name and stored in <ARG_VAR>. This is used to +The program in ``FileName`` will be found in the system search path or +left as a full path. If ``PROGRAM_ARGS`` is present with ``PROGRAM``, then +any command-line arguments present in the ``FileName`` string are split +from the program name and stored in ``<ARG_VAR>``. This is used to separate a program name from its arguments in a command line string. |