CMake builtin documentation handling: Difference between revisions

From KitwarePublic
Jump to navigationJump to 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...")
 
(Replace content with link to new CMake community wiki)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== CMake,CPack,CTest builtin documentation ==
{{CMake/Template/Moved}}


All CMake tools command line do have some builtin documentation support. The tools (cmake, cpack, ctest) supports a variable subset of:
This page has moved [https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/builtin-documentation-handling here].
 
  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
 
see
 
  cmake --help
  cpack --help
  ctest --help
 
for the details.
 
This builtin documentation comes from 2 different place:
# static variables in C++ sources
# 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.

Latest revision as of 15:41, 30 April 2018


The CMake community Wiki has moved to the Kitware GitLab Instance.

This page has moved here.

Retrieved from "https://public.kitware.com/Wiki/index.php?title=CMake_builtin_documentation_handling&oldid=62818"