diff options
| author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-03-27 08:57:30 (GMT) |
|---|---|---|
| committer | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-03-27 15:01:29 (GMT) |
| commit | 5e958ccd79024cb0dbd654ecd71120e6367d6cc4 (patch) | |
| tree | 964b5d2bed8874352a1d3c71097a4bb400ca4209 /Help | |
| parent | 07f3082d3b52f1bcba8dd4ef82b3e02c362b392e (diff) | |
| download | CMake-5e958ccd79024cb0dbd654ecd71120e6367d6cc4.zip CMake-5e958ccd79024cb0dbd654ecd71120e6367d6cc4.tar.gz CMake-5e958ccd79024cb0dbd654ecd71120e6367d6cc4.tar.bz2 | |
Help: Improve Cache documentation
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/prop_cache/ADVANCED.rst | 2 | ||||
| -rw-r--r-- | Help/prop_cache/STRINGS.rst | 4 | ||||
| -rw-r--r-- | Help/prop_cache/TYPE.rst | 6 |
3 files changed, 6 insertions, 6 deletions
diff --git a/Help/prop_cache/ADVANCED.rst b/Help/prop_cache/ADVANCED.rst index a0a4f73..ec4de9d 100644 --- a/Help/prop_cache/ADVANCED.rst +++ b/Help/prop_cache/ADVANCED.rst @@ -4,5 +4,5 @@ ADVANCED True if entry should be hidden by default in GUIs. This is a boolean value indicating whether the entry is considered -interesting only for advanced configuration. The mark_as_advanced() +interesting only for advanced configuration. The :command:`mark_as_advanced` command modifies this property. diff --git a/Help/prop_cache/STRINGS.rst b/Help/prop_cache/STRINGS.rst index 2f8e32e..0e3c326 100644 --- a/Help/prop_cache/STRINGS.rst +++ b/Help/prop_cache/STRINGS.rst @@ -1,9 +1,9 @@ STRINGS ------- -Enumerate possible STRING entry values for GUI selection. +Enumerate possible ``STRING`` entry values for GUI selection. -For cache entries with type STRING, this enumerates a set of values. +For cache entries with type ``STRING``, this enumerates a set of values. CMake GUIs may use this to provide a selection widget instead of a generic string entry field. This is for convenience only. CMake does not enforce that the value matches one of those listed. diff --git a/Help/prop_cache/TYPE.rst b/Help/prop_cache/TYPE.rst index eb75c2a..7ca859f 100644 --- a/Help/prop_cache/TYPE.rst +++ b/Help/prop_cache/TYPE.rst @@ -5,7 +5,7 @@ Widget type for entry in GUIs. Cache entry values are always strings, but CMake GUIs present widgets to help users set values. The GUIs use this property as a hint to -determine the widget type. Valid TYPE values are: +determine the widget type. Valid ``TYPE`` values are: :: @@ -17,5 +17,5 @@ determine the widget type. Valid TYPE values are: STATIC = Value managed by CMake, do not change. UNINITIALIZED = Type not yet specified. -Generally the TYPE of a cache entry should be set by the command which -creates it (set, option, find_library, etc.). +Generally the ``TYPE`` of a cache entry should be set by the command which +creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.). |