Sfoglia il codice sorgente

Help: Organize manual/*.1.rst sections

Add "Synopsis", "Description", and "See Also" manual page section
headers.  These are typical of .1 man section pages.  Also de-duplicate
the See Also section links using a separate LINKS.txt file included from
each manual.
Brad King 12 anni fa
parent
commit
ae944d176e

+ 21 - 0
Help/manual/LINKS.txt

@@ -0,0 +1,21 @@
+The following resources are available to get help using CMake:
+
+* ``Home Page``: http://www.cmake.org
+
+  The primary starting point for learning about CMake.
+
+* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
+
+  A Wiki is provided containing answers to frequently asked questions.
+
+* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
+
+  Links to available documentation may be found on this web page.
+
+* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
+
+  For help and discussion about using cmake, a mailing list is
+  provided at [email protected].  The list is member-post-only but one
+  may sign up on the CMake web page.  Please first read the full
+  documentation at http://www.cmake.org before posting questions to
+  the list.

+ 8 - 23
Help/manual/ccmake.1.rst

@@ -1,15 +1,17 @@
 ccmake(1)
 *********
 
-::
-
-  ccmake - Curses Interface for CMake.
+Synopsis
+========
 
 ::
 
   ccmake <path-to-source>
   ccmake <path-to-existing-build>
 
+Description
+===========
+
 The "ccmake" executable is the CMake curses interface.  Project
 configuration settings may be specified interactively through this
 GUI.  Brief instructions are provided at the bottom of the terminal
@@ -109,24 +111,7 @@ native tool on their platform.
 
   If a file is specified, the version is written into it.
 
-The following resources are available to get help using CMake:
-
-* ``Home Page``: http://www.cmake.org
-
-  The primary starting point for learning about CMake.
-
-* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
-
-  A Wiki is provided containing answers to frequently asked questions.
-
-* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
-
-  Links to available documentation may be found on this web page.
-
-* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
+See Also
+========
 
-  For help and discussion about using cmake, a mailing list is
-  provided at [email protected].  The list is member-post-only but one
-  may sign up on the CMake web page.  Please first read the full
-  documentation at http://www.cmake.org before posting questions to
-  the list.
+.. include:: LINKS.txt

+ 8 - 23
Help/manual/cmake-gui.1.rst

@@ -1,9 +1,8 @@
 cmake-gui(1)
 ************
 
-::
-
-  cmake-gui - CMake GUI.
+Synopsis
+========
 
 ::
 
@@ -11,6 +10,9 @@ cmake-gui(1)
   cmake-gui [options] <path-to-source>
   cmake-gui [options] <path-to-existing-build>
 
+Description
+===========
+
 The "cmake-gui" executable is the CMake GUI.  Project configuration
 settings may be specified interactively.  Brief instructions are
 provided at the bottom of the window when the program is running.
@@ -51,24 +53,7 @@ native tool on their platform.
 
   If a file is specified, the version is written into it.
 
-The following resources are available to get help using CMake:
-
-* ``Home Page``: http://www.cmake.org
-
-  The primary starting point for learning about CMake.
-
-* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
-
-  A Wiki is provided containing answers to frequently asked questions.
-
-* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
-
-  Links to available documentation may be found on this web page.
-
-* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
+See Also
+========
 
-  For help and discussion about using cmake, a mailing list is
-  provided at [email protected].  The list is member-post-only but one
-  may sign up on the CMake web page.  Please first read the full
-  documentation at http://www.cmake.org before posting questions to
-  the list.
+.. include:: LINKS.txt

+ 8 - 24
Help/manual/cmake.1.rst

@@ -1,15 +1,17 @@
 cmake(1)
 ********
 
-::
-
-  cmake - Cross-Platform Makefile Generator.
+Synopsis
+========
 
 ::
 
   cmake [options] <path-to-source>
   cmake [options] <path-to-existing-build>
 
+Description
+===========
+
 The "cmake" executable is the CMake command-line interface.  It may be
 used to configure projects in scripts.  Project configuration settings
 may be specified on the command line with the -D option.  The -i
@@ -21,7 +23,6 @@ in each directory of a source tree with the name CMakeLists.txt.
 Users build a project by using CMake to generate a build system for a
 native tool on their platform.
 
-
 * ``-C <initial-cache>``: Pre-load a script to populate the cache.
 
   When cmake is first run in an empty build tree, it creates a
@@ -351,24 +352,7 @@ native tool on their platform.
 
   If a file is specified, the version is written into it.
 
-The following resources are available to get help using CMake:
-
-* ``Home Page``: http://www.cmake.org
-
-  The primary starting point for learning about CMake.
-
-* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
-
-  A Wiki is provided containing answers to frequently asked questions.
-
-* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
-
-  Links to available documentation may be found on this web page.
-
-* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
+See Also
+========
 
-  For help and discussion about using cmake, a mailing list is
-  provided at [email protected].  The list is member-post-only but one
-  may sign up on the CMake web page.  Please first read the full
-  documentation at http://www.cmake.org before posting questions to
-  the list.
+.. include:: LINKS.txt

+ 8 - 23
Help/manual/cpack.1.rst

@@ -1,14 +1,16 @@
 cpack(1)
 ********
 
-::
-
-  cpack - Packaging driver provided by CMake.
+Synopsis
+========
 
 ::
 
   cpack -G <generator> [options]
 
+Description
+===========
+
 The "cpack" executable is the CMake packaging program.
 CMake-generated build trees created for projects that use the
 INSTALL_* commands have packaging support.  This program will generate
@@ -147,24 +149,7 @@ native tool on their platform.
 
   If a file is specified, the version is written into it.
 
-The following resources are available to get help using CMake:
-
-* ``Home Page``: http://www.cmake.org
-
-  The primary starting point for learning about CMake.
-
-* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
-
-  A Wiki is provided containing answers to frequently asked questions.
-
-* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
-
-  Links to available documentation may be found on this web page.
-
-* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
+See Also
+========
 
-  For help and discussion about using cmake, a mailing list is
-  provided at [email protected].  The list is member-post-only but one
-  may sign up on the CMake web page.  Please first read the full
-  documentation at http://www.cmake.org before posting questions to
-  the list.
+.. include:: LINKS.txt

+ 8 - 23
Help/manual/ctest.1.rst

@@ -1,14 +1,16 @@
 ctest(1)
 ********
 
-::
-
-  ctest - Testing driver provided by CMake.
+Synopsis
+========
 
 ::
 
   ctest [options]
 
+Description
+===========
+
 The "ctest" executable is the CMake test driver program.
 CMake-generated build trees created for projects that use the
 ENABLE_TESTING and ADD_TEST commands have testing support.  This
@@ -344,24 +346,7 @@ program will run the tests and report results.
 
   If a file is specified, the version is written into it.
 
-The following resources are available to get help using CMake:
-
-* ``Home Page``: http://www.cmake.org
-
-  The primary starting point for learning about CMake.
-
-* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ
-
-  A Wiki is provided containing answers to frequently asked questions.
-
-* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html
-
-  Links to available documentation may be found on this web page.
-
-* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html
+See Also
+========
 
-  For help and discussion about using cmake, a mailing list is
-  provided at [email protected].  The list is member-post-only but one
-  may sign up on the CMake web page.  Please first read the full
-  documentation at http://www.cmake.org before posting questions to
-  the list.
+.. include:: LINKS.txt