浏览代码

Help: De-duplicate manual/(cmake|ccmake).1.rst build options

Move common build options out of cmake and ccmake manuals into an
OPTIONS_BUILD.txt file and include it from the original locations.
Brad King 12 年之前
父节点
当前提交
5dde65ac5b
共有 3 个文件被更改,包括 59 次插入115 次删除
  1. 57 0
      Help/manual/OPTIONS_BUILD.txt
  2. 1 58
      Help/manual/ccmake.1.rst
  3. 1 57
      Help/manual/cmake.1.rst

+ 57 - 0
Help/manual/OPTIONS_BUILD.txt

@@ -0,0 +1,57 @@
+* ``-C <initial-cache>``: Pre-load a script to populate the cache.
+
+  When cmake is first run in an empty build tree, it creates a
+  CMakeCache.txt file and populates it with customizable settings for
+  the project.  This option may be used to specify a file from which
+  to load cache entries before the first pass through the project's
+  cmake listfiles.  The loaded entries take priority over the
+  project's default values.  The given file should be a CMake script
+  containing SET commands that use the CACHE option, not a
+  cache-format file.
+
+* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
+
+  When cmake is first run in an empty build tree, it creates a
+  CMakeCache.txt file and populates it with customizable settings for
+  the project.  This option may be used to specify a setting that
+  takes priority over the project's default value.  The option may be
+  repeated for as many cache entries as desired.
+
+* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
+
+  This option may be used to remove one or more variables from the
+  CMakeCache.txt file, globbing expressions using * and ? are
+  supported.  The option may be repeated for as many cache entries as
+  desired.
+
+  Use with care, you can make your CMakeCache.txt non-working.
+
+* ``-G <generator-name>``: Specify a build system generator.
+
+  CMake may support multiple native build systems on certain
+  platforms.  A generator is responsible for generating a particular
+  build system.  Possible generator names are specified in the
+  Generators section.
+
+* ``-T <toolset-name>``: Specify toolset name if supported by generator.
+
+  Some CMake generators support a toolset name to be given to the
+  native build system to choose a compiler.  This is supported only on
+  specific generators:
+
+  ::
+
+    Visual Studio >= 10
+    Xcode >= 3.0
+
+  See native build system documentation for allowed toolset names.
+
+* ``-Wno-dev``: Suppress developer warnings.
+
+  Suppress warnings that are meant for the author of the
+  CMakeLists.txt files.
+
+* ``-Wdev``: Enable developer warnings.
+
+  Enable warnings that are meant for the author of the CMakeLists.txt
+  files.

+ 1 - 58
Help/manual/ccmake.1.rst

@@ -23,64 +23,7 @@ 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
-  CMakeCache.txt file and populates it with customizable settings for
-  the project.  This option may be used to specify a file from which
-  to load cache entries before the first pass through the project's
-  cmake listfiles.  The loaded entries take priority over the
-  project's default values.  The given file should be a CMake script
-  containing SET commands that use the CACHE option, not a
-  cache-format file.
-
-* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
-
-  When cmake is first run in an empty build tree, it creates a
-  CMakeCache.txt file and populates it with customizable settings for
-  the project.  This option may be used to specify a setting that
-  takes priority over the project's default value.  The option may be
-  repeated for as many cache entries as desired.
-
-* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
-
-  This option may be used to remove one or more variables from the
-  CMakeCache.txt file, globbing expressions using * and ? are
-  supported.  The option may be repeated for as many cache entries as
-  desired.
-
-  Use with care, you can make your CMakeCache.txt non-working.
-
-* ``-G <generator-name>``: Specify a build system generator.
-
-  CMake may support multiple native build systems on certain
-  platforms.  A generator is responsible for generating a particular
-  build system.  Possible generator names are specified in the
-  Generators section.
-
-* ``-T <toolset-name>``: Specify toolset name if supported by generator.
-
-  Some CMake generators support a toolset name to be given to the
-  native build system to choose a compiler.  This is supported only on
-  specific generators:
-
-  ::
-
-    Visual Studio >= 10
-    Xcode >= 3.0
-
-  See native build system documentation for allowed toolset names.
-
-* ``-Wno-dev``: Suppress developer warnings.
-
-  Suppress warnings that are meant for the author of the
-  CMakeLists.txt files.
-
-* ``-Wdev``: Enable developer warnings.
-
-  Enable warnings that are meant for the author of the CMakeLists.txt
-  files.
+.. include:: OPTIONS_BUILD.txt
 
 * ``--copyright [file]``: Print the CMake copyright and exit.
 

+ 1 - 57
Help/manual/cmake.1.rst

@@ -23,63 +23,7 @@ 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
-  CMakeCache.txt file and populates it with customizable settings for
-  the project.  This option may be used to specify a file from which
-  to load cache entries before the first pass through the project's
-  cmake listfiles.  The loaded entries take priority over the
-  project's default values.  The given file should be a CMake script
-  containing SET commands that use the CACHE option, not a
-  cache-format file.
-
-* ``-D <var>:<type>=<value>``: Create a cmake cache entry.
-
-  When cmake is first run in an empty build tree, it creates a
-  CMakeCache.txt file and populates it with customizable settings for
-  the project.  This option may be used to specify a setting that
-  takes priority over the project's default value.  The option may be
-  repeated for as many cache entries as desired.
-
-* ``-U <globbing_expr>``: Remove matching entries from CMake cache.
-
-  This option may be used to remove one or more variables from the
-  CMakeCache.txt file, globbing expressions using * and ? are
-  supported.  The option may be repeated for as many cache entries as
-  desired.
-
-  Use with care, you can make your CMakeCache.txt non-working.
-
-* ``-G <generator-name>``: Specify a build system generator.
-
-  CMake may support multiple native build systems on certain
-  platforms.  A generator is responsible for generating a particular
-  build system.  Possible generator names are specified in the
-  Generators section.
-
-* ``-T <toolset-name>``: Specify toolset name if supported by generator.
-
-  Some CMake generators support a toolset name to be given to the
-  native build system to choose a compiler.  This is supported only on
-  specific generators:
-
-  ::
-
-    Visual Studio >= 10
-    Xcode >= 3.0
-
-  See native build system documentation for allowed toolset names.
-
-* ``-Wno-dev``: Suppress developer warnings.
-
-  Suppress warnings that are meant for the author of the
-  CMakeLists.txt files.
-
-* ``-Wdev``: Enable developer warnings.
-
-  Enable warnings that are meant for the author of the CMakeLists.txt
-  files.
+.. include:: OPTIONS_BUILD.txt
 
 * ``-E``: CMake command mode.