Difference between revisions of "CMake builtin documentation handling"

From KitwarePublic
Jump to: navigation, search
(Created page with "== CMake,CPack,CTest builtin documentation == All CMake tools command line do have some builtin documentation support. The tools (cmake, cpack, ctest) supports a variable subset...")
 
(CMake,CPack,CTest builtin documentation)
Line 3: Line 3:
 
All CMake tools command line do have some builtin documentation support. The tools (cmake, cpack, ctest) supports a variable subset of:
 
All CMake tools command line do have some builtin documentation support. The tools (cmake, cpack, ctest) supports a variable subset of:
  
  ctool --help-command[-list]  
+
  ctool --help-command[-list]  
  ctool --help-module[-list]
+
  ctool --help-module[-list]
  ctool --help-variable[-list]
+
  ctool --help-variable[-list]
  ctool --help-policy[-list]
+
  ctool --help-policy[-list]
  ctool --help-property[-list]
+
  ctool --help-property[-list]
  ctool --help-full
+
  ctool --help-full
  ctool --help-html
+
  ctool --help-html
  
see
+
for the detail see:
  
  cmake --help
+
  cmake --help
  cpack --help
+
  cpack --help
  ctest --help
+
  ctest --help
  
for the details.
+
This builtin documentation comes from 2 different places:
 
 
This builtin documentation comes from 2 different place:
 
 
# static variables in C++ sources
 
# static variables in C++ sources
 
# text surrounded by markup in CMake script files
 
# text surrounded by markup in CMake script files

Revision as of 03:04, 18 June 2012

CMake,CPack,CTest builtin documentation

All CMake tools command line do have some builtin documentation support. The tools (cmake, cpack, ctest) supports a variable subset of:

 ctool --help-command[-list] 
 ctool --help-module[-list]
 ctool --help-variable[-list]
 ctool --help-policy[-list]
 ctool --help-property[-list]
 ctool --help-full
 ctool --help-html

for the detail see:

 cmake --help
 cpack --help
 ctest --help

This builtin documentation comes from 2 different places:

  1. static variables in C++ sources
  2. text surrounded by markup in CMake script files

Documentation in C++ sources

This is the primary source of builtin documentation.

Documentation markup in CMake script files

This source is available since CMake 2.8.8 and is currently only used by CPack.