From 4207b3a3bb60a83aa9ea01f1288e426f3dc9e46b Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Jun 2014 13:16:28 -0400 Subject: [PATCH 1/4] Help: Use "^^^^" for subsubsection headers This is the convention suggested in the Sphinx documentation and is already used in several other places in the CMake documentation. Update a few places where we were using other characters. --- Help/command/cmake_policy.rst | 8 ++++---- Help/manual/cmake-buildsystem.7.rst | 2 +- Help/manual/cmake-developer.7.rst | 4 ++-- Help/manual/cmake-qt.7.rst | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/Help/command/cmake_policy.rst b/Help/command/cmake_policy.rst index b14a2aa6d..2bc32870f 100644 --- a/Help/command/cmake_policy.rst +++ b/Help/command/cmake_policy.rst @@ -18,7 +18,7 @@ setting is available the ``OLD`` behavior is assumed and a warning is produced requesting that the policy be set. Setting Policies by CMake Version -''''''''''''''''''''''''''''''''' +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``cmake_policy`` command is used to set policies to ``OLD`` or ``NEW`` behavior. While setting policies individually is supported, we @@ -40,7 +40,7 @@ Note that the :command:`cmake_minimum_required(VERSION)` command implicitly calls ``cmake_policy(VERSION)`` too. Setting Policies Explicitly -''''''''''''''''''''''''''' +^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: @@ -54,7 +54,7 @@ one may fix the project to work with the new behavior and set the policy state to ``NEW``. Checking Policy Settings -'''''''''''''''''''''''' +^^^^^^^^^^^^^^^^^^^^^^^^ :: @@ -65,7 +65,7 @@ The output ```` value will be ``OLD`` or ``NEW`` if the policy is set, and empty otherwise. CMake Policy Stack -'''''''''''''''''' +^^^^^^^^^^^^^^^^^^ CMake keeps policy settings on a stack, so changes made by the cmake_policy command affect only the top of the stack. A new entry on diff --git a/Help/manual/cmake-buildsystem.7.rst b/Help/manual/cmake-buildsystem.7.rst index 3e1f01135..f3616fb20 100644 --- a/Help/manual/cmake-buildsystem.7.rst +++ b/Help/manual/cmake-buildsystem.7.rst @@ -551,7 +551,7 @@ exporting see the :manual:`cmake-packages(7)` manual. .. _`Include Directories and Usage Requirements`: Include Directories and Usage Requirements -'''''''''''''''''''''''''''''''''''''''''' +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Include directories require some special consideration when specified as usage requirements and when used with generator expressions. The diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 81adea08c..b26835fac 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -808,7 +808,7 @@ Documentation`_ section above. Standard Variable Names -~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^ For a ``FindXxx.cmake`` module that takes the approach of setting variables (either instead of or in addition to creating imported @@ -914,7 +914,7 @@ them. A Sample Find Module -~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^ We will describe how to create a simple find module for a library ``Foo``. diff --git a/Help/manual/cmake-qt.7.rst b/Help/manual/cmake-qt.7.rst index cad495115..fe8d62db5 100644 --- a/Help/manual/cmake-qt.7.rst +++ b/Help/manual/cmake-qt.7.rst @@ -54,7 +54,7 @@ CMake. Target dependencies may be added to that custom target by adding them to the :prop_tgt:`AUTOGEN_TARGET_DEPENDS` target property. AUTOMOC -''''''' +^^^^^^^ The :prop_tgt:`AUTOMOC` target property controls whether :manual:`cmake(1)` inspects the C++ files in the target to determine if they require ``moc`` to @@ -84,7 +84,7 @@ variable may be populated to pre-set the options for all following targets. .. _`Qt AUTOUIC`: AUTOUIC -''''''' +^^^^^^^ The :prop_tgt:`AUTOUIC` target property controls whether :manual:`cmake(1)` inspects the C++ files in the target to determine if they require ``uic`` to @@ -147,7 +147,7 @@ result of linking with the :prop_tgt:`IMPORTED` target: .. _`Qt AUTORCC`: AUTORCC -''''''' +^^^^^^^ The :prop_tgt:`AUTORCC` target property controls whether :manual:`cmake(1)` creates rules to execute ``rcc`` at the appropriate time on source files From eaafe756d5046f9c0268cb9e8e596c2bb45555cc Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Jun 2014 13:58:01 -0400 Subject: [PATCH 2/4] Help: Add documentation style section headers to cmake-developer.7 Give the style guides titles instead of numbers so we can link to them. --- Help/manual/cmake-developer.7.rst | 242 ++++++++++++++++-------------- 1 file changed, 132 insertions(+), 110 deletions(-) diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index b26835fac..53a4f5618 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -465,168 +465,190 @@ with an explicit target. Style ----- -1) - Command signatures should be marked up as plain literal blocks, not as - cmake ``code-blocks``. +Style: Command Signatures +^^^^^^^^^^^^^^^^^^^^^^^^^ -2) - Signatures are separated from preceding content by a horizontal - line. That is, use: +Command signatures should be marked up as plain literal blocks, not as +cmake ``code-blocks``. - .. code-block:: rst +Signatures are separated from preceding content by a horizontal +line. That is, use: - ... preceding paragraph. +.. code-block:: rst - --------------------------------------------------------------------- + ... preceding paragraph. - :: + --------------------------------------------------------------------- - add_library( ...) + :: - This signature is used for ... + add_library( ...) -3) - Use "``OFF``" and "``ON``" for boolean values which can be modified by - the user, such as :prop_tgt:`POSITION_INDEPENDENT_CODE`. Such properties - may be "enabled" and "disabled". Use "``True``" and "``False``" for - inherent values which can't be modified after being set, such as the - :prop_tgt:`IMPORTED` property of a build target. + This signature is used for ... -4) - Use two spaces for indentation. Use two spaces between sentences in - prose. +Style: Boolean Constants +^^^^^^^^^^^^^^^^^^^^^^^^ -5) - Prefer to mark the start of literal blocks with ``::`` at the end of - the preceding paragraph. In cases where the following block gets - a ``code-block`` marker, put a single ``:`` at the end of the preceding - paragraph. +Use "``OFF``" and "``ON``" for boolean values which can be modified by +the user, such as :prop_tgt:`POSITION_INDEPENDENT_CODE`. Such properties +may be "enabled" and "disabled". Use "``True``" and "``False``" for +inherent values which can't be modified after being set, such as the +:prop_tgt:`IMPORTED` property of a build target. -6) - Prefer to restrict the width of lines to 75-80 columns. This is not a - hard restriction, but writing new paragraphs wrapped at 75 columns - allows space for adding minor content without significant re-wrapping of - content. +Style: Whitespace +^^^^^^^^^^^^^^^^^ -7) - Mark up self-references with ``inline-literal`` syntax. For example, - within the add_executable command documentation, use +Use two spaces for indentation. Use two spaces between sentences in +prose. - .. code-block:: rst +Style: Starting Literal Blocks +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - ``add_executable`` +Prefer to mark the start of literal blocks with ``::`` at the end of +the preceding paragraph. In cases where the following block gets +a ``code-block`` marker, put a single ``:`` at the end of the preceding +paragraph. - not +Style: Line Length +^^^^^^^^^^^^^^^^^^ - .. code-block:: rst +Prefer to restrict the width of lines to 75-80 columns. This is not a +hard restriction, but writing new paragraphs wrapped at 75 columns +allows space for adding minor content without significant re-wrapping of +content. - :command:`add_executable` +Style: Document Self-References +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - which is used elsewhere. +Mark up self-references with ``inline-literal`` syntax. For example, +within the add_executable command documentation, use -8) - Mark up all other linkable references as links, including repeats. An - alternative, which is used by wikipedia (``_), - is to link to a reference only once per article. That style is not used - in CMake documentation. +.. code-block:: rst -9) - Mark up references to keywords in signatures, file names, and other - technical terms with ``inline-literl`` syntax, for example: + ``add_executable`` - .. code-block:: rst +not - If ``WIN32`` is used with :command:`add_executable`, the - :prop_tgt:`WIN32_EXECUTABLE` target property is enabled. That command - creates the file ``.exe`` on Windows. +.. code-block:: rst + :command:`add_executable` -10) - If referring to a concept which corresponds to a property, and that - concept is described in a high-level manual, prefer to link to the - manual section instead of the property. For example: +which is used elsewhere. - .. code-block:: rst +Style: Linkable References +^^^^^^^^^^^^^^^^^^^^^^^^^^ - This command creates an :ref:`Imported Target `. +Mark up all other linkable references as links, including repeats. An +alternative, which is used by wikipedia (``_), +is to link to a reference only once per article. That style is not used +in CMake documentation. - instead of: +Style: Technical Terms +^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: rst +Mark up references to keywords in signatures, file names, and other +technical terms with ``inline-literl`` syntax, for example: - This command creates an :prop_tgt:`IMPORTED` target. +.. code-block:: rst - The latter should be used only when referring specifically to the - property. + If ``WIN32`` is used with :command:`add_executable`, the + :prop_tgt:`WIN32_EXECUTABLE` target property is enabled. That command + creates the file ``.exe`` on Windows. - References to manual sections are not automatically created by creating - a section, but code such as: +Style: Referencing Concepts +^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. code-block:: rst +If referring to a concept which corresponds to a property, and that +concept is described in a high-level manual, prefer to link to the +manual section instead of the property. For example: - .. _`Imported Targets`: +.. code-block:: rst - creates a suitable anchor. Use an anchor name which matches the name - of the corresponding section. Refer to the anchor using a - cross-reference with specified text. + This command creates an :ref:`Imported Target `. - Imported Targets need the ``IMPORTED`` term marked up with care in - particular because the term may refer to a command keyword - (``IMPORTED``), a target property (:prop_tgt:`IMPORTED`), or a - concept (:ref:`Imported Targets`). +instead of: -11) - Where a property, command or variable is related conceptually to others, - by for example, being related to the buildsystem description, generator - expressions or Qt, each relevant property, command or variable should - link to the primary manual, which provides high-level information. Only - particular information relating to the command should be in the - documentation of the command. +.. code-block:: rst -12) - When marking section titles, make the section decoration line as long as - the title text. Use only a line below the title, not above. For - example: + This command creates an :prop_tgt:`IMPORTED` target. - .. code-block:: rst +The latter should be used only when referring specifically to the +property. - Title Text - ---------- +References to manual sections are not automatically created by creating +a section, but code such as: - Capitalize the first letter of each non-minor word in the title. +.. code-block:: rst -13) - When referring to properties, variables, commands etc, prefer to link - to the target object and follow that with the type of object it is. - For example: + .. _`Imported Targets`: - .. code-block:: rst +creates a suitable anchor. Use an anchor name which matches the name +of the corresponding section. Refer to the anchor using a +cross-reference with specified text. - Set the :prop_tgt:`AUTOMOC` target property to ``ON``. +Imported Targets need the ``IMPORTED`` term marked up with care in +particular because the term may refer to a command keyword +(``IMPORTED``), a target property (:prop_tgt:`IMPORTED`), or a +concept (:ref:`Imported Targets`). - Instead of +Where a property, command or variable is related conceptually to others, +by for example, being related to the buildsystem description, generator +expressions or Qt, each relevant property, command or variable should +link to the primary manual, which provides high-level information. Only +particular information relating to the command should be in the +documentation of the command. - .. code-block:: rst +Style: Section Titles +^^^^^^^^^^^^^^^^^^^^^ - Set the target property :prop_tgt:`AUTOMOC` to ``ON``. +When marking section titles, make the section decoration line as long as +the title text. Use only a line below the title, not above. For +example: - The ``policy`` directive is an exception, and the type us usually - referred to before the link: +.. code-block:: rst - .. code-block:: rst + Title Text + ---------- - If policy :prop_tgt:`CMP0022` is set to ``NEW`` the behavior is ... +Capitalize the first letter of each non-minor word in the title. -14) - Signatures of commands should wrap optional parts with square brackets, - and should mark list of optional arguments with an ellipsis (``...``). - Elements of the signature which are specified by the user should be - specified with angle brackets, and may be referred to in prose using - ``inline-literal`` syntax. +Style: Referencing CMake Domain Objects +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -15) - Use American English spellings in prose. +When referring to properties, variables, commands etc, prefer to link +to the target object and follow that with the type of object it is. +For example: +.. code-block:: rst + + Set the :prop_tgt:`AUTOMOC` target property to ``ON``. + +Instead of + +.. code-block:: rst + + Set the target property :prop_tgt:`AUTOMOC` to ``ON``. + +The ``policy`` directive is an exception, and the type us usually +referred to before the link: + +.. code-block:: rst + + If policy :prop_tgt:`CMP0022` is set to ``NEW`` the behavior is ... + +Style: Command Signature Markup +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Signatures of commands should wrap optional parts with square brackets, +and should mark list of optional arguments with an ellipsis (``...``). +Elements of the signature which are specified by the user should be +specified with angle brackets, and may be referred to in prose using +``inline-literal`` syntax. + +Style: Prose +^^^^^^^^^^^^ + +Use American English spellings in prose. Modules ======= From 05bd31ab3ec5e0fc1e15c6504bf2e40b7d1c6a77 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Jun 2014 13:58:28 -0400 Subject: [PATCH 3/4] Help: Organize documentation style sections in cmake-developer.7 Now that the style guidelines have section titles instead of numbers, organize them into more well-defined sections. --- Help/manual/cmake-developer.7.rst | 158 +++++++++++++++--------------- 1 file changed, 77 insertions(+), 81 deletions(-) diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 53a4f5618..9476d64bf 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -465,8 +465,49 @@ with an explicit target. Style ----- -Style: Command Signatures -^^^^^^^^^^^^^^^^^^^^^^^^^ +Style: Section Headers +^^^^^^^^^^^^^^^^^^^^^^ + +When marking section titles, make the section decoration line as long as +the title text. Use only a line below the title, not above. For +example: + +.. code-block:: rst + + Title Text + ---------- + +Capitalize the first letter of each non-minor word in the title. + +Style: Whitespace +^^^^^^^^^^^^^^^^^ + +Use two spaces for indentation. Use two spaces between sentences in +prose. + +Style: Line Length +^^^^^^^^^^^^^^^^^^ + +Prefer to restrict the width of lines to 75-80 columns. This is not a +hard restriction, but writing new paragraphs wrapped at 75 columns +allows space for adding minor content without significant re-wrapping of +content. + +Style: Prose +^^^^^^^^^^^^ + +Use American English spellings in prose. + +Style: Starting Literal Blocks +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Prefer to mark the start of literal blocks with ``::`` at the end of +the preceding paragraph. In cases where the following block gets +a ``code-block`` marker, put a single ``:`` at the end of the preceding +paragraph. + +Style: CMake Command Signatures +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Command signatures should be marked up as plain literal blocks, not as cmake ``code-blocks``. @@ -486,6 +527,12 @@ line. That is, use: This signature is used for ... +Signatures of commands should wrap optional parts with square brackets, +and should mark list of optional arguments with an ellipsis (``...``). +Elements of the signature which are specified by the user should be +specified with angle brackets, and may be referred to in prose using +``inline-literal`` syntax. + Style: Boolean Constants ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -495,59 +542,11 @@ may be "enabled" and "disabled". Use "``True``" and "``False``" for inherent values which can't be modified after being set, such as the :prop_tgt:`IMPORTED` property of a build target. -Style: Whitespace -^^^^^^^^^^^^^^^^^ - -Use two spaces for indentation. Use two spaces between sentences in -prose. - -Style: Starting Literal Blocks -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Prefer to mark the start of literal blocks with ``::`` at the end of -the preceding paragraph. In cases where the following block gets -a ``code-block`` marker, put a single ``:`` at the end of the preceding -paragraph. - -Style: Line Length -^^^^^^^^^^^^^^^^^^ - -Prefer to restrict the width of lines to 75-80 columns. This is not a -hard restriction, but writing new paragraphs wrapped at 75 columns -allows space for adding minor content without significant re-wrapping of -content. - -Style: Document Self-References -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Mark up self-references with ``inline-literal`` syntax. For example, -within the add_executable command documentation, use - -.. code-block:: rst - - ``add_executable`` - -not - -.. code-block:: rst - - :command:`add_executable` - -which is used elsewhere. - -Style: Linkable References -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Mark up all other linkable references as links, including repeats. An -alternative, which is used by wikipedia (``_), -is to link to a reference only once per article. That style is not used -in CMake documentation. - -Style: Technical Terms +Style: Inline Literals ^^^^^^^^^^^^^^^^^^^^^^ Mark up references to keywords in signatures, file names, and other -technical terms with ``inline-literl`` syntax, for example: +technical terms with ``inline-literal`` syntax, for example: .. code-block:: rst @@ -555,8 +554,17 @@ technical terms with ``inline-literl`` syntax, for example: :prop_tgt:`WIN32_EXECUTABLE` target property is enabled. That command creates the file ``.exe`` on Windows. -Style: Referencing Concepts -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Style: Cross-References +^^^^^^^^^^^^^^^^^^^^^^^ + +Mark up linkable references as links, including repeats. +An alternative, which is used by wikipedia +(``_), +is to link to a reference only once per article. That style is not used +in CMake documentation. + +Style: Referencing CMake Concepts +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If referring to a concept which corresponds to a property, and that concept is described in a high-level manual, prefer to link to the @@ -598,26 +606,12 @@ link to the primary manual, which provides high-level information. Only particular information relating to the command should be in the documentation of the command. -Style: Section Titles -^^^^^^^^^^^^^^^^^^^^^ - -When marking section titles, make the section decoration line as long as -the title text. Use only a line below the title, not above. For -example: - -.. code-block:: rst - - Title Text - ---------- - -Capitalize the first letter of each non-minor word in the title. - Style: Referencing CMake Domain Objects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -When referring to properties, variables, commands etc, prefer to link -to the target object and follow that with the type of object it is. -For example: +When referring to `CMake Domain`_ objects such as properties, variables, +commands etc, prefer to link to the target object and follow that with +the type of object it is. For example: .. code-block:: rst @@ -636,19 +630,21 @@ referred to before the link: If policy :prop_tgt:`CMP0022` is set to ``NEW`` the behavior is ... -Style: Command Signature Markup -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +However, markup self-references with ``inline-literal`` syntax. +For example, within the :command:`add_executable` command +documentation, use -Signatures of commands should wrap optional parts with square brackets, -and should mark list of optional arguments with an ellipsis (``...``). -Elements of the signature which are specified by the user should be -specified with angle brackets, and may be referred to in prose using -``inline-literal`` syntax. +.. code-block:: rst -Style: Prose -^^^^^^^^^^^^ + ``add_executable`` -Use American English spellings in prose. +not + +.. code-block:: rst + + :command:`add_executable` + +which is used elsewhere. Modules ======= From 793b64e49922b3a7bf4b6afa23b4a14308330460 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Jun 2014 13:59:35 -0400 Subject: [PATCH 4/4] Help: Document section header underline hierarchy in cmake-developer.7 Explicitly specify the sequence of underline characters we use in the CMake documentation. It is the same sequence as that suggested in the Sphinx documentation, but we have our own descriptions. --- Help/manual/cmake-developer.7.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 9476d64bf..9851c127d 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -479,6 +479,15 @@ example: Capitalize the first letter of each non-minor word in the title. +The section header underline character hierarchy is + +* ``#``: Manual group (part) in the master document +* ``*``: Manual (chapter) title +* ``=``: Section within a manual +* ``-``: Subsection or `CMake Domain`_ object document title +* ``^``: Subsubsection or `CMake Domain`_ object document section +* ``"``: Paragraph or `CMake Domain`_ object document subsection + Style: Whitespace ^^^^^^^^^^^^^^^^^