Merge topic 'improve-properties-help'

6f82b5e8 Help: Link to properties in set_tests_properties.
66f5af29 Help: Link to properties in set_directory_properties docs.
f7dd3f7c Help: Add link in set_source_files_properties command docs.
3b256173 Help: Shorten too-long title marker.
8fc3a2fb Help: Add references to cmake-property sections.

Help/command/set_directory_properties.rst

@@ -7,9 +7,6 @@ Set a property of the directory.
 
   set_directory_properties(PROPERTIES prop1 value1 prop2 value2)
 
-Set a property for the current directory and subdirectories.  If the
+Set a property for the current directory and subdirectories. See
-property is not found, CMake will report an error.  The properties
+:ref:`Directory Properties` for the list of properties known
-include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES,
+to CMake.
-INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES.
-ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned as
-a part of "make clean" stage.

Help/command/set_source_files_properties.rst

@@ -10,6 +10,6 @@ Source files can have properties that affect how they are built.
                               [prop2 value2 [...]])
 
 Set properties associated with source files using a key/value paired
-list.  See properties documentation for those known to CMake.
+list.  See :ref:`Source File Properties` for the list of properties known
-Unrecognized properties are ignored.  Source file properties are
+to CMake.  Source file properties are visible only to targets added
-visible only to targets added in the same directory (CMakeLists.txt).
+in the same directory (CMakeLists.txt).

Help/command/set_tests_properties.rst

@@ -8,29 +8,7 @@ Set a property of the tests.
   set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2)
 
 Set a property for the tests.  If the test is not found, CMake
-will report an error.  Generator expressions will be expanded the same
+will report an error.
-as supported by the test's add_test call.  The properties include:
+:manual:`Generator expressions <cmake-generator-expressions(7)>` will be
-
+expanded the same as supported by the test's :command:`add_test` call.  See
-WILL_FAIL: If set to true, this will invert the pass/fail flag of the
+:ref:`Test Properties` for the list of properties known to CMake.
-test.
-
-PASS_REGULAR_EXPRESSION: If set, the test output will be checked
-against the specified regular expressions and at least one of the
-regular expressions has to match, otherwise the test will fail.
-
-::
-
-  Example: PASS_REGULAR_EXPRESSION "TestPassed;All ok"
-
-FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of
-specified regular expressions, the test will fail.
-
-::
-
-  Example: FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
-
-Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a list
-of regular expressions.
-
-TIMEOUT: Setting this will limit the test runtime to the number of
-seconds specified.

Help/manual/cmake-properties.7.rst

@@ -7,6 +7,8 @@ cmake-properties(7)
 
    .. contents::
 
+.. _`Global Properties`:
+
 Properties of Global Scope
 ==========================
 
@@ -41,6 +43,8 @@ Properties of Global Scope
    /prop_gbl/TARGET_SUPPORTS_SHARED_LIBS
    /prop_gbl/USE_FOLDERS
 
+.. _`Directory Properties`:
+
 Properties on Directories
 =========================
 
@@ -72,6 +76,8 @@ Properties on Directories
    /prop_dir/VS_GLOBAL_SECTION_POST_section
    /prop_dir/VS_GLOBAL_SECTION_PRE_section
 
+.. _`Target Properties`:
+
 Properties on Targets
 =====================
 
@@ -245,6 +251,8 @@ Properties on Targets
    /prop_tgt/XCODE_ATTRIBUTE_an-attribute
    /prop_tgt/XCTEST
 
+.. _`Test Properties`:
+
 Properties on Tests
 ===================
 
@@ -269,6 +277,8 @@ Properties on Tests
    /prop_test/WILL_FAIL
    /prop_test/WORKING_DIRECTORY
 
+.. _`Source File Properties`:
+
 Properties on Source Files
 ==========================
 
@@ -303,6 +313,8 @@ Properties on Source Files
    /prop_sf/XCODE_EXPLICIT_FILE_TYPE
    /prop_sf/XCODE_LAST_KNOWN_FILE_TYPE
 
+.. _`Cache Entry Properties`:
+
 Properties on Cache Entries
 ===========================
 
@@ -316,6 +328,8 @@ Properties on Cache Entries
    /prop_cache/TYPE
    /prop_cache/VALUE
 
+.. _`Installed File Properties`:
+
 Properties on Installed Files
 =============================
 
@@ -331,7 +345,7 @@ Properties on Installed Files
 
 
 Deprecated Properties on Directories
-=====================================
+====================================
 
 .. toctree::
    :maxdepth: 1

Help/prop_test/FAIL_REGULAR_EXPRESSION.rst

@@ -4,5 +4,12 @@ FAIL_REGULAR_EXPRESSION
 If the output matches this regular expression the test will fail.
 
 If set, if the output matches one of specified regular expressions,
-the test will fail.For example: FAIL_REGULAR_EXPRESSION
+the test will fail.  Example:
-"[^a-z]Error;ERROR;Failed"
+
+.. code-block:: cmake
+
+  set_tests_properties(mytest PROPERTIES
+    FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
+  )
+
+``FAIL_REGULAR_EXPRESSION`` expects a list of regular expressions.

Help/prop_test/PASS_REGULAR_EXPRESSION.rst

@@ -5,4 +5,12 @@ The output must match this regular expression for the test to pass.
 
 If set, the test output will be checked against the specified regular
 expressions and at least one of the regular expressions has to match,
-otherwise the test will fail.
+otherwise the test will fail.  Example:
+
+.. code-block:: cmake
+
+  set_tests_properties(mytest PROPERTIES
+    PASS_REGULAR_EXPRESSION "TestPassed;All ok"
+  )
+
+``PASS_REGULAR_EXPRESSION`` expects a list of regular expressions.