diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-16 13:28:12 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-16 13:28:12 (GMT) |
| commit | c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch) | |
| tree | 96102c69673467ce7b922697cd5f378511249201 /Source | |
| parent | 5029da5eac08171653a92b961c341f7ffcca3640 (diff) | |
| parent | 7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff) | |
| download | CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2 | |
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...
Diffstat (limited to 'Source')
208 files changed, 1222 insertions, 13975 deletions
diff --git a/Source/CMakeInstallDestinations.cmake b/Source/CMakeInstallDestinations.cmake new file mode 100644 index 0000000..33e8ce8 --- /dev/null +++ b/Source/CMakeInstallDestinations.cmake @@ -0,0 +1,36 @@ +# Keep formatting here consistent with bootstrap script expectations. +set(CMAKE_DATA_DIR_DEFAULT "share/cmake-${CMake_VERSION}") # OTHER +if(BEOS) + set(CMAKE_MAN_DIR_DEFAULT "documentation/man") # HAIKU + set(CMAKE_DOC_DIR_DEFAULT "documentation/doc/cmake-${CMake_VERSION}") # HAIKU +elseif(CYGWIN) + set(CMAKE_DOC_DIR_DEFAULT "share/doc/cmake-${CMake_VERSION}") # CYGWIN + set(CMAKE_MAN_DIR_DEFAULT "share/man") # CYGWIN +else() + set(CMAKE_DOC_DIR_DEFAULT "doc/cmake-${CMake_VERSION}") # OTHER + set(CMAKE_MAN_DIR_DEFAULT "man") # OTHER +endif() + +set(CMAKE_DATA_DIR_DESC "data") +set(CMAKE_DOC_DIR_DESC "docs") +set(CMAKE_MAN_DIR_DESC "man pages") + +foreach(v + CMAKE_DATA_DIR + CMAKE_DOC_DIR + CMAKE_MAN_DIR + ) + # Populate the cache with empty values so we know when the user sets them. + set(${v} "" CACHE STRING "") + set_property(CACHE ${v} PROPERTY HELPSTRING + "Location under install prefix for ${${v}_DESC} (default \"${${v}_DEFAULT}\")" + ) + set_property(CACHE ${v} PROPERTY ADVANCED 1) + + # Use the default when the user did not set this variable. + if(NOT ${v}) + set(${v} "${${v}_DEFAULT}") + endif() + # Remove leading slash to treat as relative to install prefix. + string(REGEX REPLACE "^/" "" ${v} "${${v}}") +endforeach() diff --git a/Source/CMakeLists.txt b/Source/CMakeLists.txt index 9b81e8b..71fae58 100644 --- a/Source/CMakeLists.txt +++ b/Source/CMakeLists.txt @@ -159,16 +159,7 @@ set(SRCS cmDependsJavaParserHelper.h cmDocumentation.cxx cmDocumentationFormatter.cxx - cmDocumentationFormatterHTML.cxx - cmDocumentationFormatterDocbook.cxx - cmDocumentationFormatterMan.cxx - cmDocumentationFormatterText.cxx - cmDocumentationFormatterUsage.cxx cmDocumentationSection.cxx - cmDocumentCompileDefinitions.h - cmDocumentGeneratorExpressions.h - cmDocumentLocationUndefined.h - cmDocumentVariables.cxx cmDynamicLoader.cxx cmDynamicLoader.h ${ELF_SRCS} @@ -261,6 +252,8 @@ set(SRCS cmPropertyMap.h cmQtAutomoc.cxx cmQtAutomoc.h + cmRST.cxx + cmRST.h cmScriptGenerator.h cmScriptGenerator.cxx cmSourceFile.cxx @@ -497,8 +490,6 @@ set(CPACK_SRCS CPack/cmCPackTarBZip2Generator.cxx CPack/cmCPackTarCompressGenerator.cxx CPack/cmCPackZIPGenerator.cxx - CPack/cmCPackDocumentVariables.cxx - CPack/cmCPackDocumentMacros.cxx ) if(CYGWIN) diff --git a/Source/CMakeVersionCompute.cmake b/Source/CMakeVersionCompute.cmake new file mode 100644 index 0000000..a166334 --- /dev/null +++ b/Source/CMakeVersionCompute.cmake @@ -0,0 +1,23 @@ +# Load version number components. +include(${CMake_SOURCE_DIR}/Source/CMakeVersion.cmake) + +# Releases define a small tweak level. +if("${CMake_VERSION_TWEAK}" VERSION_LESS 20000000) + set(CMake_VERSION_IS_RELEASE 1) + set(CMake_VERSION_SOURCE "") +else() + set(CMake_VERSION_IS_RELEASE 0) + include(${CMake_SOURCE_DIR}/Source/CMakeVersionSource.cmake) +endif() + +# Compute the full version string. +set(CMake_VERSION ${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}.${CMake_VERSION_PATCH}) +if(${CMake_VERSION_TWEAK} GREATER 0) + set(CMake_VERSION ${CMake_VERSION}.${CMake_VERSION_TWEAK}) +endif() +if(CMake_VERSION_RC) + set(CMake_VERSION ${CMake_VERSION}-rc${CMake_VERSION_RC}) +endif() +if(CMake_VERSION_SOURCE) + set(CMake_VERSION ${CMake_VERSION}-${CMake_VERSION_SOURCE}) +endif() diff --git a/Source/CPack/cmCPackDocumentMacros.cxx b/Source/CPack/cmCPackDocumentMacros.cxx deleted file mode 100644 index ddc75a4..0000000 --- a/Source/CPack/cmCPackDocumentMacros.cxx +++ /dev/null @@ -1,16 +0,0 @@ -#include "cmCPackDocumentMacros.h" - -void cmCPackDocumentMacros::GetMacrosDocumentation( - std::vector<cmDocumentationEntry>& ) -{ - // Commented-out example of use - // - // cmDocumentationEntry e("cpack_<macro>", - // "Brief Description" - // "which may be on several lines.", - // "Long description in pre-formatted format" - // " blah\n" - // " blah\n" - //); - //v.push_back(e); -} diff --git a/Source/CPack/cmCPackDocumentMacros.h b/Source/CPack/cmCPackDocumentMacros.h deleted file mode 100644 index 544f74f..0000000 --- a/Source/CPack/cmCPackDocumentMacros.h +++ /dev/null @@ -1,21 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmCPackDocumentMacros_h -#define cmCPackDocumentMacros_h -#include "cmStandardIncludes.h" -class cmCPackDocumentMacros -{ -public: - static void GetMacrosDocumentation(std::vector<cmDocumentationEntry>& v); -}; - -#endif diff --git a/Source/CPack/cmCPackDocumentVariables.cxx b/Source/CPack/cmCPackDocumentVariables.cxx deleted file mode 100644 index 8b16ae9..0000000 --- a/Source/CPack/cmCPackDocumentVariables.cxx +++ /dev/null @@ -1,122 +0,0 @@ -#include "cmCPackDocumentVariables.h" -#include "cmake.h" - -void cmCPackDocumentVariables::DefineVariables(cmake* cm) -{ - // Subsection: variables defined/used by cpack, - // which are common to all CPack generators - - cm->DefineProperty - ("CPACK_PACKAGING_INSTALL_PREFIX", cmProperty::VARIABLE, - "The prefix used in the built package.", - "Each CPack generator has a default value (like /usr)." - " This default value may" - " be overwritten from the CMakeLists.txt or the cpack command line" - " by setting an alternative value.\n" - "e.g. " - " set(CPACK_PACKAGING_INSTALL_PREFIX \"/opt\")\n" - "This is not the same purpose as CMAKE_INSTALL_PREFIX which" - " is used when installing from the build tree without building" - " a package." - "", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_INCLUDE_TOPLEVEL_DIRECTORY", cmProperty::VARIABLE, - "Boolean toggle to include/exclude top level directory.", - "When preparing a package CPack installs the item under" - " the so-called top level directory. The purpose of" - " is to include (set to 1 or ON or TRUE) the top level directory" - " in the package or not (set to 0 or OFF or FALSE).\n" - "Each CPack generator has a built-in default value for this" - " variable. E.g. Archive generators (ZIP, TGZ, ...) includes" - " the top level whereas RPM or DEB don't. The user may override" - " the default value by setting this variable.\n" - "There is a similar variable " - "CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY " - "which may be used to override the behavior for the component" - " packaging case which may have different default value for" - " historical (now backward compatibility) reason.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY", cmProperty::VARIABLE, - "Boolean toggle to include/exclude top level directory " - "(component case).", - "Similar usage as CPACK_INCLUDE_TOPLEVEL_DIRECTORY" - " but for the component case. " - "See CPACK_INCLUDE_TOPLEVEL_DIRECTORY documentation for" - " the detail.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_SET_DESTDIR", cmProperty::VARIABLE, - "Boolean toggle to make CPack use DESTDIR mechanism when" - " packaging.", "DESTDIR means DESTination DIRectory." - " It is commonly used by makefile " - "users in order to install software at non-default location. It " - "is a basic relocation mechanism that should not be used on" - " Windows (see CMAKE_INSTALL_PREFIX documentation). " - "It is usually invoked like this:\n" - " make DESTDIR=/home/john install\n" - "which will install the concerned software using the" - " installation prefix, e.g. \"/usr/local\" prepended with " - "the DESTDIR value which finally gives \"/home/john/usr/local\"." - " When preparing a package, CPack first installs the items to be " - "packaged in a local (to the build tree) directory by using the " - "same DESTDIR mechanism. Nevertheless, if " - "CPACK_SET_DESTDIR is set then CPack will set DESTDIR before" - " doing the local install. The most noticeable difference is" - " that without CPACK_SET_DESTDIR, CPack uses " - "CPACK_PACKAGING_INSTALL_PREFIX as a prefix whereas with " - "CPACK_SET_DESTDIR set, CPack will use CMAKE_INSTALL_PREFIX as" - " a prefix.\n" - "Manually setting CPACK_SET_DESTDIR may help (or simply be" - " necessary) if some install rules uses absolute " - "DESTINATION (see CMake INSTALL command)." - " However, starting with" - " CPack/CMake 2.8.3 RPM and DEB installers tries to handle DESTDIR" - " automatically so that it is seldom necessary for the user to set" - " it.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_INSTALL_SCRIPT", cmProperty::VARIABLE, - "Extra CMake script provided by the user.", - "If set this CMake script will be executed by CPack " - "during its local [CPack-private] installation " - "which is done right before packaging the files." - " The script is not called by e.g.: make install.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_ABSOLUTE_DESTINATION_FILES", cmProperty::VARIABLE, - "List of files which have been installed using " - " an ABSOLUTE DESTINATION path.", - "This variable is a Read-Only variable which is set internally" - " by CPack during installation and before packaging using" - " CMAKE_ABSOLUTE_DESTINATION_FILES defined in cmake_install.cmake " - "scripts. The value can be used within CPack project configuration" - " file and/or CPack<GEN>.cmake file of <GEN> generator.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask CPack to warn each time a file with absolute INSTALL" - " DESTINATION is encountered.", - "This variable triggers the definition of " - "CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs" - " cmake_install.cmake scripts.", false, - "Variables common to all CPack generators"); - - cm->DefineProperty - ("CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask CPack to error out as soon as a file with absolute INSTALL" - " DESTINATION is encountered.", - "The fatal error is emitted before the installation of " - "the offending file takes place. Some CPack generators, like NSIS," - "enforce this internally. " - "This variable triggers the definition of" - "CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION when CPack runs" - "Variables common to all CPack generators"); -} diff --git a/Source/CPack/cmCPackDocumentVariables.h b/Source/CPack/cmCPackDocumentVariables.h deleted file mode 100644 index e7971be..0000000 --- a/Source/CPack/cmCPackDocumentVariables.h +++ /dev/null @@ -1,21 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmCPackDocumentVariables_h -#define cmCPackDocumentVariables_h -class cmake; -class cmCPackDocumentVariables -{ -public: - static void DefineVariables(cmake* cm); -}; - -#endif diff --git a/Source/CPack/cpack.cxx b/Source/CPack/cpack.cxx index b188918..677f5b1 100644 --- a/Source/CPack/cpack.cxx +++ b/Source/CPack/cpack.cxx @@ -14,8 +14,6 @@ // Need these for documentation support. #include "cmake.h" #include "cmDocumentation.h" -#include "cmCPackDocumentVariables.h" -#include "cmCPackDocumentMacros.h" #include "cmCPackGeneratorFactory.h" #include "cmCPackGenerator.h" #include "cmake.h" @@ -29,112 +27,42 @@ #include <cmsys/SystemTools.hxx> //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " cpack - Packaging driver provided by CMake.", 0}, - {0,0,0} + " cpack - Packaging driver provided by CMake."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, - " cpack -G <generator> [options]", - 0}, - {0,0,0} + " cpack -G <generator> [options]"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = +static const char * cmDocumentationOptions[][2] = { - {0, - "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 the package.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = -{ - {"-G <generator>", "Use the specified generator to generate package.", - "CPack may support multiple native packaging systems on certain " - "platforms. A generator is responsible for generating input files for " - "particular system and invoking that systems. Possible generator names " - "are specified in the Generators section." }, - {"-C <Configuration>", "Specify the project configuration", - "This option specifies the configuration that the project was build " - "with, for example 'Debug', 'Release'." }, - {"-D <var>=<value>", "Set a CPack variable.", \ - "Set a variable that can be used by the generator."}, \ - {"--config <config file>", "Specify the config file.", - "Specify the config file to use to create the package. By default " - "CPackConfig.cmake in the current directory will be used." }, - {"--verbose,-V","enable verbose output","Run cpack with verbose output."}, - {"--debug","enable debug output (for CPack developers)", - "Run cpack with debug output (for CPack developers)."}, - {"-P <package name>","override/define CPACK_PACKAGE_NAME", - "If the package name is not specified on cpack commmand line then" - "CPack.cmake defines it as CMAKE_PROJECT_NAME"}, - {"-R <package version>","override/define CPACK_PACKAGE_VERSION", - "If version is not specified on cpack command line then" - "CPack.cmake defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]" - "look into CPack.cmake for detail"}, - {"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY", - "The directory where CPack will be doing its packaging work." - "The resulting package will be found there. Inside this directory" - "CPack creates '_CPack_Packages' sub-directory which is the" - "CPack temporary directory."}, - {"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR", - "If vendor is not specified on cpack command line " - "(or inside CMakeLists.txt) then" - "CPack.cmake defines it with a default value"}, - {"--help-command cmd [file]", "Print help for a single command and exit.", - "Full documentation specific to the given command is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-command-list [file]", "List available commands and exit.", - "The list contains all commands for which help may be obtained by using " - "the --help-command argument followed by a command name. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-commands [file]", "Print help for all commands and exit.", - "Full documentation specific for all current command is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, + {"-G <generator>", "Use the specified generator to generate package."}, + {"-C <Configuration>", "Specify the project configuration"}, + {"-D <var>=<value>", "Set a CPack variable."}, + {"--config <config file>", "Specify the config file."}, + {"--verbose,-V","enable verbose output"}, + {"--debug","enable debug output (for CPack developers)"}, + {"-P <package name>","override/define CPACK_PACKAGE_NAME"}, + {"-R <package version>","override/define CPACK_PACKAGE_VERSION"}, + {"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY"}, + {"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR"}, + {"--help-command cmd [file]", "Print help for a single command and exit."}, + {"--help-command-list [file]", "List available commands and exit."}, + {"--help-commands [file]", "Print help for all commands and exit."}, {"--help-variable var [file]", - "Print help for a single variable and exit.", - "Full documentation specific to the given variable is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variable-list [file]", "List documented variables and exit.", - "The list contains all variables for which help may be obtained by using " - "the --help-variable argument followed by a variable name. If a file is " - "specified, the help is written into it." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variables [file]", "Print help for all variables and exit.", - "Full documentation for all variables is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "cmake", 0}, - {0, "ccmake", 0}, - {0, 0, 0} + "Print help for a single variable and exit."}, + {"--help-variable-list [file]", "List documented variables and exit."}, + {"--help-variables [file]", "Print help for all variables and exit."}, + {0,0} }; //---------------------------------------------------------------------------- @@ -533,43 +461,8 @@ int main (int argc, char *argv[]) doc.SetName("cpack"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.PrependSection("Options",cmDocumentationOptions); - // statically (in C++ code) defined variables - cmCPackDocumentVariables::DefineVariables(&cminst); - - std::vector<cmDocumentationEntry> commands; - - std::string docedFile; - std::string docPath; - cmDocumentation::documentedModulesList_t docedModList; - - docedFile = globalMF->GetModulesFile("CPack.cmake"); - if (docedFile.length()!=0) - { - docPath = cmSystemTools::GetFilenamePath(docedFile.c_str()); - doc.getDocumentedModulesListInDir(docPath,"CPack*.cmake",docedModList); - } - - // parse the files for documentation. - cmDocumentation::documentedModulesList_t::iterator docedIt; - for (docedIt = docedModList.begin(); - docedIt!= docedModList.end(); ++docedIt) - { - doc.GetStructuredDocFromFile( - (docedIt->first).c_str(), - commands,&cminst); - } - - std::map<std::string,cmDocumentationSection *> propDocs; - cminst.GetPropertiesDocumentation(propDocs); - doc.SetSections(propDocs); - cminst.GetCommandDocumentation(commands,true,false); - // statically (in C++ code) defined macros/commands - cmCPackDocumentMacros::GetMacrosDocumentation(commands); - doc.SetSection("Commands",commands); - std::vector<cmDocumentationEntry> v; cmCPackGeneratorFactory::DescriptionsMap::const_iterator generatorIt; for( generatorIt = generators.GetGeneratorsList().begin(); @@ -579,12 +472,10 @@ int main (int argc, char *argv[]) cmDocumentationEntry e; e.Name = generatorIt->first.c_str(); e.Brief = generatorIt->second.c_str(); - e.Full = ""; v.push_back(e); } doc.SetSection("Generators",v); - doc.SetSeeAlsoList(cmDocumentationSeeAlso); #undef cout return doc.PrintRequestedDocumentation(std::cout)? 0:1; #define cout no_cout_use_cmCPack_Log diff --git a/Source/CTest/cmCTestBuildCommand.h b/Source/CTest/cmCTestBuildCommand.h index cabc39b..08887fe 100644 --- a/Source/CTest/cmCTestBuildCommand.h +++ b/Source/CTest/cmCTestBuildCommand.h @@ -45,34 +45,8 @@ public: */ virtual const char* GetName() const { return "ctest_build";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Build the project."; - } virtual bool InitialPass(std::vector<std::string> const& args, cmExecutionStatus &status); - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_build([BUILD build_dir] [TARGET target] [RETURN_VALUE res]\n" - " [APPEND][NUMBER_ERRORS val] [NUMBER_WARNINGS val])\n" - "Builds the given build directory and stores results in Build.xml. " - "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used.\n" - "The TARGET variable can be used to specify a build target. If none " - "is specified, the \"all\" target will be built.\n" - "The RETURN_VALUE option specifies a variable in which to store the " - "return value of the native build tool. " - "The NUMBER_ERRORS and NUMBER_WARNINGS options specify variables in " - "which to store the number of build errors and warnings detected." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } cmTypeMacro(cmCTestBuildCommand, cmCTestHandlerCommand); diff --git a/Source/CTest/cmCTestConfigureCommand.h b/Source/CTest/cmCTestConfigureCommand.h index b343fc1..b592c5a 100644 --- a/Source/CTest/cmCTestConfigureCommand.h +++ b/Source/CTest/cmCTestConfigureCommand.h @@ -40,34 +40,6 @@ public: */ virtual const char* GetName() const { return "ctest_configure";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Configure the project build tree."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]\n" - " [OPTIONS options] [RETURN_VALUE res])\n" - "Configures the given build directory and stores results in " - "Configure.xml. " - "If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. " - "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. " - "The OPTIONS argument specifies command line arguments to pass to " - "the configuration tool. " - "The RETURN_VALUE option specifies a variable in which to store the " - "return value of the native build tool." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestCoverageCommand.h b/Source/CTest/cmCTestCoverageCommand.h index 2fe762c..11bb411 100644 --- a/Source/CTest/cmCTestCoverageCommand.h +++ b/Source/CTest/cmCTestCoverageCommand.h @@ -41,32 +41,6 @@ public: */ virtual const char* GetName() const { return "ctest_coverage";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Collect coverage tool results."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n" - " [LABELS label1 [label2 [...]]])\n" - "Perform the coverage of the given build directory and stores results " - "in Coverage.xml. The second argument is a variable that will hold " - "value." - "\n" - "The LABELS option filters the coverage report to include only " - "source files labeled with at least one of the labels specified." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestCoverageCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h b/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h index a763fe9..07e59a4 100644 --- a/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h +++ b/Source/CTest/cmCTestEmptyBinaryDirectoryCommand.h @@ -50,26 +50,6 @@ public: */ virtual const char* GetName() const { return "ctest_empty_binary_directory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "empties the binary directory"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_empty_binary_directory( directory )\n" - "Removes a binary directory. This command will perform some checks " - "prior to deleting the directory in an attempt to avoid malicious " - "or accidental directory deletion."; - } - cmTypeMacro(cmCTestEmptyBinaryDirectoryCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestMemCheckCommand.h b/Source/CTest/cmCTestMemCheckCommand.h index 6db47ae..b50170d 100644 --- a/Source/CTest/cmCTestMemCheckCommand.h +++ b/Source/CTest/cmCTestMemCheckCommand.h @@ -43,40 +43,6 @@ public: */ virtual const char* GetName() const { return "ctest_memcheck";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Run tests with a dynamic analysis tool."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND]\n" - " [START start number] [END end number]\n" - " [STRIDE stride number] [EXCLUDE exclude regex ]\n" - " [INCLUDE include regex] \n" - " [EXCLUDE_LABEL exclude regex] \n" - " [INCLUDE_LABEL label regex] \n" - " [PARALLEL_LEVEL level] )\n" - "Tests the given build directory and stores results in MemCheck.xml. " - "The second argument is a variable that will hold value. Optionally, " - "you can specify the starting test number START, the ending test number " - "END, the number of tests to skip between each test STRIDE, a regular " - "expression for tests to run INCLUDE, or a regular expression for tests " - "not to run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular " - "expressions for tests to be included or excluded by the test " - "property LABEL. PARALLEL_LEVEL should be set to a positive number " - "representing the number of tests to be run in parallel." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestMemCheckCommand, cmCTestTestCommand); protected: diff --git a/Source/CTest/cmCTestReadCustomFilesCommand.h b/Source/CTest/cmCTestReadCustomFilesCommand.h index b984c84..9c0af81 100644 --- a/Source/CTest/cmCTestReadCustomFilesCommand.h +++ b/Source/CTest/cmCTestReadCustomFilesCommand.h @@ -48,25 +48,6 @@ public: */ virtual const char* GetName() const { return "ctest_read_custom_files";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "read CTestCustom files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_read_custom_files( directory ... )\n" - "Read all the CTestCustom.ctest or CTestCustom.cmake files from " - "the given directory."; - } - cmTypeMacro(cmCTestReadCustomFilesCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestRunScriptCommand.h b/Source/CTest/cmCTestRunScriptCommand.h index 05e7899..f34bd13 100644 --- a/Source/CTest/cmCTestRunScriptCommand.h +++ b/Source/CTest/cmCTestRunScriptCommand.h @@ -49,30 +49,6 @@ public: */ virtual const char* GetName() const { return "ctest_run_script";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "runs a ctest -S script"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_run_script([NEW_PROCESS] script_file_name script_file_name1 \n" - " script_file_name2 ... [RETURN_VALUE var])\n" - "Runs a script or scripts much like if it was run from ctest -S. " - "If no argument is provided then the current script is run using " - "the current settings of the variables. If NEW_PROCESS is specified " - "then each script will be run in a separate process." - "If RETURN_VALUE is specified the return value of the last script " - "run will be put into var."; - } - cmTypeMacro(cmCTestRunScriptCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestScriptHandler.cxx b/Source/CTest/cmCTestScriptHandler.cxx index 8643cb3..64bcd59 100644 --- a/Source/CTest/cmCTestScriptHandler.cxx +++ b/Source/CTest/cmCTestScriptHandler.cxx @@ -361,12 +361,6 @@ void cmCTestScriptHandler::CreateCMake() this->AddCTestCommand(new cmCTestUploadCommand); } -void cmCTestScriptHandler::GetCommandDocumentation( - std::vector<cmDocumentationEntry>& v) const -{ - this->CMake->GetCommandDocumentation(v); -} - //---------------------------------------------------------------------- // this sets up some variables for the script to use, creates the required // cmake instance and generators, and then reads in the script diff --git a/Source/CTest/cmCTestScriptHandler.h b/Source/CTest/cmCTestScriptHandler.h index 9d852ca..80d5831 100644 --- a/Source/CTest/cmCTestScriptHandler.h +++ b/Source/CTest/cmCTestScriptHandler.h @@ -110,7 +110,6 @@ public: void Initialize(); void CreateCMake(); - void GetCommandDocumentation(std::vector<cmDocumentationEntry>& v) const; cmake* GetCMake() { return this->CMake;} private: // reads in a script diff --git a/Source/CTest/cmCTestSleepCommand.h b/Source/CTest/cmCTestSleepCommand.h index 0f51ddf..c6baf1c 100644 --- a/Source/CTest/cmCTestSleepCommand.h +++ b/Source/CTest/cmCTestSleepCommand.h @@ -49,26 +49,6 @@ public: */ virtual const char* GetName() const { return "ctest_sleep";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "sleeps for some amount of time"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_sleep(<seconds>)\n" - "Sleep for given number of seconds.\n" - " ctest_sleep(<time1> <duration> <time2>)\n" - "Sleep for t=(time1 + duration - time2) seconds if t > 0."; - } - cmTypeMacro(cmCTestSleepCommand, cmCTestCommand); }; diff --git a/Source/CTest/cmCTestStartCommand.h b/Source/CTest/cmCTestStartCommand.h index 6be4770..e5535c1 100644 --- a/Source/CTest/cmCTestStartCommand.h +++ b/Source/CTest/cmCTestStartCommand.h @@ -57,30 +57,6 @@ public: */ virtual const char* GetName() const { return "ctest_start";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Starts the testing for a given model"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_start(Model [TRACK <track>] [APPEND] [source [binary]])\n" - "Starts the testing for a given model. The command should be called " - "after the binary directory is initialized. If the 'source' and " - "'binary' directory are not specified, it reads the " - "CTEST_SOURCE_DIRECTORY and CTEST_BINARY_DIRECTORY. If the track is " - "specified, the submissions will go to the specified track. " - "If APPEND is used, the existing TAG is used rather than " - "creating a new one based on the current time stamp."; - } - cmTypeMacro(cmCTestStartCommand, cmCTestCommand); private: diff --git a/Source/CTest/cmCTestSubmitCommand.h b/Source/CTest/cmCTestSubmitCommand.h index 53ee875..64c6cae 100644 --- a/Source/CTest/cmCTestSubmitCommand.h +++ b/Source/CTest/cmCTestSubmitCommand.h @@ -50,44 +50,6 @@ public: */ virtual const char* GetName() const { return "ctest_submit";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Submit results to a dashboard server."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_submit([PARTS ...] [FILES ...] [RETRY_COUNT count] " - " [RETRY_DELAY delay][RETURN_VALUE res])\n" - "By default all available parts are submitted if no PARTS or FILES " - "are specified. " - "The PARTS option lists a subset of parts to be submitted. " - "Valid part names are:\n" - " Start = nothing\n" - " Update = ctest_update results, in Update.xml\n" - " Configure = ctest_configure results, in Configure.xml\n" - " Build = ctest_build results, in Build.xml\n" - " Test = ctest_test results, in Test.xml\n" - " Coverage = ctest_coverage results, in Coverage.xml\n" - " MemCheck = ctest_memcheck results, in DynamicAnalysis.xml\n" - " Notes = Files listed by CTEST_NOTES_FILES, in Notes.xml\n" - " ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES\n" - " Submit = nothing\n" - "The FILES option explicitly lists specific files to be submitted. " - "Each individual file must exist at the time of the call.\n" - "The RETRY_DELAY option specifies how long in seconds to wait after " - "a timed-out submission before attempting to re-submit.\n" - "The RETRY_COUNT option specifies how many times to retry a timed-out " - "submission.\n"; - } - cmTypeMacro(cmCTestSubmitCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestTestCommand.h b/Source/CTest/cmCTestTestCommand.h index 130cb69..451ac99 100644 --- a/Source/CTest/cmCTestTestCommand.h +++ b/Source/CTest/cmCTestTestCommand.h @@ -41,45 +41,6 @@ public: */ virtual const char* GetName() const { return "ctest_test";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Run tests in the project build tree."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_test([BUILD build_dir] [APPEND]\n" - " [START start number] [END end number]\n" - " [STRIDE stride number] [EXCLUDE exclude regex ]\n" - " [INCLUDE include regex] [RETURN_VALUE res] \n" - " [EXCLUDE_LABEL exclude regex] \n" - " [INCLUDE_LABEL label regex] \n" - " [PARALLEL_LEVEL level] \n" - " [SCHEDULE_RANDOM on] \n" - " [STOP_TIME time of day]) \n" - "Tests the given build directory and stores results in Test.xml. The " - "second argument is a variable that will hold value. Optionally, " - "you can specify the starting test number START, the ending test number " - "END, the number of tests to skip between each test STRIDE, a regular " - "expression for tests to run INCLUDE, or a regular expression for tests " - "to not run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular " - "expression for test to be included or excluded by the test " - "property LABEL. PARALLEL_LEVEL should be set to a positive number " - "representing the number of tests to be run in parallel. " - "SCHEDULE_RANDOM will launch tests in a random order, and is " - "typically used to detect implicit test dependencies. STOP_TIME is the " - "time of day at which the tests should all stop running." - "\n" - CTEST_COMMAND_APPEND_OPTION_DOCS; - } - cmTypeMacro(cmCTestTestCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestTestHandler.cxx b/Source/CTest/cmCTestTestHandler.cxx index 09d343d..da24ae4 100644 --- a/Source/CTest/cmCTestTestHandler.cxx +++ b/Source/CTest/cmCTestTestHandler.cxx @@ -61,10 +61,6 @@ public: */ virtual const char* GetName() const { return "subdirs";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestSubdirCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -162,10 +158,6 @@ public: */ virtual const char* GetName() const { return "add_subdirectory";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestAddSubdirectoryCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -252,10 +244,6 @@ public: */ virtual const char* GetName() const { return "add_test";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestAddTestCommand, cmCommand); cmCTestTestHandler* TestHandler; @@ -300,10 +288,6 @@ public: */ virtual const char* GetName() const { return "set_tests_properties";} - // Unused methods - virtual const char* GetTerseDocumentation() const { return ""; } - virtual const char* GetFullDocumentation() const { return ""; } - cmTypeMacro(cmCTestSetTestsPropertiesCommand, cmCommand); cmCTestTestHandler* TestHandler; diff --git a/Source/CTest/cmCTestUpdateCommand.h b/Source/CTest/cmCTestUpdateCommand.h index c578fff..a785bd8 100644 --- a/Source/CTest/cmCTestUpdateCommand.h +++ b/Source/CTest/cmCTestUpdateCommand.h @@ -41,28 +41,6 @@ public: */ virtual const char* GetName() const { return "ctest_update";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Update the work tree from version control."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_update([SOURCE source] [RETURN_VALUE res])\n" - "Updates the given source directory and stores results in Update.xml. " - "If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. " - "The RETURN_VALUE option specifies a variable in which to store the " - "result, which is the number of files updated or -1 on error." - ; - } - cmTypeMacro(cmCTestUpdateCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CTest/cmCTestUploadCommand.h b/Source/CTest/cmCTestUploadCommand.h index 62f379f..e867fb6 100644 --- a/Source/CTest/cmCTestUploadCommand.h +++ b/Source/CTest/cmCTestUploadCommand.h @@ -45,25 +45,6 @@ public: */ virtual const char* GetName() const { return "ctest_upload";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Upload files to a dashboard server."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " ctest_upload(FILES ...)\n" - "Pass a list of files to be sent along with the build results to " - "the dashboard server.\n"; - } - cmTypeMacro(cmCTestUploadCommand, cmCTestHandlerCommand); protected: diff --git a/Source/CursesDialog/ccmake.cxx b/Source/CursesDialog/ccmake.cxx index 623d7d3..3855d53 100644 --- a/Source/CursesDialog/ccmake.cxx +++ b/Source/CursesDialog/ccmake.cxx @@ -23,47 +23,27 @@ #include <form.h> //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " ccmake - Curses Interface for CMake.", 0}, - {0,0,0} + " ccmake - Curses Interface for CMake."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, " ccmake <path-to-source>\n" - " ccmake <path-to-existing-build>", 0}, - {0,0,0} + " ccmake <path-to-existing-build>"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = -{ - {0, - "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 when the program is running.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = +static const char * cmDocumentationOptions[][2] = { CMAKE_STANDARD_OPTIONS_TABLE, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "cmake", 0}, - {0, "ctest", 0}, - {0, 0, 0} + {0,0} }; cmCursesForm* cmCursesForm::CurrentForm=0; @@ -106,21 +86,13 @@ int main(int argc, char** argv) if(doc.CheckOptions(argc, argv)) { cmake hcm; - std::vector<cmDocumentationEntry> commands; - std::vector<cmDocumentationEntry> compatCommands; std::vector<cmDocumentationEntry> generators; - hcm.GetCommandDocumentation(commands, true, false); - hcm.GetCommandDocumentation(compatCommands, false, true); hcm.GetGeneratorDocumentation(generators); doc.SetName("ccmake"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.SetSection("Generators",generators); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Command",commands); - doc.SetSection("Compatibility Commands",compatCommands); - doc.SetSeeAlsoList(cmDocumentationSeeAlso); return doc.PrintRequestedDocumentation(std::cout)? 0:1; } diff --git a/Source/QtDialog/CMakeSetup.cxx b/Source/QtDialog/CMakeSetup.cxx index 01893f5..cfefab2 100644 --- a/Source/QtDialog/CMakeSetup.cxx +++ b/Source/QtDialog/CMakeSetup.cxx @@ -23,39 +23,27 @@ #include <cmsys/SystemTools.hxx> //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " cmake-gui - CMake GUI.", 0}, - {0,0,0} + " cmake-gui - CMake GUI."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, " cmake-gui [options]\n" " cmake-gui [options] <path-to-source>\n" - " cmake-gui [options] <path-to-existing-build>", 0}, - {0,0,0} + " cmake-gui [options] <path-to-existing-build>"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = +static const char * cmDocumentationOptions[][2] = { - {0, - "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.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = -{ - {0,0,0} + {0,0} }; int main(int argc, char** argv) @@ -76,24 +64,14 @@ int main(int argc, char** argv) { doc.SetCMakeRoot(root); } - std::vector<cmDocumentationEntry> commands; - std::vector<cmDocumentationEntry> compatCommands; - std::map<std::string,cmDocumentationSection *> propDocs; std::vector<cmDocumentationEntry> generators; - hcm.GetCommandDocumentation(commands, true, false); - hcm.GetCommandDocumentation(compatCommands, false, true); hcm.GetGeneratorDocumentation(generators); - hcm.GetPropertiesDocumentation(propDocs); doc.SetName("cmake"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.AppendSection("Generators",generators); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Commands",commands); - doc.SetSection("Compatilbility Commands", compatCommands); - doc.SetSections(propDocs); return (doc.PrintRequestedDocumentation(std::cout)? 0:1); } diff --git a/Source/cmAddCompileOptionsCommand.h b/Source/cmAddCompileOptionsCommand.h index e9bbf28..38ed208 100644 --- a/Source/cmAddCompileOptionsCommand.h +++ b/Source/cmAddCompileOptionsCommand.h @@ -13,7 +13,6 @@ #define cmAddCompileOptionsCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" class cmAddCompileOptionsCommand : public cmCommand { @@ -38,33 +37,6 @@ public: */ virtual const char* GetName() const {return "add_compile_options";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Adds options to the compilation of source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_compile_options(<option> ...)\n" - "Adds options to the compiler command line for sources in the " - "current directory and below. This command can be used to add any " - "options, but alternative commands exist to add preprocessor " - "definitions or include directories. " - "See documentation of the directory and target COMPILE_OPTIONS " - "properties for details. " - "Arguments to add_compile_options may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmAddCompileOptionsCommand, cmCommand); }; diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h index 2504185..114957f 100644 --- a/Source/cmAddCustomCommandCommand.h +++ b/Source/cmAddCustomCommandCommand.h @@ -13,7 +13,6 @@ #define cmAddCustomCommandCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" /** \class cmAddCustomCommandCommand * \brief cmAddCustomCommandCommand defines a new command (rule) that can @@ -44,141 +43,6 @@ public: */ virtual const char* GetName() const {return "add_custom_command";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a custom build rule to the generated build system."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "There are two main signatures for add_custom_command " - "The first signature is for adding a custom command " - "to produce an output.\n" - " add_custom_command(OUTPUT output1 [output2 ...]\n" - " COMMAND command1 [ARGS] [args1...]\n" - " [COMMAND command2 [ARGS] [args2...] ...]\n" - " [MAIN_DEPENDENCY depend]\n" - " [DEPENDS [depends...]]\n" - " [IMPLICIT_DEPENDS <lang1> depend1\n" - " [<lang2> depend2] ...]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM] [APPEND])\n" - "This defines a command to generate specified OUTPUT file(s). " - "A target created in the same directory (CMakeLists.txt file) that " - "specifies any output of the custom command as a source file is given " - "a rule to generate the file using the command at build time. " - "Do not list the output in more than one independent target that may " - "build in parallel or the two instances of the rule may conflict " - "(instead use add_custom_target to drive the command and make the " - "other targets depend on that one). " - "If an output name is a relative path it will be interpreted " - "relative to the build tree directory corresponding to the current " - "source directory. " - "Note that MAIN_DEPENDENCY is completely optional and is " - "used as a suggestion to visual studio about where to hang the " - "custom command. In makefile terms this creates a new target in the " - "following form:\n" - " OUTPUT: MAIN_DEPENDENCY DEPENDS\n" - " COMMAND\n" - "If more than one command is specified they will be executed in order. " - "The optional ARGS argument is for backward compatibility and will be " - "ignored.\n" - "The second signature adds a custom command to a target " - "such as a library or executable. This is useful for " - "performing an operation before or after building the target. " - "The command becomes part of the target and will only execute " - "when the target itself is built. If the target is already built," - " the command will not execute.\n" - " add_custom_command(TARGET target\n" - " PRE_BUILD | PRE_LINK | POST_BUILD\n" - " COMMAND command1 [ARGS] [args1...]\n" - " [COMMAND command2 [ARGS] [args2...] ...]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM])\n" - "This defines a new command that will be associated with " - "building the specified target. When the command will " - "happen is determined by which of the following is specified:\n" - " PRE_BUILD - run before all other dependencies\n" - " PRE_LINK - run after other dependencies\n" - " POST_BUILD - run after the target has been built\n" - "Note that the PRE_BUILD option is only supported on Visual " - "Studio 7 or later. For all other generators PRE_BUILD " - "will be treated as PRE_LINK.\n" - "If WORKING_DIRECTORY is specified the command will be executed " - "in the directory given. " - "If it is a relative path it will be interpreted relative to the " - "build tree directory corresponding to the current source directory. " - "If COMMENT is set, the value will be displayed as a " - "message before the commands are executed at build time. " - "If APPEND is specified the COMMAND and DEPENDS option values " - "are appended to the custom command for the first output specified. " - "There must have already been a previous call to this command with " - "the same output. The COMMENT, WORKING_DIRECTORY, and MAIN_DEPENDENCY " - "options are currently ignored when APPEND is given, " - "but may be used in the future." - "\n" - "If VERBATIM is given then all arguments to the commands will be " - "escaped properly for the build tool so that the invoked command " - "receives each argument unchanged. " - "Note that one level of escapes is still used by the CMake language " - "processor before add_custom_command even sees the arguments. " - "Use of VERBATIM is recommended as it enables correct behavior. " - "When VERBATIM is not given the behavior is platform specific because " - "there is no protection of tool-specific special characters." - "\n" - "If the output of the custom command is not actually " - "created as a file on disk it should be marked as SYMBOLIC with " - "SET_SOURCE_FILES_PROPERTIES.\n" - - "The IMPLICIT_DEPENDS option requests scanning of implicit " - "dependencies of an input file. The language given specifies the " - "programming language whose corresponding dependency scanner should " - "be used. Currently only C and CXX language scanners are supported. " - "The language has to be specified for every file in the " - "IMPLICIT_DEPENDS list. " - "Dependencies discovered from the scanning are added to those of " - "the custom command at build time. Note that the IMPLICIT_DEPENDS " - "option is currently supported only for Makefile generators and " - "will be ignored by other generators." - "\n" - "If COMMAND specifies an executable target (created by " - "ADD_EXECUTABLE) it will automatically be replaced by the location " - "of the executable created at build time. Additionally a " - "target-level dependency will be added so that the executable target " - "will be built before any target using this custom command. However " - "this does NOT add a file-level dependency that would cause the " - "custom command to re-run whenever the executable is recompiled." - "\n" - "Arguments to COMMAND may use \"generator expressions\" with the " - "syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - "References to target names in generator expressions imply " - "target-level dependencies, but NOT file-level dependencies. " - "List target names with the DEPENDS option to add file dependencies." - "\n" - "The DEPENDS option specifies files on which the command depends. " - "If any dependency is an OUTPUT of another custom command in the " - "same directory (CMakeLists.txt file) CMake automatically brings the " - "other custom command into the target in which this command is built. " - "If DEPENDS is not specified the command will run whenever the OUTPUT " - "is missing; if the command does not actually create the OUTPUT then " - "the rule will always run. " - "If DEPENDS specifies any target (created by an ADD_* command) " - "a target-level dependency is created to make sure the target is " - "built before any target using this custom command. Additionally, " - "if the target is an executable or library a file-level dependency " - "is created to cause the custom command to re-run whenever the target " - "is recompiled.\n" - ; - } - cmTypeMacro(cmAddCustomCommandCommand, cmCommand); protected: bool CheckOutputs(const std::vector<std::string>& outputs); diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h index d4ed450..d0fcdad 100644 --- a/Source/cmAddCustomTargetCommand.h +++ b/Source/cmAddCustomTargetCommand.h @@ -45,63 +45,6 @@ public: virtual const char* GetName() const {return "add_custom_target";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a target with no output so it will always be built."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_custom_target(Name [ALL] [command1 [args1...]]\n" - " [COMMAND command2 [args2...] ...]\n" - " [DEPENDS depend depend depend ... ]\n" - " [WORKING_DIRECTORY dir]\n" - " [COMMENT comment] [VERBATIM]\n" - " [SOURCES src1 [src2...]])\n" - "Adds a target with the given name that executes the given commands. " - "The target has no output file and is ALWAYS CONSIDERED OUT OF DATE " - "even if the commands try to create a file with the name of the " - "target. Use ADD_CUSTOM_COMMAND to generate a file with dependencies. " - "By default nothing depends on the custom target. Use " - "ADD_DEPENDENCIES to add dependencies to or from other targets. " - "If the ALL option is specified " - "it indicates that this target should be added to the default build " - "target so that it will be run every time " - "(the command cannot be called ALL). " - "The command and arguments are optional and if not specified an " - "empty target will be created. " - "If WORKING_DIRECTORY is set, then the command will be run in that " - "directory. " - "If it is a relative path it will be interpreted relative to the " - "build tree directory corresponding to the current source directory. " - "If COMMENT is set, the value will be displayed as a " - "message before the commands are executed at build time. " - "Dependencies listed with the DEPENDS argument may reference files " - "and outputs of custom commands created with add_custom_command() in " - "the same directory (CMakeLists.txt file).\n" - "If VERBATIM is given then all arguments to the commands will be " - "escaped properly for the build tool so that the invoked command " - "receives each argument unchanged. " - "Note that one level of escapes is still used by the CMake language " - "processor before add_custom_target even sees the arguments. " - "Use of VERBATIM is recommended as it enables correct behavior. " - "When VERBATIM is not given the behavior is platform specific because " - "there is no protection of tool-specific special characters." - "\n" - "The SOURCES option specifies additional source files to be included " - "in the custom target. " - "Specified source files will be added to IDE project files for " - "convenience in editing even if they have not build rules." - ; - } - cmTypeMacro(cmAddCustomTargetCommand, cmCommand); }; diff --git a/Source/cmAddDefinitionsCommand.h b/Source/cmAddDefinitionsCommand.h index ff2c4a0..d05f187 100644 --- a/Source/cmAddDefinitionsCommand.h +++ b/Source/cmAddDefinitionsCommand.h @@ -43,35 +43,6 @@ public: */ virtual const char* GetName() const {return "add_definitions";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Adds -D define flags to the compilation of source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_definitions(-DFOO -DBAR ...)\n" - "Adds flags to the compiler command line for sources in the current " - "directory and below. This command can be used to add any flags, " - "but it was originally intended to add preprocessor definitions. " - "Flags beginning in -D or /D that look like preprocessor definitions " - "are automatically added to the COMPILE_DEFINITIONS property for " - "the current directory. Definitions with non-trivial values may be " - "left in the set of flags instead of being converted for reasons of " - "backwards compatibility. See documentation of the directory, " - "target, and source file COMPILE_DEFINITIONS properties for details " - "on adding preprocessor definitions to specific scopes and " - "configurations." - ; - } - cmTypeMacro(cmAddDefinitionsCommand, cmCommand); }; diff --git a/Source/cmAddDependenciesCommand.h b/Source/cmAddDependenciesCommand.h index 148fd99..247cc54 100644 --- a/Source/cmAddDependenciesCommand.h +++ b/Source/cmAddDependenciesCommand.h @@ -42,35 +42,6 @@ public: */ virtual const char* GetName() const { return "add_dependencies";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a dependency between top-level targets."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_dependencies(<target> [<target-dependency>]...)\n" - "Make a top-level <target> depend on other top-level targets to " - "ensure that they build before <target> does. " - "A top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, " - "or ADD_CUSTOM_TARGET. " - "Dependencies added to an IMPORTED target are followed transitively " - "in its place since the target itself does not build. " - "\n" - "See the DEPENDS option of ADD_CUSTOM_TARGET " - "and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom " - "rules. See the OBJECT_DEPENDS option in " - "SET_SOURCE_FILES_PROPERTIES to add file-level dependencies to object " - "files."; - } - cmTypeMacro(cmAddDependenciesCommand, cmCommand); }; diff --git a/Source/cmAddExecutableCommand.h b/Source/cmAddExecutableCommand.h index 2774ce8..30ecce3 100644 --- a/Source/cmAddExecutableCommand.h +++ b/Source/cmAddExecutableCommand.h @@ -43,86 +43,6 @@ public: */ virtual const char* GetName() const { return "add_executable";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add an executable to the project using the specified source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_executable(<name> [WIN32] [MACOSX_BUNDLE]\n" - " [EXCLUDE_FROM_ALL]\n" - " source1 source2 ... sourceN)\n" - "Adds an executable target called <name> to be built from the " - "source files listed in the command invocation. " - "The <name> corresponds to the logical target name and must be " - "globally unique within a project. " - "The actual file name of the executable built is constructed based on " - "conventions of the native platform " - "(such as <name>.exe or just <name>). " - "\n" - "By default the executable file will be created in the build tree " - "directory corresponding to the source tree directory in which " - "the command was invoked. " - "See documentation of the RUNTIME_OUTPUT_DIRECTORY " - "target property to change this location. " - "See documentation of the OUTPUT_NAME target property to change " - "the <name> part of the final file name. " - "\n" - "If WIN32 is given the property WIN32_EXECUTABLE will be set on the " - "target created. " - "See documentation of that target property for details." - "\n" - "If MACOSX_BUNDLE is given the corresponding property will be " - "set on the created target. " - "See documentation of the MACOSX_BUNDLE target property for details." - "\n" - "If EXCLUDE_FROM_ALL is given the corresponding property will be " - "set on the created target. " - "See documentation of the EXCLUDE_FROM_ALL target property for " - "details." - "\n" - "The add_executable command can also create IMPORTED executable " - "targets using this signature:\n" - " add_executable(<name> IMPORTED [GLOBAL])\n" - "An IMPORTED executable target references an executable file located " - "outside the project. " - "No rules are generated to build it. " - "The target name has scope in the directory in which it is created " - "and below, but the GLOBAL option extends visibility. " - "It may be referenced like any target built within the project. " - "IMPORTED executables are useful for convenient reference from " - "commands like add_custom_command. " - "Details about the imported executable are specified by setting " - "properties whose names begin in \"IMPORTED_\". " - "The most important such property is IMPORTED_LOCATION " - "(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) " - "which specifies the location of the main executable file on disk. " - "See documentation of the IMPORTED_* properties for more information." - "\n" - "The signature\n" - " add_executable(<name> ALIAS <target>)\n" - "creates an alias, such that <name> can be used to refer to <target> " - "in subsequent commands. The <name> does not appear in the generated " - "buildsystem as a make target. The <target> may not be an IMPORTED " - "target or an ALIAS. Alias targets can be used as linkable targets, " - "targets to read properties from, executables for custom commands and " - "custom targets. They can also be tested for existance with the " - "regular if(TARGET) subcommand. The <name> may not be used to modify " - "properties of <target>, that is, it may not be used as the operand of " - "set_property, set_target_properties, target_link_libraries etc. An " - "ALIAS target may not be installed of exported." - ; - } - cmTypeMacro(cmAddExecutableCommand, cmCommand); }; diff --git a/Source/cmAddLibraryCommand.h b/Source/cmAddLibraryCommand.h index 64d048b..1001043 100644 --- a/Source/cmAddLibraryCommand.h +++ b/Source/cmAddLibraryCommand.h @@ -43,127 +43,6 @@ public: */ virtual const char* GetName() const { return "add_library";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a library to the project using the specified source files."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_library(<name> [STATIC | SHARED | MODULE]\n" - " [EXCLUDE_FROM_ALL]\n" - " source1 source2 ... sourceN)\n" - "Adds a library target called <name> to be built from the " - "source files listed in the command invocation. " - "The <name> corresponds to the logical target name and must be " - "globally unique within a project. " - "The actual file name of the library built is constructed based on " - "conventions of the native platform " - "(such as lib<name>.a or <name>.lib)." - "\n" - "STATIC, SHARED, or MODULE may be given to specify the type of library " - "to be created. " - "STATIC libraries are archives of object files for use when linking " - "other targets. " - "SHARED libraries are linked dynamically and loaded at runtime. " - "MODULE libraries are plugins that are not linked into other targets " - "but may be loaded dynamically at runtime using dlopen-like " - "functionality. " - "If no type is given explicitly the type is STATIC or SHARED based " - "on whether the current value of the variable BUILD_SHARED_LIBS is " - "true. " - "For SHARED and MODULE libraries the POSITION_INDEPENDENT_CODE " - "target property is set to TRUE automatically." - "\n" - "By default the library file will be created in the build tree " - "directory corresponding to the source tree directory in which " - "the command was invoked. " - "See documentation of the ARCHIVE_OUTPUT_DIRECTORY, " - "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY " - "target properties to change this location. " - "See documentation of the OUTPUT_NAME target property to change " - "the <name> part of the final file name. " - "\n" - "If EXCLUDE_FROM_ALL is given the corresponding property will be " - "set on the created target. " - "See documentation of the EXCLUDE_FROM_ALL target property for " - "details." - "\n" - "The add_library command can also create IMPORTED library " - "targets using this signature:\n" - " add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED\n" - " [GLOBAL])\n" - "An IMPORTED library target references a library file located " - "outside the project. " - "No rules are generated to build it. " - "The target name has scope in the directory in which it is created " - "and below, but the GLOBAL option extends visibility. " - "It may be referenced like any target built within the project. " - "IMPORTED libraries are useful for convenient reference from " - "commands like target_link_libraries. " - "Details about the imported library are specified by setting " - "properties whose names begin in \"IMPORTED_\". " - "The most important such property is IMPORTED_LOCATION " - "(and its per-configuration version IMPORTED_LOCATION_<CONFIG>) " - "which specifies the location of the main library file on disk. " - "See documentation of the IMPORTED_* properties for more information." - "\n" - "The signature\n" - " add_library(<name> OBJECT <src>...)\n" - "creates a special \"object library\" target. " - "An object library compiles source files but does not archive or link " - "their object files into a library. " - "Instead other targets created by add_library or add_executable may " - "reference the objects using an expression of the form " - "$<TARGET_OBJECTS:objlib> as a source, where \"objlib\" is the " - "object library name. " - "For example:\n" - " add_library(... $<TARGET_OBJECTS:objlib> ...)\n" - " add_executable(... $<TARGET_OBJECTS:objlib> ...)\n" - "will include objlib's object files in a library and an executable " - "along with those compiled from their own sources. " - "Object libraries may contain only sources (and headers) that compile " - "to object files. " - "They may contain custom commands generating such sources, but not " - "PRE_BUILD, PRE_LINK, or POST_BUILD commands. " - "Object libraries cannot be imported, exported, installed, or linked." - " " - "Some native build systems may not like targets that have only " - "object files, so consider adding at least one real source file " - "to any target that references $<TARGET_OBJECTS:objlib>." - "\n" - "The signature\n" - " add_library(<name> ALIAS <target>)\n" - "creates an alias, such that <name> can be used to refer to <target> " - "in subsequent commands. The <name> does not appear in the generated " - "buildsystem as a make target. The <target> may not be an IMPORTED " - "target or an ALIAS. Alias targets can be used as linkable targets, " - "targets to read properties from. They can also be tested for " - "existance with the " - "regular if(TARGET) subcommand. The <name> may not be used to modify " - "properties of <target>, that is, it may not be used as the operand of " - "set_property, set_target_properties, target_link_libraries etc. An " - "ALIAS target may not be installed of exported." - "\n" - "The signature\n" - " add_library(<name> INTERFACE)\n" - "creates an interface target. An interface target does not directly " - "create build output, though it may have properties set on it and it " - "may be installed, exported and imported. Typically the INTERFACE_* " - "properties are populated on the interface target using the " - "set_property(), target_link_libraries(), target_include_directories() " - "and target_compile_defintions() commands, and then it is used as an " - "argument to target_link_libraries() like any other target." - ; - } - cmTypeMacro(cmAddLibraryCommand, cmCommand); }; diff --git a/Source/cmAddSubDirectoryCommand.h b/Source/cmAddSubDirectoryCommand.h index e7f907c..1e5b1ab 100644 --- a/Source/cmAddSubDirectoryCommand.h +++ b/Source/cmAddSubDirectoryCommand.h @@ -44,53 +44,6 @@ public: */ virtual const char* GetName() const { return "add_subdirectory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a subdirectory to the build."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_subdirectory(source_dir [binary_dir] \n" - " [EXCLUDE_FROM_ALL])\n" - "Add a subdirectory to the build. The source_dir specifies the " - "directory in which the source CMakeLists.txt and code files are " - "located. If it is a relative " - "path it will be evaluated with respect to the current " - "directory (the typical usage), but it may also be an absolute path. " - "The binary_dir specifies the directory in which to place the output " - "files. If it is a relative path it will be evaluated with respect " - "to the current output directory, but it may also be an absolute " - "path. If binary_dir is not specified, the value of source_dir, " - "before expanding any relative path, will be used (the typical usage). " - "The CMakeLists.txt file in the specified source directory will " - "be processed immediately by CMake before processing in the current " - "input file continues beyond this command.\n" - - "If the EXCLUDE_FROM_ALL argument is provided then targets in the " - "subdirectory will not be included in the ALL target of the parent " - "directory by default, and will be excluded from IDE project files. " - "Users must explicitly build targets in the subdirectory. " - "This is meant for use when the subdirectory contains a separate part " - "of the project that is useful but not necessary, such as a set of " - "examples. " - "Typically the subdirectory should contain its own project() command " - "invocation so that a full build system will be generated in the " - "subdirectory (such as a VS IDE solution file). " - "Note that inter-target dependencies supercede this exclusion. " - "If a target built by the parent project depends on a target in the " - "subdirectory, the dependee target will be included in the parent " - "project build system to satisfy the dependency." - ; - } - cmTypeMacro(cmAddSubDirectoryCommand, cmCommand); }; diff --git a/Source/cmAddTestCommand.h b/Source/cmAddTestCommand.h index ce98aaa..9173454 100644 --- a/Source/cmAddTestCommand.h +++ b/Source/cmAddTestCommand.h @@ -13,7 +13,6 @@ #define cmAddTestCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" /** \class cmAddTestCommand * \brief Add a test to the lists of tests to run. @@ -43,59 +42,6 @@ public: */ virtual const char* GetName() const { return "add_test";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add a test to the project with the specified arguments."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " add_test(testname Exename arg1 arg2 ... )\n" - "If the ENABLE_TESTING command has been run, this command adds a " - "test target to the current directory. If ENABLE_TESTING has not " - "been run, this command does nothing. " - "The tests are run by the testing subsystem by executing Exename " - "with the specified arguments. Exename can be either an executable " - "built by this project or an arbitrary executable on the " - "system (like tclsh). The test will be run with the current working " - "directory set to the CMakeList.txt files corresponding directory " - "in the binary tree. Tests added using this signature do not support " - "generator expressions.\n" - "\n" - " add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]\n" - " [WORKING_DIRECTORY dir]\n" - " COMMAND <command> [arg1 [arg2 ...]])\n" - "Add a test called <name>. " - "The test name may not contain spaces, quotes, or other characters " - "special in CMake syntax. " - "If COMMAND specifies an executable target (created by " - "add_executable) it will automatically be replaced by the location " - "of the executable created at build time. " - "If a CONFIGURATIONS option is given then the test will be executed " - "only when testing under one of the named configurations. " - "If a WORKING_DIRECTORY option is given then the test will be executed " - "in the given directory." - "\n" - "Arguments after COMMAND may use \"generator expressions\" with the " - "syntax \"$<...>\". " - CM_DOCUMENT_ADD_TEST_GENERATOR_EXPRESSIONS - "Example usage:\n" - " add_test(NAME mytest\n" - " COMMAND testDriver --config $<CONFIGURATION>\n" - " --exe $<TARGET_FILE:myexe>)\n" - "This creates a test \"mytest\" whose command runs a testDriver " - "tool passing the configuration name and the full path to the " - "executable file produced by target \"myexe\"." - ; - } - cmTypeMacro(cmAddTestCommand, cmCommand); private: bool HandleNameMode(std::vector<std::string> const& args); diff --git a/Source/cmAuxSourceDirectoryCommand.h b/Source/cmAuxSourceDirectoryCommand.h index 8a70f19..8b5fa8a 100644 --- a/Source/cmAuxSourceDirectoryCommand.h +++ b/Source/cmAuxSourceDirectoryCommand.h @@ -46,38 +46,6 @@ public: */ virtual const char* GetName() const { return "aux_source_directory";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find all source files in a directory."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " aux_source_directory(<dir> <variable>)\n" - "Collects the names of all the source files in the specified " - "directory and stores the list in the <variable> provided. This " - "command is intended to be used by projects that use explicit " - "template instantiation. Template instantiation files can be " - "stored in a \"Templates\" subdirectory and collected automatically " - "using this command to avoid manually listing all instantiations.\n" - "It is tempting to use this command to avoid writing the list of " - "source files for a library or executable target. While this seems " - "to work, there is no way for CMake to generate a build system that " - "knows when a new source file has been added. Normally the " - "generated build system knows when it needs to rerun CMake because " - "the CMakeLists.txt file is modified to add a new source. When the " - "source is just added to the directory without modifying this file, " - "one would have to manually rerun CMake to generate a build system " - "incorporating the new file."; - } - cmTypeMacro(cmAuxSourceDirectoryCommand, cmCommand); }; diff --git a/Source/cmBreakCommand.h b/Source/cmBreakCommand.h index 17f57cf..52f0e9c 100644 --- a/Source/cmBreakCommand.h +++ b/Source/cmBreakCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const {return "break";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Break from an enclosing foreach or while loop."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " break()\n" - "Breaks from an enclosing foreach loop or while loop"; - } - cmTypeMacro(cmBreakCommand, cmCommand); }; diff --git a/Source/cmBuildCommand.h b/Source/cmBuildCommand.h index 1bab453..2160655 100644 --- a/Source/cmBuildCommand.h +++ b/Source/cmBuildCommand.h @@ -52,45 +52,6 @@ public: */ virtual const char* GetName() const {return "build_command";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get the command line to build this project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " build_command(<variable>\n" - " [CONFIGURATION <config>]\n" - " [PROJECT_NAME <projname>]\n" - " [TARGET <target>])\n" - "Sets the given <variable> to a string containing the command line " - "for building one configuration of a target in a project using the " - "build tool appropriate for the current CMAKE_GENERATOR.\n" - "If CONFIGURATION is omitted, CMake chooses a reasonable default " - "value for multi-configuration generators. CONFIGURATION is " - "ignored for single-configuration generators.\n" - "If PROJECT_NAME is omitted, the resulting command line will build " - "the top level PROJECT in the current build tree.\n" - "If TARGET is omitted, the resulting command line will build " - "everything, effectively using build target 'all' or 'ALL_BUILD'.\n" - " build_command(<cachevariable> <makecommand>)\n" - "This second signature is deprecated, but still available for " - "backwards compatibility. Use the first signature instead.\n" - "Sets the given <cachevariable> to a string containing the command " - "to build this project from the root of the build tree using " - "the build tool given by <makecommand>. <makecommand> should be " - "the full path to msdev, devenv, nmake, make or one of the end " - "user build tools." - ; - } - cmTypeMacro(cmBuildCommand, cmCommand); }; diff --git a/Source/cmBuildNameCommand.h b/Source/cmBuildNameCommand.h index 26505a2..faeb3c0 100644 --- a/Source/cmBuildNameCommand.h +++ b/Source/cmBuildNameCommand.h @@ -47,27 +47,6 @@ public: */ virtual const char* GetName() const {return "build_name";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " build_name(variable)\n" - "Sets the specified variable to a string representing the platform " - "and compiler settings. These values are now available through the " - "CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmCMakeHostSystemInformationCommand.h b/Source/cmCMakeHostSystemInformationCommand.h index d1b8700..27ba638 100644 --- a/Source/cmCMakeHostSystemInformationCommand.h +++ b/Source/cmCMakeHostSystemInformationCommand.h @@ -53,41 +53,6 @@ public: return "cmake_host_system_information"; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Query host system specific information."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " cmake_host_system_information(RESULT <variable> QUERY <key> ...)\n" - "Queries system information of the host system on which cmake runs. " - "One or more <key> can be provided to " - "select the information to be queried. " - "The list of queried values is stored in <variable>.\n" - "<key> can be one of the following values:\n" - " NUMBER_OF_LOGICAL_CORES = Number of logical cores.\n" - " NUMBER_OF_PHYSICAL_CORES = Number of physical cores.\n" - " HOSTNAME = Hostname.\n" - " FQDN = Fully qualified domain name.\n" - " TOTAL_VIRTUAL_MEMORY = " - "Total virtual memory in megabytes.\n" - " AVAILABLE_VIRTUAL_MEMORY = " - "Available virtual memory in megabytes.\n" - " TOTAL_PHYSICAL_MEMORY = " - "Total physical memory in megabytes.\n" - " AVAILABLE_PHYSICAL_MEMORY = " - "Available physical memory in megabytes.\n" - ; - } - cmTypeMacro(cmCMakeHostSystemInformationCommand, cmCommand); private: diff --git a/Source/cmCMakeMinimumRequired.h b/Source/cmCMakeMinimumRequired.h index acf2829..0cdd4c5 100644 --- a/Source/cmCMakeMinimumRequired.h +++ b/Source/cmCMakeMinimumRequired.h @@ -47,37 +47,6 @@ public: */ virtual const char* GetName() const {return "cmake_minimum_required";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set the minimum required version of cmake for a project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]]\n" - " [FATAL_ERROR])\n" - "If the current version of CMake is lower than that required " - "it will stop processing the project and report an error. " - "When a version higher than 2.4 is specified the command implicitly " - "invokes\n" - " cmake_policy(VERSION major[.minor[.patch[.tweak]]])\n" - "which sets the cmake policy version level to the version specified. " - "When version 2.4 or lower is given the command implicitly invokes\n" - " cmake_policy(VERSION 2.4)\n" - "which enables compatibility features for CMake 2.4 and lower.\n" - "The FATAL_ERROR option is accepted but ignored by CMake 2.6 " - "and higher. " - "It should be specified so CMake versions 2.4 and lower fail with an " - "error instead of just a warning."; - } - cmTypeMacro(cmCMakeMinimumRequired, cmCommand); private: diff --git a/Source/cmCMakePolicyCommand.h b/Source/cmCMakePolicyCommand.h index 4f9faa1..7e3f4e6 100644 --- a/Source/cmCMakePolicyCommand.h +++ b/Source/cmCMakePolicyCommand.h @@ -48,88 +48,6 @@ public: */ virtual const char* GetName() const {return "cmake_policy";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Manage CMake Policy settings."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "As CMake evolves it is sometimes necessary to change existing " - "behavior in order to fix bugs or improve implementations of " - "existing features. " - "The CMake Policy mechanism is designed to help keep existing projects " - "building as new versions of CMake introduce changes in behavior. " - "Each new policy (behavioral change) is given an identifier of " - "the form \"CMP<NNNN>\" where \"<NNNN>\" is an integer index. " - "Documentation associated with each policy describes the OLD and NEW " - "behavior and the reason the policy was introduced. " - "Projects may set each policy to select the desired behavior. " - "When CMake needs to know which behavior to use it checks for " - "a setting specified by the project. " - "If no setting is available the OLD behavior is assumed and a warning " - "is produced requesting that the policy be set.\n" - "The cmake_policy command is used to set policies to OLD or NEW " - "behavior. " - "While setting policies individually is supported, we encourage " - "projects to set policies based on CMake versions.\n" - " cmake_policy(VERSION major.minor[.patch[.tweak]])\n" - "Specify that the current CMake list file is written for the " - "given version of CMake. " - "All policies introduced in the specified version or earlier " - "will be set to use NEW behavior. " - "All policies introduced after the specified version will be unset " - "(unless variable CMAKE_POLICY_DEFAULT_CMP<NNNN> sets a default). " - "This effectively requests behavior preferred as of a given CMake " - "version and tells newer CMake versions to warn about their new " - "policies. " - "The policy version specified must be at least 2.4 or the command " - "will report an error. " - "In order to get compatibility features supporting versions earlier " - "than 2.4 see documentation of policy CMP0001." - "\n" - " cmake_policy(SET CMP<NNNN> NEW)\n" - " cmake_policy(SET CMP<NNNN> OLD)\n" - "Tell CMake to use the OLD or NEW behavior for a given policy. " - "Projects depending on the old behavior of a given policy may " - "silence a policy warning by setting the policy state to OLD. " - "Alternatively one may fix the project to work with the new behavior " - "and set the policy state to NEW." - "\n" - " cmake_policy(GET CMP<NNNN> <variable>)\n" - "Check whether a given policy is set to OLD or NEW behavior. " - "The output variable value will be \"OLD\" or \"NEW\" if the " - "policy is set, and empty otherwise." - "\n" - "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 the policy stack is managed automatically for each " - "subdirectory to protect its parents and siblings. " - "CMake also manages a new entry for scripts loaded by include() and " - "find_package() commands except when invoked with the NO_POLICY_SCOPE " - "option (see also policy CMP0011). " - "The cmake_policy command provides an interface to manage custom " - "entries on the policy stack:\n" - " cmake_policy(PUSH)\n" - " cmake_policy(POP)\n" - "Each PUSH must have a matching POP to erase any changes. " - "This is useful to make temporary changes to policy settings." - "\n" - "Functions and macros record policy settings when they are created " - "and use the pre-record policies when they are invoked. " - "If the function or macro implementation sets policies, the changes " - "automatically propagate up through callers until they reach the " - "closest nested policy stack entry." - ; - } - cmTypeMacro(cmCMakePolicyCommand, cmCommand); private: bool HandleSetMode(std::vector<std::string> const& args); diff --git a/Source/cmCacheManager.cxx b/Source/cmCacheManager.cxx index ed09545..a2baa80 100644 --- a/Source/cmCacheManager.cxx +++ b/Source/cmCacheManager.cxx @@ -935,65 +935,3 @@ bool cmCacheManager::NeedCacheCompatibility(int major, int minor) return (actual_compat && actual_compat <= CMake_VERSION_ENCODE(major, minor, 0)); } - -//---------------------------------------------------------------------------- -void cmCacheManager::DefineProperties(cmake *cm) -{ - cm->DefineProperty - ("ADVANCED", cmProperty::CACHE, - "True if entry should be hidden by default in GUIs.", - "This is a boolean value indicating whether the entry is considered " - "interesting only for advanced configuration. " - "The mark_as_advanced() command modifies this property." - ); - - cm->DefineProperty - ("HELPSTRING", cmProperty::CACHE, - "Help associated with entry in GUIs.", - "This string summarizes the purpose of an entry to help users set it " - "through a CMake GUI." - ); - - cm->DefineProperty - ("TYPE", cmProperty::CACHE, - "Widget type for entry in GUIs.", - "Cache entry values are always strings, but CMake GUIs present widgets " - "to help users set values. " - "The GUIs use this property as a hint to determine the widget type. " - "Valid TYPE values are:\n" - " BOOL = Boolean ON/OFF value.\n" - " PATH = Path to a directory.\n" - " FILEPATH = Path to a file.\n" - " STRING = Generic string value.\n" - " INTERNAL = Do not present in GUI at all.\n" - " STATIC = Value managed by CMake, do not change.\n" - " UNINITIALIZED = Type not yet specified.\n" - "Generally the TYPE of a cache entry should be set by the command " - "which creates it (set, option, find_library, etc.)." - ); - - cm->DefineProperty - ("MODIFIED", cmProperty::CACHE, - "Internal management property. Do not set or get.", - "This is an internal cache entry property managed by CMake to " - "track interactive user modification of entries. Ignore it." - ); - - cm->DefineProperty - ("STRINGS", cmProperty::CACHE, - "Enumerate possible STRING entry values for GUI selection.", - "For cache entries with type STRING, this enumerates a set of values. " - "CMake GUIs may use this to provide a selection widget instead of a " - "generic string entry field. " - "This is for convenience only. " - "CMake does not enforce that the value matches one of those listed." - ); - - cm->DefineProperty - ("VALUE", cmProperty::CACHE, - "Value of a cache entry.", - "This property maps to the actual value of a cache entry. " - "Setting this property always sets the value without checking, so " - "use with care." - ); -} diff --git a/Source/cmCacheManager.h b/Source/cmCacheManager.h index a5e5eee..2eb440a 100644 --- a/Source/cmCacheManager.h +++ b/Source/cmCacheManager.h @@ -149,9 +149,6 @@ public: unsigned int GetCacheMinorVersion() { return this->CacheMinorVersion; } bool NeedCacheCompatibility(int major, int minor); - /** Define and document CACHE entry properties. */ - static void DefineProperties(cmake *cm); - protected: ///! Add an entry into the cache void AddCacheEntry(const char* key, const char* value, diff --git a/Source/cmCommand.h b/Source/cmCommand.h index 49f451b..83184a0 100644 --- a/Source/cmCommand.h +++ b/Source/cmCommand.h @@ -127,16 +127,6 @@ public: virtual const char* GetName() const = 0; /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const = 0; - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const = 0; - - /** * Enable the command. */ void EnabledOn() diff --git a/Source/cmConfigure.cmake.h.in b/Source/cmConfigure.cmake.h.in index ab53b1d..348f5d3 100644 --- a/Source/cmConfigure.cmake.h.in +++ b/Source/cmConfigure.cmake.h.in @@ -16,7 +16,6 @@ #cmakedefine HAVE_ENVIRON_NOT_REQUIRE_PROTOTYPE #cmakedefine HAVE_UNSETENV #cmakedefine CMAKE_USE_ELF_PARSER -#cmakedefine CMAKE_STRICT #define CMAKE_ROOT_DIR "${CMake_SOURCE_DIR}" #define CMAKE_BUILD_DIR "${CMake_BINARY_DIR}" #define CMAKE_DATA_DIR "/@CMAKE_DATA_DIR@" diff --git a/Source/cmConfigureFileCommand.h b/Source/cmConfigureFileCommand.h index 0393ecf..605b58b 100644 --- a/Source/cmConfigureFileCommand.h +++ b/Source/cmConfigureFileCommand.h @@ -41,61 +41,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Copy a file to another location and modify its contents."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " configure_file(<input> <output>\n" - " [COPYONLY] [ESCAPE_QUOTES] [@ONLY] \n" - " [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])\n" - "Copies a file <input> to file <output> and substitutes variable " - "values referenced in the file content. " - "If <input> is a relative path it is evaluated with respect to " - "the current source directory. " - "The <input> must be a file, not a directory. " - "If <output> is a relative path it is evaluated with respect to " - "the current binary directory. " - "If <output> names an existing directory the input file is placed " - "in that directory with its original name. " - "\n" - "If the <input> file is modified the build system will re-run CMake " - "to re-configure the file and generate the build system again." - "\n" - "This command replaces any variables in the input file referenced as " - "${VAR} or @VAR@ with their values as determined by CMake. If a " - "variable is not defined, it will be replaced with nothing. " - "If COPYONLY is specified, then no variable expansion will take " - "place. If ESCAPE_QUOTES is specified then any substituted quotes " - "will be C-style escaped. " - "The file will be configured with the current values of CMake " - "variables. If @ONLY is specified, only variables " - "of the form @VAR@ will be replaced and ${VAR} will be ignored. " - "This is useful for configuring scripts that use ${VAR}." - "\n" - "Input file lines of the form \"#cmakedefine VAR ...\" " - "will be replaced with either \"#define VAR ...\" or " - "\"/* #undef VAR */\" depending on whether VAR is set in CMake to " - "any value not considered a false constant by the if() command. " - "(Content of \"...\", if any, is processed as above.) " - "Input file lines of the form \"#cmakedefine01 VAR\" " - "will be replaced with either \"#define VAR 1\" or " - "\"#define VAR 0\" similarly." - "\n" - "With NEWLINE_STYLE the line ending could be adjusted: \n" - " 'UNIX' or 'LF' for \\n, 'DOS', 'WIN32' or 'CRLF' for \\r\\n.\n" - "COPYONLY must not be used with NEWLINE_STYLE.\n"; - } - virtual void FinalPass(); virtual bool HasFinalPass() const { return !this->Immediate; } diff --git a/Source/cmCreateTestSourceList.h b/Source/cmCreateTestSourceList.h index b9c6341..8b1e4de 100644 --- a/Source/cmCreateTestSourceList.h +++ b/Source/cmCreateTestSourceList.h @@ -42,46 +42,6 @@ public: */ virtual const char* GetName() const {return "create_test_sourcelist";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create a test driver and source list for building test programs."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " create_test_sourcelist(sourceListName driverName\n" - " test1 test2 test3\n" - " EXTRA_INCLUDE include.h\n" - " FUNCTION function)\n" - "A test driver is a program that links together many small tests into " - "a single executable. This is useful when building static executables " - "with large libraries to shrink the total required size. " - "The list of source files " - "needed to build the test driver will be in sourceListName. " - "DriverName is the name of the test driver program. The rest of " - "the arguments consist of a list of test source files, can be " - "semicolon separated. Each test source file should have a function in " - "it that is the same name as the file with no extension (foo.cxx " - "should have int foo(int, char*[]);) DriverName will be able to " - "call each of the " - "tests by name on the command line. If EXTRA_INCLUDE is specified, " - "then the next argument is included into the generated file. If " - "FUNCTION is specified, then the next argument is taken as a function " - "name that is passed a pointer to ac and av. This can be used to add " - "extra command line processing to each test. The cmake variable " - "CMAKE_TESTDRIVER_BEFORE_TESTMAIN can be set to have code that will be " - "placed directly before calling the test main function. " - "CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set to have code that will be " - "placed directly after the call to the test main function."; - } - cmTypeMacro(cmCreateTestSourceList, cmCommand); }; diff --git a/Source/cmDefinePropertyCommand.cxx b/Source/cmDefinePropertyCommand.cxx index 5816829..1ad98af 100644 --- a/Source/cmDefinePropertyCommand.cxx +++ b/Source/cmDefinePropertyCommand.cxx @@ -12,7 +12,6 @@ #include "cmDefinePropertyCommand.h" #include "cmake.h" -// cmDefinePropertiesCommand bool cmDefinePropertyCommand ::InitialPass(std::vector<std::string> const& args, cmExecutionStatus &) { diff --git a/Source/cmDefinePropertyCommand.h b/Source/cmDefinePropertyCommand.h index b5175d5..8dc4d96 100644 --- a/Source/cmDefinePropertyCommand.h +++ b/Source/cmDefinePropertyCommand.h @@ -34,53 +34,6 @@ public: */ virtual const char* GetName() const { return "define_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Define and document custom properties."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |\n" - " TEST | VARIABLE | CACHED_VARIABLE>\n" - " PROPERTY <name> [INHERITED]\n" - " BRIEF_DOCS <brief-doc> [docs...]\n" - " FULL_DOCS <full-doc> [docs...])\n" - "Define one property in a scope for use with the " - "set_property and get_property commands. " - "This is primarily useful to associate documentation with property " - "names that may be retrieved with the get_property command. " - "The first argument determines the kind of scope in which the " - "property should be used. It must be one of the following:\n" - " GLOBAL = associated with the global namespace\n" - " DIRECTORY = associated with one directory\n" - " TARGET = associated with one target\n" - " SOURCE = associated with one source file\n" - " TEST = associated with a test named with add_test\n" - " VARIABLE = documents a CMake language variable\n" - " CACHED_VARIABLE = documents a CMake cache variable\n" - "Note that unlike set_property and get_property no actual scope " - "needs to be given; only the kind of scope is important.\n" - "The required PROPERTY option is immediately followed by the name " - "of the property being defined.\n" - "If the INHERITED option then the get_property command will chain " - "up to the next higher scope when the requested property is not " - "set in the scope given to the command. " - "DIRECTORY scope chains to GLOBAL. " - "TARGET, SOURCE, and TEST chain to DIRECTORY.\n" - "The BRIEF_DOCS and FULL_DOCS options are followed by strings to be " - "associated with the property as its brief and full documentation. " - "Corresponding options to the get_property command will retrieve the " - "documentation."; - } - cmTypeMacro(cmDefinePropertyCommand, cmCommand); private: std::string PropertyName; diff --git a/Source/cmDocumentCompileDefinitions.h b/Source/cmDocumentCompileDefinitions.h deleted file mode 100644 index d15bd6d..0000000 --- a/Source/cmDocumentCompileDefinitions.h +++ /dev/null @@ -1,34 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2011 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentCompileDefinitions_h -#define cmDocumentCompileDefinitions_h - -#define CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER \ - "Disclaimer: Most native build tools have poor support for escaping " \ - "certain values. CMake has work-arounds for many cases but some " \ - "values may just not be possible to pass correctly. If a value " \ - "does not seem to be escaped correctly, do not attempt to " \ - "work-around the problem by adding escape sequences to the value. " \ - "Your work-around may break in a future version of CMake that " \ - "has improved escape support. Instead consider defining the macro " \ - "in a (configured) header file. Then report the limitation. " \ - "Known limitations include:\n" \ - " # - broken almost everywhere\n" \ - " ; - broken in VS IDE 7.0 and Borland Makefiles\n" \ - " , - broken in VS IDE\n" \ - " % - broken in some cases in NMake\n" \ - " & | - broken in some cases on MinGW\n" \ - " ^ < > \\\" - broken in most Make tools on Windows\n" \ - "CMake does not reject these values outright because they do work " \ - "in some cases. Use with caution. " - -#endif diff --git a/Source/cmDocumentGeneratorExpressions.h b/Source/cmDocumentGeneratorExpressions.h deleted file mode 100644 index 7bab741..0000000 --- a/Source/cmDocumentGeneratorExpressions.h +++ /dev/null @@ -1,101 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2010 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentGeneratorExpressions_h -#define cmDocumentGeneratorExpressions_h - -#define CM_DOCUMENT_ADD_TEST_GENERATOR_EXPRESSIONS \ - "Generator expressions are evaluated during build system generation " \ - "to produce information specific to each build configuration. " \ - "Valid expressions are:\n" \ - " $<0:...> = empty string (ignores \"...\")\n" \ - " $<1:...> = content of \"...\"\n" \ - " $<CONFIG:cfg> = '1' if config is \"cfg\", else '0'\n" \ - " $<CONFIGURATION> = configuration name\n" \ - " $<BOOL:...> = '1' if the '...' is true, else '0'\n" \ - " $<STREQUAL:a,b> = '1' if a is STREQUAL b, else '0'\n" \ - " $<ANGLE-R> = A literal '>'. Used to compare " \ - "strings which contain a '>' for example.\n" \ - " $<COMMA> = A literal ','. Used to compare " \ - "strings which contain a ',' for example.\n" \ - " $<SEMICOLON> = A literal ';'. Used to prevent " \ - "list expansion on an argument with ';'.\n" \ - " $<JOIN:list,...> = joins the list with the content of " \ - "\"...\"\n" \ - " $<TARGET_NAME:...> = Marks ... as being the name of a " \ - "target. This is required if exporting targets to multiple " \ - "dependent export sets. The '...' must be a literal name of a " \ - "target- it may not contain generator expressions.\n" \ - " $<INSTALL_INTERFACE:...> = content of \"...\" when the property " \ - "is exported using install(EXPORT), and empty otherwise.\n" \ - " $<BUILD_INTERFACE:...> = content of \"...\" when the property " \ - "is exported using export(), or when the target is used by another " \ - "target in the same buildsystem. Expands to the empty string " \ - "otherwise.\n" \ - " $<PLATFORM_ID> = The CMake-id of the platform " \ - " $<PLATFORM_ID:comp> = '1' if the The CMake-id of the " \ - "platform matches comp, otherwise '0'.\n" \ - " $<C_COMPILER_ID> = The CMake-id of the C compiler " \ - "used.\n" \ - " $<C_COMPILER_ID:comp> = '1' if the CMake-id of the C " \ - "compiler matches comp, otherwise '0'.\n" \ - " $<CXX_COMPILER_ID> = The CMake-id of the CXX compiler " \ - "used.\n" \ - " $<CXX_COMPILER_ID:comp> = '1' if the CMake-id of the CXX " \ - "compiler matches comp, otherwise '0'.\n" \ - " $<VERSION_GREATER:v1,v2> = '1' if v1 is a version greater than " \ - "v2, else '0'.\n" \ - " $<VERSION_LESS:v1,v2> = '1' if v1 is a version less than v2, " \ - "else '0'.\n" \ - " $<VERSION_EQUAL:v1,v2> = '1' if v1 is the same version as v2, " \ - "else '0'.\n" \ - " $<C_COMPILER_VERSION> = The version of the C compiler used.\n" \ - " $<C_COMPILER_VERSION:ver> = '1' if the version of the C " \ - "compiler matches ver, otherwise '0'.\n" \ - " $<CXX_COMPILER_VERSION> = The version of the CXX compiler " \ - "used.\n" \ - " $<CXX_COMPILER_VERSION:ver> = '1' if the version of the CXX " \ - "compiler matches ver, otherwise '0'.\n" \ - " $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)\n" \ - " $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)\n" \ - " $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)\n" \ - "where \"tgt\" is the name of a target. " \ - "Target file expressions produce a full path, but _DIR and _NAME " \ - "versions can produce the directory and file name components:\n" \ - " $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>\n" \ - " $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>\n" \ - " $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>\n" \ - "\n" \ - " $<TARGET_PROPERTY:tgt,prop> = The value of the property prop " \ - "on the target tgt.\n" \ - "Note that tgt is not added as a dependency of the target this " \ - "expression is evaluated on.\n" \ - " $<TARGET_POLICY:pol> = '1' if the policy was NEW when " \ - "the 'head' target was created, else '0'. If the policy was not " \ - "set, the warning message for the policy will be emitted. This " \ - "generator expression only works for a subset of policies.\n" \ - " $<INSTALL_PREFIX> = Content of the install prefix when " \ - "the target is exported via INSTALL(EXPORT) and empty otherwise.\n" \ - "Boolean expressions:\n" \ - " $<AND:?[,?]...> = '1' if all '?' are '1', else '0'\n" \ - " $<OR:?[,?]...> = '0' if all '?' are '0', else '1'\n" \ - " $<NOT:?> = '0' if '?' is '1', else '1'\n" \ - "where '?' is always either '0' or '1'.\n" \ - "" - -#define CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS \ - CM_DOCUMENT_ADD_TEST_GENERATOR_EXPRESSIONS \ - "Expressions with an implicit 'this' target:\n" \ - " $<TARGET_PROPERTY:prop> = The value of the property prop on " \ - "the target on which the generator expression is evaluated.\n" \ - "" - -#endif diff --git a/Source/cmDocumentLocationUndefined.h b/Source/cmDocumentLocationUndefined.h deleted file mode 100644 index 9aecf21..0000000 --- a/Source/cmDocumentLocationUndefined.h +++ /dev/null @@ -1,24 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2011 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentLocationUndefined_h -#define cmDocumentLocationUndefined_h - -#define CM_LOCATION_UNDEFINED_BEHAVIOR(action) \ - "\n" \ - "Do not set properties that affect the location of a target after " \ - action ". These include properties whose names match " \ - "\"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?\", " \ - "\"(IMPLIB_)?(PREFIX|SUFFIX)\", or \"LINKER_LANGUAGE\". " \ - "Failure to follow this rule is not diagnosed and leaves the location " \ - "of the target undefined." - -#endif diff --git a/Source/cmDocumentVariables.cxx b/Source/cmDocumentVariables.cxx deleted file mode 100644 index dbe1b04..0000000 --- a/Source/cmDocumentVariables.cxx +++ /dev/null @@ -1,2069 +0,0 @@ -#include "cmDocumentVariables.h" -#include "cmake.h" - -#include <cmsys/ios/sstream> - -void cmDocumentVariables::DefineVariables(cmake* cm) -{ - // Subsection: variables defined by cmake, that give - // information about the project, and cmake - cm->DefineProperty - ("CMAKE_AR", cmProperty::VARIABLE, - "Name of archiving tool for static libraries.", - "This specifies the name of the program that creates archive " - "or static libraries.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_COMMAND", cmProperty::VARIABLE, - "The full path to the cmake executable.", - "This is the full path to the CMake executable cmake which is " - "useful from custom commands that want to use the cmake -E " - "option for portable system commands. " - "(e.g. /usr/local/bin/cmake", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_BINARY_DIR", cmProperty::VARIABLE, - "The path to the top level of the build tree.", - "This is the full path to the top level of the current CMake " - "build tree. For an in-source build, this would be the same " - "as CMAKE_SOURCE_DIR.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE, - "The path to the top level of the source tree.", - "This is the full path to the top level of the current CMake " - "source tree. For an in-source build, this would be the same " - "as CMAKE_BINARY_DIR.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CURRENT_BINARY_DIR", cmProperty::VARIABLE, - "The path to the binary directory currently being processed.", - "This the full path to the build directory that is currently " - "being processed by cmake. Each directory added by " - "add_subdirectory will create a binary directory in the build " - "tree, and as it is being processed this variable will be set. " - "For in-source builds this is the current source directory " - "being processed.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CURRENT_SOURCE_DIR", cmProperty::VARIABLE, - "The path to the source directory currently being processed.", - "This the full path to the source directory that is currently " - "being processed by cmake. ", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CURRENT_LIST_FILE", cmProperty::VARIABLE, - "Full path to the listfile currently being processed.", - "As CMake processes the listfiles in your project this " - "variable will always be set to the one currently being " - "processed. " - "The value has dynamic scope. " - "When CMake starts processing commands in a source file " - "it sets this variable to the location of the file. " - "When CMake finishes processing commands from the file it " - "restores the previous value. " - "Therefore the value of the variable inside a macro or " - "function is the file invoking the bottom-most entry on " - "the call stack, not the file containing the macro or " - "function definition." - "\n" - "See also CMAKE_PARENT_LIST_FILE.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CURRENT_LIST_LINE", cmProperty::VARIABLE, - "The line number of the current file being processed.", - "This is the line number of the file currently being" - " processed by cmake.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CURRENT_LIST_DIR", cmProperty::VARIABLE, - "Full directory of the listfile currently being processed.", - "As CMake processes the listfiles in your project this " - "variable will always be set to the directory where the listfile which " - "is currently being processed (CMAKE_CURRENT_LIST_FILE) is located. " - "The value has dynamic scope. " - "When CMake starts processing commands in a source file " - "it sets this variable to the directory where this file is located. " - "When CMake finishes processing commands from the file it " - "restores the previous value. " - "Therefore the value of the variable inside a macro or " - "function is the directory of the file invoking the bottom-most entry on " - "the call stack, not the directory of the file containing the macro or " - "function definition." - "\n" - "See also CMAKE_CURRENT_LIST_FILE.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_SCRIPT_MODE_FILE", cmProperty::VARIABLE, - "Full path to the -P script file currently being processed.", - "When run in -P script mode, CMake sets this variable to the full " - "path of the script file. When run to configure a CMakeLists.txt " - "file, this variable is not set.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_ARGC", cmProperty::VARIABLE, - "Number of command line arguments passed to CMake in script mode.", - "When run in -P script mode, CMake sets this variable to the number " - "of command line arguments. See also CMAKE_ARGV0, 1, 2 ...", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_ARGV0", cmProperty::VARIABLE, - "Command line argument passed to CMake in script mode.", - "When run in -P script mode, CMake sets this variable to " - "the first command line argument. It then also sets CMAKE_ARGV1, " - "CMAKE_ARGV2, ... and so on, up to the number of command line arguments " - "given. See also CMAKE_ARGC.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_BUILD_TOOL", cmProperty::VARIABLE, - "Tool used for the actual build process.", - "This variable is set to the program that will be" - " needed to build the output of CMake. If the " - "generator selected was Visual Studio 6, the " - "CMAKE_BUILD_TOOL will be set to msdev, for " - "Unix Makefiles it will be set to make or gmake, " - "and for Visual Studio 7 it set to devenv. For " - "NMake Makefiles the value is nmake. This can be " - "useful for adding special flags and commands based" - " on the final build environment.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CROSSCOMPILING", cmProperty::VARIABLE, - "Is CMake currently cross compiling.", - "This variable will be set to true by CMake if CMake is cross " - "compiling. Specifically if the build platform is different " - "from the target platform.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CACHEFILE_DIR", cmProperty::VARIABLE, - "The directory with the CMakeCache.txt file.", - "This is the full path to the directory that has the " - "CMakeCache.txt file in it. This is the same as " - "CMAKE_BINARY_DIR.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CACHE_MAJOR_VERSION", cmProperty::VARIABLE, - "Major version of CMake used to create the CMakeCache.txt file", - "This stores the major version of CMake used to " - "write a CMake cache file. It is only different when " - "a different version of CMake is run on a previously " - "created cache file.", false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_CACHE_MINOR_VERSION", cmProperty::VARIABLE, - "Minor version of CMake used to create the CMakeCache.txt file", - "This stores the minor version of CMake used to " - "write a CMake cache file. It is only different when " - "a different version of CMake is run on a previously " - "created cache file.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CACHE_PATCH_VERSION", cmProperty::VARIABLE, - "Patch version of CMake used to create the CMakeCache.txt file", - "This stores the patch version of CMake used to " - "write a CMake cache file. It is only different when " - "a different version of CMake is run on a previously " - "created cache file.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CFG_INTDIR", cmProperty::VARIABLE, - "Build-time reference to per-configuration output subdirectory.", - "For native build systems supporting multiple configurations " - "in the build tree (such as Visual Studio and Xcode), " - "the value is a reference to a build-time variable specifying " - "the name of the per-configuration output subdirectory. " - "On Makefile generators this evaluates to \".\" because there " - "is only one configuration in a build tree. " - "Example values:\n" - " $(IntDir) = Visual Studio 6\n" - " $(OutDir) = Visual Studio 7, 8, 9\n" - " $(Configuration) = Visual Studio 10\n" - " $(CONFIGURATION) = Xcode\n" - " . = Make-based tools\n" - "Since these values are evaluated by the native build system, this " - "variable is suitable only for use in command lines that will be " - "evaluated at build time. " - "Example of intended usage:\n" - " add_executable(mytool mytool.c)\n" - " add_custom_command(\n" - " OUTPUT out.txt\n" - " COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool\n" - " ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt\n" - " DEPENDS mytool in.txt\n" - " )\n" - " add_custom_target(drive ALL DEPENDS out.txt)\n" - "Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose " - "but has been left for compatibility with existing projects. " - "Instead add_custom_command() recognizes executable target names in " - "its COMMAND option, so " - "\"${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool\" can be " - "replaced by just \"mytool\"." - "\n" - "This variable is read-only. Setting it is undefined behavior. " - "In multi-configuration build systems the value of this variable " - "is passed as the value of preprocessor symbol \"CMAKE_INTDIR\" to " - "the compilation of all source files.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_CTEST_COMMAND", cmProperty::VARIABLE, - "Full path to ctest command installed with cmake.", - "This is the full path to the CTest executable ctest " - "which is useful from custom commands that want " - "to use the cmake -E option for portable system " - "commands.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_DL_LIBS", cmProperty::VARIABLE, - "Name of library containing dlopen and dlcose.", - "The name of the library that has dlopen and " - "dlclose in it, usually -ldl on most UNIX machines.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_EDIT_COMMAND", cmProperty::VARIABLE, - "Full path to cmake-gui or ccmake.", - "This is the full path to the CMake executable " - "that can graphically edit the cache. For example," - " cmake-gui, ccmake, or cmake -i.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_GENERATOR", cmProperty::VARIABLE, - "The generator used to build the project.", - "The name of the generator that is being used to generate the " - "build files. (e.g. \"Unix Makefiles\", " - "\"Visual Studio 6\", etc.)",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_EXTRA_GENERATOR", cmProperty::VARIABLE, - "The extra generator used to build the project.", - "When using the Eclipse, CodeBlocks or KDevelop generators, CMake " - "generates Makefiles (CMAKE_GENERATOR) and additionally project files " - "for the respective IDE. This IDE project file generator is stored in " - "CMAKE_EXTRA_GENERATOR (e.g. \"Eclipse CDT4\").",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_GENERATOR_TOOLSET", cmProperty::VARIABLE, - "Native build system toolset name specified by user.", - "Some CMake generators support a toolset name to be given to the " - "native build system to choose a compiler. " - "If the user specifies a toolset name (e.g. via the cmake -T option) " - "the value will be available in this variable.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_HOME_DIRECTORY", cmProperty::VARIABLE, - "Path to top of source tree.", - "This is the path to the top level of the source tree.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_LINK_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for libraries that you link to.", - "The suffix to use for the end of a library filename, .lib on Windows." - ,false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_EXECUTABLE_SUFFIX", cmProperty::VARIABLE, - "The suffix for executables on this platform.", - "The suffix to use for the end of an executable filename if any, " - ".exe on Windows." - "\n" - "CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MAJOR_VERSION", cmProperty::VARIABLE, - "The Major version of cmake (i.e. the 2 in 2.X.X)", - "This specifies the major version of the CMake executable" - " being run.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MAKE_PROGRAM", cmProperty::VARIABLE, - "See CMAKE_BUILD_TOOL.", - "This variable is around for backwards compatibility, " - "see CMAKE_BUILD_TOOL.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_VS_PLATFORM_TOOLSET", cmProperty::VARIABLE, - "Visual Studio Platform Toolset name.", - "VS 10 and above use MSBuild under the hood and support multiple " - "compiler toolchains. " - "CMake may specify a toolset explicitly, such as \"v110\" for " - "VS 11 or \"Windows7.1SDK\" for 64-bit support in VS 10 Express. " - "CMake provides the name of the chosen toolset in this variable." - ,false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_XCODE_PLATFORM_TOOLSET", cmProperty::VARIABLE, - "Xcode compiler selection.", - "Xcode supports selection of a compiler from one of the installed " - "toolsets. " - "CMake provides the name of the chosen toolset in this variable, " - "if any is explicitly selected (e.g. via the cmake -T option)." - ,false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MINOR_VERSION", cmProperty::VARIABLE, - "The Minor version of cmake (i.e. the 4 in X.4.X).", - "This specifies the minor version of the CMake" - " executable being run.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_PATCH_VERSION", cmProperty::VARIABLE, - "The patch version of cmake (i.e. the 3 in X.X.3).", - "This specifies the patch version of the CMake" - " executable being run.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_TWEAK_VERSION", cmProperty::VARIABLE, - "The tweak version of cmake (i.e. the 1 in X.X.X.1).", - "This specifies the tweak version of the CMake executable being run. " - "Releases use tweak < 20000000 and development versions use the date " - "format CCYYMMDD for the tweak level." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_VERSION", cmProperty::VARIABLE, - "The full version of cmake in major.minor.patch[.tweak[-id]] format.", - "This specifies the full version of the CMake executable being run. " - "This variable is defined by versions 2.6.3 and higher. " - "See variables CMAKE_MAJOR_VERSION, CMAKE_MINOR_VERSION, " - "CMAKE_PATCH_VERSION, and CMAKE_TWEAK_VERSION " - "for individual version components. " - "The [-id] component appears in non-release versions " - "and may be arbitrary text.", false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_PARENT_LIST_FILE", cmProperty::VARIABLE, - "Full path to the CMake file that included the current one.", - "While processing a CMake file loaded by include() or find_package() " - "this variable contains the full path to the file including it. " - "The top of the include stack is always the CMakeLists.txt for the " - "current directory. " - "See also CMAKE_CURRENT_LIST_FILE.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_PROJECT_NAME", cmProperty::VARIABLE, - "The name of the current project.", - "This specifies name of the current project from" - " the closest inherited PROJECT command.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_RANLIB", cmProperty::VARIABLE, - "Name of randomizing tool for static libraries.", - "This specifies name of the program that randomizes " - "libraries on UNIX, not used on Windows, but may be present.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_ROOT", cmProperty::VARIABLE, - "Install directory for running cmake.", - "This is the install root for the running CMake and" - " the Modules directory can be found here. This is" - " commonly used in this format: ${CMAKE_ROOT}/Modules",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SIZEOF_VOID_P", cmProperty::VARIABLE, - "Size of a void pointer.", - "This is set to the size of a pointer on the machine, " - "and is determined by a try compile. If a 64 bit size " - "is found, then the library search path is modified to " - "look for 64 bit libraries first.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SKIP_RPATH", cmProperty::VARIABLE, - "If true, do not add run time path information.", - "If this is set to TRUE, then the rpath information " - "is not added to compiled executables. The default " - "is to add rpath information if the platform supports it. " - "This allows for easy running from the build tree. To omit RPATH " - "in the install step, but not the build step, use " - "CMAKE_SKIP_INSTALL_RPATH instead.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE, - "Source directory for project.", - "This is the top level source directory for the project. " - "It corresponds to the source directory given to " - "cmake-gui or ccmake.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_STANDARD_LIBRARIES", cmProperty::VARIABLE, - "Libraries linked into every executable and shared library.", - "This is the list of libraries that are linked " - "into all executables and libraries.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_VERBOSE_MAKEFILE", cmProperty::VARIABLE, - "Create verbose makefiles if on.", - "This variable defaults to false. You can set " - "this variable to true to make CMake produce verbose " - "makefiles that show each command line as it is used.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("PROJECT_BINARY_DIR", cmProperty::VARIABLE, - "Full path to build directory for project.", - "This is the binary directory of the most recent " - "PROJECT command.",false,"Variables that Provide Information"); - cm->DefineProperty - ("PROJECT_NAME", cmProperty::VARIABLE, - "Name of the project given to the project command.", - "This is the name given to the most " - "recent PROJECT command.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE, - "Top level source directory for the current project.", - "This is the source directory of the most recent " - "PROJECT command.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("<PROJECT-NAME>_BINARY_DIR", cmProperty::VARIABLE, - "Top level binary directory for the named project.", - "A variable is created with the name used in the PROJECT " - "command, and is the binary directory for the project. " - " This can be useful when SUBDIR is used to connect " - "several projects.",false, - "Variables that Provide Information"); - cm->DefineProperty - ("<PROJECT-NAME>_SOURCE_DIR", cmProperty::VARIABLE, - "Top level source directory for the named project.", - "A variable is created with the name used in the PROJECT " - "command, and is the source directory for the project." - " This can be useful when add_subdirectory " - "is used to connect several projects.",false, - "Variables that Provide Information"); - - cm->DefineProperty - ("CMAKE_IMPORT_LIBRARY_PREFIX", cmProperty::VARIABLE, - "The prefix for import libraries that you link to.", - "The prefix to use for the name of an import library if used " - "on this platform." - "\n" - "CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_IMPORT_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for import libraries that you link to.", - "The suffix to use for the end of an import library filename if used " - "on this platform." - "\n" - "CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_LIBRARY_PREFIX", cmProperty::VARIABLE, - "The prefix for shared libraries that you link to.", - "The prefix to use for the name of a shared library, lib on UNIX." - "\n" - "CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for shared libraries that you link to.", - "The suffix to use for the end of a shared library filename, " - ".dll on Windows." - "\n" - "CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_MODULE_PREFIX", cmProperty::VARIABLE, - "The prefix for loadable modules that you link to.", - "The prefix to use for the name of a loadable module on this platform." - "\n" - "CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_SHARED_MODULE_SUFFIX", cmProperty::VARIABLE, - "The suffix for shared libraries that you link to.", - "The suffix to use for the end of a loadable module filename " - "on this platform" - "\n" - "CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_STATIC_LIBRARY_PREFIX", cmProperty::VARIABLE, - "The prefix for static libraries that you link to.", - "The prefix to use for the name of a static library, lib on UNIX." - "\n" - "CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_STATIC_LIBRARY_SUFFIX", cmProperty::VARIABLE, - "The suffix for static libraries that you link to.", - "The suffix to use for the end of a static library filename, " - ".lib on Windows." - "\n" - "CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>." - ,false, "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES", cmProperty::VARIABLE, - "Additional suffixes for shared libraries.", - "Extensions for shared libraries other than that specified by " - "CMAKE_SHARED_LIBRARY_SUFFIX, if any. " - "CMake uses this to recognize external shared library files during " - "analysis of libraries linked by a target.", - false, - "Variables that Provide Information"); - cm->DefineProperty - ("CMAKE_MINIMUM_REQUIRED_VERSION", cmProperty::VARIABLE, - "Version specified to cmake_minimum_required command", - "Variable containing the VERSION component specified in the " - "cmake_minimum_required command.", - false, - "Variables that Provide Information"); - - - // Variables defined by cmake, that change the behavior - // of cmake - - cm->DefineProperty - ("CMAKE_POLICY_DEFAULT_CMP<NNNN>", cmProperty::VARIABLE, - "Default for CMake Policy CMP<NNNN> when it is otherwise left unset.", - "Commands cmake_minimum_required(VERSION) and cmake_policy(VERSION) " - "by default leave policies introduced after the given version unset. " - "Set CMAKE_POLICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the " - "default for policy CMP<NNNN>, where <NNNN> is the policy number." - "\n" - "This variable should not be set by a project in CMake code; " - "use cmake_policy(SET) instead. " - "Users running CMake may set this variable in the cache " - "(e.g. -DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) " - "to set a policy not otherwise set by the project. " - "Set to OLD to quiet a policy warning while using old behavior " - "or to NEW to try building the project with new behavior.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_AUTOMOC_RELAXED_MODE", cmProperty::VARIABLE, - "Switch between strict and relaxed automoc mode.", - "By default, automoc behaves exactly as described in the documentation " - "of the AUTOMOC target property. " - "When set to TRUE, it accepts more input and tries to find the correct " - "input file for moc even if it differs from the documented behaviour. " - "In this mode it e.g. also checks whether a header file is intended to " - "be processed by moc when a \"foo.moc\" file has been included.\n" - "Relaxed mode has to be enabled for KDE4 compatibility.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_INSTALL_DEFAULT_COMPONENT_NAME", cmProperty::VARIABLE, - "Default component used in install() commands.", - "If an install() command is used without the COMPONENT argument, " - "these files will be grouped into a default component. The name of this " - "default install component will be taken from this variable. " - "It defaults to \"Unspecified\".", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_FIND_LIBRARY_PREFIXES", cmProperty::VARIABLE, - "Prefixes to prepend when looking for libraries.", - "This specifies what prefixes to add to library names when " - "the find_library command looks for libraries. On UNIX " - "systems this is typically lib, meaning that when trying " - "to find the foo library it will look for libfoo.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_FIND_LIBRARY_SUFFIXES", cmProperty::VARIABLE, - "Suffixes to append when looking for libraries.", - "This specifies what suffixes to add to library names when " - "the find_library command looks for libraries. On Windows " - "systems this is typically .lib and .dll, meaning that when trying " - "to find the foo library it will look for foo.dll etc.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_CONFIGURATION_TYPES", cmProperty::VARIABLE, - "Specifies the available build types on multi-config generators.", - "This specifies what build types (configurations) will be available " - "such as Debug, Release, RelWithDebInfo etc. " - "This has reasonable defaults on most platforms, " - "but can be extended to provide other build types. " - "See also CMAKE_BUILD_TYPE for details of managing configuration data, " - "and CMAKE_CFG_INTDIR." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE, - "Specifies the build type on single-configuration generators.", - "This statically specifies what build type (configuration) " - "will be built in this build tree. Possible values are " - "empty, Debug, Release, RelWithDebInfo and MinSizeRel. " - "This variable is only meaningful to single-configuration generators " - "(such as make and Ninja) i.e. " - "those which choose a single configuration " - "when CMake runs to generate a build tree as opposed to " - "multi-configuration generators which offer selection of the build " - "configuration within the generated build environment. " - "There are many per-config properties and variables " - "(usually following clean SOME_VAR_<CONFIG> order conventions), " - "such as CMAKE_C_FLAGS_<CONFIG>, specified as uppercase: " - "CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. " - "For example, in a build tree configured " - "to build type Debug, CMake will see to having " - "CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS settings. " - "See also CMAKE_CONFIGURATION_TYPES." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_BACKWARDS_COMPATIBILITY", cmProperty::VARIABLE, - "Version of cmake required to build project", - "From the point of view of backwards compatibility, this " - "specifies what version of CMake should be supported. By " - "default this value is the version number of CMake that " - "you are running. You can set this to an older version of" - " CMake to support deprecated commands of CMake in projects" - " that were written to use older versions of CMake. This " - "can be set by the user or set at the beginning of a " - "CMakeLists file.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE, - "Install directory used by install.", - "If \"make install\" is invoked or INSTALL is built" - ", this directory is prepended onto all install " - "directories. This variable defaults to /usr/local" - " on UNIX and c:/Program Files on Windows.\n" - "On UNIX one can use the DESTDIR mechanism in order" - " to relocate the whole installation. " - "DESTDIR means DESTination DIRectory. It is " - "commonly used by makefile users " - "in order to install software at non-default location. " - "It is usually invoked like this:\n" - " make DESTDIR=/home/john install\n" - "which will install the concerned software using the" - " installation prefix, e.g. \"/usr/local\" prepended with " - "the DESTDIR value which finally gives \"/home/john/usr/local\".\n" - "WARNING: DESTDIR may not be used on Windows because installation" - " prefix usually contains a drive letter like in \"C:/Program Files\"" - " which cannot be prepended with some other prefix." - "\n" - "The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH " - "so that find_package, find_program, find_library, find_path, and " - "find_file will search the prefix for other software." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SKIP_INSTALL_ALL_DEPENDENCY", cmProperty::VARIABLE, - "Don't make the install target depend on the all target.", - "By default, the \"install\" target depends on the \"all\" target. " - "This has the effect, that when \"make install\" is invoked or INSTALL " - "is built, first the \"all\" target is built, then the installation " - "starts. " - "If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency " - "is not created, so the installation process will start immediately, " - "independent from whether the project has been completely built or not." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_MODULE_PATH", cmProperty::VARIABLE, - "List of directories to search for CMake modules.", - "Commands like include() and find_package() search for files in " - "directories listed by this variable before checking the default " - "modules that come with CMake.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_WARN_DEPRECATED", cmProperty::VARIABLE, - "Whether to issue deprecation warnings for macros and functions.", - "If TRUE, this can be used by macros and functions to issue " - "deprecation warnings. This variable is FALSE by default.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_ERROR_DEPRECATED", cmProperty::VARIABLE, - "Whether to issue deprecation errors for macros and functions.", - "If TRUE, this can be used by macros and functions to issue " - "fatal errors when deprecated macros or functions are used. This " - "variable is FALSE by default.", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_PREFIX_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_XXX(), with appropriate suffixes added.", - "Specifies a path which will be used by the FIND_XXX() commands. It " - "contains the \"base\" directories, the FIND_XXX() commands append " - "appropriate subdirectories to the base directories. So FIND_PROGRAM() " - "adds /bin to each of the directories in the path, FIND_LIBRARY() " - "appends /lib to each of the directories, and FIND_PATH() and " - "FIND_FILE() append /include . By default it is empty, it is intended " - "to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, " - "CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_INCLUDE_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_FILE() and FIND_PATH().", - "Specifies a path which will be used both by FIND_FILE() and " - "FIND_PATH(). Both commands will check each of the contained directories " - "for the existence of the file which is currently searched. By default " - "it is empty, it is intended to be set by the project. See also " - "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_LIBRARY_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_LIBRARY().", - "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() " - "will check each of the contained directories for the existence of the " - "library which is currently searched. By default it is empty, it is " - "intended to be set by the project. See also CMAKE_SYSTEM_LIBRARY_PATH, " - "CMAKE_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_PROGRAM_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_PROGRAM().", - "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() " - "will check each of the contained directories for the existence of the " - "program which is currently searched. By default it is empty, it is " - "intended to be set by the project. See also CMAKE_SYSTEM_PROGRAM_PATH, " - " CMAKE_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_PREFIX_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_XXX(), with appropriate suffixes added.", - "Specifies a path which will be used by the FIND_XXX() commands. It " - "contains the \"base\" directories, the FIND_XXX() commands append " - "appropriate subdirectories to the base directories. So FIND_PROGRAM() " - "adds /bin to each of the directories in the path, FIND_LIBRARY() " - "appends /lib to each of the directories, and FIND_PATH() and " - "FIND_FILE() append /include . By default this contains the standard " - "directories for the current system and the CMAKE_INSTALL_PREFIX. " - "It is NOT intended " - "to be modified by the project, use CMAKE_PREFIX_PATH for this. See also " - "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, " - "CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYSTEM_IGNORE_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_IGNORE_PATH", cmProperty::VARIABLE, - "Path to be ignored by FIND_XXX() commands.", - "Specifies directories to be ignored by searches in FIND_XXX() " - "commands. " - "This is useful in cross-compiled environments where some system " - "directories contain incompatible but possibly linkable libraries. For " - "example, on cross-compiled cluster environments, this allows a user to " - "ignore directories containing libraries meant for the front-end " - "machine that modules like FindX11 (and others) would normally search. " - "By default this contains a list of directories containing incompatible " - "binaries for the host system. " - "See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, " - "CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_IGNORE_PATH", cmProperty::VARIABLE, - "Path to be ignored by FIND_XXX() commands.", - "Specifies directories to be ignored by searches in FIND_XXX() " - "commands. " - "This is useful in cross-compiled environments where some system " - "directories contain incompatible but possibly linkable libraries. For " - "example, on cross-compiled cluster environments, this allows a user to " - "ignore directories containing libraries meant for the front-end " - "machine that modules like FindX11 (and others) would normally search. " - "By default this is empty; it is intended to be set by the project. " - "Note that CMAKE_IGNORE_PATH takes a list of directory names, NOT a " - "list of prefixes. If you want to ignore paths under prefixes (bin, " - "include, lib, etc.), you'll need to specify them explicitly. " - "See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, CMAKE_INCLUDE_PATH, " - "CMAKE_PROGRAM_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_INCLUDE_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_FILE() and FIND_PATH().", - "Specifies a path which will be used both by FIND_FILE() and " - "FIND_PATH(). Both commands will check each of the contained directories " - "for the existence of the file which is currently searched. By default " - "it contains the standard directories for the current system. It is " - "NOT intended to be modified by the project, use CMAKE_INCLUDE_PATH " - "for this. See also CMAKE_SYSTEM_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_LIBRARY_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_LIBRARY().", - "Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() " - "will check each of the contained directories for the existence of the " - "library which is currently searched. By default it contains the " - "standard directories for the current system. It is NOT intended to be " - "modified by the project, use CMAKE_LIBRARY_PATH for this. See " - "also CMAKE_SYSTEM_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_SYSTEM_PROGRAM_PATH", cmProperty::VARIABLE, - "Path used for searching by FIND_PROGRAM().", - "Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() " - "will check each of the contained directories for the existence of the " - "program which is currently searched. By default it contains the " - "standard directories for the current system. It is NOT intended to be " - "modified by the project, use CMAKE_PROGRAM_PATH for this. See also " - "CMAKE_SYSTEM_PREFIX_PATH.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_DISABLE_FIND_PACKAGE_<PackageName>", cmProperty::VARIABLE, - "Variable for disabling find_package() calls.", - "Every non-REQUIRED find_package() call in a project can be disabled " - "by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to " - "TRUE. This can be used to build a project without an optional package, " - "although that package is installed.\n" - "This switch should be used during the initial CMake run. Otherwise if " - "the package has already been found in a previous CMake run, the " - "variables which have been stored in the cache will still be there. " - "In that case it is recommended to remove the cache variables for " - "this package from the cache using the cache editor or cmake -U", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_FIND_PACKAGE_WARN_NO_MODULE", cmProperty::VARIABLE, - "Tell find_package to warn if called without an explicit mode.", - "If find_package is called without an explicit mode option " - "(MODULE, CONFIG or NO_MODULE) and no Find<pkg>.cmake module is " - "in CMAKE_MODULE_PATH then CMake implicitly assumes that the " - "caller intends to search for a package configuration file. " - "If no package configuration file is found then the wording " - "of the failure message must account for both the case that the " - "package is really missing and the case that the project has a " - "bug and failed to provide the intended Find module. " - "If instead the caller specifies an explicit mode option then " - "the failure message can be more specific." - "\n" - "Set CMAKE_FIND_PACKAGE_WARN_NO_MODULE to TRUE to tell find_package " - "to warn when it implicitly assumes Config mode. " - "This helps developers enforce use of an explicit mode in all calls " - "to find_package within a project.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE, - "Specify a CMake file that overrides platform information.", - "CMake loads the specified file while enabling support for each " - "language from either the project() or enable_language() commands. " - "It is loaded after CMake's builtin compiler and platform information " - "modules have been loaded but before the information is used. " - "The file may set platform information variables to override CMake's " - "defaults." - "\n" - "This feature is intended for use only in overriding information " - "variables that must be set before CMake builds its first test " - "project to check that the compiler for a language works. " - "It should not be used to load a file in cases that a normal include() " - "will work. " - "Use it only as a last resort for behavior that cannot be achieved " - "any other way. " - "For example, one may set CMAKE_C_FLAGS_INIT to change the default " - "value used to initialize CMAKE_C_FLAGS before it is cached. " - "The override file should NOT be used to set anything that could " - "be set after languages are enabled, such as variables like " - "CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect the placement of binaries. " - "Information set in the file will be used for try_compile and try_run " - "builds too." - ,false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("BUILD_SHARED_LIBS", cmProperty::VARIABLE, - "Global flag to cause add_library to create shared libraries if on.", - "If present and true, this will cause all libraries to be " - "built shared unless the library was explicitly added as a " - "static library. This variable is often added to projects " - "as an OPTION so that each user of a project can decide if " - "they want to build the project using shared or static " - "libraries.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_NOT_USING_CONFIG_FLAGS", cmProperty::VARIABLE, - "Skip _BUILD_TYPE flags if true.", - "This is an internal flag used by the generators in " - "CMake to tell CMake to skip the _BUILD_TYPE flags.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_MFC_FLAG", cmProperty::VARIABLE, - "Tell cmake to use MFC for an executable or dll.", - "This can be set in a CMakeLists.txt file and will " - "enable MFC in the application. It should be set " - "to 1 for the static MFC library, and 2 for " - "the shared MFC library. This is used in Visual " - "Studio 6 and 7 project files. The CMakeSetup " - "dialog used MFC and the CMakeLists.txt looks like this:\n" - " add_definitions(-D_AFXDLL)\n" - " set(CMAKE_MFC_FLAG 2)\n" - " add_executable(CMakeSetup WIN32 ${SRCS})\n",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_COLOR_MAKEFILE", cmProperty::VARIABLE, - "Enables color output when using the Makefile generator.", - "When enabled, the generated Makefiles will produce colored output. " - "Default is ON.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_ABSOLUTE_DESTINATION_FILES", cmProperty::VARIABLE, - "List of files which have been installed using " - " an ABSOLUTE DESTINATION path.", - "This variable is defined by CMake-generated cmake_install.cmake " - "scripts." - " It can be used (read-only) by programs or scripts that source those" - " install scripts. This is used by some CPack generators (e.g. RPM).", - false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_WARN_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask cmake_install.cmake script to warn each time a file with " - "absolute INSTALL DESTINATION is encountered.", - "This variable is used by CMake-generated cmake_install.cmake" - " scripts. If one sets this variable to ON while running the" - " script, it may get warning messages from the script.", false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION", cmProperty::VARIABLE, - "Ask cmake_install.cmake script to error out as soon as " - "a file with absolute INSTALL DESTINATION is encountered.", - "The fatal error is emitted before the installation of " - "the offending file takes place." - " This variable is used by CMake-generated cmake_install.cmake" - " scripts. If one sets this variable to ON while running the" - " script, it may get fatal error messages from the script.",false, - "Variables That Change Behavior"); - - cm->DefineProperty - ("CMAKE_DEBUG_TARGET_PROPERTIES", cmProperty::VARIABLE, - "Enables tracing output for target properties.", - "This variable can be populated with a list of properties to generate " - "debug output for when evaluating target properties. Currently it can " - "only be used when evaluating the INCLUDE_DIRECTORIES, " - "COMPILE_DEFINITIONS and COMPILE_OPTIONS target properties. " - "In that case, it outputs a backtrace for each entry in the target " - "property. Default is unset.", false, "Variables That Change Behavior"); - - // Variables defined by CMake that describe the system - - cm->DefineProperty - ("CMAKE_SYSTEM", cmProperty::VARIABLE, - "Name of system cmake is compiling for.", - "This variable is the composite of CMAKE_SYSTEM_NAME " - "and CMAKE_SYSTEM_VERSION, like this " - "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. " - "If CMAKE_SYSTEM_VERSION is not set, then " - "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_SYSTEM_NAME", cmProperty::VARIABLE, - "Name of the OS CMake is building for.", - "This is the name of the operating system on " - "which CMake is targeting. On systems that " - "have the uname command, this variable is set " - "to the output of uname -s. Linux, Windows, " - " and Darwin for Mac OS X are the values found " - " on the big three operating systems." ,false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_SYSTEM_PROCESSOR", cmProperty::VARIABLE, - "The name of the CPU CMake is building for.", - "On systems that support uname, this variable is " - "set to the output of uname -p, on windows it is " - "set to the value of the environment variable " - "PROCESSOR_ARCHITECTURE",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_SYSTEM_VERSION", cmProperty::VARIABLE, - "OS version CMake is building for.", - "A numeric version string for the system, on " - "systems that support uname, this variable is " - "set to the output of uname -r. On other " - "systems this is set to major-minor version numbers.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_LIBRARY_ARCHITECTURE", cmProperty::VARIABLE, - "Target architecture library directory name, if detected.", - "This is the value of CMAKE_<lang>_LIBRARY_ARCHITECTURE as " - "detected for one of the enabled languages.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_LIBRARY_ARCHITECTURE_REGEX", cmProperty::VARIABLE, - "Regex matching possible target architecture library directory names.", - "This is used to detect CMAKE_<lang>_LIBRARY_ARCHITECTURE from the " - "implicit linker search path by matching the <arch> name.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_SYSTEM", cmProperty::VARIABLE, - "Name of system cmake is being run on.", - "The same as CMAKE_SYSTEM but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_HOST_SYSTEM_NAME", cmProperty::VARIABLE, - "Name of the OS CMake is running on.", - "The same as CMAKE_SYSTEM_NAME but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_HOST_SYSTEM_PROCESSOR", cmProperty::VARIABLE, - "The name of the CPU CMake is running on.", - "The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - cm->DefineProperty - ("CMAKE_HOST_SYSTEM_VERSION", cmProperty::VARIABLE, - "OS version CMake is running on.", - "The same as CMAKE_SYSTEM_VERSION but for the host system instead " - "of the target system when cross compiling.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("APPLE", cmProperty::VARIABLE, - "True if running on Mac OS X.", - "Set to true on Mac OS X." - ,false, - "Variables That Describe the System"); - - cm->DefineProperty - ("BORLAND", cmProperty::VARIABLE, - "True if the Borland compiler is being used.", - "This is set to true if the Borland compiler is being used.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CYGWIN", cmProperty::VARIABLE, - "True for Cygwin.", - "Set to true when using Cygwin." - ,false, - "Variables That Describe the System"); - - cm->DefineProperty - ("MSVC", cmProperty::VARIABLE, - "True when using Microsoft Visual C", - "Set to true when the compiler is some version of Microsoft Visual C.", - false, - "Variables That Describe the System"); - - int msvc_versions[] = { 60, 70, 71, 80, 90, 100, 110, 120, 0 }; - for (int i = 0; msvc_versions[i] != 0; i ++) - { - const char minor = (char)('0' + (msvc_versions[i] % 10)); - cmStdString varName = "MSVC"; - cmsys_ios::ostringstream majorStr; - - majorStr << (msvc_versions[i] / 10); - varName += majorStr.str(); - if (msvc_versions[i] < 100) - { - varName += minor; - } - - cmStdString verString = majorStr.str() + "." + minor; - - cmStdString shortStr = "True when using Microsoft Visual C " + verString; - cmStdString fullStr = "Set to true when the compiler is version " + - verString + - " of Microsoft Visual C."; - cm->DefineProperty - (varName.c_str(), cmProperty::VARIABLE, - shortStr.c_str(), - fullStr.c_str(), - false, - "Variables That Describe the System"); - } - - cm->DefineProperty - ("MSVC_IDE", cmProperty::VARIABLE, - "True when using the Microsoft Visual C IDE", - "Set to true when the target platform is the Microsoft Visual C IDE, " - "as opposed to the command line compiler.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("MSVC_VERSION", cmProperty::VARIABLE, - "The version of Microsoft Visual C/C++ being used if any.", - "Known version numbers are:\n" - " 1200 = VS 6.0\n" - " 1300 = VS 7.0\n" - " 1310 = VS 7.1\n" - " 1400 = VS 8.0\n" - " 1500 = VS 9.0\n" - " 1600 = VS 10.0\n" - " 1700 = VS 11.0\n" - " 1800 = VS 12.0\n" - "", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_CL_64", cmProperty::VARIABLE, - "Using the 64 bit compiler from Microsoft", - "Set to true when using the 64 bit cl compiler from Microsoft.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_COMPILER_2005", cmProperty::VARIABLE, - "Using the Visual Studio 2005 compiler from Microsoft", - "Set to true when using the Visual Studio 2005 compiler " - "from Microsoft.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("UNIX", cmProperty::VARIABLE, - "True for UNIX and UNIX like operating systems.", - "Set to true when the target system is UNIX or UNIX like " - "(i.e. APPLE and CYGWIN).",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("WIN32", cmProperty::VARIABLE, - "True on windows systems, including win64.", - "Set to true when the target system is Windows.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("XCODE_VERSION", cmProperty::VARIABLE, - "Version of Xcode (Xcode generator only).", - "Under the Xcode generator, this is the version of Xcode as specified in " - "\"Xcode.app/Contents/version.plist\" (such as \"3.1.2\").",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_APPLE", cmProperty::VARIABLE, - "True for Apple OS X operating systems.", - "Set to true when the host system is Apple OS X.", - false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_UNIX", cmProperty::VARIABLE, - "True for UNIX and UNIX like operating systems.", - "Set to true when the host system is UNIX or UNIX like " - "(i.e. APPLE and CYGWIN).",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_HOST_WIN32", cmProperty::VARIABLE, - "True on windows systems, including win64.", - "Set to true when the host system is Windows and on Cygwin." - ,false, - "Variables That Describe the System"); - - cm->DefineProperty - ("CMAKE_OBJECT_PATH_MAX", cmProperty::VARIABLE, - "Maximum object file full-path length allowed by native build tools.", - "CMake computes for every source file an object file name that is " - "unique to the source file and deterministic with respect to the " - "full path to the source file. " - "This allows multiple source files in a target to share the same name " - "if they lie in different directories without rebuilding when one is " - "added or removed. " - "However, it can produce long full paths in a few cases, so CMake " - "shortens the path using a hashing scheme when the full path to an " - "object file exceeds a limit. " - "CMake has a built-in limit for each platform that is sufficient for " - "common tools, but some native tools may have a lower limit. " - "This variable may be set to specify the limit explicitly. " - "The value must be an integer no less than 128.",false, - "Variables That Describe the System"); - - cm->DefineProperty - ("ENV", cmProperty::VARIABLE, - "Access environment variables.", - "Use the syntax $ENV{VAR} to read environment variable VAR. " - "See also the set() command to set ENV{VAR}." - ,false, - "Variables That Describe the System"); - - // Variables that affect the building of object files and - // targets. - // - cm->DefineProperty - ("CMAKE_INCLUDE_CURRENT_DIR", cmProperty::VARIABLE, - "Automatically add the current source- and build directories " - "to the include path.", - "If this variable is enabled, CMake automatically adds in each " - "directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} " - "to the include path for this directory. These additional include " - "directories do not propagate down to subdirectories. This is useful " - "mainly for out-of-source builds, where files generated into the " - "build tree are included by files located in the source tree.\n" - "By default CMAKE_INCLUDE_CURRENT_DIR is OFF.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE", cmProperty::VARIABLE, - "Automatically add the current source- and build directories " - "to the INTERFACE_INCLUDE_DIRECTORIES.", - "If this variable is enabled, CMake automatically adds for each shared " - "library target, static library target, module target and executable " - "target, ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to " - "the INTERFACE_INCLUDE_DIRECTORIES." - "By default CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE is OFF.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INSTALL_RPATH", cmProperty::VARIABLE, - "The rpath to use for installed targets.", - "A semicolon-separated list specifying the rpath " - "to use in installed targets (for platforms that support it). " - "This is used to initialize the target property " - "INSTALL_RPATH for all targets.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INSTALL_RPATH_USE_LINK_PATH", cmProperty::VARIABLE, - "Add paths to linker search and installed rpath.", - "CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true " - "will append directories in the linker search path and outside the " - "project to the INSTALL_RPATH. " - "This is used to initialize the target property " - "INSTALL_RPATH_USE_LINK_PATH for all targets.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_INSTALL_NAME_DIR", cmProperty::VARIABLE, - "Mac OS X directory name for installed targets.", - "CMAKE_INSTALL_NAME_DIR is used to initialize the " - "INSTALL_NAME_DIR property on all targets. See that target " - "property for more information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_Fortran_FORMAT", cmProperty::VARIABLE, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This variable is used to initialize the Fortran_FORMAT " - "property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_Fortran_MODULE_DIRECTORY", cmProperty::VARIABLE, - "Fortran module output directory.", - "This variable is used to initialize the " - "Fortran_MODULE_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_LIBRARY_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the LIBRARY targets when built.", - "This variable is used to initialize the " - "LIBRARY_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_ARCHIVE_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the ARCHIVE targets when built.", - "This variable is used to initialize the " - "ARCHIVE_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_RUNTIME_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the RUNTIME targets when built.", - "This variable is used to initialize the " - "RUNTIME_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_PDB_OUTPUT_DIRECTORY", cmProperty::VARIABLE, - "Where to put all the MS debug symbol files from linker.", - "This variable is used to initialize the " - "PDB_OUTPUT_DIRECTORY property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_LINK_DEPENDS_NO_SHARED", cmProperty::VARIABLE, - "Whether to skip link dependencies on shared library files.", - "This variable initializes the LINK_DEPENDS_NO_SHARED " - "property on targets when they are created. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_AUTOMOC", cmProperty::VARIABLE, - "Whether to handle moc automatically for Qt targets.", - "This variable is used to initialize the " - "AUTOMOC property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_AUTOMOC_MOC_OPTIONS", cmProperty::VARIABLE, - "Additional options for moc when using automoc (see CMAKE_AUTOMOC).", - "This variable is used to initialize the " - "AUTOMOC_MOC_OPTIONS property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_GNUtoMS", cmProperty::VARIABLE, - "Convert GNU import libraries (.dll.a) to MS format (.lib).", - "This variable is used to initialize the GNUtoMS property on targets " - "when they are created. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_DEBUG_POSTFIX", cmProperty::VARIABLE, - "See variable CMAKE_<CONFIG>_POSTFIX.", - "This variable is a special case of the more-general " - "CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configuration.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_<CONFIG>_POSTFIX", cmProperty::VARIABLE, - "Default filename postfix for libraries under configuration <CONFIG>.", - "When a non-executable target is created its <CONFIG>_POSTFIX " - "target property is initialized with the value of this variable " - "if it is set.", - false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_BUILD_WITH_INSTALL_RPATH", cmProperty::VARIABLE, - "Use the install path for the RPATH", - "Normally CMake uses the build tree for the RPATH when building " - "executables etc on systems that use RPATH. When the software " - "is installed the executables etc are relinked by CMake to have " - "the install RPATH. If this variable is set to true then the software " - "is always built with the install path for the RPATH and does not " - "need to be relinked when installed.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_NO_BUILTIN_CHRPATH", cmProperty::VARIABLE, - "Do not use the builtin ELF editor to fix RPATHs on installation.", - "When an ELF binary needs to have a different RPATH after installation " - "than it does in the build tree, CMake uses a builtin editor to change " - "the RPATH in the installed copy. " - "If this variable is set to true then CMake will relink the binary " - "before installation instead of using its builtin editor.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SKIP_BUILD_RPATH", cmProperty::VARIABLE, - "Do not include RPATHs in the build tree.", - "Normally CMake uses the build tree for the RPATH when building " - "executables etc on systems that use RPATH. When the software " - "is installed the executables etc are relinked by CMake to have " - "the install RPATH. If this variable is set to true then the software " - "is always built with no RPATH.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SKIP_INSTALL_RPATH", cmProperty::VARIABLE, - "Do not include RPATHs in the install tree.", - "Normally CMake uses the build tree for the RPATH when building " - "executables etc on systems that use RPATH. When the software " - "is installed the executables etc are relinked by CMake to have " - "the install RPATH. If this variable is set to true then the software " - "is always installed without RPATH, even if RPATH is enabled when " - "building. This can be useful for example to allow running tests from " - "the build directory with RPATH enabled before the installation step. " - "To omit RPATH in both the build and install steps, use " - "CMAKE_SKIP_RPATH instead.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create executables.", - "These flags will be used by the linker when creating an executable." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_EXE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking an executable.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating executables.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_MODULE_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create modules.", - "These flags will be used by the linker when creating a module." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_MODULE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking a module.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating modules.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SHARED_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create shared libraries.", - "These flags will be used by the linker when creating a shared library." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_SHARED_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking a shared library.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating shared libraries.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_STATIC_LINKER_FLAGS", cmProperty::VARIABLE, - "Linker flags to be used to create static libraries.", - "These flags will be used by the linker when creating a static library." - ,false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_STATIC_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE, - "Flags to be used when linking a static library.", - "Same as CMAKE_C_FLAGS_* but used by the linker " - "when creating static libraries.",false, - "Variables that Control the Build"); - - cm->DefineProperty - ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE, - "The flag to be used to add a library search path to a compiler.", - "The flag will be used to specify a library directory to the compiler. " - "On most compilers this is \"-L\".",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_DEF_FILE_FLAG", cmProperty::VARIABLE, - "Linker flag to be used to specify a .def file for dll creation.", - "The flag will be used to add a .def file when creating " - "a dll on Windows; this is only defined on Windows." - ,false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE, - "Flag to be used to link a library into an executable.", - "The flag will be used to specify a library to link to an executable. " - "On most compilers this is \"-l\".",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE, - "Flag to be used to link a library specified by a path to its file.", - "The flag will be used before a library file path is given to the " - "linker. " - "This is needed only on very few platforms.", false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE, - "Use relative paths (May not work!).", - "If this is set to TRUE, then CMake will use " - "relative paths between the source and binary tree. " - "This option does not work for more complicated " - "projects, and relative paths are used when possible. " - "In general, it is not possible to move CMake generated" - " makefiles to a different location regardless " - "of the value of this variable.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("EXECUTABLE_OUTPUT_PATH", cmProperty::VARIABLE, - "Old executable location variable.", - "The target property RUNTIME_OUTPUT_DIRECTORY supercedes " - "this variable for a target if it is set. " - "Executable targets are otherwise placed in this directory.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("LIBRARY_OUTPUT_PATH", cmProperty::VARIABLE, - "Old library location variable.", - "The target properties ARCHIVE_OUTPUT_DIRECTORY, " - "LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede " - "this variable for a target if they are set. " - "Library targets are otherwise placed in this directory.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_TRY_COMPILE_CONFIGURATION", cmProperty::VARIABLE, - "Build configuration used for try_compile and try_run projects.", - "Projects built by try_compile and try_run are built " - "synchronously during the CMake configuration step. " - "Therefore a specific build configuration must be chosen even " - "if the generated build system supports multiple configurations.",false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_LINK_INTERFACE_LIBRARIES", cmProperty::VARIABLE, - "Default value for LINK_INTERFACE_LIBRARIES of targets.", - "This variable is used to initialize the " - "LINK_INTERFACE_LIBRARIES property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_WIN32_EXECUTABLE", cmProperty::VARIABLE, - "Default value for WIN32_EXECUTABLE of targets.", - "This variable is used to initialize the " - "WIN32_EXECUTABLE property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_MACOSX_BUNDLE", cmProperty::VARIABLE, - "Default value for MACOSX_BUNDLE of targets.", - "This variable is used to initialize the " - "MACOSX_BUNDLE property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_POSITION_INDEPENDENT_CODE", cmProperty::VARIABLE, - "Default value for POSITION_INDEPENDENT_CODE of targets.", - "This variable is used to initialize the " - "POSITION_INDEPENDENT_CODE property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_NO_SYSTEM_FROM_IMPORTED", cmProperty::VARIABLE, - "Default value for NO_SYSTEM_FROM_IMPORTED of targets.", - "This variable is used to initialize the " - "NO_SYSTEM_FROM_IMPORTED property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_<LANG>_VISIBILITY_PRESET", cmProperty::VARIABLE, - "Default value for <LANG>_VISIBILITY_PRESET of targets.", - "This variable is used to initialize the " - "<LANG>_VISIBILITY_PRESET property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_VISIBILITY_INLINES_HIDDEN", cmProperty::VARIABLE, - "Default value for VISIBILITY_INLINES_HIDDEN of targets.", - "This variable is used to initialize the " - "VISIBILITY_INLINES_HIDDEN property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - cm->DefineProperty - ("CMAKE_MAP_IMPORTED_CONFIG_<CONFIG>", cmProperty::VARIABLE, - "Default value for MAP_IMPORTED_CONFIG_<CONFIG> of targets.", - "This variable is used to initialize the " - "MAP_IMPORTED_CONFIG_<CONFIG> property on all the targets. " - "See that target property for additional information.", - false, - "Variables that Control the Build"); - -// Variables defined when the a language is enabled These variables will -// also be defined whenever CMake has loaded its support for compiling (LANG) -// programs. This support will be loaded whenever CMake is used to compile -// (LANG) files. C and CXX are examples of the most common values for (LANG). - - cm->DefineProperty - ("CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>", cmProperty::VARIABLE, - "Specify a CMake file that overrides platform information for <LANG>.", - "This is a language-specific version of " - "CMAKE_USER_MAKE_RULES_OVERRIDE loaded only when enabling " - "language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE, - "The full path to the compiler for LANG.", - "This is the command that will be used as the <LANG> compiler. " - "Once set, you can not change this variable.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER_ID", cmProperty::VARIABLE, - "Compiler identification string.", - "A short string unique to the compiler vendor. " - "Possible values include:\n" - " Absoft = Absoft Fortran (absoft.com)\n" - " ADSP = Analog VisualDSP++ (analog.com)\n" - " AppleClang = Apple Clang (apple.com)\n" - " Clang = LLVM Clang (clang.llvm.org)\n" - " Cray = Cray Compiler (cray.com)\n" - " Embarcadero, Borland = Embarcadero (embarcadero.com)\n" - " G95 = G95 Fortran (g95.org)\n" - " GNU = GNU Compiler Collection (gcc.gnu.org)\n" - " HP = Hewlett-Packard Compiler (hp.com)\n" - " Intel = Intel Compiler (intel.com)\n" - " MIPSpro = SGI MIPSpro (sgi.com)\n" - " MSVC = Microsoft Visual Studio (microsoft.com)\n" - " PGI = The Portland Group (pgroup.com)\n" - " PathScale = PathScale (pathscale.com)\n" - " SDCC = Small Device C Compiler (sdcc.sourceforge.net)\n" - " SunPro = Oracle Solaris Studio (oracle.com)\n" - " TI = Texas Instruments (ti.com)\n" - " TinyCC = Tiny C Compiler (tinycc.org)\n" - " Watcom = Open Watcom (openwatcom.org)\n" - " XL, VisualAge, zOS = IBM XL (ibm.com)\n" - "This variable is not guaranteed to be defined for all " - "compilers or languages.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_PLATFORM_ID", cmProperty::VARIABLE, - "An internal variable subject to change.", - "This is used in determining the platform and is subject to change.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER_ABI", cmProperty::VARIABLE, - "An internal variable subject to change.", - "This is used in determining the compiler ABI and is subject to change.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILER_VERSION", cmProperty::VARIABLE, - "Compiler version string.", - "Compiler version in major[.minor[.patch[.tweak]]] format. " - "This variable is not guaranteed to be defined for all " - "compilers or languages.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_INTERNAL_PLATFORM_ABI", cmProperty::VARIABLE, - "An internal variable subject to change.", - "This is used in determining the compiler ABI and is subject to change.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_SIMULATE_ID", cmProperty::VARIABLE, - "Identification string of \"simulated\" compiler.", - "Some compilers simulate other compilers to serve as drop-in " - "replacements. " - "When CMake detects such a compiler it sets this variable to what " - "would have been the CMAKE_<LANG>_COMPILER_ID for the simulated " - "compiler.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_SIMULATE_VERSION", cmProperty::VARIABLE, - "Version string of \"simulated\" compiler.", - "Some compilers simulate other compilers to serve as drop-in " - "replacements. " - "When CMake detects such a compiler it sets this variable to what " - "would have been the CMAKE_<LANG>_COMPILER_VERSION for the simulated " - "compiler.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_SIZEOF_DATA_PTR", cmProperty::VARIABLE, - "Size of pointer-to-data types for language <LANG>.", - "This holds the size (in bytes) of pointer-to-data types in the target " - "platform ABI. " - "It is defined for languages C and CXX (C++).", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE, - "True if the compiler is GNU.", - "If the selected <LANG> compiler is the GNU " - "compiler then this is TRUE, if not it is FALSE. " - "Unlike the other per-language variables, this uses the GNU syntax for " - "identifying languages instead of the CMake syntax. Recognized values of " - "the <LANG> suffix are:\n" - " CC = C compiler\n" - " CXX = C++ compiler\n" - " G77 = Fortran compiler", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS", cmProperty::VARIABLE, - "Flags for all build types.", - "<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE, - "Flags for Debug build type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is Debug.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_MINSIZEREL", cmProperty::VARIABLE, - "Flags for MinSizeRel build type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel." - "Short for minimum size release.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_RELEASE", cmProperty::VARIABLE, - "Flags for Release build type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is Release",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE, - "Flags for RelWithDebInfo type or configuration.", - "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. " - "Short for Release With Debug Information.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE, - "Rule variable to compile a single object file.", - "This is a rule variable that tells CMake how to " - "compile a single object file for the language <LANG>." - ,false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_CREATE_SHARED_LIBRARY", cmProperty::VARIABLE, - "Rule variable to create a shared library.", - "This is a rule variable that tells CMake how to " - "create a shared library for the language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_CREATE_SHARED_MODULE", cmProperty::VARIABLE, - "Rule variable to create a shared module.", - "This is a rule variable that tells CMake how to " - "create a shared library for the language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_CREATE_STATIC_LIBRARY", cmProperty::VARIABLE, - "Rule variable to create a static library.", - "This is a rule variable that tells CMake how " - "to create a static library for the language <LANG>.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_ARCHIVE_CREATE", cmProperty::VARIABLE, - "Rule variable to create a new static archive.", - "This is a rule variable that tells CMake how to create a static " - "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY " - "on some platforms in order to support large object counts. " - "See also CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.", - false, "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_ARCHIVE_APPEND", cmProperty::VARIABLE, - "Rule variable to append to a static archive.", - "This is a rule variable that tells CMake how to append to a static " - "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY " - "on some platforms in order to support large object counts. " - "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.", - false, "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_ARCHIVE_FINISH", cmProperty::VARIABLE, - "Rule variable to finish an existing static archive.", - "This is a rule variable that tells CMake how to finish a static " - "archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY " - "on some platforms in order to support large object counts. " - "See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.", - false, "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE, - "File extensions that should be ignored by the build.", - "This is a list of file extensions that may be " - "part of a project for a given language but are not compiled.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES", cmProperty::VARIABLE, - "Directories implicitly searched by the compiler for header files.", - "CMake does not explicitly specify these directories on compiler " - "command lines for language <LANG>. " - "This prevents system include directories from being treated as user " - "include directories on some compilers.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES", cmProperty::VARIABLE, - "Implicit linker search path detected for language <LANG>.", - "Compilers typically pass directories containing language runtime " - "libraries and default library search paths when they invoke a linker. " - "These paths are implicit linker search directories for the compiler's " - "language. " - "CMake automatically detects these directories for each language and " - "reports the results in this variable." - "\n" - "When a library in one of these directories is given by full path to " - "target_link_libraries() CMake will generate the -l<name> form on " - "link lines to ensure the linker searches its implicit directories " - "for the library. " - "Note that some toolchains read implicit directories from an " - "environment variable such as LIBRARY_PATH so keep its value " - "consistent when operating in a given build tree.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES", cmProperty::VARIABLE, - "Implicit linker framework search path detected for language <LANG>.", - "These paths are implicit linker framework search directories for " - "the compiler's language. " - "CMake automatically detects these directories for each language and " - "reports the results in this variable.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES", cmProperty::VARIABLE, - "Implicit link libraries and flags detected for language <LANG>.", - "Compilers typically pass language runtime library names and " - "other flags when they invoke a linker. " - "These flags are implicit link options for the compiler's language. " - "CMake automatically detects these libraries and flags for each " - "language and reports the results in this variable.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LIBRARY_ARCHITECTURE", cmProperty::VARIABLE, - "Target architecture library directory name detected for <lang>.", - "If the <lang> compiler passes to the linker an architecture-specific " - "system library search directory such as <prefix>/lib/<arch> this " - "variable contains the <arch> name if/as detected by CMake.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES", cmProperty::VARIABLE, - "True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets.", - "This is used when CMake selects a linker language for a target. " - "Languages compiled directly into the target are always considered. " - "A language compiled into static libraries linked by the target is " - "considered if this variable is true.", false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LINKER_PREFERENCE", cmProperty::VARIABLE, - "Preference value for linker language selection.", - "The \"linker language\" for executable, shared library, and module " - "targets is the language whose compiler will invoke the linker. " - "The LINKER_LANGUAGE target property sets the language explicitly. " - "Otherwise, the linker language is that whose linker preference value " - "is highest among languages compiled and linked into the target. " - "See also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable.", - false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_LINK_EXECUTABLE", cmProperty::VARIABLE, - "Rule variable to link an executable.", - "Rule variable to link an executable for the given language." - ,false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_OUTPUT_EXTENSION", cmProperty::VARIABLE, - "Extension for the output of a compile for a single file.", - "This is the extension for an object file for " - "the given <LANG>. For example .obj for C on Windows.",false, - "Variables for Languages"); - - cm->DefineProperty - ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE, - "Extensions of source files for the given language.", - "This is the list of extensions for a " - "given language's source files." - ,false, - "Variables for Languages"); - - cm->DefineProperty( - "CMAKE_<LANG>_COMPILER_LOADED", cmProperty::VARIABLE, - "Defined to true if the language is enabled.", - "When language <LANG> is enabled by project() or enable_language() " - "this variable is defined to 1.", - false,"Variables for Languages"); - - cm->DefineProperty( - "CMAKE_Fortran_MODDIR_FLAG", cmProperty::VARIABLE, - "Fortran flag for module output directory.", - "This stores the flag needed to pass the value of the " - "Fortran_MODULE_DIRECTORY target property to the compiler.", - false,"Variables for Languages"); - - cm->DefineProperty( - "CMAKE_Fortran_MODDIR_DEFAULT", cmProperty::VARIABLE, - "Fortran default module output directory.", - "Most Fortran compilers write .mod files to the current working " - "directory. " - "For those that do not, this is set to \".\" and used when the " - "Fortran_MODULE_DIRECTORY target property is not set.", - false,"Variables for Languages"); - - cm->DefineProperty( - "CMAKE_Fortran_MODOUT_FLAG", cmProperty::VARIABLE, - "Fortran flag to enable module output.", - "Most Fortran compilers write .mod files out by default. " - "For others, this stores the flag needed to enable module output.", - false,"Variables for Languages"); - - // variables that are used by cmake but not to be documented - cm->DefineProperty("CMAKE_MATCH_0", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_1", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_2", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_3", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_4", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_5", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_6", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_7", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_8", cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MATCH_9", cmProperty::VARIABLE,0,0); - - cm->DefineProperty("CMAKE_<LANG>_COMPILER_ARG1", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_COMPILER_ENV_VAR", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_COMPILER_ID_RUN", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_ABI_FILES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_CREATE_ASSEMBLY_SOURCE", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_CREATE_PREPROCESSED_SOURCE", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_DEBUG_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_MINSIZEREL_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELEASE_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_FRAMEWORK_SEARCH_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_INFORMATION_LOADED", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_LINK_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_RESPONSE_FILE_LINK_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_STANDARD_LIBRARIES_INIT", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_INCLUDES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_<LANG>_USE_RESPONSE_FILE_FOR_OBJECTS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXE_LINK_DYNAMIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXE_LINK_STATIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_GENERATOR_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_IMPORT_LIBRARY_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_INCLUDE_FLAG_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_INCLUDE_FLAG_SEP_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_INCLUDE_SYSTEM_FLAG_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_NEEDS_REQUIRES_STEP_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_CREATE_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_DYNAMIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_LINK_STATIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_RUNTIME_<LANG>_FLAG_SEP", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_LIBRARY_RPATH_LINK_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_RUNTIME_<LANG>_FLAG_SEP", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_EXECUTABLE_RPATH_LINK_<LANG>_FLAG", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_PLATFORM_REQUIRED_RUNTIME_PATH", - cmProperty::VARIABLE,0,0); - cm->DefineProperty( - "CMAKE_<LANG>_USE_IMPLICIT_LINK_DIRECTORIES_IN_RUNTIME_PATH", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_CREATE_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_DYNAMIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_LINK_STATIC_<LANG>_FLAGS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_SHARED_MODULE_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_STATIC_LIBRARY_PREFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_STATIC_LIBRARY_SUFFIX_<LANG>", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_FILES", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_LINK_DEPENDENT_LIBRARY_DIRS", - cmProperty::VARIABLE,0,0); - cm->DefineProperty("CMAKE_MAKE_INCLUDE_FROM_ROOT", - cmProperty::VARIABLE,0,0); -} diff --git a/Source/cmDocumentVariables.h b/Source/cmDocumentVariables.h deleted file mode 100644 index 1d59b24..0000000 --- a/Source/cmDocumentVariables.h +++ /dev/null @@ -1,21 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef cmDocumentVariables_h -#define cmDocumentVariables_h -class cmake; -class cmDocumentVariables -{ -public: - static void DefineVariables(cmake* cm); -}; - -#endif diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index 58ce36b..2d7feab 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -13,208 +13,38 @@ #include "cmSystemTools.h" #include "cmVersion.h" +#include "cmRST.h" + #include <cmsys/Directory.hxx> #include <cmsys/Glob.hxx> -#include <algorithm> - -//---------------------------------------------------------------------------- -static const char *cmDocumentationStandardOptions[][3] = -{ - {"--copyright [file]", "Print the CMake copyright and exit.", - "If a file is specified, the copyright is written into it."}, - {"--help,-help,-usage,-h,-H,/?", "Print usage information and exit.", - "Usage describes the basic command line interface and its options."}, - {"--help-full [file]", "Print full help and exit.", - "Full help displays most of the documentation provided by the UNIX " - "man page. It is provided for use on non-UNIX platforms, but is " - "also convenient if the man page is not installed. If a file is " - "specified, the help is written into it."}, - {"--help-html [file]", "Print full help in HTML format.", - "This option is used by CMake authors to help produce web pages. " - "If a file is specified, the help is written into it."}, - {"--help-man [file]", "Print full help as a UNIX man page and exit.", - "This option is used by the cmake build to generate the UNIX man page. " - "If a file is specified, the help is written into it."}, - {"--version,-version,/V [file]", - "Show program name/version banner and exit.", - "If a file is specified, the version is written into it."}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmModulesDocumentationDescription[][3] = -{ - {0, - " CMake Modules - Modules coming with CMake, the Cross-Platform Makefile " - "Generator.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for the modules and scripts coming with CMake. " - "Using these modules you can check the computer system for " - "installed software packages, features of the compiler and the " - "existence of headers to name just a few.", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmCustomModulesDocumentationDescription[][3] = -{ - {0, - " Custom CMake Modules - Additional Modules for CMake.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for additional modules and scripts for CMake. " - "Using these modules you can check the computer system for " - "installed software packages, features of the compiler and the " - "existence of headers to name just a few.", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmPropertiesDocumentationDescription[][3] = -{ - {0, - " CMake Properties - Properties supported by CMake, " - "the Cross-Platform Makefile Generator.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for the properties supported by CMake. " - "Properties can have different scopes. They can either be assigned to a " - "source file, a directory, a target or globally to CMake. By modifying the " - "values of properties the behaviour of the build system can be customized.", - 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmCompatCommandsDocumentationDescription[][3] = -{ - {0, - " CMake Compatibility Listfile Commands - " - "Obsolete commands supported by CMake for compatibility.", 0}, -// CMAKE_DOCUMENTATION_OVERVIEW, - {0, - "This is the documentation for now obsolete listfile commands from previous " - "CMake versions, which are still supported for compatibility reasons. You " - "should instead use the newer, faster and shinier new commands. ;-)", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmDocumentationModulesHeader[][3] = -{ - {0, - "The following modules are provided with CMake. " - "They can be used with INCLUDE(ModuleName).", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char *cmDocumentationCustomModulesHeader[][3] = -{ - {0, - "The following modules are also available for CMake. " - "They can be used with INCLUDE(ModuleName).", 0}, - {0,0,0} -}; +#include <ctype.h> -//---------------------------------------------------------------------------- -static const char *cmDocumentationGeneratorsHeader[][3] = -{ - {0, - "The following generators are available on this platform:", 0}, - {0,0,0} -}; +#include <algorithm> //---------------------------------------------------------------------------- -static const char *cmDocumentationStandardSeeAlso[][3] = +static const char *cmDocumentationStandardOptions[][2] = { - {0, - "The following resources are available to get help using CMake:", 0}, - {"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 " - "cmake@cmake.org. " - "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."}, - {0,0,0} + {"--copyright [file]", "Print the CMake copyright and exit."}, + {"--help,-help,-usage,-h,-H,/?", "Print usage information and exit."}, + {"--help-full [file]", "Print full help and exit."}, + {"--help-html [file]", "Print full help in HTML format."}, + {"--help-man [file]", "Print full help as a UNIX man page and exit."}, + {"--version,-version,/V [file]"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char *cmDocumentationCopyright[][3] = +static const char *cmDocumentationGeneratorsHeader[][2] = { {0, - "Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. " - "All rights reserved.", 0}, - {0, - "Redistribution and use in source and binary forms, with or without " - "modification, are permitted provided that the following conditions are " - "met:", 0}, - {"", - "Redistributions of source code must retain the above copyright notice, " - "this list of conditions and the following disclaimer.", 0}, - {"", - "Redistributions in binary form must reproduce the above copyright " - "notice, this list of conditions and the following disclaimer in the " - "documentation and/or other materials provided with the distribution.", - 0}, - {"", - "Neither the names of Kitware, Inc., the Insight Software Consortium, " - "nor the names of their contributors may be used to endorse or promote " - "products derived from this software without specific prior written " - "permission.", 0}, - {0, - "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS " - "\"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT " - "LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR " - "A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT " - "HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, " - "SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT " - "LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, " - "DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY " - "THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT " - "(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE " - "OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", - 0}, - {0, 0, 0} + "The following generators are available on this platform:"}, + {0,0} }; //---------------------------------------------------------------------------- -#define DOCUMENT_INTRO(type, default_name, desc) \ - static char const *cmDocumentation##type##Intro[2] = { default_name, desc }; -#define GET_DOCUMENT_INTRO(type) cmDocumentation##type##Intro - -DOCUMENT_INTRO(Modules, "cmakemodules", - "Reference of available CMake modules."); -DOCUMENT_INTRO(CustomModules, "cmakecustommodules", - "Reference of available CMake custom modules."); -DOCUMENT_INTRO(Policies, "cmakepolicies", - "Reference of CMake policies."); -DOCUMENT_INTRO(Properties, "cmakeprops", - "Reference of CMake properties."); -DOCUMENT_INTRO(Variables, "cmakevars", - "Reference of CMake variables."); -DOCUMENT_INTRO(Commands, "cmakecommands", - "Reference of available CMake commands."); -DOCUMENT_INTRO(CompatCommands, "cmakecompat", - "Reference of CMake compatibility commands."); - -//---------------------------------------------------------------------------- cmDocumentation::cmDocumentation() -:CurrentFormatter(0) { - this->SetForm(TextForm, 0); this->addCommonStandardDocSections(); this->ShowGenerators = true; } @@ -222,11 +52,6 @@ cmDocumentation::cmDocumentation() //---------------------------------------------------------------------------- cmDocumentation::~cmDocumentation() { - for(std::vector< char* >::iterator i = this->ModuleStrings.begin(); - i != this->ModuleStrings.end(); ++i) - { - delete [] *i; - } for(std::map<std::string,cmDocumentationSection *>::iterator i = this->AllSections.begin(); i != this->AllSections.end(); ++i) @@ -236,30 +61,6 @@ cmDocumentation::~cmDocumentation() } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintCopyright(std::ostream& os) -{ - cmDocumentationSection *sec = this->AllSections["Copyright"]; - const std::vector<cmDocumentationEntry> &entries = sec->GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << " * "; - this->TextFormatter.SetIndent(" "); - this->TextFormatter.PrintColumn(os, op->Brief.c_str()); - } - else - { - this->TextFormatter.SetIndent(""); - this->TextFormatter.PrintColumn(os, op->Brief.c_str()); - } - os << "\n"; - } - return true; -} - -//---------------------------------------------------------------------------- bool cmDocumentation::PrintVersion(std::ostream& os) { os << this->GetNameString() << " version " @@ -268,317 +69,46 @@ bool cmDocumentation::PrintVersion(std::ostream& os) } //---------------------------------------------------------------------------- -void cmDocumentation::AddSectionToPrint(const char *section) +bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os) { - if (this->AllSections.find(section) != this->AllSections.end()) - { - this->PrintSections.push_back(this->AllSections[section]); - } -} - -//---------------------------------------------------------------------------- -void cmDocumentation::ClearSections() -{ - this->PrintSections.erase(this->PrintSections.begin(), - this->PrintSections.end()); - this->ModulesFound.clear(); -} - -//---------------------------------------------------------------------------- -void cmDocumentation::AddDocumentIntroToPrint(const char* intro[2]) -{ - const char* docname = this->GetDocName(false); - if(intro && docname) - { - cmDocumentationSection* section; - std::string desc(""); - - desc += docname; - desc += " - "; - desc += intro[1]; - - section = new cmDocumentationSection("Introduction", "NAME"); - section->Append(0, desc.c_str(), 0); - this->PrintSections.push_back(section); - } -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os, - const char* docname) -{ - if ((this->CurrentFormatter->GetForm() != HTMLForm) - && (this->CurrentFormatter->GetForm() != DocbookForm) - && (this->CurrentFormatter->GetForm() != ManForm)) - { - this->PrintVersion(os); - } - - // Handle Document Name. docname==0 disables intro. - this->SetDocName(""); - if (docname) - { - if (*docname) - this->SetDocName(docname); - else // empty string was given. select default if possible - this->SetDocName(this->GetDefaultDocName(ht)); - } - switch (ht) { case cmDocumentation::Usage: return this->PrintDocumentationUsage(os); - case cmDocumentation::Single: - return this->PrintDocumentationSingle(os); - case cmDocumentation::SingleModule: - return this->PrintDocumentationSingleModule(os); - case cmDocumentation::SinglePolicy: - return this->PrintDocumentationSinglePolicy(os); - case cmDocumentation::SingleProperty: - return this->PrintDocumentationSingleProperty(os); - case cmDocumentation::SingleVariable: - return this->PrintDocumentationSingleVariable(os); - case cmDocumentation::List: - this->PrintDocumentationList(os,"Commands"); - this->PrintDocumentationList(os,"Compatibility Commands"); - return true; - case cmDocumentation::ModuleList: - // find the modules first, print the custom module docs only if - // any custom modules have been found actually, Alex - this->CreateCustomModulesSection(); - this->CreateModulesSection(); - if (this->AllSections.find("Custom CMake Modules") - != this->AllSections.end()) - { - this->PrintDocumentationList(os,"Custom CMake Modules"); - } - this->PrintDocumentationList(os,"Modules"); - return true; - case cmDocumentation::PropertyList: - this->PrintDocumentationList(os,"Properties Description"); - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - i != this->PropertySections.end(); ++i) - { - this->PrintDocumentationList(os,i->c_str()); - } - return true; - case cmDocumentation::VariableList: - for (std::vector<std::string>::iterator i = - this->VariableSections.begin(); - i != this->VariableSections.end(); ++i) - { - this->PrintDocumentationList(os,i->c_str()); - } - return true; - case cmDocumentation::Full: - return this->PrintDocumentationFull(os); - case cmDocumentation::Modules: - return this->PrintDocumentationModules(os); - case cmDocumentation::CustomModules: - return this->PrintDocumentationCustomModules(os); - case cmDocumentation::Policies: - return this->PrintDocumentationPolicies(os); - case cmDocumentation::Properties: - return this->PrintDocumentationProperties(os); - case cmDocumentation::Variables: - return this->PrintDocumentationVariables(os); - case cmDocumentation::Commands: - return this->PrintDocumentationCurrentCommands(os); - case cmDocumentation::CompatCommands: - return this->PrintDocumentationCompatCommands(os); - - case cmDocumentation::Copyright: - return this->PrintCopyright(os); + case cmDocumentation::OneManual: + return this->PrintHelpOneManual(os); + case cmDocumentation::OneCommand: + return this->PrintHelpOneCommand(os); + case cmDocumentation::OneModule: + return this->PrintHelpOneModule(os); + case cmDocumentation::OnePolicy: + return this->PrintHelpOnePolicy(os); + case cmDocumentation::OneProperty: + return this->PrintHelpOneProperty(os); + case cmDocumentation::OneVariable: + return this->PrintHelpOneVariable(os); + case cmDocumentation::ListManuals: + return this->PrintHelpListManuals(os); + case cmDocumentation::ListCommands: + return this->PrintHelpListCommands(os); + case cmDocumentation::ListModules: + return this->PrintHelpListModules(os); + case cmDocumentation::ListProperties: + return this->PrintHelpListProperties(os); + case cmDocumentation::ListVariables: + return this->PrintHelpListVariables(os); + case cmDocumentation::ListPolicies: + return this->PrintHelpListPolicies(os); case cmDocumentation::Version: - return true; + return this->PrintVersion(os); default: return false; } } //---------------------------------------------------------------------------- -bool cmDocumentation::CreateModulesSection() -{ - cmDocumentationSection *sec = - new cmDocumentationSection("Standard CMake Modules", "MODULES"); - this->AllSections["Modules"] = sec; - std::string cmakeModules = this->CMakeRoot; - cmakeModules += "/Modules"; - cmsys::Directory dir; - dir.Load(cmakeModules.c_str()); - if (dir.GetNumberOfFiles() > 0) - { - sec->Append(cmDocumentationModulesHeader[0]); - sec->Append(cmModulesDocumentationDescription); - this->CreateModuleDocsForDir(dir, *this->AllSections["Modules"]); - } - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::CreateCustomModulesSection() -{ - bool sectionHasHeader = false; - - std::vector<std::string> dirs; - cmSystemTools::ExpandListArgument(this->CMakeModulePath, dirs); - - for(std::vector<std::string>::const_iterator dirIt = dirs.begin(); - dirIt != dirs.end(); - ++dirIt) - { - cmsys::Directory dir; - dir.Load(dirIt->c_str()); - if (dir.GetNumberOfFiles() > 0) - { - if (!sectionHasHeader) - { - cmDocumentationSection *sec = - new cmDocumentationSection("Custom CMake Modules","CUSTOM MODULES"); - this->AllSections["Custom CMake Modules"] = sec; - sec->Append(cmDocumentationCustomModulesHeader[0]); - sec->Append(cmCustomModulesDocumentationDescription); - sectionHasHeader = true; - } - this->CreateModuleDocsForDir - (dir, *this->AllSections["Custom CMake Modules"]); - } - } - - return true; -} - -//---------------------------------------------------------------------------- -void cmDocumentation -::CreateModuleDocsForDir(cmsys::Directory& dir, - cmDocumentationSection &moduleSection) -{ - // sort the files alphabetically, so the docs for one module are easier - // to find than if they are in random order - std::vector<std::string> sortedFiles; - for(unsigned int i = 0; i < dir.GetNumberOfFiles(); ++i) - { - sortedFiles.push_back(dir.GetFile(i)); - } - std::sort(sortedFiles.begin(), sortedFiles.end()); - - for(std::vector<std::string>::const_iterator fname = sortedFiles.begin(); - fname!=sortedFiles.end(); ++fname) - { - if(fname->length() > 6) - { - if(fname->substr(fname->length()-6, 6) == ".cmake") - { - std::string moduleName = fname->substr(0, fname->length()-6); - // this check is to avoid creating documentation for the modules with - // the same name in multiple directories of CMAKE_MODULE_PATH - if (this->ModulesFound.find(moduleName) == this->ModulesFound.end()) - { - this->ModulesFound.insert(moduleName); - std::string path = dir.GetPath(); - path += "/"; - path += (*fname); - this->CreateSingleModule(path.c_str(), moduleName.c_str(), - moduleSection); - } - } - } - } -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::CreateSingleModule(const char* fname, - const char* moduleName, - cmDocumentationSection &moduleSection) -{ - std::ifstream fin(fname); - if(!fin) - { - std::cerr << "Internal error: can not open module." << fname << std::endl; - return false; - } - std::string line; - std::string text; - std::string brief; - brief = " "; - bool newParagraph = true; - while ( fin && cmSystemTools::GetLineFromStream(fin, line) ) - { - if(line.size() && line[0] == '#') - { - /* line beginnings with ## are mark-up ignore them */ - if (line.size()>=2 && line[1] == '#') continue; - // blank line - if(line.size() <= 2) - { - text += "\n"; - newParagraph = true; - } - else if(line[2] == '-') - { - brief = line.c_str()+4; - } - else - { - // two spaces - if(line[1] == ' ' && line[2] == ' ') - { - if(!newParagraph) - { - text += "\n"; - newParagraph = true; - } - // Skip #, and leave space for preformatted - text += line.c_str()+1; - text += "\n"; - } - else if(line[1] == ' ') - { - if(!newParagraph) - { - text += " "; - } - newParagraph = false; - // skip # and space - text += line.c_str()+2; - } - else - { - if(!newParagraph) - { - text += " "; - } - newParagraph = false; - // skip # - text += line.c_str()+1; - } - } - } - else - { - break; - } - } - - if(text.length() < 2 && brief.length() == 1) - { - return false; - } - - char* pname = strcpy(new char[strlen(moduleName)+1], moduleName); - char* ptext = strcpy(new char[text.length()+1], text.c_str()); - this->ModuleStrings.push_back(pname); - this->ModuleStrings.push_back(ptext); - char* pbrief = strcpy(new char[brief.length()+1], brief.c_str()); - this->ModuleStrings.push_back(pbrief); - moduleSection.Append(pname, pbrief, ptext); - return true; -} - - -//---------------------------------------------------------------------------- bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) { + int count = 0; bool result = true; // Loop over requested documentation types. @@ -587,13 +117,11 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) i != this->RequestedHelpItems.end(); ++i) { - this->SetForm(i->HelpForm, i->ManSection); this->CurrentArgument = i->Argument; // If a file name was given, use it. Otherwise, default to the // given stream. std::ofstream* fout = 0; std::ostream* s = &os; - std::string docname(""); if(i->Filename.length() > 0) { fout = new std::ofstream(i->Filename.c_str(), std::ios::out); @@ -605,14 +133,14 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) { result = false; } - if(i->Filename != "-") - { - docname = cmSystemTools::GetFilenameWithoutLastExtension(i->Filename); - } + } + else if(++count > 1) + { + os << "\n\n"; } // Print this documentation type to the stream. - if(!this->PrintDocumentation(i->HelpType, *s, docname.c_str()) || !*s) + if(!this->PrintDocumentation(i->HelpType, *s) || !*s) { result = false; } @@ -634,33 +162,27 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) }; -cmDocumentation::Form cmDocumentation::GetFormFromFilename( - const std::string& filename, - int* manSection) +void cmDocumentation::WarnFormFromFilename( + cmDocumentation::RequestedHelpItem& request) { - std::string ext = cmSystemTools::GetFilenameLastExtension(filename); + std::string ext = cmSystemTools::GetFilenameLastExtension(request.Filename); ext = cmSystemTools::UpperCase(ext); if ((ext == ".HTM") || (ext == ".HTML")) { - return cmDocumentation::HTMLForm; + request.HelpType = cmDocumentation::None; + cmSystemTools::Message("Warning: HTML help format no longer supported"); } - - if (ext == ".DOCBOOK") + else if (ext == ".DOCBOOK") { - return cmDocumentation::DocbookForm; + request.HelpType = cmDocumentation::None; + cmSystemTools::Message("Warning: Docbook help format no longer supported"); } - // ".1" to ".9" should be manpages - if ((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) + else if ((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) { - if (manSection) - { - *manSection = ext[1] - '0'; - } - return cmDocumentation::ManForm; + request.HelpType = cmDocumentation::None; + cmSystemTools::Message("Warning: Man help format no longer supported"); } - - return cmDocumentation::TextForm; } //---------------------------------------------------------------------------- @@ -668,29 +190,9 @@ void cmDocumentation::addCommonStandardDocSections() { cmDocumentationSection *sec; - sec = new cmDocumentationSection("Author","AUTHOR"); - sec->Append(cmDocumentationEntry - (0, - "This manual page was generated by the \"--help-man\" option.", - 0)); - this->AllSections["Author"] = sec; - - sec = new cmDocumentationSection("Copyright","COPYRIGHT"); - sec->Append(cmDocumentationCopyright); - this->AllSections["Copyright"] = sec; - - sec = new cmDocumentationSection("See Also","SEE ALSO"); - sec->Append(cmDocumentationStandardSeeAlso); - this->AllSections["Standard See Also"] = sec; - sec = new cmDocumentationSection("Options","OPTIONS"); sec->Append(cmDocumentationStandardOptions); this->AllSections["Options"] = sec; - - sec = new cmDocumentationSection("Compatibility Commands", - "COMPATIBILITY COMMANDS"); - sec->Append(cmCompatCommandsDocumentationDescription); - this->AllSections["Compatibility Commands"] = sec; } //---------------------------------------------------------------------------- @@ -698,27 +200,9 @@ void cmDocumentation::addCMakeStandardDocSections() { cmDocumentationSection *sec; - sec = new cmDocumentationSection("Properties","PROPERTIES"); - sec->Append(cmPropertiesDocumentationDescription); - this->AllSections["Properties Description"] = sec; - sec = new cmDocumentationSection("Generators","GENERATORS"); sec->Append(cmDocumentationGeneratorsHeader); this->AllSections["Generators"] = sec; - - this->PropertySections.push_back("Properties of Global Scope"); - this->PropertySections.push_back("Properties on Directories"); - this->PropertySections.push_back("Properties on Targets"); - this->PropertySections.push_back("Properties on Tests"); - this->PropertySections.push_back("Properties on Source Files"); - this->PropertySections.push_back("Properties on Cache Entries"); - - this->VariableSections.push_back("Variables that Provide Information"); - this->VariableSections.push_back("Variables That Change Behavior"); - this->VariableSections.push_back("Variables That Describe the System"); - this->VariableSections.push_back("Variables that Control the Build"); - this->VariableSections.push_back("Variables for Languages"); - } //---------------------------------------------------------------------------- @@ -737,347 +221,6 @@ void cmDocumentation::addCPackStandardDocSections() sec = new cmDocumentationSection("Generators","GENERATORS"); sec->Append(cmDocumentationGeneratorsHeader); this->AllSections["Generators"] = sec; - - this->VariableSections.push_back( - "Variables common to all CPack generators"); -} - -void cmDocumentation::addAutomaticVariableSections(const std::string& section) -{ - std::vector<std::string>::iterator it; - it = std::find(this->VariableSections.begin(), - this->VariableSections.end(), - section); - /* if the section does not exist then add it */ - if (it==this->VariableSections.end()) - { - this->VariableSections.push_back(section); - } -} -//---------------------------------------------------------------------------- -int cmDocumentation::getDocumentedModulesListInDir( - std::string path, - std::string globExpr, - documentedModulesList_t& docedModuleList) -{ - cmsys::Glob gl; - std::string findExpr; - std::vector<std::string> files; - std::string line; - documentedModuleSectionPair_t docPair; - int nbDocumentedModules = 0; - - findExpr = path + "/" + globExpr; - if (gl.FindFiles(findExpr)) - { - files = gl.GetFiles(); - for (std::vector<std::string>::iterator itf=files.begin(); - itf!=files.end();++itf) - { - std::ifstream fin((*itf).c_str()); - // file access trouble ignore it (ignore this kind of error) - if (!fin) continue; - /* read first line in order to get doc section */ - if (cmSystemTools::GetLineFromStream(fin, line)) - { - /* Doc section indicates that - * this file has structured doc in it. - */ - if (line.find("##section")!=std::string::npos) - { - // ok found one more documented module - ++nbDocumentedModules; - docPair.first = *itf; - // 10 is the size of '##section' + 1 - docPair.second = line.substr(10,std::string::npos); - docedModuleList.push_back(docPair); - } - // No else if no section is found (undocumented module) - } - // No else cannot read first line (ignore this kind of error) - line = ""; - } - } - if (nbDocumentedModules>0) - { - return 0; - } - else - { - return 1; - } -} - -//---------------------------------------------------------------------------- -static void trim(std::string& s) -{ - std::string::size_type pos = s.find_last_not_of(' '); - if(pos != std::string::npos) - { - s.erase(pos + 1); - pos = s.find_first_not_of(' '); - if(pos != std::string::npos) s.erase(0, pos); - } - else - { - s.erase(s.begin(), s.end()); - } -} - -int cmDocumentation::GetStructuredDocFromFile( - const char* fname, - std::vector<cmDocumentationEntry>& commands, - cmake* cm) -{ - enum sdoce { - SDOC_NONE, SDOC_MODULE, SDOC_MACRO, SDOC_FUNCTION, SDOC_VARIABLE, - SDOC_SECTION, - SDOC_UNKNOWN}; - int nbDocItemFound = 0; - int docCtxIdx = 0; - std::vector<int> docContextStack(60); - docContextStack[docCtxIdx]=SDOC_NONE; - cmDocumentationEntry e; - std::ifstream fin(fname); - if(!fin) - { - return nbDocItemFound; - } - std::string section; - std::string name; - std::string full; - std::string brief; - std::string line; - bool newCtx = false; /* we've just entered ##<beginkey> context */ - bool inBrief = false; /* we are currently parsing brief desc. */ - bool inFullFirstParagraph = false; /* we are currently parsing full - desc. first paragraph */ - brief = ""; - full = ""; - bool newParagraph = true; - while ( fin && cmSystemTools::GetLineFromStream(fin, line) ) - { - if(line.size() && line[0] == '#') - { - /* handle structured doc context */ - if ((line.size()>=2) && line[1]=='#') - { - /* markup word is following '##' stopping at first space - * Some markup word like 'section' may have more characters - * following but we don't handle those here. - */ - std::string mkword = line.substr(2,line.find(' ',2)-2); - if (mkword=="macro") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_MACRO; - newCtx = true; - } - else if (mkword=="variable") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_VARIABLE; - newCtx = true; - } - else if (mkword=="function") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_FUNCTION; - newCtx = true; - } - else if (mkword=="module") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_MODULE; - newCtx = true; - } - else if (mkword=="section") - { - docCtxIdx++; - docContextStack[docCtxIdx]=SDOC_SECTION; - // 10 is the size of '##section' + 1 - section = line.substr(10,std::string::npos); - /* drop the rest of the line */ - line = ""; - newCtx = true; - } - else if (mkword.substr(0,3)=="end") - { - switch (docContextStack[docCtxIdx]) { - case SDOC_MACRO: - /* for now MACRO and FUNCTION are handled in the same way */ - case SDOC_FUNCTION: - commands.push_back(cmDocumentationEntry(name.c_str(), - brief.c_str(),full.c_str())); - break; - case SDOC_VARIABLE: - this->addAutomaticVariableSections(section); - cm->DefineProperty - (name.c_str(), cmProperty::VARIABLE, - brief.c_str(), - full.c_str(),false, - section.c_str()); - break; - case SDOC_MODULE: - /* not implemented */ - break; - case SDOC_SECTION: - /* not implemented */ - break; - default: - /* ignore other cases */ - break; - } - docCtxIdx--; - newCtx = false; - ++nbDocItemFound; - } - else - { - // error out unhandled context - return nbDocItemFound; - } - /* context is set go to next doc line */ - continue; - } - - // Now parse the text attached to the context - - // The first line after the context mark-up contains:: - // name - brief until. (brief is dot terminated or - // followed by a blank line) - if (newCtx) - { - // no brief (for easy variable definition) - if (line.find("-")==std::string::npos) - { - name = line.substr(1,std::string::npos); - trim(name); - brief = ""; - inBrief = false; - full = ""; - } - // here we have a name and brief beginning - else - { - name = line.substr(1,line.find("-")-1); - trim(name); - // we are parsing the brief context - brief = line.substr(line.find("-")+1,std::string::npos); - trim(brief); - // Brief may already be terminated on the first line - if (brief.find('.')!=std::string::npos) - { - inBrief = false; - full = brief.substr(brief.find('.')+1,std::string::npos); - trim(full); - inFullFirstParagraph = true; - brief = brief.substr(0,brief.find('.')); - } - // brief is continued on following lines - else - { - inBrief = true; - full = ""; - } - } - newCtx = false; - continue; - } - // blank line - if(line.size() <= 2) - { - if (inBrief) { - inBrief = false; - full = ""; - } else { - if (full.length()>0) - { - full += "\n"; - } - // the first paragraph of full has ended - inFullFirstParagraph = false; - } - newParagraph = true; - } - // brief is terminated by '.' - else if (inBrief && (line.find('.')!=std::string::npos)) - { - /* the brief just ended */ - inBrief = false; - std::string endBrief = line.substr(1,line.find('.')); - trim(endBrief); - trim(brief); - brief += " " + endBrief; - full += line.substr(line.find('.')+1,std::string::npos); - trim(full); - inFullFirstParagraph = true; - } - // we handle full text or multi-line brief. - else - { - std::string* text; - if (inBrief) - { - text = &brief; - } - else - { - text = &full; - } - // two spaces - if(line[1] == ' ' && line[2] == ' ') - { - // there is no "full first paragraph at all." - if (line[3] == ' ') - { - inFullFirstParagraph = false; - } - - if(!newParagraph && !inFullFirstParagraph) - { - *text += "\n"; - newParagraph = true; - } - // Skip #, and leave space for pre-formatted - if (inFullFirstParagraph) - { - std::string temp = line.c_str()+1; - trim(temp); - *text += " " + temp; - } - else - { - *text += line.c_str()+1; - *text += "\n"; - } - } - else if(line[1] == ' ') - { - if(!newParagraph) - { - *text += " "; - } - newParagraph = false; - // skip # and space - *text += line.c_str()+2; - } - else - { - if(!newParagraph) - { - *text += " "; - } - newParagraph = false; - // skip # - *text += line.c_str()+1; - } - } - } - /* next line is not the first context line */ - newCtx = false; - } - return nbDocItemFound; } //---------------------------------------------------------------------------- @@ -1089,7 +232,6 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, { RequestedHelpItem help; help.HelpType = cmDocumentation::Usage; - help.HelpForm = cmDocumentation::UsageForm; this->RequestedHelpItems.push_back(help); return true; } @@ -1113,154 +255,159 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, (strcmp(argv[i], "-H") == 0)) { help.HelpType = cmDocumentation::Usage; - help.HelpForm = cmDocumentation::UsageForm; GET_OPT_ARGUMENT(help.Argument); help.Argument = cmSystemTools::LowerCase(help.Argument); // special case for single command if (!help.Argument.empty()) { - help.HelpType = cmDocumentation::Single; + help.HelpType = cmDocumentation::OneCommand; } } else if(strcmp(argv[i], "--help-properties") == 0) { - help.HelpType = cmDocumentation::Properties; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-properties.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-policies") == 0) { - help.HelpType = cmDocumentation::Policies; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-policies.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-variables") == 0) { - help.HelpType = cmDocumentation::Variables; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-variables.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-modules") == 0) { - help.HelpType = cmDocumentation::Modules; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-modules.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-custom-modules") == 0) { - help.HelpType = cmDocumentation::CustomModules; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + cmSystemTools::Message( + "Warning: --help-custom-modules no longer supported"); + return true; } else if(strcmp(argv[i], "--help-commands") == 0) { - help.HelpType = cmDocumentation::Commands; + help.HelpType = cmDocumentation::OneManual; + help.Argument = "cmake-commands.7"; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-compatcommands") == 0) { - help.HelpType = cmDocumentation::CompatCommands; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + cmSystemTools::Message( + "Warning: --help-compatcommands no longer supported"); + return true; } else if(strcmp(argv[i], "--help-full") == 0) { - help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + cmSystemTools::Message("Warning: --help-full no longer supported"); + return true; } else if(strcmp(argv[i], "--help-html") == 0) { - help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::HTMLForm; + cmSystemTools::Message("Warning: --help-html no longer supported"); + return true; } else if(strcmp(argv[i], "--help-man") == 0) { - help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::ManForm; - help.ManSection = 1; + cmSystemTools::Message("Warning: --help-man no longer supported"); + return true; } else if(strcmp(argv[i], "--help-command") == 0) { - help.HelpType = cmDocumentation::Single; + help.HelpType = cmDocumentation::OneCommand; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); help.Argument = cmSystemTools::LowerCase(help.Argument); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-module") == 0) { - help.HelpType = cmDocumentation::SingleModule; + help.HelpType = cmDocumentation::OneModule; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-property") == 0) { - help.HelpType = cmDocumentation::SingleProperty; + help.HelpType = cmDocumentation::OneProperty; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-policy") == 0) { - help.HelpType = cmDocumentation::SinglePolicy; + help.HelpType = cmDocumentation::OnePolicy; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-variable") == 0) { - help.HelpType = cmDocumentation::SingleVariable; + help.HelpType = cmDocumentation::OneVariable; + GET_OPT_ARGUMENT(help.Argument); + GET_OPT_ARGUMENT(help.Filename); + this->WarnFormFromFilename(help); + } + else if(strcmp(argv[i], "--help-manual") == 0) + { + help.HelpType = cmDocumentation::OneManual; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = this->GetFormFromFilename(help.Filename, - &help.ManSection); + this->WarnFormFromFilename(help); } else if(strcmp(argv[i], "--help-command-list") == 0) { - help.HelpType = cmDocumentation::List; + help.HelpType = cmDocumentation::ListCommands; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--help-module-list") == 0) { - help.HelpType = cmDocumentation::ModuleList; + help.HelpType = cmDocumentation::ListModules; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--help-property-list") == 0) { - help.HelpType = cmDocumentation::PropertyList; + help.HelpType = cmDocumentation::ListProperties; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--help-variable-list") == 0) { - help.HelpType = cmDocumentation::VariableList; + help.HelpType = cmDocumentation::ListVariables; + GET_OPT_ARGUMENT(help.Filename); + } + else if(strcmp(argv[i], "--help-policy-list") == 0) + { + help.HelpType = cmDocumentation::ListPolicies; + GET_OPT_ARGUMENT(help.Filename); + } + else if(strcmp(argv[i], "--help-manual-list") == 0) + { + help.HelpType = cmDocumentation::ListManuals; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::TextForm; } else if(strcmp(argv[i], "--copyright") == 0) { - help.HelpType = cmDocumentation::Copyright; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::UsageForm; + cmSystemTools::Message("Warning: --copyright no longer supported"); + return true; } else if((strcmp(argv[i], "--version") == 0) || (strcmp(argv[i], "-version") == 0) || @@ -1268,7 +415,6 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, { help.HelpType = cmDocumentation::Version; GET_OPT_ARGUMENT(help.Filename); - help.HelpForm = cmDocumentation::UsageForm; } if(help.HelpType != None) { @@ -1281,40 +427,12 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv, } //---------------------------------------------------------------------------- -void cmDocumentation::Print(Form f, int manSection, std::ostream& os) -{ - this->SetForm(f, manSection); - this->Print(os); -} - -//---------------------------------------------------------------------------- -void cmDocumentation::Print(std::ostream& os) -{ - // if the formatter supports it, print a master index for - // all sections - this->CurrentFormatter->PrintIndex(os, this->PrintSections); - for(unsigned int i=0; i < this->PrintSections.size(); ++i) - { - std::string name = this->PrintSections[i]-> - GetName((this->CurrentFormatter->GetForm())); - this->CurrentFormatter->PrintSection(os,*this->PrintSections[i], - name.c_str()); - } -} - -//---------------------------------------------------------------------------- void cmDocumentation::SetName(const char* name) { this->NameString = name?name:""; } //---------------------------------------------------------------------------- -void cmDocumentation::SetDocName(const char *docname) -{ - this->DocName = docname?docname:""; -} - -//---------------------------------------------------------------------------- void cmDocumentation::SetSection(const char *name, cmDocumentationSection *section) { @@ -1338,7 +456,7 @@ void cmDocumentation::SetSection(const char *name, //---------------------------------------------------------------------------- void cmDocumentation::SetSection(const char *name, - const char *docs[][3]) + const char *docs[][2]) { cmDocumentationSection *sec = new cmDocumentationSection(name, @@ -1360,7 +478,7 @@ void cmDocumentation //---------------------------------------------------------------------------- void cmDocumentation::PrependSection(const char *name, - const char *docs[][3]) + const char *docs[][2]) { cmDocumentationSection *sec = 0; if (this->AllSections.find(name) == this->AllSections.end()) @@ -1396,7 +514,7 @@ void cmDocumentation::PrependSection(const char *name, //---------------------------------------------------------------------------- void cmDocumentation::AppendSection(const char *name, - const char *docs[][3]) + const char *docs[][2]) { cmDocumentationSection *sec = 0; if (this->AllSections.find(name) == this->AllSections.end()) @@ -1451,471 +569,242 @@ void cmDocumentation::PrependSection(const char *name, } //---------------------------------------------------------------------------- -void cmDocumentation::SetSeeAlsoList(const char *data[][3]) +void cmDocumentation::GlobHelp(std::vector<std::string>& files, + std::string const& pattern) { - cmDocumentationSection *sec = - new cmDocumentationSection("See Also", "SEE ALSO"); - this->AllSections["See Also"] = sec; - this->SeeAlsoString = ".B "; - int i = 0; - while(data[i][1]) + cmsys::Glob gl; + std::string findExpr = this->CMakeRoot + "/Help/" + pattern + ".rst"; + if(gl.FindFiles(findExpr)) { - this->SeeAlsoString += data[i][1]; - this->SeeAlsoString += data[i+1][1]? "(1), ":"(1)"; - ++i; + files = gl.GetFiles(); } - sec->Append(0,this->SeeAlsoString.c_str(),0); - sec->Append(cmDocumentationStandardSeeAlso); } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationGeneric(std::ostream& os, - const char *section) +void cmDocumentation::PrintNames(std::ostream& os, + std::string const& pattern) { - if(this->AllSections.find(section) == this->AllSections.end()) - { - os << "Internal error: " << section << " list is empty." << std::endl; - return false; - } - if(this->CurrentArgument.length() == 0) - { - os << "Required argument missing.\n"; - return false; - } - const std::vector<cmDocumentationEntry> &entries = - this->AllSections[section]->GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator ei = - entries.begin(); - ei != entries.end(); ++ei) + std::vector<std::string> files; + this->GlobHelp(files, pattern); + std::vector<std::string> names; + for (std::vector<std::string>::const_iterator i = files.begin(); + i != files.end(); ++i) { - if(this->CurrentArgument == ei->Name) + std::string line; + std::ifstream fin(i->c_str()); + while(fin && cmSystemTools::GetLineFromStream(fin, line)) { - this->PrintDocumentationCommand(os, *ei); - return true; + if(!line.empty() && (isalnum(line[0]) || line[0] == '<')) + { + names.push_back(line); + break; + } } } - return false; + std::sort(names.begin(), names.end()); + for (std::vector<std::string>::iterator i = names.begin(); + i != names.end(); ++i) + { + os << *i << "\n"; + } } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingle(std::ostream& os) +bool cmDocumentation::PrintFiles(std::ostream& os, + std::string const& pattern) { - if (this->PrintDocumentationGeneric(os,"Commands")) - { - return true; - } - if (this->PrintDocumentationGeneric(os,"Compatibility Commands")) + bool found = false; + std::vector<std::string> files; + this->GlobHelp(files, pattern); + std::sort(files.begin(), files.end()); + cmRST r(os, this->CMakeRoot + "/Help"); + for (std::vector<std::string>::const_iterator i = files.begin(); + i != files.end(); ++i) { - return true; + found = r.ProcessFile(i->c_str()) || found; } - - // Argument was not a command. Complain. - os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-command is not a CMake command. " - << "Use --help-command-list to see all commands.\n"; - return false; + return found; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingleModule(std::ostream& os) +bool cmDocumentation::PrintHelpOneManual(std::ostream& os) { - if(this->CurrentArgument.length() == 0) + std::string mname = this->CurrentArgument; + std::string::size_type mlen = mname.length(); + if(mlen > 3 && mname[mlen-3] == '(' && + mname[mlen-1] == ')') { - os << "Argument --help-module needs a module name.\n"; - return false; + mname = mname.substr(0, mlen-3) + "." + mname[mlen-2]; } - - std::string moduleName; - // find the module - std::vector<std::string> dirs; - cmSystemTools::ExpandListArgument(this->CMakeModulePath, dirs); - for(std::vector<std::string>::const_iterator dirIt = dirs.begin(); - dirIt != dirs.end(); - ++dirIt) + if(this->PrintFiles(os, "manual/" + mname) || + this->PrintFiles(os, "manual/" + mname + ".[0-9]")) { - moduleName = *dirIt; - moduleName += "/"; - moduleName += this->CurrentArgument; - moduleName += ".cmake"; - if(cmSystemTools::FileExists(moduleName.c_str())) - { - break; - } - moduleName = ""; - } - - if (moduleName.empty()) - { - moduleName = this->CMakeRoot; - moduleName += "/Modules/"; - moduleName += this->CurrentArgument; - moduleName += ".cmake"; - if(!cmSystemTools::FileExists(moduleName.c_str())) - { - moduleName = ""; - } - } - - if(!moduleName.empty()) - { - cmDocumentationSection *sec = - new cmDocumentationSection("Standard CMake Modules", "MODULES"); - this->AllSections["Modules"] = sec; - if (this->CreateSingleModule(moduleName.c_str(), - this->CurrentArgument.c_str(), - *this->AllSections["Modules"])) - { - if(this->AllSections["Modules"]->GetEntries().size()) - { - this->PrintDocumentationCommand - (os, this->AllSections["Modules"]->GetEntries()[0]); - os << "\n Defined in: "; - os << moduleName << "\n"; - return true; - } - else - { - return false; - } - } + return true; } - - // Argument was not a module. Complain. + // Argument was not a manual. Complain. os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-module is not a CMake module.\n"; + << "\" to --help-manual is not an available manual. " + << "Use --help-manual-list to see all available manuals.\n"; return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingleProperty(std::ostream& os) +bool cmDocumentation::PrintHelpListManuals(std::ostream& os) { - bool done = false; - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - !done && i != this->PropertySections.end(); ++i) - { - done = this->PrintDocumentationGeneric(os,i->c_str()); - } + this->PrintNames(os, "manual/*"); + return true; +} - if (done) +//---------------------------------------------------------------------------- +bool cmDocumentation::PrintHelpOneCommand(std::ostream& os) +{ + std::string cname = cmSystemTools::LowerCase(this->CurrentArgument); + if(this->PrintFiles(os, "command/" + cname)) { return true; } - // Argument was not a command. Complain. os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-property is not a CMake property. " - << "Use --help-property-list to see all properties.\n"; + << "\" to --help-command is not a CMake command. " + << "Use --help-command-list to see all commands.\n"; return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSinglePolicy(std::ostream& os) +bool cmDocumentation::PrintHelpListCommands(std::ostream& os) { - if (this->PrintDocumentationGeneric(os,"Policies")) - { - return true; - } - - // Argument was not a policy. Complain. - os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-policy is not a CMake policy.\n"; - return false; + this->PrintNames(os, "command/*"); + return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationSingleVariable(std::ostream& os) +bool cmDocumentation::PrintHelpOneModule(std::ostream& os) { - bool done = false; - for (std::vector<std::string>::iterator i = - this->VariableSections.begin(); - !done && i != this->VariableSections.end(); ++i) - { - done = this->PrintDocumentationGeneric(os,i->c_str()); - } - - if (done) + std::string mname = this->CurrentArgument; + if(this->PrintFiles(os, "module/" + mname)) { return true; } - - // Argument was not a variable. Complain. + // Argument was not a module. Complain. os << "Argument \"" << this->CurrentArgument.c_str() - << "\" to --help-variable is not a defined variable. " - << "Use --help-variable-list to see all defined variables.\n"; + << "\" to --help-module is not a CMake module.\n"; return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationList(std::ostream& os, - const char *section) +bool cmDocumentation::PrintHelpListModules(std::ostream& os) { - if(this->AllSections.find(section) == this->AllSections.end()) + std::vector<std::string> files; + this->GlobHelp(files, "module/*"); + std::vector<std::string> modules; + for (std::vector<std::string>::iterator fi = files.begin(); + fi != files.end(); ++fi) { - os << "Internal error: " << section << " list is empty." << std::endl; - return false; + std::string module = cmSystemTools::GetFilenameName(*fi); + modules.push_back(module.substr(0, module.size()-4)); } - - const std::vector<cmDocumentationEntry> &entries = - this->AllSections[section]->GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator ei = - entries.begin(); - ei != entries.end(); ++ei) + std::sort(modules.begin(), modules.end()); + for (std::vector<std::string>::iterator i = modules.begin(); + i != modules.end(); ++i) { - if(ei->Name.size()) - { - os << ei->Name << std::endl; - } + os << *i << "\n"; } return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationUsage(std::ostream& os) +bool cmDocumentation::PrintHelpOneProperty(std::ostream& os) { - this->ClearSections(); - this->AddSectionToPrint("Usage"); - this->AddSectionToPrint("Options"); - if(this->ShowGenerators) + std::string pname = cmSystemTools::HelpFileName(this->CurrentArgument); + if(this->PrintFiles(os, "prop_*/" + pname)) { - this->AddSectionToPrint("Generators"); + return true; } - this->Print(os); - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationFull(std::ostream& os) -{ - this->CreateFullDocumentation(); - this->CurrentFormatter->PrintHeader(GetNameString(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationModules(std::ostream& os) -{ - this->ClearSections(); - this->CreateModulesSection(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Modules)); - this->AddSectionToPrint("Description"); - this->AddSectionToPrint("Modules"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; + // Argument was not a property. Complain. + os << "Argument \"" << this->CurrentArgument.c_str() + << "\" to --help-property is not a CMake property. " + << "Use --help-property-list to see all properties.\n"; + return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationCustomModules(std::ostream& os) +bool cmDocumentation::PrintHelpListProperties(std::ostream& os) { - this->ClearSections(); - this->CreateCustomModulesSection(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(CustomModules)); - this->AddSectionToPrint("Description"); - this->AddSectionToPrint("Custom CMake Modules"); -// the custom modules are most probably not under Kitware's copyright, Alex -// this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("See Also"); - - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); + this->PrintNames(os, "prop_*/*"); return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationPolicies(std::ostream& os) +bool cmDocumentation::PrintHelpOnePolicy(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Policies)); - this->AddSectionToPrint("Description"); - this->AddSectionToPrint("Policies"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("See Also"); + std::string pname = this->CurrentArgument; + std::vector<std::string> files; + if(this->PrintFiles(os, "policy/" + pname)) + { + return true; + } - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; + // Argument was not a policy. Complain. + os << "Argument \"" << this->CurrentArgument.c_str() + << "\" to --help-policy is not a CMake policy.\n"; + return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationProperties(std::ostream& os) +bool cmDocumentation::PrintHelpListPolicies(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Properties)); - this->AddSectionToPrint("Properties Description"); - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - i != this->PropertySections.end(); ++i) - { - this->AddSectionToPrint(i->c_str()); - } - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); + this->PrintNames(os, "policy/*"); return true; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationVariables(std::ostream& os) +bool cmDocumentation::PrintHelpOneVariable(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Variables)); - for (std::vector<std::string>::iterator i = - this->VariableSections.begin(); - i != this->VariableSections.end(); ++i) + std::string vname = cmSystemTools::HelpFileName(this->CurrentArgument); + if(this->PrintFiles(os, "variable/" + vname)) { - this->AddSectionToPrint(i->c_str()); + return true; } - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; -} - -//---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationCurrentCommands(std::ostream& os) -{ - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(Commands)); - this->AddSectionToPrint("Commands"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); - return true; + // Argument was not a variable. Complain. + os << "Argument \"" << this->CurrentArgument.c_str() + << "\" to --help-variable is not a defined variable. " + << "Use --help-variable-list to see all defined variables.\n"; + return false; } //---------------------------------------------------------------------------- -bool cmDocumentation::PrintDocumentationCompatCommands(std::ostream& os) +bool cmDocumentation::PrintHelpListVariables(std::ostream& os) { - this->ClearSections(); - this->AddDocumentIntroToPrint(GET_DOCUMENT_INTRO(CompatCommands)); - this->AddSectionToPrint("Compatibility Commands Description"); - this->AddSectionToPrint("Compatibility Commands"); - this->AddSectionToPrint("Copyright"); - this->AddSectionToPrint("Standard See Also"); - this->CurrentFormatter->PrintHeader(GetDocName(), GetNameString(), os); - this->Print(os); - this->CurrentFormatter->PrintFooter(os); + this->PrintNames(os, "variable/*"); return true; } //---------------------------------------------------------------------------- -void cmDocumentation -::PrintDocumentationCommand(std::ostream& os, - const cmDocumentationEntry &entry) -{ - // the string "SingleItem" will be used in a few places to detect the case - // that only the documentation for a single item is printed - cmDocumentationSection *sec = new cmDocumentationSection("SingleItem",""); - sec->Append(entry); - this->AllSections["temp"] = sec; - this->ClearSections(); - this->AddSectionToPrint("temp"); - this->Print(os); - this->AllSections.erase("temp"); - delete sec; -} - -//---------------------------------------------------------------------------- -void cmDocumentation::CreateFullDocumentation() +bool cmDocumentation::PrintDocumentationUsage(std::ostream& os) { - this->ClearSections(); - this->CreateCustomModulesSection(); - this->CreateModulesSection(); - - std::set<std::string> emitted; - this->AddSectionToPrint("Name"); - emitted.insert("Name"); - this->AddSectionToPrint("Usage"); - emitted.insert("Usage"); - this->AddSectionToPrint("Description"); - emitted.insert("Description"); - this->AddSectionToPrint("Options"); - emitted.insert("Options"); - this->AddSectionToPrint("Generators"); - emitted.insert("Generators"); - this->AddSectionToPrint("Commands"); - emitted.insert("Commands"); - - - this->AddSectionToPrint("Properties Description"); - emitted.insert("Properties Description"); - for (std::vector<std::string>::iterator i = - this->PropertySections.begin(); - i != this->PropertySections.end(); ++i) + std::map<std::string,cmDocumentationSection*>::iterator si; + si = this->AllSections.find("Usage"); + if(si != this->AllSections.end()) { - this->AddSectionToPrint(i->c_str()); - emitted.insert(i->c_str()); + this->Formatter.PrintSection(os, *si->second); } - - emitted.insert("Copyright"); - emitted.insert("See Also"); - emitted.insert("Standard See Also"); - emitted.insert("Author"); - - // add any sections not yet written out, or to be written out - for (std::map<std::string, cmDocumentationSection*>::iterator i = - this->AllSections.begin(); - i != this->AllSections.end(); ++i) - { - if (emitted.find(i->first) == emitted.end()) - { - this->AddSectionToPrint(i->first.c_str()); - } - } - - this->AddSectionToPrint("Copyright"); - - if(this->CurrentFormatter->GetForm() == ManForm) + si = this->AllSections.find("Options"); + if(si != this->AllSections.end()) { - this->AddSectionToPrint("See Also"); - this->AddSectionToPrint("Author"); + this->Formatter.PrintSection(os, *si->second); } - else + if(this->ShowGenerators) { - this->AddSectionToPrint("Standard See Also"); + si = this->AllSections.find("Generators"); + if(si != this->AllSections.end()) + { + this->Formatter.PrintSection(os, *si->second); + } } + return true; } //---------------------------------------------------------------------------- -void cmDocumentation::SetForm(Form f, int manSection) -{ - switch(f) - { - case HTMLForm: - this->CurrentFormatter = &this->HTMLFormatter; - break; - case DocbookForm: - this->CurrentFormatter = &this->DocbookFormatter; - break; - case ManForm: - this->ManFormatter.SetManSection(manSection); - this->CurrentFormatter = &this->ManFormatter; - break; - case TextForm: - this->CurrentFormatter = &this->TextFormatter; - break; - case UsageForm: - this->CurrentFormatter = & this->UsageFormatter; - break; - } -} - - -//---------------------------------------------------------------------------- const char* cmDocumentation::GetNameString() const { if(this->NameString.length() > 0) @@ -1929,41 +818,6 @@ const char* cmDocumentation::GetNameString() const } //---------------------------------------------------------------------------- -const char* cmDocumentation::GetDocName(bool fallbackToNameString) const -{ - if (this->DocName.length() > 0) - { - return this->DocName.c_str(); - } - else if (fallbackToNameString) - { - return this->GetNameString(); - } - else - return 0; -} - -//---------------------------------------------------------------------------- -#define CASE_DEFAULT_DOCNAME(doctype) \ - case cmDocumentation::doctype : \ - return GET_DOCUMENT_INTRO(doctype)[0]; -const char* cmDocumentation::GetDefaultDocName(Type ht) const -{ - switch (ht) - { - CASE_DEFAULT_DOCNAME(Modules) - CASE_DEFAULT_DOCNAME(CustomModules) - CASE_DEFAULT_DOCNAME(Policies) - CASE_DEFAULT_DOCNAME(Properties) - CASE_DEFAULT_DOCNAME(Variables) - CASE_DEFAULT_DOCNAME(Commands) - CASE_DEFAULT_DOCNAME(CompatCommands) - default: break; - } - return 0; -} - -//---------------------------------------------------------------------------- bool cmDocumentation::IsOption(const char* arg) const { return ((arg[0] == '-') || (strcmp(arg, "/V") == 0) || diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index 218f44d..a4072c5 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -15,11 +15,6 @@ #include "cmStandardIncludes.h" #include "cmProperty.h" #include "cmDocumentationFormatter.h" -#include "cmDocumentationFormatterHTML.h" -#include "cmDocumentationFormatterDocbook.h" -#include "cmDocumentationFormatterMan.h" -#include "cmDocumentationFormatterText.h" -#include "cmDocumentationFormatterUsage.h" #include "cmDocumentationSection.h" #include "cmake.h" @@ -37,22 +32,6 @@ public: ~cmDocumentation(); /** - * An helper type pair for [structured] documented modules. - * The comment of those module contains structure markup - * which makes it possible to retrieve the documentation - * of variables, macros and functions defined in the module. - * - first is the filename of the module - * - second is the section of the doc the module belongs too - */ - typedef std::pair<std::string,std::string> documentedModuleSectionPair_t; - /** - * A list of documented module(s). - */ - typedef std::list<documentedModuleSectionPair_t> documentedModulesList_t; - - // High-level interface for standard documents: - - /** * Check command line arguments for documentation options. Returns * true if documentation options are found, and false otherwise. * When true is returned, PrintRequestedDocumentation should be @@ -72,7 +51,7 @@ public: bool PrintRequestedDocumentation(std::ostream& os); /** Print help of the given type. */ - bool PrintDocumentation(Type ht, std::ostream& os, const char* docname=0); + bool PrintDocumentation(Type ht, std::ostream& os); void SetShowGenerators(bool showGen) { this->ShowGenerators = showGen; } @@ -80,62 +59,33 @@ public: void SetName(const char* name); /** Set a section of the documentation. Typical sections include Name, - Usage, Description, Options, SeeAlso */ + Usage, Description, Options */ void SetSection(const char *sectionName, cmDocumentationSection *section); void SetSection(const char *sectionName, std::vector<cmDocumentationEntry> &docs); void SetSection(const char *sectionName, - const char *docs[][3]); + const char *docs[][2]); void SetSections(std::map<std::string,cmDocumentationSection *> §ions); /** Add the documentation to the beginning/end of the section */ void PrependSection(const char *sectionName, - const char *docs[][3]); + const char *docs[][2]); void PrependSection(const char *sectionName, std::vector<cmDocumentationEntry> &docs); void PrependSection(const char *sectionName, cmDocumentationEntry &docs); void AppendSection(const char *sectionName, - const char *docs[][3]); + const char *docs[][2]); void AppendSection(const char *sectionName, std::vector<cmDocumentationEntry> &docs); void AppendSection(const char *sectionName, cmDocumentationEntry &docs); - /** - * Print documentation in the given form. All previously added - * sections will be generated. - */ - void Print(Form f, int manSection, std::ostream& os); - - /** - * Print documentation in the current form. All previously added - * sections will be generated. - */ - void Print(std::ostream& os); - - /** - * Add a section of documentation. This can be used to generate custom help - * documents. - */ - void AddSectionToPrint(const char *section); - - void SetSeeAlsoList(const char *data[][3]); - - /** Clear all previously added sections of help. */ - void ClearSections(); - /** Set cmake root so we can find installed files */ void SetCMakeRoot(const char* root) { this->CMakeRoot = root;} - /** Set CMAKE_MODULE_PATH so we can find additional cmake modules */ - void SetCMakeModulePath(const char* path) { this->CMakeModulePath = path;} - - static Form GetFormFromFilename(const std::string& filename, - int* ManSection); - /** Add common (to all tools) documentation section(s) */ void addCommonStandardDocSections(); @@ -148,123 +98,50 @@ public: /** Add the CPack standard documentation section(s) */ void addCPackStandardDocSections(); - /** Add automatic variables sections */ - void addAutomaticVariableSections(const std::string& section); - - /** - * Retrieve the list of documented module located in - * path which match the globing expression globExpr. - * @param[in] path directory where to start the search - * we will recurse into it. - * @param[in] globExpr the globing expression used to - * match the file in path. - * @param[out] docModuleList the list of obtained pairs (may be empty) - * @return 0 on success 1 on error or empty list - */ - int getDocumentedModulesListInDir( - std::string path, - std::string globExpr, - documentedModulesList_t& docModuleList); - - /** - * Get the documentation of macros, functions and variable documented - * with CMake structured documentation in a CMake script. - * (in fact it may be in any file which follow the structured doc format) - * Structured documentation begin with - * ## (double sharp) in column 1 & 2 immediately followed - * by a markup. Those ## are ignored by the legacy module - * documentation parser @see CreateSingleModule. - * Current markup are ##section, ##module, - * ##macro, ##function, ##variable and ##end. - * ##end is closing either of the previous ones. - * @param[in] fname the script file name to be parsed for documentation - * @param[in,out] commands the vector of command/macros documentation - * entry found in the script file. - * @param[in,out] cm the cmake object instance to which variable - * documentation will be attached - * (using @see cmake::DefineProperty) - * @return the number of documented items (command and variable) - * found in the file. - */ - int GetStructuredDocFromFile(const char* fname, - std::vector<cmDocumentationEntry>& commands, - cmake* cm); private: - void SetForm(Form f, int manSection); - void SetDocName(const char* docname); - - bool CreateSingleModule(const char* fname, - const char* moduleName, - cmDocumentationSection &sec); - void CreateModuleDocsForDir(cmsys::Directory& dir, - cmDocumentationSection &moduleSection); - bool CreateModulesSection(); - bool CreateCustomModulesSection(); - void CreateFullDocumentation(); - void AddDocumentIntroToPrint(const char* intro[2]); + void GlobHelp(std::vector<std::string>& files, std::string const& pattern); + void PrintNames(std::ostream& os, std::string const& pattern); + bool PrintFiles(std::ostream& os, std::string const& pattern); - bool PrintCopyright(std::ostream& os); bool PrintVersion(std::ostream& os); - bool PrintDocumentationGeneric(std::ostream& os, const char *section); - bool PrintDocumentationList(std::ostream& os, const char *section); - bool PrintDocumentationSingle(std::ostream& os); - bool PrintDocumentationSingleModule(std::ostream& os); - bool PrintDocumentationSingleProperty(std::ostream& os); - bool PrintDocumentationSinglePolicy(std::ostream& os); - bool PrintDocumentationSingleVariable(std::ostream& os); + bool PrintHelpOneManual(std::ostream& os); + bool PrintHelpOneCommand(std::ostream& os); + bool PrintHelpOneModule(std::ostream& os); + bool PrintHelpOnePolicy(std::ostream& os); + bool PrintHelpOneProperty(std::ostream& os); + bool PrintHelpOneVariable(std::ostream& os); + bool PrintHelpListManuals(std::ostream& os); + bool PrintHelpListCommands(std::ostream& os); + bool PrintHelpListModules(std::ostream& os); + bool PrintHelpListProperties(std::ostream& os); + bool PrintHelpListVariables(std::ostream& os); + bool PrintHelpListPolicies(std::ostream& os); bool PrintDocumentationUsage(std::ostream& os); - bool PrintDocumentationFull(std::ostream& os); - bool PrintDocumentationModules(std::ostream& os); - bool PrintDocumentationCustomModules(std::ostream& os); - bool PrintDocumentationPolicies(std::ostream& os); - bool PrintDocumentationProperties(std::ostream& os); - bool PrintDocumentationVariables(std::ostream& os); - bool PrintDocumentationCurrentCommands(std::ostream& os); - bool PrintDocumentationCompatCommands(std::ostream& os); - void PrintDocumentationCommand(std::ostream& os, - const cmDocumentationEntry &entry); - const char* GetNameString() const; - const char* GetDocName(bool fallbackToNameString = true) const; - const char* GetDefaultDocName(Type ht) const; bool IsOption(const char* arg) const; bool ShowGenerators; std::string NameString; - std::string DocName; std::map<std::string,cmDocumentationSection*> AllSections; - std::string SeeAlsoString; std::string CMakeRoot; - std::string CMakeModulePath; - std::set<std::string> ModulesFound; - std::vector< char* > ModuleStrings; - std::vector<const cmDocumentationSection *> PrintSections; std::string CurrentArgument; struct RequestedHelpItem { - RequestedHelpItem():HelpForm(TextForm), HelpType(None), ManSection(1) {} - cmDocumentationEnums::Form HelpForm; + RequestedHelpItem(): HelpType(None) {} cmDocumentationEnums::Type HelpType; std::string Filename; std::string Argument; - int ManSection; }; std::vector<RequestedHelpItem> RequestedHelpItems; - cmDocumentationFormatter* CurrentFormatter; - cmDocumentationFormatterHTML HTMLFormatter; - cmDocumentationFormatterDocbook DocbookFormatter; - cmDocumentationFormatterMan ManFormatter; - cmDocumentationFormatterText TextFormatter; - cmDocumentationFormatterUsage UsageFormatter; + cmDocumentationFormatter Formatter; - std::vector<std::string> PropertySections; - std::vector<std::string> VariableSections; + static void WarnFormFromFilename(RequestedHelpItem& request); }; #endif diff --git a/Source/cmDocumentationFormatter.cxx b/Source/cmDocumentationFormatter.cxx index 9f01949..29c806d 100644 --- a/Source/cmDocumentationFormatter.cxx +++ b/Source/cmDocumentationFormatter.cxx @@ -11,7 +11,10 @@ ============================================================================*/ #include "cmDocumentationFormatter.h" -cmDocumentationFormatter::cmDocumentationFormatter() +#include "cmDocumentationSection.h" + +cmDocumentationFormatter::cmDocumentationFormatter(): + TextWidth(77), TextIndent("") { } @@ -66,91 +69,162 @@ void cmDocumentationFormatter::PrintFormatted(std::ostream& os, } } -//---------------------------------------------------------------------------- -std::string -cmDocumentationFormatter::ComputeSectionLinkPrefix(std::string const& name) +void cmDocumentationFormatter::PrintPreformatted(std::ostream& os, + const char* text) { - // Map from section name to a prefix for links pointing within the - // section. For example, the commands section should have HTML - // links to each command with names like #command:ADD_EXECUTABLE. - if(name.find("Command") != name.npos) - { - return "command"; - } - else if(name.find("Propert") != name.npos) + bool newline = true; + for(const char* ptr = text; *ptr; ++ptr) { - if(name.find("Global") != name.npos) - { - return "prop_global"; - } - else if(name.find("Direct") != name.npos) + if(newline && *ptr != '\n') { - return "prop_dir"; + os << this->TextIndent; + newline = false; } - else if(name.find("Target") != name.npos) + os << *ptr; + if(*ptr == '\n') { - return "prop_tgt"; + newline = true; } - else if(name.find("Test") != name.npos) + } + os << "\n"; +} + +void cmDocumentationFormatter::PrintParagraph(std::ostream& os, + const char* text) +{ + os << this->TextIndent; + this->PrintColumn(os, text); + os << "\n"; +} + +void cmDocumentationFormatter::SetIndent(const char* indent) +{ + this->TextIndent = indent; +} + +void cmDocumentationFormatter::PrintColumn(std::ostream& os, + const char* text) +{ + // Print text arranged in an indented column of fixed witdh. + const char* l = text; + long column = 0; + bool newSentence = false; + bool firstLine = true; + int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent)); + + // Loop until the end of the text. + while(*l) + { + // Parse the next word. + const char* r = l; + while(*r && (*r != '\n') && (*r != ' ')) { ++r; } + + // Does it fit on this line? + if(r-l < (width-column-(newSentence?1:0))) { - return "prop_test"; + // Word fits on this line. + if(r > l) + { + if(column) + { + // Not first word on line. Separate from the previous word + // by a space, or two if this is a new sentence. + if(newSentence) + { + os << " "; + column += 2; + } + else + { + os << " "; + column += 1; + } + } + else + { + // First word on line. Print indentation unless this is the + // first line. + os << (firstLine?"":this->TextIndent); + } + + // Print the word. + os.write(l, static_cast<long>(r-l)); + newSentence = (*(r-1) == '.'); + } + + if(*r == '\n') + { + // Text provided a newline. Start a new line. + os << "\n"; + ++r; + column = 0; + firstLine = false; + } + else + { + // No provided newline. Continue this line. + column += static_cast<long>(r-l); + } } - else if(name.find("Source") != name.npos) + else { - return "prop_sf"; + // Word does not fit on this line. Start a new line. + os << "\n"; + firstLine = false; + if(r > l) + { + os << this->TextIndent; + os.write(l, static_cast<long>(r-l)); + column = static_cast<long>(r-l); + newSentence = (*(r-1) == '.'); + } + else + { + column = 0; + } } - return "property"; - } - else if(name.find("Variable") != name.npos) - { - return "variable"; - } - else if(name.find("Polic") != name.npos) - { - return "policy"; - } - else if(name.find("Module") != name.npos) - { - return "module"; - } - else if(name.find("Name") != name.npos || - name.find("Introduction") != name.npos) - { - return "name"; - } - else if(name.find("Usage") != name.npos) - { - return "usage"; - } - else if(name.find("Description") != name.npos) - { - return "desc"; - } - else if(name.find("Generators") != name.npos) - { - return "gen"; - } - else if(name.find("Options") != name.npos) - { - return "opt"; - } - else if(name.find("Copyright") != name.npos) - { - return "copy"; - } - else if(name.find("See Also") != name.npos) - { - return "see"; - } - else if(name.find("SingleItem") != name.npos) - { - return "single_item"; + + // Move to beginning of next word. Skip over whitespace. + l = r; + while(*l && (*l == ' ')) { ++l; } } - else +} + +void cmDocumentationFormatter +::PrintSection(std::ostream& os, + cmDocumentationSection const& section) +{ + os << section.GetName() << "\n"; + + const std::vector<cmDocumentationEntry> &entries = + section.GetEntries(); + for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); + op != entries.end(); ++op) { - std::cerr - << "WARNING: ComputeSectionLinkPrefix failed for \"" << name << "\"" - << std::endl; - return "other"; + if(op->Name.size()) + { + os << " " << op->Name; + this->TextIndent = " "; + int align = static_cast<int>(strlen(this->TextIndent))-4; + for(int i = static_cast<int>(op->Name.size()); i < align; ++i) + { + os << " "; + } + if (op->Name.size() > strlen(this->TextIndent)-4 ) + { + os << "\n"; + os.write(this->TextIndent, strlen(this->TextIndent)-2); + } + os << "= "; + this->PrintColumn(os, op->Brief.c_str()); + os << "\n"; + } + else + { + os << "\n"; + this->TextIndent = ""; + this->PrintFormatted(os, op->Brief.c_str()); + } } + os << "\n"; } diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h index 665b9b6..c7da52c 100644 --- a/Source/cmDocumentationFormatter.h +++ b/Source/cmDocumentationFormatter.h @@ -25,19 +25,16 @@ class cmDocumentationEnums public: /** Types of help provided. */ enum Type - { None, Usage, Single, SingleModule, SingleProperty, SingleVariable, - List, ModuleList, PropertyList, VariableList, - Full, Properties, Variables, Modules, CustomModules, Commands, - CompatCommands, Copyright, Version, Policies, SinglePolicy }; - - /** Forms of documentation output. */ - enum Form { TextForm, HTMLForm, ManForm, UsageForm, DocbookForm }; + { + None, Version, Usage, ListManuals, + ListCommands, ListModules, ListProperties, ListVariables, ListPolicies, + OneManual, OneCommand, OneModule, OneProperty, OneVariable, OnePolicy + }; }; class cmDocumentationSection; -/** Base class for printing the documentation in the various supported - formats. */ +/** Print documentation in a simple text format. */ class cmDocumentationFormatter { public: @@ -45,23 +42,15 @@ public: virtual ~cmDocumentationFormatter(); void PrintFormatted(std::ostream& os, const char* text); - virtual cmDocumentationEnums::Form GetForm() const = 0; - - virtual void PrintHeader(const char* /*docname*/, - const char* /*appname*/, - std::ostream& /*os*/) {} - virtual void PrintFooter(std::ostream& /*os*/) {} virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name) = 0; - virtual void PrintPreformatted(std::ostream& os, const char* text) = 0; - virtual void PrintParagraph(std::ostream& os, const char* text) = 0; - virtual void PrintIndex(std::ostream& , - std::vector<const cmDocumentationSection *>&) - {} - - /** Compute a prefix for links into a section (#\<prefix\>_SOMETHING). */ - std::string ComputeSectionLinkPrefix(std::string const& name); + cmDocumentationSection const& section); + virtual void PrintPreformatted(std::ostream& os, const char* text); + virtual void PrintParagraph(std::ostream& os, const char* text); + void PrintColumn(std::ostream& os, const char* text); + void SetIndent(const char* indent); +private: + int TextWidth; + const char* TextIndent; }; #endif diff --git a/Source/cmDocumentationFormatterDocbook.cxx b/Source/cmDocumentationFormatterDocbook.cxx deleted file mode 100644 index 706ce0a..0000000 --- a/Source/cmDocumentationFormatterDocbook.cxx +++ /dev/null @@ -1,254 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#include "cmDocumentationFormatterDocbook.h" -#include "cmDocumentationSection.h" -#include <algorithm> -#include <ctype.h> // for isalnum - -static int cmIsAlnum(int c) -{ - return isalnum(c); -} - -//---------------------------------------------------------------------------- - -// this function is a copy of the one in the HTML formatter -// the three functions below are slightly modified copies -static bool cmDocumentationIsHyperlinkCharDocbook(char c) -{ - // This is not a complete list but works for CMake documentation. - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || c == '.' || c == '/' || c == '~' || c == '@' || - c == ':' || c == '_' || c == '&' || c == '?' || c == '='); -} - -//---------------------------------------------------------------------------- -static void cmDocumentationPrintDocbookChar(std::ostream& os, char c) -{ - // Use an escape sequence if necessary. - switch(c) - { - case '<': - os << "<"; - break; - case '>': - os << ">"; - break; - case '&': - os << "&"; - break; - default: - os << c; - } -} - -//---------------------------------------------------------------------------- -const char* cmDocumentationPrintDocbookLink(std::ostream& os,const char* begin) -{ - // Look for the end of the link. - const char* end = begin; - while(cmDocumentationIsHyperlinkCharDocbook(*end)) - { - ++end; - } - - // Print the hyperlink itself. - os << "<ulink url=\""; - for(const char* c = begin; c != end; ++c) - { - cmDocumentationPrintDocbookChar(os, *c); - } - os << "\" />"; - - return end; -} - -//---------------------------------------------------------------------------- -void cmDocumentationPrintDocbookEscapes(std::ostream& os, const char* text) -{ - // Hyperlink prefixes. - static const char* hyperlinks[] = {"http://", "ftp://", "mailto:", 0}; - - // Print each character. - for(const char* p = text; *p;) - { - // Handle hyperlinks specially to make them active. - bool found_hyperlink = false; - for(const char** h = hyperlinks; !found_hyperlink && *h; ++h) - { - if(strncmp(p, *h, strlen(*h)) == 0) - { - p = cmDocumentationPrintDocbookLink(os, p); - found_hyperlink = true; - } - } - - // Print other characters normally. - if(!found_hyperlink) - { - cmDocumentationPrintDocbookChar(os, *p++); - } - } -} - -//---------------------------------------------------------------------------- -cmDocumentationFormatterDocbook::cmDocumentationFormatterDocbook() -:cmDocumentationFormatter() -{ -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - os << "<sect1 id=\""; - this->PrintId(os, 0, name); - os << "\">\n<title>" << name << "</title>\n"; - - std::string prefix = this->ComputeSectionLinkPrefix(name); - const std::vector<cmDocumentationEntry> &entries = section.GetEntries(); - - bool hasSubSections = false; - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - hasSubSections = true; - break; - } - } - - bool inAbstract = false; - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - if(inAbstract) - { - os << "</abstract>\n"; - inAbstract = false; - } - os << "<sect2 id=\""; - this->PrintId(os, prefix.c_str(), op->Name); - os << "\">\n<title>"; - cmDocumentationPrintDocbookEscapes(os, op->Name.c_str()); - os << "</title>\n"; - if(op->Full.size()) - { - os << "<abstract>\n<para>"; - cmDocumentationPrintDocbookEscapes(os, op->Brief.c_str()); - os << "</para>\n</abstract>\n"; - this->PrintFormatted(os, op->Full.c_str()); - } - else - { - this->PrintFormatted(os, op->Brief.c_str()); - } - os << "</sect2>\n"; - } - else - { - if(hasSubSections && op == entries.begin()) - { - os << "<abstract>\n"; - inAbstract = true; - } - this->PrintFormatted(os, op->Brief.c_str()); - } - } - - // empty sections are not allowed in docbook. - if(entries.empty()) - { - os << "<para/>\n"; - } - - os << "</sect1>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintPreformatted(std::ostream& os, const char* text) -{ - os << "<para>\n<programlisting>"; - cmDocumentationPrintDocbookEscapes(os, text); - os << "</programlisting>\n</para>\n"; -} - -void cmDocumentationFormatterDocbook -::PrintParagraph(std::ostream& os, const char* text) -{ - os << "<para>"; - cmDocumentationPrintDocbookEscapes(os, text); - os << "</para>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintHeader(const char* docname, const char* appname, std::ostream& os) -{ - this->Docname = docname; - - // this one is used to ensure that we don't create multiple link targets - // with the same name. We can clear it here since we are at the - // start of a document here. - this->EmittedLinkIds.clear(); - - os << "<?xml version=\"1.0\" ?>\n" - "<!DOCTYPE article PUBLIC \"-//OASIS//DTD DocBook V4.5//EN\" " - "\"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd\" [\n" - "<!ENTITY % addindex \"IGNORE\">\n" - "<!ENTITY % English \"INCLUDE\"> ]>\n" - "<article>\n" - "<articleinfo>\n" - "<title>" << docname << " - " << appname << "</title>\n" - "</articleinfo>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook::PrintFooter(std::ostream& os) -{ - os << "</article>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook -::PrintId(std::ostream& os, const char* prefix, std::string id) -{ - std::replace_if(id.begin(), id.end(), - std::not1(std::ptr_fun(cmIsAlnum)), '_'); - if(prefix) - { - id = std::string(prefix) + "." + id; - } - os << this->Docname << '.' << id; - - // make sure that each id exists only once. Since it seems - // not easily possible to determine which link refers to which id, - // we have at least to make sure that the duplicated id's get a - // different name (by appending an increasing number), Alex - if (this->EmittedLinkIds.find(id) == this->EmittedLinkIds.end()) - { - this->EmittedLinkIds.insert(id); - } - else - { - static unsigned int i=0; - os << i++; - } -} diff --git a/Source/cmDocumentationFormatterDocbook.h b/Source/cmDocumentationFormatterDocbook.h deleted file mode 100644 index 0352d34..0000000 --- a/Source/cmDocumentationFormatterDocbook.h +++ /dev/null @@ -1,43 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterDocbook_h -#define _cmDocumentationFormatterDocbook_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as Docbook. - http://www.oasis-open.org/docbook/xml/4.2/ */ -class cmDocumentationFormatterDocbook : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterDocbook(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::DocbookForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintFooter(std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); -private: - void PrintId(std::ostream& os, const char* prefix, std::string id); - std::set<std::string> EmittedLinkIds; - std::string Docname; -}; - -#endif diff --git a/Source/cmDocumentationFormatterHTML.cxx b/Source/cmDocumentationFormatterHTML.cxx deleted file mode 100644 index 7213b43..0000000 --- a/Source/cmDocumentationFormatterHTML.cxx +++ /dev/null @@ -1,288 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#include "cmDocumentationFormatterHTML.h" -#include "cmDocumentationSection.h" -#include "cmVersion.h" -//---------------------------------------------------------------------------- -static bool cmDocumentationIsHyperlinkChar(char c) -{ - // This is not a complete list but works for CMake documentation. - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || c == '.' || c == '/' || c == '~' || c == '@' || - c == ':' || c == '_' || c == '&' || c == '?' || c == '='); -} - -//---------------------------------------------------------------------------- -static void cmDocumentationPrintHTMLChar(std::ostream& os, char c) -{ - // Use an escape sequence if necessary. - switch (c) - { - case '<': - os << "<"; - break; - case '>': - os << ">"; - break; - case '&': - os << "&"; - break; - case '\n': - os << "<br />"; - break; - default: - os << c; - } -} - -//---------------------------------------------------------------------------- -bool cmDocumentationHTMLIsIdChar(char c) -{ - // From the HTML specification: - // ID and NAME tokens must begin with a letter ([A-Za-z]) and may - // be followed by any number of letters, digits ([0-9]), hyphens - // ("-"), underscores ("_"), colons (":"), and periods ("."). - return ((c >= 'A' && c <= 'Z') || - (c >= 'a' && c <= 'z') || - (c >= '0' && c <= '9') || - c == '-' || c == '_' || c == ':' || c == '.'); -} - -//---------------------------------------------------------------------------- -void cmDocumentationPrintHTMLId(std::ostream& os, const char* begin) -{ - for(const char* c = begin; *c; ++c) - { - if(cmDocumentationHTMLIsIdChar(*c)) - { - os << *c; - } - } -} - -//---------------------------------------------------------------------------- -const char* cmDocumentationPrintHTMLLink(std::ostream& os, const char* begin) -{ - // Look for the end of the link. - const char* end = begin; - while(cmDocumentationIsHyperlinkChar(*end)) - { - ++end; - } - - // Print the hyperlink itself. - os << "<a href=\""; - for(const char* c = begin; c != end; ++c) - { - cmDocumentationPrintHTMLChar(os, *c); - } - os << "\">"; - - // The name of the hyperlink is the text itself. - for(const char* c = begin; c != end; ++c) - { - cmDocumentationPrintHTMLChar(os, *c); - } - os << "</a>"; - - // Return the position at which to continue scanning the input - // string. - return end; -} - - -cmDocumentationFormatterHTML::cmDocumentationFormatterHTML() -:cmDocumentationFormatter() -{ -} - -void cmDocumentationFormatterHTML -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - std::string prefix = this->ComputeSectionLinkPrefix(name); - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - - // skip the index if the help for only a single item (--help-command, - // --help-policy, --help-property, --help-module) is printed - bool isSingleItemHelp = ((name!=0) && (strcmp(name, "SingleItem")==0)); - - if (!isSingleItemHelp) - { - if (name) - { - os << "<h2><a name=\"section_"; - cmDocumentationPrintHTMLId(os, name); - os << "\"></a>" << name << "</h2>\n"; - } - - // Is a list needed? - for(std::vector<cmDocumentationEntry>::const_iterator op - = entries.begin(); op != entries.end(); ++ op ) - { - if (op->Name.size()) - { - os << "<ul>\n"; - for(;op != entries.end() && op->Name.size(); ++op) - { - if(op->Name.size()) - { - os << " <li><a href=\"#" << prefix << ":"; - cmDocumentationPrintHTMLId(os, op->Name.c_str()); - os << "\"><b><code>"; - this->PrintHTMLEscapes(os, op->Name.c_str()); - os << "</code></b></a></li>\n"; - } - } - os << "</ul>\n" ; - break; // Skip outer loop termination test - } - } - } - - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end();) - { - if(op->Name.size()) - { - os << "<ul>\n"; - for(;op != entries.end() && op->Name.size(); ++op) - { - os << " <li>\n"; - if(op->Name.size()) - { - os << " <a name=\"" << prefix << ":"; - cmDocumentationPrintHTMLId(os, op->Name.c_str()); - os << "\"></a><b><code>"; - this->PrintHTMLEscapes(os, op->Name.c_str()); - os << "</code></b>: "; - } - this->PrintHTMLEscapes(os, op->Brief.c_str()); - if(op->Full.size()) - { - os << "<br />\n "; - this->PrintFormatted(os, op->Full.c_str()); - } - os << "\n"; - os << " </li>\n"; - } - os << "</ul>\n"; - } - else - { - this->PrintFormatted(os, op->Brief.c_str()); - os << "\n"; - ++op; - } - } -} - -void cmDocumentationFormatterHTML::PrintPreformatted(std::ostream& os, - const char* text) -{ - os << "<pre>"; - this->PrintHTMLEscapes(os, text); - os << "</pre>\n "; -} - -void cmDocumentationFormatterHTML::PrintParagraph(std::ostream& os, - const char* text) -{ - os << "<p>"; - this->PrintHTMLEscapes(os, text); - os << "</p>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterHTML::PrintHeader(const char* docname, - const char* appname, - std::ostream& os) -{ - os << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" - << " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n"; - os << "<html xmlns=\"http://www.w3.org/1999/xhtml\"" - << " xml:lang=\"en\" lang=\"en\">\n"; - os << "<head><meta http-equiv=\"Content-Type\" " - << "content=\"text/html;charset=utf-8\" /><title>"; - os << docname << " - " << appname; - os << "</title></head><body>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterHTML::PrintFooter(std::ostream& os) -{ - os << "</body></html>\n"; -} - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterHTML::PrintHTMLEscapes(std::ostream& os, - const char* text) -{ - // Hyperlink prefixes. - static const char* hyperlinks[] = {"http://", "ftp://", "mailto:", 0}; - - // Print each character. - for(const char* p = text; *p;) - { - // Handle hyperlinks specially to make them active. - bool found_hyperlink = false; - for(const char** h = hyperlinks; !found_hyperlink && *h; ++h) - { - if(strncmp(p, *h, strlen(*h)) == 0) - { - p = cmDocumentationPrintHTMLLink(os, p); - found_hyperlink = true; - } - } - - // Print other characters normally. - if(!found_hyperlink) - { - cmDocumentationPrintHTMLChar(os, *p++); - } - } -} - -void cmDocumentationFormatterHTML -::PrintIndex(std::ostream& os, - std::vector<const cmDocumentationSection *>& sections) -{ - // skip the index if only the help for a single item is printed - if ((sections.size() == 1) - && (sections[0]->GetName(this->GetForm()) != 0 ) - && (std::string(sections[0]->GetName(this->GetForm())) == "SingleItem")) - { - return; - } - - os << "<h2><a name=\"section_Index\"></a>Master Index " - << "CMake " << cmVersion::GetCMakeVersion() - << "</h2>\n"; - - if (!sections.empty()) - { - os << "<ul>\n"; - for(unsigned int i=0; i < sections.size(); ++i) - { - std::string name = sections[i]->GetName((this->GetForm())); - os << " <li><a href=\"#section_"; - cmDocumentationPrintHTMLId(os, name.c_str()); - os << "\"><b>" << name << "</b></a></li>\n"; - } - os << "</ul>\n"; - } -} diff --git a/Source/cmDocumentationFormatterHTML.h b/Source/cmDocumentationFormatterHTML.h deleted file mode 100644 index 44bf240..0000000 --- a/Source/cmDocumentationFormatterHTML.h +++ /dev/null @@ -1,42 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterHTML_h -#define _cmDocumentationFormatterHTML_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as HTML. */ -class cmDocumentationFormatterHTML : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterHTML(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::HTMLForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintFooter(std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - virtual void PrintIndex(std::ostream& , - std::vector<const cmDocumentationSection *>&); -private: - void PrintHTMLEscapes(std::ostream& os, const char* text); -}; - -#endif diff --git a/Source/cmDocumentationFormatterMan.cxx b/Source/cmDocumentationFormatterMan.cxx deleted file mode 100644 index 4123c85..0000000 --- a/Source/cmDocumentationFormatterMan.cxx +++ /dev/null @@ -1,102 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ - -#include "cmDocumentationFormatterMan.h" -#include "cmDocumentationSection.h" - -#include "cmSystemTools.h" -#include "cmVersion.h" - - -cmDocumentationFormatterMan::cmDocumentationFormatterMan() -:cmDocumentationFormatter() -,ManSection(1) -{ -} - -void cmDocumentationFormatterMan::SetManSection(int manSection) -{ - this->ManSection = manSection; -} - -void cmDocumentationFormatterMan -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - if(name) - { - os << ".SH " << name << "\n"; - } - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << ".TP\n" - << ".B " << (op->Name.size()?op->Name.c_str():"*") << "\n"; - this->PrintFormatted(os, op->Brief.c_str()); - this->PrintFormatted(os, op->Full.c_str()); - } - else - { - os << ".PP\n"; - this->PrintFormatted(os, op->Brief.c_str()); - } - } -} - -void cmDocumentationFormatterMan::EscapeText(std::string& man_text) -{ - cmSystemTools::ReplaceString(man_text, "\\", "\\\\"); - cmSystemTools::ReplaceString(man_text, "-", "\\-"); -} - -void cmDocumentationFormatterMan::PrintPreformatted(std::ostream& os, - const char* text) -{ - std::string man_text = text; - this->EscapeText(man_text); - os << ".nf\n" << man_text; - if (*text && man_text.at(man_text.length()-1) != '\n') - os << "\n"; - os << ".fi\n\n"; -} - -void cmDocumentationFormatterMan::PrintParagraph(std::ostream& os, - const char* text) -{ - std::string man_text = text; - this->EscapeText(man_text); - os << man_text << "\n\n"; -} - - -//---------------------------------------------------------------------------- -void cmDocumentationFormatterMan::PrintHeader(const char* docname, - const char* appname, - std::ostream& os) -{ - std::string s_docname(docname), s_appname(appname); - - this->EscapeText(s_docname); - this->EscapeText(s_appname); - os << ".TH " << s_docname << " " << this->ManSection << " \"" - << cmSystemTools::GetCurrentDateTime("%B %d, %Y").c_str() - << "\" \"" << s_appname - << " " << cmVersion::GetCMakeVersion() - << "\"\n"; -} - diff --git a/Source/cmDocumentationFormatterMan.h b/Source/cmDocumentationFormatterMan.h deleted file mode 100644 index b3d069c..0000000 --- a/Source/cmDocumentationFormatterMan.h +++ /dev/null @@ -1,43 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterMan_h -#define _cmDocumentationFormatterMan_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as man page. */ -class cmDocumentationFormatterMan : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterMan(); - - void SetManSection(int manSection); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::ManForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - -private: - void EscapeText(std::string& man_text); - int ManSection; -}; - -#endif diff --git a/Source/cmDocumentationFormatterText.cxx b/Source/cmDocumentationFormatterText.cxx deleted file mode 100644 index 5def194..0000000 --- a/Source/cmDocumentationFormatterText.cxx +++ /dev/null @@ -1,180 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ - -#include "cmDocumentationFormatterText.h" -#include "cmDocumentationSection.h" - -cmDocumentationFormatterText::cmDocumentationFormatterText() -:cmDocumentationFormatter() -,TextWidth(77) -,TextIndent("") -{ -} - -void cmDocumentationFormatterText -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - if(name && (strcmp(name, "SingleItem")!=0)) - { - os << - "---------------------------------------" - "---------------------------------------\n"; - os << name << "\n\n"; - } - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << " " << op->Name << "\n"; - this->TextIndent = " "; - this->PrintFormatted(os, op->Brief.c_str()); - if(op->Full.size()) - { - os << "\n"; - this->PrintFormatted(os, op->Full.c_str()); - } - } - else - { - this->TextIndent = ""; - this->PrintFormatted(os, op->Brief.c_str()); - } - os << "\n"; - } -} - -void cmDocumentationFormatterText::PrintPreformatted(std::ostream& os, - const char* text) -{ - bool newline = true; - for(const char* ptr = text; *ptr; ++ptr) - { - if(newline && *ptr != '\n') - { - os << this->TextIndent; - newline = false; - } - os << *ptr; - if(*ptr == '\n') - { - newline = true; - } - } - os << "\n"; -} - -void cmDocumentationFormatterText::PrintParagraph(std::ostream& os, - const char* text) -{ - os << this->TextIndent; - this->PrintColumn(os, text); - os << "\n"; -} - -void cmDocumentationFormatterText::SetIndent(const char* indent) -{ - this->TextIndent = indent; -} - -void cmDocumentationFormatterText::PrintColumn(std::ostream& os, - const char* text) -{ - // Print text arranged in an indented column of fixed witdh. - const char* l = text; - long column = 0; - bool newSentence = false; - bool firstLine = true; - int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent)); - - // Loop until the end of the text. - while(*l) - { - // Parse the next word. - const char* r = l; - while(*r && (*r != '\n') && (*r != ' ')) { ++r; } - - // Does it fit on this line? - if(r-l < (width-column-(newSentence?1:0))) - { - // Word fits on this line. - if(r > l) - { - if(column) - { - // Not first word on line. Separate from the previous word - // by a space, or two if this is a new sentence. - if(newSentence) - { - os << " "; - column += 2; - } - else - { - os << " "; - column += 1; - } - } - else - { - // First word on line. Print indentation unless this is the - // first line. - os << (firstLine?"":this->TextIndent); - } - - // Print the word. - os.write(l, static_cast<long>(r-l)); - newSentence = (*(r-1) == '.'); - } - - if(*r == '\n') - { - // Text provided a newline. Start a new line. - os << "\n"; - ++r; - column = 0; - firstLine = false; - } - else - { - // No provided newline. Continue this line. - column += static_cast<long>(r-l); - } - } - else - { - // Word does not fit on this line. Start a new line. - os << "\n"; - firstLine = false; - if(r > l) - { - os << this->TextIndent; - os.write(l, static_cast<long>(r-l)); - column = static_cast<long>(r-l); - newSentence = (*(r-1) == '.'); - } - else - { - column = 0; - } - } - - // Move to beginning of next word. Skip over whitespace. - l = r; - while(*l && (*l == ' ')) { ++l; } - } -} diff --git a/Source/cmDocumentationFormatterText.h b/Source/cmDocumentationFormatterText.h deleted file mode 100644 index d9c2af2..0000000 --- a/Source/cmDocumentationFormatterText.h +++ /dev/null @@ -1,40 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterText_h -#define _cmDocumentationFormatterText_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as plain text. */ -class cmDocumentationFormatterText : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterText(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::TextForm;} - - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - void PrintColumn(std::ostream& os, const char* text); - void SetIndent(const char* indent); -protected: - int TextWidth; - const char* TextIndent; -}; - -#endif diff --git a/Source/cmDocumentationFormatterUsage.cxx b/Source/cmDocumentationFormatterUsage.cxx deleted file mode 100644 index a068e56..0000000 --- a/Source/cmDocumentationFormatterUsage.cxx +++ /dev/null @@ -1,63 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ - -#include "cmDocumentationFormatterUsage.h" -#include "cmDocumentationSection.h" - -cmDocumentationFormatterUsage::cmDocumentationFormatterUsage() -:cmDocumentationFormatterText() -{ -} - -void cmDocumentationFormatterUsage -::PrintSection(std::ostream& os, - const cmDocumentationSection §ion, - const char* name) -{ - if(name) - { - os << name << "\n"; - } - - const std::vector<cmDocumentationEntry> &entries = - section.GetEntries(); - for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); - op != entries.end(); ++op) - { - if(op->Name.size()) - { - os << " " << op->Name; - this->TextIndent = " "; - int align = static_cast<int>(strlen(this->TextIndent))-4; - for(int i = static_cast<int>(op->Name.size()); i < align; ++i) - { - os << " "; - } - if (op->Name.size() > strlen(this->TextIndent)-4 ) - { - os << "\n"; - os.write(this->TextIndent, strlen(this->TextIndent)-2); - } - os << "= "; - this->PrintColumn(os, op->Brief.c_str()); - os << "\n"; - } - else - { - os << "\n"; - this->TextIndent = ""; - this->PrintFormatted(os, op->Brief.c_str()); - } - } - os << "\n"; -} - diff --git a/Source/cmDocumentationFormatterUsage.h b/Source/cmDocumentationFormatterUsage.h deleted file mode 100644 index 3ed3442..0000000 --- a/Source/cmDocumentationFormatterUsage.h +++ /dev/null @@ -1,31 +0,0 @@ -/*============================================================================ - CMake - Cross Platform Makefile Generator - Copyright 2000-2009 Kitware, Inc., Insight Software Consortium - - Distributed under the OSI-approved BSD License (the "License"); - see accompanying file Copyright.txt for details. - - This software is distributed WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - See the License for more information. -============================================================================*/ -#ifndef _cmDocumentationFormatterUsage_h -#define _cmDocumentationFormatterUsage_h - -#include "cmDocumentationFormatterText.h" - -/** Class to print the documentation as usage on the command line. */ -class cmDocumentationFormatterUsage : public cmDocumentationFormatterText -{ -public: - cmDocumentationFormatterUsage(); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::UsageForm;} - - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); -}; - -#endif diff --git a/Source/cmDocumentationSection.cxx b/Source/cmDocumentationSection.cxx index a2dfe70..b0dd8ef 100644 --- a/Source/cmDocumentationSection.cxx +++ b/Source/cmDocumentationSection.cxx @@ -13,69 +13,33 @@ //---------------------------------------------------------------------------- -void cmDocumentationSection::Append(const char *data[][3]) +void cmDocumentationSection::Append(const char *data[][2]) { int i = 0; while(data[i][1]) { this->Entries.push_back(cmDocumentationEntry(data[i][0], - data[i][1], - data[i][2])); + data[i][1])); data += 1; } } //---------------------------------------------------------------------------- -void cmDocumentationSection::Prepend(const char *data[][3]) +void cmDocumentationSection::Prepend(const char *data[][2]) { std::vector<cmDocumentationEntry> tmp; int i = 0; while(data[i][1]) { tmp.push_back(cmDocumentationEntry(data[i][0], - data[i][1], - data[i][2])); + data[i][1])); data += 1; } this->Entries.insert(this->Entries.begin(),tmp.begin(),tmp.end()); } //---------------------------------------------------------------------------- -void cmDocumentationSection::Append(const char *n, const char *b, - const char *f) +void cmDocumentationSection::Append(const char *n, const char *b) { - this->Entries.push_back(cmDocumentationEntry(n,b,f)); + this->Entries.push_back(cmDocumentationEntry(n,b)); } - -#if 0 -//---------------------------------------------------------------------------- -void cmDocumentationSection::Set(const cmDocumentationEntry* header, - const cmDocumentationEntry* section, - const cmDocumentationEntry* footer) -{ - this->Entries.erase(this->Entries.begin(), this->Entries.end()); - if(header) - { - for(const cmDocumentationEntry* op = header; op->brief; ++op) - { - this->Entries.push_back(*op); - } - } - if(section) - { - for(const cmDocumentationEntry* op = section; op->brief; ++op) - { - this->Entries.push_back(*op); - } - } - if(footer) - { - for(const cmDocumentationEntry* op = footer; op->brief; ++op) - { - this->Entries.push_back(*op); - } - } - cmDocumentationEntry empty = {0,0,0}; - this->Entries.push_back(empty); -} -#endif diff --git a/Source/cmDocumentationSection.h b/Source/cmDocumentationSection.h index 4f8c10d..636860d 100644 --- a/Source/cmDocumentationSection.h +++ b/Source/cmDocumentationSection.h @@ -24,8 +24,8 @@ class cmDocumentationSection { public: /** Create a cmSection, with a special name for man-output mode. */ - cmDocumentationSection(const char* name, const char* manName) - :Name(name), ManName(manName) {} + cmDocumentationSection(const char* name, const char*) + :Name(name) {} /** Has any content been added to this section or is it empty ? */ bool IsEmpty() const { return this->Entries.empty(); } @@ -33,10 +33,9 @@ public: /** Clear contents. */ void Clear() { this->Entries.clear(); } - /** Return the name of this section for the given output form. */ - const char* GetName(cmDocumentationEnums::Form form) const - { return (form==cmDocumentationEnums::ManForm ? - this->ManName.c_str() : this->Name.c_str()); } + /** Return the name of this section. */ + const char* GetName() const + { return this->Name.c_str(); } /** Return a pointer to the first entry of this section. */ const std::vector<cmDocumentationEntry> &GetEntries() const @@ -49,11 +48,11 @@ public: { this->Entries.insert(this->Entries.end(),entries.begin(),entries.end()); } /** Append an entry to this section using NULL terminated chars */ - void Append(const char *[][3]); - void Append(const char *n, const char *b, const char *f); + void Append(const char *[][2]); + void Append(const char *n, const char *b); /** prepend some documentation to this section */ - void Prepend(const char *[][3]); + void Prepend(const char *[][2]); void Prepend(const std::vector<cmDocumentationEntry> &entries) { this->Entries.insert(this->Entries.begin(), entries.begin(),entries.end()); } @@ -61,7 +60,6 @@ public: private: std::string Name; - std::string ManName; std::vector<cmDocumentationEntry> Entries; }; diff --git a/Source/cmElseCommand.h b/Source/cmElseCommand.h index f259919..d472e99 100644 --- a/Source/cmElseCommand.h +++ b/Source/cmElseCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const { return "else";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Starts the else portion of an if block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " else(expression)\n" - "See the if command."; - } - cmTypeMacro(cmElseCommand, cmCommand); }; diff --git a/Source/cmElseIfCommand.h b/Source/cmElseIfCommand.h index 46e2bd9..d811b35 100644 --- a/Source/cmElseIfCommand.h +++ b/Source/cmElseIfCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const { return "elseif";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Starts the elseif portion of an if block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " elseif(expression)\n" - "See the if command."; - } - cmTypeMacro(cmElseIfCommand, cmCommand); }; diff --git a/Source/cmEnableLanguageCommand.h b/Source/cmEnableLanguageCommand.h index 747448b..a248042 100644 --- a/Source/cmEnableLanguageCommand.h +++ b/Source/cmEnableLanguageCommand.h @@ -45,37 +45,6 @@ public: */ virtual const char* GetName() const {return "enable_language";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Enable a language (CXX/C/Fortran/etc)"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " enable_language(<lang> [OPTIONAL] )\n" - "This command enables support for the named language in CMake. " - "This is the same as the project command but does not create " - "any of the extra variables that are created by the project command. " - "Example languages are CXX, C, Fortran. " - "\n" - "This command must be called in file scope, not in a function call. " - "Furthermore, it must be called in the highest directory common to " - "all targets using the named language directly for compiling sources " - "or indirectly through link dependencies. " - "It is simplest to enable all needed languages in the top-level " - "directory of a project." - "\n" - "The OPTIONAL keyword is a placeholder for future implementation " - "and does not currently work."; - } - cmTypeMacro(cmEnableLanguageCommand, cmCommand); }; diff --git a/Source/cmEnableTestingCommand.h b/Source/cmEnableTestingCommand.h index 9b9e985..e102f5e 100644 --- a/Source/cmEnableTestingCommand.h +++ b/Source/cmEnableTestingCommand.h @@ -50,27 +50,6 @@ public: */ virtual const char* GetName() const { return "enable_testing";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Enable testing for current directory and below."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " enable_testing()\n" - "Enables testing for this directory and below. " - "See also the add_test command. Note that ctest expects to find " - "a test file in the build directory root. Therefore, this command " - "should be in the source directory root."; - } - cmTypeMacro(cmEnableTestingCommand, cmCommand); }; diff --git a/Source/cmEndForEachCommand.h b/Source/cmEndForEachCommand.h index d5ee8a6..44d29b5 100644 --- a/Source/cmEndForEachCommand.h +++ b/Source/cmEndForEachCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endforeach";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a FOREACH block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endforeach(expression)\n" - "See the FOREACH command."; - } - cmTypeMacro(cmEndForEachCommand, cmCommand); }; diff --git a/Source/cmEndFunctionCommand.h b/Source/cmEndFunctionCommand.h index d7b74e9..4fdca6b 100644 --- a/Source/cmEndFunctionCommand.h +++ b/Source/cmEndFunctionCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endfunction";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a function block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endfunction(expression)\n" - "See the function command."; - } - cmTypeMacro(cmEndFunctionCommand, cmCommand); }; diff --git a/Source/cmEndIfCommand.h b/Source/cmEndIfCommand.h index 5c4b9e3..634da60 100644 --- a/Source/cmEndIfCommand.h +++ b/Source/cmEndIfCommand.h @@ -47,24 +47,6 @@ public: */ virtual const char* GetName() const { return "endif";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in an if block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endif(expression)\n" - "See the if command."; - } - cmTypeMacro(cmEndIfCommand, cmCommand); }; diff --git a/Source/cmEndMacroCommand.h b/Source/cmEndMacroCommand.h index 9d0e70f..db15f27 100644 --- a/Source/cmEndMacroCommand.h +++ b/Source/cmEndMacroCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endmacro";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a macro block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endmacro(expression)\n" - "See the macro command."; - } - cmTypeMacro(cmEndMacroCommand, cmCommand); }; diff --git a/Source/cmEndWhileCommand.h b/Source/cmEndWhileCommand.h index 18ba5ea..41138d1 100644 --- a/Source/cmEndWhileCommand.h +++ b/Source/cmEndWhileCommand.h @@ -54,24 +54,6 @@ public: */ virtual const char* GetName() const { return "endwhile";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Ends a list of commands in a while block."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " endwhile(expression)\n" - "See the while command."; - } - cmTypeMacro(cmEndWhileCommand, cmCommand); }; diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h index f752501..4892dd8 100644 --- a/Source/cmExecProgramCommand.h +++ b/Source/cmExecProgramCommand.h @@ -50,39 +50,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Deprecated. Use the execute_process() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Run an executable program during the processing of the CMakeList.txt" - " file.\n" - " exec_program(Executable [directory in which to run]\n" - " [ARGS <arguments to executable>]\n" - " [OUTPUT_VARIABLE <var>]\n" - " [RETURN_VALUE <var>])\n" - "The executable is run in the optionally specified directory. The " - "executable can include arguments if it is double quoted, but it is " - "better to use the optional ARGS argument to specify arguments to the " - "program. This is because cmake will then be able to escape spaces " - "in the executable path. An optional argument OUTPUT_VARIABLE " - "specifies a variable in which to store the output. " - "To capture the return value of the execution, provide a RETURN_VALUE. " - "If OUTPUT_VARIABLE is specified, then no output will go to the " - "stdout/stderr of the console running cmake.\n" - ; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmExecuteProcessCommand.h b/Source/cmExecuteProcessCommand.h index 0e20a4b..bd0f783 100644 --- a/Source/cmExecuteProcessCommand.h +++ b/Source/cmExecuteProcessCommand.h @@ -49,64 +49,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Execute one or more child processes."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " execute_process(COMMAND <cmd1> [args1...]]\n" - " [COMMAND <cmd2> [args2...] [...]]\n" - " [WORKING_DIRECTORY <directory>]\n" - " [TIMEOUT <seconds>]\n" - " [RESULT_VARIABLE <variable>]\n" - " [OUTPUT_VARIABLE <variable>]\n" - " [ERROR_VARIABLE <variable>]\n" - " [INPUT_FILE <file>]\n" - " [OUTPUT_FILE <file>]\n" - " [ERROR_FILE <file>]\n" - " [OUTPUT_QUIET]\n" - " [ERROR_QUIET]\n" - " [OUTPUT_STRIP_TRAILING_WHITESPACE]\n" - " [ERROR_STRIP_TRAILING_WHITESPACE])\n" - "Runs the given sequence of one or more commands with the standard " - "output of each process piped to the standard input of the next. " - "A single standard error pipe is used for all processes. " - "If WORKING_DIRECTORY is given the named directory will be set as " - "the current working directory of the child processes. " - "If TIMEOUT is given the child processes will be terminated if they " - "do not finish in the specified number of seconds " - "(fractions are allowed). " - "If RESULT_VARIABLE is given the variable will be set to contain " - "the result of running the processes. This will be an integer return " - "code from the last child or a string describing an error condition. " - "If OUTPUT_VARIABLE or ERROR_VARIABLE are given the variable named " - "will be set with the contents of the standard output and standard " - "error pipes respectively. If the same variable is named for both " - "pipes their output will be merged in the order produced. " - "If INPUT_FILE, OUTPUT_FILE, or ERROR_FILE is given the file named " - "will be attached to the standard input of the first process, " - "standard output of the last process, or standard error of all " - "processes respectively. " - "If OUTPUT_QUIET or ERROR_QUIET is given then the standard output " - "or standard error results will be quietly ignored. " - "If more than one OUTPUT_* or ERROR_* option is given for the same " - "pipe the precedence is not specified. " - "If no OUTPUT_* or ERROR_* options are given the output will be shared " - "with the corresponding pipes of the CMake process itself.\n" - "The execute_process command is a newer more powerful version of " - "exec_program, but the old command has been kept for compatibility." - ; - } - cmTypeMacro(cmExecuteProcessCommand, cmCommand); }; diff --git a/Source/cmExportCommand.h b/Source/cmExportCommand.h index 38e8d9a..ea7c3a3 100644 --- a/Source/cmExportCommand.h +++ b/Source/cmExportCommand.h @@ -13,7 +13,6 @@ #define cmExportCommand_h #include "cmCommand.h" -#include "cmDocumentLocationUndefined.h" class cmExportBuildFileGenerator; @@ -47,61 +46,6 @@ public: */ virtual const char* GetName() const { return "export";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Export targets from the build tree for use by outside projects."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>]\n" - " [APPEND] FILE <filename> [EXPORT_LINK_INTERFACE_LIBRARIES])\n" - "Create a file <filename> that may be included by outside projects to " - "import targets from the current project's build tree. " - "This is useful during cross-compiling to build utility executables " - "that can run on the host platform in one project and then import " - "them into another project being compiled for the target platform. " - "If the NAMESPACE option is given the <namespace> string will be " - "prepended to all target names written to the file. " - "If the APPEND option is given the generated code will be appended " - "to the file instead of overwriting it. " - "The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the " - "contents of the properties matching " - "(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? to be exported, when " - "policy CMP0022 is NEW. " - "If a library target is included in the export but " - "a target to which it links is not included the behavior is " - "unspecified." - "\n" - "The file created by this command is specific to the build tree and " - "should never be installed. " - "See the install(EXPORT) command to export targets from an " - "installation tree." - "\n" - "The properties set on the generated IMPORTED targets will have the " - "same values as the final values of the input TARGETS." - "\n" - " export(PACKAGE <name>)\n" - "Store the current build directory in the CMake user package registry " - "for package <name>. " - "The find_package command may consider the directory while searching " - "for package <name>. " - "This helps dependent projects find and use a package from the " - "current project's build tree without help from the user. " - "Note that the entry in the package registry that this command " - "creates works only in conjunction with a package configuration " - "file (<name>Config.cmake) that works with the build tree." - ; - } - cmTypeMacro(cmExportCommand, cmCommand); private: diff --git a/Source/cmExportLibraryDependencies.h b/Source/cmExportLibraryDependencies.h index d8b65cc..a384a7c 100644 --- a/Source/cmExportLibraryDependencies.h +++ b/Source/cmExportLibraryDependencies.h @@ -50,38 +50,6 @@ public: */ virtual const char* GetName() const { return "export_library_dependencies";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use INSTALL(EXPORT) or EXPORT command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command generates an old-style library dependencies file. " - "Projects requiring CMake 2.6 or later should not use the command. " - "Use instead the install(EXPORT) command to help export targets " - "from an installation tree and the export() command to export targets " - "from a build tree.\n" - "The old-style library dependencies file does not take into account " - "per-configuration names of libraries or the LINK_INTERFACE_LIBRARIES " - "target property.\n" - " export_library_dependencies(<file> [APPEND])\n" - "Create a file named <file> that can be included into a CMake listfile " - "with the INCLUDE command. The file will contain a number of SET " - "commands that will set all the variables needed for library dependency " - "information. This should be the last command in the top level " - "CMakeLists.txt file of the project. If the APPEND option is " - "specified, the SET commands will be appended to the given file " - "instead of replacing it."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmExtraCodeBlocksGenerator.cxx b/Source/cmExtraCodeBlocksGenerator.cxx index dfbb1c0..1e799b8 100644 --- a/Source/cmExtraCodeBlocksGenerator.cxx +++ b/Source/cmExtraCodeBlocksGenerator.cxx @@ -42,13 +42,6 @@ void cmExtraCodeBlocksGenerator { entry.Name = this->GetName(); entry.Brief = "Generates CodeBlocks project files."; - entry.Full = - "Project files for CodeBlocks will be created in the top directory " - "and in every subdirectory which features a CMakeLists.txt file " - "containing a PROJECT() call. " - "Additionally a hierarchy of makefiles is generated into the " - "build tree. The appropriate make program can build the project through " - "the default make target. A \"make install\" target is also provided."; } cmExtraCodeBlocksGenerator::cmExtraCodeBlocksGenerator() diff --git a/Source/cmExtraEclipseCDT4Generator.cxx b/Source/cmExtraEclipseCDT4Generator.cxx index d80e775..bd3d669 100644 --- a/Source/cmExtraEclipseCDT4Generator.cxx +++ b/Source/cmExtraEclipseCDT4Generator.cxx @@ -48,13 +48,6 @@ void cmExtraEclipseCDT4Generator { entry.Name = this->GetName(); entry.Brief = "Generates Eclipse CDT 4.0 project files."; - entry.Full = - "Project files for Eclipse will be created in the top directory. " - "In out of source builds, a linked resource to the top level source " - "directory will be created. " - "Additionally a hierarchy of makefiles is generated into the " - "build tree. The appropriate make program can build the project through " - "the default make target. A \"make install\" target is also provided."; } //---------------------------------------------------------------------------- diff --git a/Source/cmExtraSublimeTextGenerator.cxx b/Source/cmExtraSublimeTextGenerator.cxx index 523fca9..baed733 100644 --- a/Source/cmExtraSublimeTextGenerator.cxx +++ b/Source/cmExtraSublimeTextGenerator.cxx @@ -45,13 +45,6 @@ void cmExtraSublimeTextGenerator { entry.Name = this->GetName(); entry.Brief = "Generates Sublime Text 2 project files."; - entry.Full = - "Project files for Sublime Text 2 will be created in the top directory " - "and in every subdirectory which features a CMakeLists.txt file " - "containing a PROJECT() call. " - "Additionally Makefiles (or build.ninja files) are generated into the " - "build tree. The appropriate make program can build the project through " - "the default make target. A \"make install\" target is also provided."; } cmExtraSublimeTextGenerator::cmExtraSublimeTextGenerator() diff --git a/Source/cmFLTKWrapUICommand.h b/Source/cmFLTKWrapUICommand.h index 530de2c..b94390c 100644 --- a/Source/cmFLTKWrapUICommand.h +++ b/Source/cmFLTKWrapUICommand.h @@ -54,28 +54,6 @@ public: */ virtual const char* GetName() const { return "fltk_wrap_ui";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create FLTK user interfaces Wrappers."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " fltk_wrap_ui(resultingLibraryName source1\n" - " source2 ... sourceN )\n" - "Produce .h and .cxx files for all the .fl and .fld files listed. " - "The resulting .h and .cxx files will be added to a variable named " - "resultingLibraryName_FLTK_UI_SRCS which should be added to your " - "library."; - } - private: /** * List of produced files. diff --git a/Source/cmFileCommand.h b/Source/cmFileCommand.h index aa755d1..ba45815 100644 --- a/Source/cmFileCommand.h +++ b/Source/cmFileCommand.h @@ -48,213 +48,6 @@ public: */ virtual const char* GetName() const { return "file";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "File manipulation command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " file(WRITE filename \"message to write\"... )\n" - " file(APPEND filename \"message to write\"... )\n" - " file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])\n" - " file(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> filename variable)\n" - " file(STRINGS filename variable [LIMIT_COUNT num]\n" - " [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]\n" - " [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]\n" - " [NEWLINE_CONSUME] [REGEX regex]\n" - " [NO_HEX_CONVERSION])\n" - " file(GLOB variable [RELATIVE path] [globbing expressions]...)\n" - " file(GLOB_RECURSE variable [RELATIVE path] \n" - " [FOLLOW_SYMLINKS] [globbing expressions]...)\n" - " file(RENAME <oldname> <newname>)\n" - " file(REMOVE [file1 ...])\n" - " file(REMOVE_RECURSE [file1 ...])\n" - " file(MAKE_DIRECTORY [directory1 directory2 ...])\n" - " file(RELATIVE_PATH variable directory file)\n" - " file(TO_CMAKE_PATH path result)\n" - " file(TO_NATIVE_PATH path result)\n" - " file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout]\n" - " [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]\n" - " [EXPECTED_HASH ALGO=value] [EXPECTED_MD5 sum]\n" - " [TLS_VERIFY on|off] [TLS_CAINFO file])\n" - " file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout]\n" - " [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS])\n" - " file(TIMESTAMP filename variable [<format string>] [UTC])\n" - " file(GENERATE OUTPUT output_file\n" - " <INPUT input_file|CONTENT input_content>\n" - " [CONDITION expression])\n" - "WRITE will write a message into a file called 'filename'. It " - "overwrites the file if it already exists, and creates the file " - "if it does not exist. (If the file is a build input, use " - "configure_file to update the file only when its content changes.)\n" - "APPEND will write a message into a file same as WRITE, except " - "it will append it to the end of the file\n" - "READ will read the content of a file and store it into the " - "variable. It will start at the given offset and read up to numBytes. " - "If the argument HEX is given, the binary data will be converted to " - "hexadecimal representation and this will be stored in the variable.\n" - "MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 " - "will compute a cryptographic hash of the content of a file.\n" - "STRINGS will parse a list of ASCII strings from a file and " - "store it in a variable. Binary data in the file are ignored. Carriage " - "return (CR) characters are ignored. It works also for Intel Hex and " - "Motorola S-record files, which are automatically converted to binary " - "format when reading them. Disable this using NO_HEX_CONVERSION.\n" - "LIMIT_COUNT sets the maximum number of strings to return. " - "LIMIT_INPUT sets the maximum number of bytes to read from " - "the input file. " - "LIMIT_OUTPUT sets the maximum number of bytes to store in the " - "output variable. " - "LENGTH_MINIMUM sets the minimum length of a string to return. " - "Shorter strings are ignored. " - "LENGTH_MAXIMUM sets the maximum length of a string to return. Longer " - "strings are split into strings no longer than the maximum length. " - "NEWLINE_CONSUME allows newlines to be included in strings instead " - "of terminating them.\n" - "REGEX specifies a regular expression that a string must match to be " - "returned. Typical usage \n" - " file(STRINGS myfile.txt myfile)\n" - "stores a list in the variable \"myfile\" in which each item is " - "a line from the input file.\n" - "GLOB will generate a list of all files that match the globbing " - "expressions and store it into the variable. Globbing expressions " - "are similar to regular expressions, but much simpler. If RELATIVE " - "flag is specified for an expression, the results will be returned " - "as a relative path to the given path. " - "(We do not recommend using GLOB to collect a list of source files " - "from your source tree. If no CMakeLists.txt file changes when a " - "source is added or removed then the generated build system cannot " - "know when to ask CMake to regenerate.)" - "\n" - "Examples of globbing expressions include:\n" - " *.cxx - match all files with extension cxx\n" - " *.vt? - match all files with extension vta,...,vtz\n" - " f[3-5].txt - match files f3.txt, f4.txt, f5.txt\n" - "GLOB_RECURSE will generate a list similar to the regular GLOB, except " - "it will traverse all the subdirectories of the matched directory and " - "match the files. Subdirectories that are symlinks are only traversed " - "if FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not set to NEW. " - "See cmake --help-policy CMP0009 for more information.\n" - "Examples of recursive globbing include:\n" - " /dir/*.py - match all python files in /dir and subdirectories\n" - "MAKE_DIRECTORY will create the given directories, also if their parent " - "directories don't exist yet\n" - "RENAME moves a file or directory within a filesystem, " - "replacing the destination atomically." - "\n" - "REMOVE will remove the given files, also in subdirectories\n" - "REMOVE_RECURSE will remove the given files and directories, also " - "non-empty directories\n" - "RELATIVE_PATH will determine relative path from directory to the given" - " file.\n" - "TO_CMAKE_PATH will convert path into a cmake style path with unix /. " - " The input can be a single path or a system path like \"$ENV{PATH}\". " - " Note the double quotes around the ENV call TO_CMAKE_PATH only takes " - " one argument. This command will also convert the native list" - " delimiters for a list of paths like the PATH environment variable.\n" - "TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will convert from " - " a cmake style path into the native path style \\ for windows and / " - "for UNIX.\n" - "DOWNLOAD will download the given URL to the given file. " - "If LOG var is specified a log of the download will be put in var. " - "If STATUS var is specified the status of the operation will" - " be put in var. The status is returned in a list of length 2. " - "The first element is the numeric return value for the operation, " - "and the second element is a string value for the error. A 0 " - "numeric error means no error in the operation. " - "If TIMEOUT time is specified, the operation will " - "timeout after time seconds, time should be specified as an integer. " - "The INACTIVITY_TIMEOUT specifies an integer number of seconds of " - "inactivity after which the operation should terminate. " - "If EXPECTED_HASH ALGO=value is specified, the operation will verify " - "that the downloaded file's actual hash matches the expected value, " - "where ALGO is one of MD5, SHA1, SHA224, SHA256, SHA384, or SHA512. " - "If it does not match, the operation fails with an error. " - "(\"EXPECTED_MD5 sum\" is short-hand for \"EXPECTED_HASH MD5=sum\".) " - "If SHOW_PROGRESS is specified, progress information will be printed " - "as status messages until the operation is complete. " - "For https URLs CMake must be built with OpenSSL. " - "TLS/SSL certificates are not checked by default. " - "Set TLS_VERIFY to ON to check certificates and/or use " - "EXPECTED_HASH to verify downloaded content. " - "Set TLS_CAINFO to specify a custom Certificate Authority file. " - "If either TLS option is not given CMake will check variables " - "CMAKE_TLS_VERIFY and CMAKE_TLS_CAINFO, " - "respectively." - "\n" - "UPLOAD will upload the given file to the given URL. " - "If LOG var is specified a log of the upload will be put in var. " - "If STATUS var is specified the status of the operation will" - " be put in var. The status is returned in a list of length 2. " - "The first element is the numeric return value for the operation, " - "and the second element is a string value for the error. A 0 " - "numeric error means no error in the operation. " - "If TIMEOUT time is specified, the operation will " - "timeout after time seconds, time should be specified as an integer. " - "The INACTIVITY_TIMEOUT specifies an integer number of seconds of " - "inactivity after which the operation should terminate. " - "If SHOW_PROGRESS is specified, progress information will be printed " - "as status messages until the operation is complete." - "\n" - "TIMESTAMP will write a string representation of " - "the modification time of filename to variable.\n" - "Should the command be unable to obtain a timestamp " - "variable will be set to the empty string \"\".\n" - "See documentation of the string TIMESTAMP sub-command for more details." - "\n" - "The file() command also provides COPY and INSTALL signatures:\n" - " file(<COPY|INSTALL> files... DESTINATION <dir>\n" - " [FILE_PERMISSIONS permissions...]\n" - " [DIRECTORY_PERMISSIONS permissions...]\n" - " [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS]\n" - " [FILES_MATCHING]\n" - " [[PATTERN <pattern> | REGEX <regex>]\n" - " [EXCLUDE] [PERMISSIONS permissions...]] [...])\n" - "The COPY signature copies files, directories, and symlinks to a " - "destination folder. " - "Relative input paths are evaluated with respect to the current " - "source directory, and a relative destination is evaluated with " - "respect to the current build directory. " - "Copying preserves input file timestamps, and optimizes out a file " - "if it exists at the destination with the same timestamp. " - "Copying preserves input permissions unless explicit permissions or " - "NO_SOURCE_PERMISSIONS are given (default is USE_SOURCE_PERMISSIONS). " - "See the install(DIRECTORY) command for documentation of permissions, " - "PATTERN, REGEX, and EXCLUDE options. " - "\n" - "The INSTALL signature differs slightly from COPY: " - "it prints status messages, and NO_SOURCE_PERMISSIONS is default. " - "Installation scripts generated by the install() command use this " - "signature (with some undocumented options for internal use)." - "\n" - "GENERATE will write an <output_file> with content from an " - "<input_file>, or from <input_content>. The output is generated " - "conditionally based on the content of the <condition>. The file is " - "written at CMake generate-time and the input may contain generator " - "expressions. The <condition>, <output_file> and <input_file> may " - "also contain generator expressions. The <condition> must evaluate to " - "either '0' or '1'. The <output_file> must evaluate to a unique name " - "among all configurations and among all invocations of file(GENERATE)." - // Undocumented INSTALL options: - // - RENAME <name> - // - OPTIONAL - // - FILES keyword to re-enter files... list - // - PERMISSIONS before REGEX is alias for FILE_PERMISSIONS - // - DIR_PERMISSIONS is alias for DIRECTORY_PERMISSIONS - // - TYPE <FILE|DIRECTORY|EXECUTABLE|PROGRAM| - // STATIC_LIBRARY|SHARED_LIBRARY|MODULE> - // - COMPONENTS, CONFIGURATIONS, PROPERTIES (ignored for compat) - ; - } - cmTypeMacro(cmFileCommand, cmCommand); protected: diff --git a/Source/cmFindBase.cxx b/Source/cmFindBase.cxx index 7ce0032..c1e7b1e 100644 --- a/Source/cmFindBase.cxx +++ b/Source/cmFindBase.cxx @@ -20,106 +20,6 @@ cmFindBase::cmFindBase() } //---------------------------------------------------------------------------- -void cmFindBase::GenerateDocumentation() -{ - this->cmFindCommon::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_ARGS_XXX", "<VAR> NAMES name"); - this->GenericDocumentation = - " FIND_XXX(<VAR> name1 [path1 path2 ...])\n" - "This is the short-hand signature for the command that " - "is sufficient in many cases. It is the same " - "as FIND_XXX(<VAR> name1 [PATHS path1 path2 ...])\n" - " FIND_XXX(\n" - " <VAR>\n" - " name | NAMES name1 [name2 ...]\n" - " [HINTS path1 [path2 ... ENV var]]\n" - " [PATHS path1 [path2 ... ENV var]]\n" - " [PATH_SUFFIXES suffix1 [suffix2 ...]]\n" - " [DOC \"cache documentation string\"]\n" - " [NO_DEFAULT_PATH]\n" - " [NO_CMAKE_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PATH]\n" - " [NO_SYSTEM_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_SYSTEM_PATH]\n" - " [CMAKE_FIND_ROOT_PATH_BOTH |\n" - " ONLY_CMAKE_FIND_ROOT_PATH |\n" - " NO_CMAKE_FIND_ROOT_PATH]\n" - " )\n" - "" - "This command is used to find a SEARCH_XXX_DESC. " - "A cache entry named by <VAR> is created to store the result " - "of this command. " - "If the SEARCH_XXX is found the result is stored in the variable " - "and the search will not be repeated unless the variable is cleared. " - "If nothing is found, the result will be " - "<VAR>-NOTFOUND, and the search will be attempted again the " - "next time FIND_XXX is invoked with the same variable. " - "The name of the SEARCH_XXX that " - "is searched for is specified by the names listed " - "after the NAMES argument. Additional search locations " - "can be specified after the PATHS argument. If ENV var is " - "found in the HINTS or PATHS section the environment variable var " - "will be read and converted from a system environment variable to " - "a cmake style list of paths. For example ENV PATH would be a way " - "to list the system path variable. The argument " - "after DOC will be used for the documentation string in " - "the cache. " - "PATH_SUFFIXES specifies additional subdirectories to check below " - "each search path." - "\n" - "If NO_DEFAULT_PATH is specified, then no additional paths are " - "added to the search. " - "If NO_DEFAULT_PATH is not specified, the search process is as follows:\n" - "1. Search paths specified in cmake-specific cache variables. " - "These are intended to be used on the command line with a -DVAR=value. " - "This can be skipped if NO_CMAKE_PATH is passed.\n" - "XXX_EXTRA_PREFIX_ENTRY" - " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_PREFIX_PATH\n" - " CMAKE_XXX_PATH\n" - " CMAKE_XXX_MAC_PATH\n" - "2. Search paths specified in cmake-specific environment variables. " - "These are intended to be set in the user's shell configuration. " - "This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.\n" - "XXX_EXTRA_PREFIX_ENTRY" - " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_PREFIX_PATH\n" - " CMAKE_XXX_PATH\n" - " CMAKE_XXX_MAC_PATH\n" - "3. Search the paths specified by the HINTS option. " - "These should be paths computed by system introspection, such as a " - "hint provided by the location of another item already found. " - "Hard-coded guesses should be specified with the PATHS option.\n" - "4. Search the standard system environment variables. " - "This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.\n" - " PATH\n" - " XXX_SYSTEM\n" // replace with "", LIB, or INCLUDE - "5. Search cmake variables defined in the Platform files " - "for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH " - "is passed.\n" - "XXX_EXTRA_PREFIX_ENTRY" - " <prefix>/XXX_SUBDIR for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH\n" - " CMAKE_SYSTEM_XXX_PATH\n" - " CMAKE_SYSTEM_XXX_MAC_PATH\n" - "6. Search the paths specified by the PATHS option " - "or in the short-hand version of the command. " - "These are typically hard-coded guesses.\n" - ; - this->GenericDocumentation += this->GenericDocumentationMacPolicy; - this->GenericDocumentation += this->GenericDocumentationRootPath; - this->GenericDocumentation += this->GenericDocumentationPathsOrder; -} - -//---------------------------------------------------------------------------- -const char* cmFindBase::GetFullDocumentation() const -{ - if(this->GenericDocumentation.empty()) - { - const_cast<cmFindBase *>(this)->GenerateDocumentation(); - } - return this->GenericDocumentation.c_str(); -} - -//---------------------------------------------------------------------------- bool cmFindBase::ParseArguments(std::vector<std::string> const& argsIn) { if(argsIn.size() < 2 ) diff --git a/Source/cmFindBase.h b/Source/cmFindBase.h index 84b0330..0562b1b 100644 --- a/Source/cmFindBase.h +++ b/Source/cmFindBase.h @@ -31,10 +31,7 @@ public: virtual bool ParseArguments(std::vector<std::string> const& args); cmTypeMacro(cmFindBase, cmFindCommon); - virtual const char* GetFullDocumentation() const; - protected: - virtual void GenerateDocumentation(); void PrintFindStuff(); void ExpandPaths(); void AddPathSuffixes(); @@ -44,7 +41,6 @@ protected: // if it has documentation in the cache bool CheckForVariableInCache(); - cmStdString GenericDocumentation; // use by command during find cmStdString VariableDocumentation; cmStdString VariableName; diff --git a/Source/cmFindCommon.cxx b/Source/cmFindCommon.cxx index b44864e..7beeda0 100644 --- a/Source/cmFindCommon.cxx +++ b/Source/cmFindCommon.cxx @@ -37,55 +37,6 @@ cmFindCommon::cmFindCommon() } //---------------------------------------------------------------------------- -void cmFindCommon::GenerateDocumentation() -{ - // Documentation components. - this->GenericDocumentationMacPolicy = - "On Darwin or systems supporting OS X Frameworks, the cmake variable" - " CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:\n" - " \"FIRST\" - Try to find frameworks before standard\n" - " libraries or headers. This is the default on Darwin.\n" - " \"LAST\" - Try to find frameworks after standard\n" - " libraries or headers.\n" - " \"ONLY\" - Only try to find frameworks.\n" - " \"NEVER\" - Never try to find frameworks.\n" - "On Darwin or systems supporting OS X Application Bundles, the cmake " - "variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the " - "following:\n" - " \"FIRST\" - Try to find application bundles before standard\n" - " programs. This is the default on Darwin.\n" - " \"LAST\" - Try to find application bundles after standard\n" - " programs.\n" - " \"ONLY\" - Only try to find application bundles.\n" - " \"NEVER\" - Never try to find application bundles.\n"; - this->GenericDocumentationRootPath = - "The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more " - "directories to be prepended to all other search directories. " - "This effectively \"re-roots\" the entire search under given locations. " - "By default it is empty. It is especially useful when " - "cross-compiling to point to the root directory of the " - "target environment and CMake will search there too. By default at first " - "the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted " - "directories will be searched. " - "The default behavior can be adjusted by setting " - "CMAKE_FIND_ROOT_PATH_MODE_XXX. This behavior can be manually " - "overridden on a per-call basis. " - "By using CMAKE_FIND_ROOT_PATH_BOTH the search order will " - "be as described above. If NO_CMAKE_FIND_ROOT_PATH is used " - "then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH " - "is used then only the re-rooted directories will be searched.\n"; - this->GenericDocumentationPathsOrder = - "The default search order is designed to be most-specific to " - "least-specific for common use cases. " - "Projects may override the order by simply calling the command " - "multiple times and using the NO_* options:\n" - " FIND_XXX(FIND_ARGS_XXX PATHS paths... NO_DEFAULT_PATH)\n" - " FIND_XXX(FIND_ARGS_XXX)\n" - "Once one of the calls succeeds the result variable will be set " - "and stored in the cache so that no call will search again."; -} - -//---------------------------------------------------------------------------- cmFindCommon::~cmFindCommon() { } diff --git a/Source/cmFindCommon.h b/Source/cmFindCommon.h index 542805f..6109a9f 100644 --- a/Source/cmFindCommon.h +++ b/Source/cmFindCommon.h @@ -56,8 +56,6 @@ protected: /** Compute the current default bundle/framework search policy. */ void SelectDefaultMacMode(); - virtual void GenerateDocumentation(); - cmStdString CMakePathName; RootPathMode FindRootPathMode; @@ -85,10 +83,6 @@ protected: std::vector<std::string> SearchPaths; std::set<cmStdString> SearchPathsEmitted; - std::string GenericDocumentationMacPolicy; - std::string GenericDocumentationRootPath; - std::string GenericDocumentationPathsOrder; - bool SearchFrameworkFirst; bool SearchFrameworkOnly; bool SearchFrameworkLast; diff --git a/Source/cmFindFileCommand.cxx b/Source/cmFindFileCommand.cxx index fa66fa1..615e7c1 100644 --- a/Source/cmFindFileCommand.cxx +++ b/Source/cmFindFileCommand.cxx @@ -16,15 +16,3 @@ cmFindFileCommand::cmFindFileCommand() { this->IncludeFileInPath = true; } - -void cmFindFileCommand::GenerateDocumentation() -{ - this->cmFindPathCommand::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "find_path", "find_file"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "directory containing the named file", - "full path to named file"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "file in a directory", "full path to a file"); -} diff --git a/Source/cmFindFileCommand.h b/Source/cmFindFileCommand.h index 1bfdcbd..3f0baa2 100644 --- a/Source/cmFindFileCommand.h +++ b/Source/cmFindFileCommand.h @@ -35,17 +35,7 @@ public: } virtual const char* GetName() const { return "find_file";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find the full path to a file."; - } - cmTypeMacro(cmFindFileCommand, cmFindPathCommand); -protected: - virtual void GenerateDocumentation(); }; diff --git a/Source/cmFindLibraryCommand.cxx b/Source/cmFindLibraryCommand.cxx index 4af7e11..de52df7 100644 --- a/Source/cmFindLibraryCommand.cxx +++ b/Source/cmFindLibraryCommand.cxx @@ -20,62 +20,6 @@ cmFindLibraryCommand::cmFindLibraryCommand() this->NamesPerDirAllowed = true; } -//---------------------------------------------------------------------------- -void cmFindLibraryCommand::GenerateDocumentation() -{ - this->cmFindBase::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "FIND_XXX", "find_library"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_PATH", "CMAKE_LIBRARY_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_MAC_PATH", - "CMAKE_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_MAC_PATH", - "CMAKE_SYSTEM_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SYSTEM", "LIB"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_PATH", - "CMAKE_SYSTEM_LIBRARY_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX_DESC", "library"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX", "library"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SUBDIR", "lib"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "NAMES name1 [name2 ...]", - "NAMES name1 [name2 ...] [NAMES_PER_DIR]"); - cmSystemTools::ReplaceString( - this->GenericDocumentation, - "XXX_EXTRA_PREFIX_ENTRY", - " <prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and\n"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_LIBRARY"); - this->GenericDocumentation += - "\n" - "When more than one value is given to the NAMES option this command " - "by default will consider one name at a time and search every directory " - "for it. " - "The NAMES_PER_DIR option tells this command to consider one directory " - "at a time and search for all names in it." - "\n" - "If the library found is a framework, then VAR will be set to " - "the full path to the framework <fullPath>/A.framework. " - "When a full path to a framework is used as a library, " - "CMake will use a -framework A, and a -F<fullPath> to " - "link the framework to the target." - "\n" - "If the global property FIND_LIBRARY_USE_LIB64_PATHS is set all search " - "paths will be tested as normal, with \"64/\" appended, and with all " - "matches of \"lib/\" replaced with \"lib64/\". This property is " - "automatically set for the platforms that are known to need it if at " - "least one of the languages supported by the PROJECT command is enabled."; -} - // cmFindLibraryCommand bool cmFindLibraryCommand ::InitialPass(std::vector<std::string> const& argsIn, cmExecutionStatus &) diff --git a/Source/cmFindLibraryCommand.h b/Source/cmFindLibraryCommand.h index cd0fce8..a9ec40e 100644 --- a/Source/cmFindLibraryCommand.h +++ b/Source/cmFindLibraryCommand.h @@ -51,13 +51,6 @@ public: */ virtual const char* GetName() const {return "find_library";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find a library."; - } cmTypeMacro(cmFindLibraryCommand, cmFindBase); protected: @@ -67,7 +60,6 @@ protected: const char* suffix, bool fresh = true); std::string FindLibrary(); - virtual void GenerateDocumentation(); private: std::string FindNormalLibrary(); std::string FindNormalLibraryNamesPerDir(); diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx index 1d6530f..aeca39a 100644 --- a/Source/cmFindPackageCommand.cxx +++ b/Source/cmFindPackageCommand.cxx @@ -79,322 +79,6 @@ cmFindPackageCommand::cmFindPackageCommand() } //---------------------------------------------------------------------------- -void cmFindPackageCommand::GenerateDocumentation() -{ - this->cmFindCommon::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentationRootPath, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_PACKAGE"); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_ARGS_XXX", "<package>"); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_XXX", "find_package"); - this->CommandDocumentation = - " find_package(<package> [version] [EXACT] [QUIET] [MODULE]\n" - " [REQUIRED] [[COMPONENTS] [components...]]\n" - " [OPTIONAL_COMPONENTS components...]\n" - " [NO_POLICY_SCOPE])\n" - "Finds and loads settings from an external project. " - "<package>_FOUND will be set to indicate whether the package was found. " - "When the package is found package-specific information is provided " - "through variables and imported targets documented by the package " - "itself. " - "The QUIET option disables messages if the package cannot be found. " - "The MODULE option disables the second signature documented below. " - "The REQUIRED option stops processing with an error message if the " - "package cannot be found." - "\n" - "A package-specific list of required components may be listed after the " - "COMPONENTS option (or after the REQUIRED option if present). " - "Additional optional components may be listed after OPTIONAL_COMPONENTS. " - "Available components and their influence on whether a package is " - "considered to be found are defined by the target package." - "\n" - "The [version] argument requests a version with which the package found " - "should be compatible (format is major[.minor[.patch[.tweak]]]). " - "The EXACT option requests that the version be matched exactly. " - "If no [version] and/or component list is given to a recursive " - "invocation inside a find-module, the corresponding arguments " - "are forwarded automatically from the outer call (including the " - "EXACT flag for [version]). " - "Version support is currently provided only on a package-by-package " - "basis (details below).\n" - "User code should generally look for packages using the above simple " - "signature. The remainder of this command documentation specifies the " - "full command signature and details of the search process. Project " - "maintainers wishing to provide a package to be found by this command " - "are encouraged to read on.\n" - "The command has two modes by which it searches for packages: " - "\"Module\" mode and \"Config\" mode. " - "Module mode is available when the command is invoked with the above " - "reduced signature. " - "CMake searches for a file called \"Find<package>.cmake\" in " - "the CMAKE_MODULE_PATH followed by the CMake installation. " - "If the file is found, it is read and processed by CMake. " - "It is responsible for finding the package, checking the version, " - "and producing any needed messages. " - "Many find-modules provide limited or no support for versioning; " - "check the module documentation. " - "If no module is found and the MODULE option is not given the command " - "proceeds to Config mode.\n" - "The complete Config mode command signature is:\n" - " find_package(<package> [version] [EXACT] [QUIET]\n" - " [REQUIRED] [[COMPONENTS] [components...]]\n" - " [CONFIG|NO_MODULE]\n" - " [NO_POLICY_SCOPE]\n" - " [NAMES name1 [name2 ...]]\n" - " [CONFIGS config1 [config2 ...]]\n" - " [HINTS path1 [path2 ... ]]\n" - " [PATHS path1 [path2 ... ]]\n" - " [PATH_SUFFIXES suffix1 [suffix2 ...]]\n" - " [NO_DEFAULT_PATH]\n" - " [NO_CMAKE_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PATH]\n" - " [NO_SYSTEM_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PACKAGE_REGISTRY]\n" - " [NO_CMAKE_BUILDS_PATH]\n" - " [NO_CMAKE_SYSTEM_PATH]\n" - " [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]\n" - " [CMAKE_FIND_ROOT_PATH_BOTH |\n" - " ONLY_CMAKE_FIND_ROOT_PATH |\n" - " NO_CMAKE_FIND_ROOT_PATH])\n" - "The CONFIG option may be used to skip Module mode explicitly and " - "switch to Config mode. It is synonymous to using NO_MODULE. " - "Config mode is also implied by use of options not specified in the " - "reduced signature. " - "\n" - "Config mode attempts to locate a configuration file provided by the " - "package to be found. A cache entry called <package>_DIR is created to " - "hold the directory containing the file. " - "By default the command searches for a package with the name <package>. " - "If the NAMES option is given the names following it are used instead " - "of <package>. " - "The command searches for a file called \"<name>Config.cmake\" or " - "\"<lower-case-name>-config.cmake\" for each name specified. " - "A replacement set of possible configuration file names may be given " - "using the CONFIGS option. " - "The search procedure is specified below. Once found, the configuration " - "file is read and processed by CMake. Since the file is provided by the " - "package it already knows the location of package contents. " - "The full path to the configuration file is stored in the cmake " - "variable <package>_CONFIG." - "\n" - "All configuration files which have been considered by CMake while " - "searching for an installation of the package with an appropriate " - "version are stored in the cmake variable <package>_CONSIDERED_CONFIGS, " - "the associated versions in <package>_CONSIDERED_VERSIONS. " - "\n" - "If the package configuration file cannot be found CMake " - "will generate an error describing the problem unless the QUIET " - "argument is specified. If REQUIRED is specified and the package " - "is not found a fatal error is generated and the configure step stops " - "executing. If <package>_DIR has been set to a directory not containing " - "a configuration file CMake will ignore it and search from scratch." - "\n" - "When the [version] argument is given Config mode will only find a " - "version of the package that claims compatibility with the requested " - "version (format is major[.minor[.patch[.tweak]]]). " - "If the EXACT option is given only a version of the package claiming " - "an exact match of the requested version may be found. " - "CMake does not establish any convention for the meaning of version " - "numbers. " - "Package version numbers are checked by \"version\" files provided by " - "the packages themselves. " - "For a candidate package configuration file \"<config-file>.cmake\" the " - "corresponding version file is located next to it and named either " - "\"<config-file>-version.cmake\" or \"<config-file>Version.cmake\". " - "If no such version file is available then the configuration file " - "is assumed to not be compatible with any requested version. " - "A basic version file containing generic version matching code can be " - "created using the macro write_basic_package_version_file(), see its " - "documentation for more details. " - "When a version file is found it is loaded to check the requested " - "version number. " - "The version file is loaded in a nested scope in which the following " - "variables have been defined:\n" - " PACKAGE_FIND_NAME = the <package> name\n" - " PACKAGE_FIND_VERSION = full requested version string\n" - " PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0\n" - " PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0\n" - " PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0\n" - " PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0\n" - " PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4\n" - "The version file checks whether it satisfies the requested version " - "and sets these variables:\n" - " PACKAGE_VERSION = full provided version string\n" - " PACKAGE_VERSION_EXACT = true if version is exact match\n" - " PACKAGE_VERSION_COMPATIBLE = true if version is compatible\n" - " PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version\n" - "These variables are checked by the find_package command to determine " - "whether the configuration file provides an acceptable version. " - "They are not available after the find_package call returns. " - "If the version is acceptable the following variables are set:\n" - " <package>_VERSION = full provided version string\n" - " <package>_VERSION_MAJOR = major version if provided, else 0\n" - " <package>_VERSION_MINOR = minor version if provided, else 0\n" - " <package>_VERSION_PATCH = patch version if provided, else 0\n" - " <package>_VERSION_TWEAK = tweak version if provided, else 0\n" - " <package>_VERSION_COUNT = number of version components, 0 to 4\n" - "and the corresponding package configuration file is loaded. " - "When multiple package configuration files are available whose version " - "files claim compatibility with the version requested it is unspecified " - "which one is chosen. " - "No attempt is made to choose a highest or closest version number." - "\n" - "Config mode provides an elaborate interface and search procedure. " - "Much of the interface is provided for completeness and for use " - "internally by find-modules loaded by Module mode. " - "Most user code should simply call\n" - " find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET])\n" - "in order to find a package. Package maintainers providing CMake " - "package configuration files are encouraged to name and install " - "them such that the procedure outlined below will find them " - "without requiring use of additional options." - "\n" - "CMake constructs a set of possible installation prefixes for the " - "package. Under each prefix several directories are searched for a " - "configuration file. The tables below show the directories searched. " - "Each entry is meant for installation trees following Windows (W), " - "UNIX (U), or Apple (A) conventions.\n" - " <prefix>/ (W)\n" - " <prefix>/(cmake|CMake)/ (W)\n" - " <prefix>/<name>*/ (W)\n" - " <prefix>/<name>*/(cmake|CMake)/ (W)\n" - " <prefix>/(lib/<arch>|lib|share)/cmake/<name>*/ (U)\n" - " <prefix>/(lib/<arch>|lib|share)/<name>*/ (U)\n" - " <prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/ (U)\n" - "On systems supporting OS X Frameworks and Application Bundles " - "the following directories are searched for frameworks or bundles " - "containing a configuration file:\n" - " <prefix>/<name>.framework/Resources/ (A)\n" - " <prefix>/<name>.framework/Resources/CMake/ (A)\n" - " <prefix>/<name>.framework/Versions/*/Resources/ (A)\n" - " <prefix>/<name>.framework/Versions/*/Resources/CMake/ (A)\n" - " <prefix>/<name>.app/Contents/Resources/ (A)\n" - " <prefix>/<name>.app/Contents/Resources/CMake/ (A)\n" - "In all cases the <name> is treated as case-insensitive and corresponds " - "to any of the names specified (<package> or names given by NAMES). " - "Paths with lib/<arch> are enabled if CMAKE_LIBRARY_ARCHITECTURE is set. " - "If PATH_SUFFIXES is specified the suffixes are appended to each " - "(W) or (U) directory entry one-by-one.\n" - "This set of directories is intended to work in cooperation with " - "projects that provide configuration files in their installation trees. " - "Directories above marked with (W) are intended for installations on " - "Windows where the prefix may point at the top of an application's " - "installation directory. Those marked with (U) are intended for " - "installations on UNIX platforms where the prefix is shared by " - "multiple packages. This is merely a convention, so all (W) and (U) " - "directories are still searched on all platforms. " - "Directories marked with (A) are intended for installations on " - "Apple platforms. The cmake variables CMAKE_FIND_FRAMEWORK and " - "CMAKE_FIND_APPBUNDLE determine the order of preference " - "as specified below.\n" - "The set of installation prefixes is constructed using the following " - "steps. If NO_DEFAULT_PATH is specified all NO_* options are enabled.\n" - "1. Search paths specified in cmake-specific cache variables. " - "These are intended to be used on the command line with a -DVAR=value. " - "This can be skipped if NO_CMAKE_PATH is passed.\n" - " CMAKE_PREFIX_PATH\n" - " CMAKE_FRAMEWORK_PATH\n" - " CMAKE_APPBUNDLE_PATH\n" - "2. Search paths specified in cmake-specific environment variables. " - "These are intended to be set in the user's shell configuration. " - "This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.\n" - " <package>_DIR\n" - " CMAKE_PREFIX_PATH\n" - " CMAKE_FRAMEWORK_PATH\n" - " CMAKE_APPBUNDLE_PATH\n" - "3. Search paths specified by the HINTS option. " - "These should be paths computed by system introspection, such as a " - "hint provided by the location of another item already found. " - "Hard-coded guesses should be specified with the PATHS option.\n" - "4. Search the standard system environment variables. " - "This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is passed. " - "Path entries ending in \"/bin\" or \"/sbin\" are automatically " - "converted to their parent directories.\n" - " PATH\n" - "5. Search project build trees recently configured in a CMake GUI. " - "This can be skipped if NO_CMAKE_BUILDS_PATH is passed. " - "It is intended for the case when a user is building multiple " - "dependent projects one after another.\n" - "6. Search paths stored in the CMake user package registry. " - "This can be skipped if NO_CMAKE_PACKAGE_REGISTRY is passed. " - "On Windows a <package> may appear under registry key\n" - " HKEY_CURRENT_USER\\Software\\Kitware\\CMake\\Packages\\<package>\n" - "as a REG_SZ value, with arbitrary name, that specifies the directory " - "containing the package configuration file. " - "On UNIX platforms a <package> may appear under the directory\n" - " ~/.cmake/packages/<package>\n" - "as a file, with arbitrary name, whose content specifies the directory " - "containing the package configuration file. " - "See the export(PACKAGE) command to create user package registry entries " - "for project build trees." - "\n" - "7. Search cmake variables defined in the Platform files " - "for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH " - "is passed.\n" - " CMAKE_SYSTEM_PREFIX_PATH\n" - " CMAKE_SYSTEM_FRAMEWORK_PATH\n" - " CMAKE_SYSTEM_APPBUNDLE_PATH\n" - "8. Search paths stored in the CMake system package registry. " - "This can be skipped if NO_CMAKE_SYSTEM_PACKAGE_REGISTRY is passed. " - "On Windows a <package> may appear under registry key\n" - " HKEY_LOCAL_MACHINE\\Software\\Kitware\\CMake\\Packages\\<package>\n" - "as a REG_SZ value, with arbitrary name, that specifies the directory " - "containing the package configuration file. " - "There is no system package registry on non-Windows platforms." - "\n" - "9. Search paths specified by the PATHS option. " - "These are typically hard-coded guesses.\n" - ; - this->CommandDocumentation += this->GenericDocumentationMacPolicy; - this->CommandDocumentation += this->GenericDocumentationRootPath; - this->CommandDocumentation += this->GenericDocumentationPathsOrder; - this->CommandDocumentation += - "\n" - "Every non-REQUIRED find_package() call can be disabled by setting the " - "variable CMAKE_DISABLE_FIND_PACKAGE_<package> to TRUE. See the " - "documentation for the CMAKE_DISABLE_FIND_PACKAGE_<package> variable for " - "more information.\n" - "When loading a find module or package configuration file find_package " - "defines variables to provide information about the call arguments " - "(and restores their original state before returning):\n" - " <package>_FIND_REQUIRED = true if REQUIRED option was given\n" - " <package>_FIND_QUIETLY = true if QUIET option was given\n" - " <package>_FIND_VERSION = full requested version string\n" - " <package>_FIND_VERSION_MAJOR = major version if requested, else 0\n" - " <package>_FIND_VERSION_MINOR = minor version if requested, else 0\n" - " <package>_FIND_VERSION_PATCH = patch version if requested, else 0\n" - " <package>_FIND_VERSION_TWEAK = tweak version if requested, else 0\n" - " <package>_FIND_VERSION_COUNT = number of version components, 0 to 4\n" - " <package>_FIND_VERSION_EXACT = true if EXACT option was given\n" - " <package>_FIND_COMPONENTS = list of requested components\n" - " <package>_FIND_REQUIRED_<c> = true if component <c> is required\n" - " false if component <c> is optional\n" - "In Module mode the loaded find module is responsible to honor the " - "request detailed by these variables; see the find module for details. " - "In Config mode find_package handles REQUIRED, QUIET, and version " - "options automatically but leaves it to the package configuration file " - "to handle components in a way that makes sense for the package. " - "The package configuration file may set <package>_FOUND to false " - "to tell find_package that component requirements are not satisfied." - "\n" - "See the cmake_policy() command documentation for discussion of the " - "NO_POLICY_SCOPE option." - ; -} - -//---------------------------------------------------------------------------- -const char* cmFindPackageCommand::GetFullDocumentation() const -{ - if(this->CommandDocumentation.empty()) - { - const_cast<cmFindPackageCommand *>(this)->GenerateDocumentation(); - } - return this->CommandDocumentation.c_str(); -} - -//---------------------------------------------------------------------------- bool cmFindPackageCommand ::InitialPass(std::vector<std::string> const& args, cmExecutionStatus &) { diff --git a/Source/cmFindPackageCommand.h b/Source/cmFindPackageCommand.h index c380122..1ed0710 100644 --- a/Source/cmFindPackageCommand.h +++ b/Source/cmFindPackageCommand.h @@ -51,22 +51,7 @@ public: */ virtual const char* GetName() const { return "find_package";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load settings for an external project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const; - cmTypeMacro(cmFindPackageCommand, cmFindCommon); -protected: - virtual void GenerateDocumentation(); private: void AppendSuccessInformation(); void AppendToFoundProperty(bool found); @@ -113,7 +98,6 @@ private: struct OriginalDef { bool exists; std::string value; }; std::map<cmStdString, OriginalDef> OriginalDefs; - std::string CommandDocumentation; cmStdString Name; cmStdString Variable; cmStdString Version; diff --git a/Source/cmFindPathCommand.cxx b/Source/cmFindPathCommand.cxx index 6a43298..8459995 100644 --- a/Source/cmFindPathCommand.cxx +++ b/Source/cmFindPathCommand.cxx @@ -20,51 +20,6 @@ cmFindPathCommand::cmFindPathCommand() this->IncludeFileInPath = false; } -void cmFindPathCommand::GenerateDocumentation() -{ - this->cmFindBase::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "FIND_XXX", "find_path"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_PATH", "CMAKE_INCLUDE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_MAC_PATH", - "CMAKE_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_MAC_PATH", - "CMAKE_SYSTEM_FRAMEWORK_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SYSTEM", "INCLUDE"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_PATH", - "CMAKE_SYSTEM_INCLUDE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX_DESC", - "directory containing the named file"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX", "file in a directory"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SUBDIR", "include"); - cmSystemTools::ReplaceString( - this->GenericDocumentation, - "XXX_EXTRA_PREFIX_ENTRY", - " <prefix>/include/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and\n"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_INCLUDE"); - if(!this->IncludeFileInPath) - { - this->GenericDocumentation += - "\n" - "When searching for frameworks, if the file is specified as " - "A/b.h, then the framework search will look for " - "A.framework/Headers/b.h. " - "If that is found the path will be set to the path to the framework. " - "CMake will convert this to the correct -F option to include the " - "file. "; - } -} - // cmFindPathCommand bool cmFindPathCommand ::InitialPass(std::vector<std::string> const& argsIn, cmExecutionStatus &) diff --git a/Source/cmFindPathCommand.h b/Source/cmFindPathCommand.h index 759567d..8df4540 100644 --- a/Source/cmFindPathCommand.h +++ b/Source/cmFindPathCommand.h @@ -51,18 +51,8 @@ public: */ virtual const char* GetName() const {return "find_path";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find the directory containing a file."; - } - cmTypeMacro(cmFindPathCommand, cmFindBase); bool IncludeFileInPath; -protected: - virtual void GenerateDocumentation(); private: std::string FindHeaderInFramework(std::string const& file, std::string const& dir); diff --git a/Source/cmFindProgramCommand.cxx b/Source/cmFindProgramCommand.cxx index 909b333..bb27753 100644 --- a/Source/cmFindProgramCommand.cxx +++ b/Source/cmFindProgramCommand.cxx @@ -17,37 +17,6 @@ #include <CoreFoundation/CoreFoundation.h> #endif -void cmFindProgramCommand::GenerateDocumentation() -{ - this->cmFindBase::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "FIND_XXX", "find_program"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_PATH", "CMAKE_PROGRAM_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_XXX_MAC_PATH", - "CMAKE_APPBUNDLE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_MAC_PATH", - "CMAKE_SYSTEM_APPBUNDLE_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SYSTEM", ""); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_SYSTEM_XXX_PATH", - "CMAKE_SYSTEM_PROGRAM_PATH"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX_DESC", "program"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "SEARCH_XXX", "program"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_SUBDIR", "[s]bin"); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "XXX_EXTRA_PREFIX_ENTRY", ""); - cmSystemTools::ReplaceString(this->GenericDocumentation, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_PROGRAM"); -} - // cmFindProgramCommand bool cmFindProgramCommand ::InitialPass(std::vector<std::string> const& argsIn, cmExecutionStatus &) diff --git a/Source/cmFindProgramCommand.h b/Source/cmFindProgramCommand.h index 8350c9b..7f4811c 100644 --- a/Source/cmFindProgramCommand.h +++ b/Source/cmFindProgramCommand.h @@ -50,19 +50,10 @@ public: */ virtual const char* GetName() const { return "find_program";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Find an executable program."; - } - cmTypeMacro(cmFindProgramCommand, cmFindBase); protected: std::string FindProgram(std::vector<std::string> names); - virtual void GenerateDocumentation(); private: std::string FindAppBundle(std::vector<std::string> names); diff --git a/Source/cmForEachCommand.h b/Source/cmForEachCommand.h index dc47613..e548ba8 100644 --- a/Source/cmForEachCommand.h +++ b/Source/cmForEachCommand.h @@ -61,52 +61,6 @@ public: */ virtual const char* GetName() const { return "foreach";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Evaluate a group of commands for each value in a list."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " foreach(loop_var arg1 arg2 ...)\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endforeach(loop_var)\n" - "All commands between foreach and the matching endforeach are recorded " - "without being invoked. Once the endforeach is evaluated, the " - "recorded list of commands is invoked once for each argument listed " - "in the original foreach command. Before each iteration of the loop " - "\"${loop_var}\" will be set as a variable with " - "the current value in the list.\n" - " foreach(loop_var RANGE total)\n" - " foreach(loop_var RANGE start stop [step])\n" - "Foreach can also iterate over a generated range of numbers. " - "There are three types of this iteration:\n" - "* When specifying single number, the range will have elements " - "0 to \"total\".\n" - "* When specifying two numbers, the range will have elements from " - "the first number to the second number.\n" - "* The third optional number is the increment used to iterate from " - "the first number to the second number." - "\n" - " foreach(loop_var IN [LISTS [list1 [...]]]\n" - " [ITEMS [item1 [...]]])\n" - "Iterates over a precise list of items. " - "The LISTS option names list-valued variables to be traversed, " - "including empty elements (an empty string is a zero-length list). " - "The ITEMS option ends argument parsing and includes all arguments " - "following it in the iteration." - ; - } - cmTypeMacro(cmForEachCommand, cmCommand); private: bool HandleInMode(std::vector<std::string> const& args); diff --git a/Source/cmFunctionCommand.cxx b/Source/cmFunctionCommand.cxx index a126cd1..85b89d9 100644 --- a/Source/cmFunctionCommand.cxx +++ b/Source/cmFunctionCommand.cxx @@ -66,24 +66,6 @@ public: */ virtual const char* GetName() const { return this->Args[0].c_str(); } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - std::string docs = "Function named: "; - docs += this->GetName(); - return docs.c_str(); - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return this->GetTerseDocumentation(); - } - cmTypeMacro(cmFunctionHelperCommand, cmCommand); std::vector<std::string> Args; diff --git a/Source/cmFunctionCommand.h b/Source/cmFunctionCommand.h index 0a029dc..a8bd3e7 100644 --- a/Source/cmFunctionCommand.h +++ b/Source/cmFunctionCommand.h @@ -59,46 +59,6 @@ public: */ virtual const char* GetName() const { return "function";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Start recording a function for later invocation as a command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " function(<name> [arg1 [arg2 [arg3 ...]]])\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endfunction(<name>)\n" - "Define a function named <name> that takes arguments named " - "arg1 arg2 arg3 (...). Commands listed after function, but before " - "the matching endfunction, are not invoked until the function " - "is invoked. When it is invoked, the commands recorded in the " - "function are first modified by replacing formal parameters (${arg1}) " - "with the arguments passed, and then invoked as normal commands. In " - "addition to referencing the formal parameters you can reference " - "the variable ARGC which will be set to the number of arguments " - "passed into the function as well as ARGV0 ARGV1 ARGV2 ... which " - "will have the actual values of the arguments passed in. This " - "facilitates creating functions with optional arguments. Additionally " - "ARGV holds the list of all arguments given to the function and ARGN " - "holds the list of arguments past the last expected argument." - "\n" - "A function opens a new scope: see set(var PARENT_SCOPE) for details." - "\n" - "See the cmake_policy() command documentation for the behavior of " - "policies inside functions." - ; - } - cmTypeMacro(cmFunctionCommand, cmCommand); }; diff --git a/Source/cmGetCMakePropertyCommand.h b/Source/cmGetCMakePropertyCommand.h index b77eaae..6c58bb4 100644 --- a/Source/cmGetCMakePropertyCommand.h +++ b/Source/cmGetCMakePropertyCommand.h @@ -39,31 +39,6 @@ public: */ virtual const char* GetName() const { return "get_cmake_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property of the CMake instance."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_cmake_property(VAR property)\n" - "Get a property from the CMake instance. " - "The value of the property is stored in the variable VAR. " - "If the property is not found, VAR will be set to \"NOTFOUND\". " - "Some supported properties " - "include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and " - "COMPONENTS." - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetCMakePropertyCommand, cmCommand); }; diff --git a/Source/cmGetDirectoryPropertyCommand.h b/Source/cmGetDirectoryPropertyCommand.h index d0d5820..aea04ad 100644 --- a/Source/cmGetDirectoryPropertyCommand.h +++ b/Source/cmGetDirectoryPropertyCommand.h @@ -39,37 +39,6 @@ public: */ virtual const char* GetName() const { return "get_directory_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property of DIRECTORY scope."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)\n" - "Store a property of directory scope in the named variable. " - "If the property is not defined the empty-string is returned. " - "The DIRECTORY argument specifies another directory from which " - "to retrieve the property value. " - "The specified directory must have already been traversed by " - "CMake." - "\n" - " get_directory_property(<variable> [DIRECTORY <dir>]\n" - " DEFINITION <var-name>)\n" - "Get a variable definition from a directory. " - "This form is useful to get a variable definition from another " - "directory." - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetDirectoryPropertyCommand, cmCommand); }; diff --git a/Source/cmGetFilenameComponentCommand.h b/Source/cmGetFilenameComponentCommand.h index 09af332..e2cd219 100644 --- a/Source/cmGetFilenameComponentCommand.h +++ b/Source/cmGetFilenameComponentCommand.h @@ -48,43 +48,6 @@ public: */ virtual const char* GetName() const { return "get_filename_component";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a specific component of a full filename."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_filename_component(<VAR> <FileName> <COMP> [CACHE])\n" - "Set <VAR> to a component of <FileName>, where <COMP> is one of:\n" - " DIRECTORY = Directory without file name\n" - " NAME = File name without directory\n" - " EXT = File name longest extension (.b.c from d/a.b.c)\n" - " NAME_WE = File name without directory or longest extension\n" - " ABSOLUTE = Full path to file\n" - " REALPATH = Full path to existing file with symlinks resolved\n" - " PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)\n" - "Paths are returned with forward slashes and have no trailing slahes. " - "The longest file extension is always considered. " - "If the optional CACHE argument is specified, the result variable is " - "added to the cache.\n" - " get_filename_component(<VAR> FileName\n" - " PROGRAM [PROGRAM_ARGS <ARG_VAR>]\n" - " [CACHE])\n" - "The program in FileName will be found in the system search path or " - "left as a full path. If PROGRAM_ARGS is present with PROGRAM, then " - "any command-line arguments present in the FileName string are split " - "from the program name and stored in <ARG_VAR>. This is used to " - "separate a program name from its arguments in a command line string."; - } - cmTypeMacro(cmGetFilenameComponentCommand, cmCommand); }; diff --git a/Source/cmGetPropertyCommand.h b/Source/cmGetPropertyCommand.h index 3c597fd..e1630ff 100644 --- a/Source/cmGetPropertyCommand.h +++ b/Source/cmGetPropertyCommand.h @@ -41,58 +41,6 @@ public: */ virtual const char* GetName() const { return "get_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_property(<variable>\n" - " <GLOBAL |\n" - " DIRECTORY [dir] |\n" - " TARGET <target> |\n" - " SOURCE <source> |\n" - " TEST <test> |\n" - " CACHE <entry> |\n" - " VARIABLE>\n" - " PROPERTY <name>\n" - " [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])\n" - "Get one property from one object in a scope. " - "The first argument specifies the variable in which to store the " - "result. " - "The second argument determines the scope from which to get the " - "property. It must be one of the following:\n" - "GLOBAL scope is unique and does not accept a name.\n" - "DIRECTORY scope defaults to the current directory but another " - "directory (already processed by CMake) may be named by full or " - "relative path.\n" - "TARGET scope must name one existing target.\n" - "SOURCE scope must name one source file.\n" - "TEST scope must name one existing test.\n" - "CACHE scope must name one cache entry.\n" - "VARIABLE scope is unique and does not accept a name.\n" - "The required PROPERTY option is immediately followed by the name " - "of the property to get. " - "If the property is not set an empty value is returned. " - "If the SET option is given the variable is set to a boolean " - "value indicating whether the property has been set. " - "If the DEFINED option is given the variable is set to a boolean " - "value indicating whether the property has been defined " - "such as with define_property. " - "If BRIEF_DOCS or FULL_DOCS is given then the variable is set to " - "a string containing documentation for the requested property. " - "If documentation is requested for a property that has not been " - "defined NOTFOUND is returned."; - } - cmTypeMacro(cmGetPropertyCommand, cmCommand); private: enum OutType { OutValue, OutDefined, OutBriefDoc, OutFullDoc, OutSet }; diff --git a/Source/cmGetSourceFilePropertyCommand.h b/Source/cmGetSourceFilePropertyCommand.h index 2ba8103..338318e 100644 --- a/Source/cmGetSourceFilePropertyCommand.h +++ b/Source/cmGetSourceFilePropertyCommand.h @@ -34,30 +34,6 @@ public: */ virtual const char* GetName() const { return "get_source_file_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property for a source file."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_source_file_property(VAR file property)\n" - "Get a property from a source file. The value of the property is " - "stored in the variable VAR. If the property is not found, VAR " - "will be set to \"NOTFOUND\". Use set_source_files_properties to set " - "property values. Source file properties usually control how the " - "file is built. One property that is always there is LOCATION" - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetSourceFilePropertyCommand, cmCommand); }; diff --git a/Source/cmGetTargetPropertyCommand.h b/Source/cmGetTargetPropertyCommand.h index f5e1aa7..4985b3c 100644 --- a/Source/cmGetTargetPropertyCommand.h +++ b/Source/cmGetTargetPropertyCommand.h @@ -34,32 +34,6 @@ public: */ virtual const char* GetName() const { return "get_target_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property from a target."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_target_property(VAR target property)\n" - "Get a property from a target. The value of the property is " - "stored in the variable VAR. If the property is not found, VAR " - "will be set to \"NOTFOUND\". Use set_target_properties to set " - "property values. Properties are usually used to control how " - "a target is built, but some query the target instead. " - "This command can get properties for any target so far created. " - "The targets do not need to be in the current CMakeLists.txt file." - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetTargetPropertyCommand, cmCommand); }; diff --git a/Source/cmGetTestPropertyCommand.h b/Source/cmGetTestPropertyCommand.h index 01f54d9..2dccabe 100644 --- a/Source/cmGetTestPropertyCommand.h +++ b/Source/cmGetTestPropertyCommand.h @@ -34,29 +34,6 @@ public: */ virtual const char* GetName() const { return "get_test_property";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Get a property of the test."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " get_test_property(test property VAR)\n" - "Get a property from the Test. The value of the property is " - "stored in the variable VAR. If the property is not found, VAR " - "will be set to \"NOTFOUND\". For a list of standard properties " - "you can type cmake --help-property-list" - "\n" - "See also the more general get_property() command."; - } - cmTypeMacro(cmGetTestPropertyCommand, cmCommand); }; diff --git a/Source/cmGlobalBorlandMakefileGenerator.cxx b/Source/cmGlobalBorlandMakefileGenerator.cxx index 2a7d61d..6c20952 100644 --- a/Source/cmGlobalBorlandMakefileGenerator.cxx +++ b/Source/cmGlobalBorlandMakefileGenerator.cxx @@ -59,5 +59,4 @@ void cmGlobalBorlandMakefileGenerator { entry.Name = cmGlobalBorlandMakefileGenerator::GetActualName(); entry.Brief = "Generates Borland makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalJOMMakefileGenerator.cxx b/Source/cmGlobalJOMMakefileGenerator.cxx index 4af0607..bc15ef2 100644 --- a/Source/cmGlobalJOMMakefileGenerator.cxx +++ b/Source/cmGlobalJOMMakefileGenerator.cxx @@ -65,5 +65,4 @@ void cmGlobalJOMMakefileGenerator { entry.Name = cmGlobalJOMMakefileGenerator::GetActualName(); entry.Brief = "Generates JOM makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalKdevelopGenerator.cxx b/Source/cmGlobalKdevelopGenerator.cxx index a81c26c..e7c857e 100644 --- a/Source/cmGlobalKdevelopGenerator.cxx +++ b/Source/cmGlobalKdevelopGenerator.cxx @@ -28,16 +28,6 @@ void cmGlobalKdevelopGenerator { entry.Name = this->GetName(); entry.Brief = "Generates KDevelop 3 project files."; - entry.Full = - "Project files for KDevelop 3 will be created in the top directory " - "and in every subdirectory which features a CMakeLists.txt file " - "containing a PROJECT() call. " - "If you change the settings using KDevelop cmake will try its best " - "to keep your changes when regenerating the project files. " - "Additionally a hierarchy of UNIX makefiles is generated into the " - "build tree. Any " - "standard UNIX-style make program can build the project through the " - "default make target. A \"make install\" target is also provided."; } cmGlobalKdevelopGenerator::cmGlobalKdevelopGenerator() diff --git a/Source/cmGlobalMSYSMakefileGenerator.cxx b/Source/cmGlobalMSYSMakefileGenerator.cxx index d49639b..539d2af 100644 --- a/Source/cmGlobalMSYSMakefileGenerator.cxx +++ b/Source/cmGlobalMSYSMakefileGenerator.cxx @@ -110,6 +110,4 @@ void cmGlobalMSYSMakefileGenerator { entry.Name = cmGlobalMSYSMakefileGenerator::GetActualName(); entry.Brief = "Generates MSYS makefiles."; - entry.Full = "The makefiles use /bin/sh as the shell. " - "They require msys to be installed on the machine."; } diff --git a/Source/cmGlobalMinGWMakefileGenerator.cxx b/Source/cmGlobalMinGWMakefileGenerator.cxx index 1f374d3..e00c7dd 100644 --- a/Source/cmGlobalMinGWMakefileGenerator.cxx +++ b/Source/cmGlobalMinGWMakefileGenerator.cxx @@ -49,6 +49,4 @@ void cmGlobalMinGWMakefileGenerator { entry.Name = cmGlobalMinGWMakefileGenerator::GetActualName(); entry.Brief = "Generates a make file for use with mingw32-make."; - entry.Full = "The makefiles generated use cmd.exe as the shell. " - "They do not require msys or a unix shell."; } diff --git a/Source/cmGlobalNMakeMakefileGenerator.cxx b/Source/cmGlobalNMakeMakefileGenerator.cxx index 7af4ee3..4fbabe4 100644 --- a/Source/cmGlobalNMakeMakefileGenerator.cxx +++ b/Source/cmGlobalNMakeMakefileGenerator.cxx @@ -65,5 +65,4 @@ void cmGlobalNMakeMakefileGenerator { entry.Name = cmGlobalNMakeMakefileGenerator::GetActualName(); entry.Brief = "Generates NMake makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalNinjaGenerator.cxx b/Source/cmGlobalNinjaGenerator.cxx index e45d024..bdc08b3 100644 --- a/Source/cmGlobalNinjaGenerator.cxx +++ b/Source/cmGlobalNinjaGenerator.cxx @@ -470,10 +470,6 @@ void cmGlobalNinjaGenerator { entry.Name = cmGlobalNinjaGenerator::GetActualName(); entry.Brief = "Generates build.ninja files (experimental)."; - entry.Full = - "A build.ninja file is generated into the build tree. Recent " - "versions of the ninja program can build the project through the " - "\"all\" target. An \"install\" target is also provided."; } // Implemented in all cmGlobaleGenerator sub-classes. diff --git a/Source/cmGlobalUnixMakefileGenerator3.cxx b/Source/cmGlobalUnixMakefileGenerator3.cxx index 9e23ae9..7ab107f 100644 --- a/Source/cmGlobalUnixMakefileGenerator3.cxx +++ b/Source/cmGlobalUnixMakefileGenerator3.cxx @@ -65,10 +65,6 @@ void cmGlobalUnixMakefileGenerator3 { entry.Name = cmGlobalUnixMakefileGenerator3::GetActualName(); entry.Brief = "Generates standard UNIX makefiles."; - entry.Full = - "A hierarchy of UNIX makefiles is generated into the build tree. Any " - "standard UNIX-style make program can build the project through the " - "default make target. A \"make install\" target is also provided."; } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalVisualStudio10Generator.cxx b/Source/cmGlobalVisualStudio10Generator.cxx index b2a337c..07ccc33 100644 --- a/Source/cmGlobalVisualStudio10Generator.cxx +++ b/Source/cmGlobalVisualStudio10Generator.cxx @@ -48,11 +48,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = "Visual Studio 10"; entry.Brief = "Generates Visual Studio 10 (2010) project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 10 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 10 IA64\" for Itanium."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudio11Generator.cxx b/Source/cmGlobalVisualStudio11Generator.cxx index 8ae7331..41a349e 100644 --- a/Source/cmGlobalVisualStudio11Generator.cxx +++ b/Source/cmGlobalVisualStudio11Generator.cxx @@ -68,11 +68,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = "Visual Studio 11"; entry.Brief = "Generates Visual Studio 11 (2012) project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 11 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 11 ARM\" for ARM."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudio12Generator.cxx b/Source/cmGlobalVisualStudio12Generator.cxx index c56dfff..c2cdc0b 100644 --- a/Source/cmGlobalVisualStudio12Generator.cxx +++ b/Source/cmGlobalVisualStudio12Generator.cxx @@ -43,11 +43,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = "Visual Studio 12"; entry.Brief = "Generates Visual Studio 12 (2013) project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 12 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 12 ARM\" for ARM."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalVisualStudio6Generator.cxx b/Source/cmGlobalVisualStudio6Generator.cxx index 5296248..4006df4 100644 --- a/Source/cmGlobalVisualStudio6Generator.cxx +++ b/Source/cmGlobalVisualStudio6Generator.cxx @@ -405,7 +405,6 @@ void cmGlobalVisualStudio6Generator { entry.Name = cmGlobalVisualStudio6Generator::GetActualName(); entry.Brief = "Generates Visual Studio 6 project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalVisualStudio71Generator.cxx b/Source/cmGlobalVisualStudio71Generator.cxx index 51efc46..2643719 100644 --- a/Source/cmGlobalVisualStudio71Generator.cxx +++ b/Source/cmGlobalVisualStudio71Generator.cxx @@ -313,5 +313,4 @@ void cmGlobalVisualStudio71Generator { entry.Name = cmGlobalVisualStudio71Generator::GetActualName(); entry.Brief = "Generates Visual Studio .NET 2003 project files."; - entry.Full = ""; } diff --git a/Source/cmGlobalVisualStudio7Generator.cxx b/Source/cmGlobalVisualStudio7Generator.cxx index 65eb3a9..0b9796d 100644 --- a/Source/cmGlobalVisualStudio7Generator.cxx +++ b/Source/cmGlobalVisualStudio7Generator.cxx @@ -841,7 +841,6 @@ void cmGlobalVisualStudio7Generator { entry.Name = cmGlobalVisualStudio7Generator::GetActualName(); entry.Brief = "Generates Visual Studio .NET 2002 project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalVisualStudio8Generator.cxx b/Source/cmGlobalVisualStudio8Generator.cxx index 92e40a8..b9bc1ae 100644 --- a/Source/cmGlobalVisualStudio8Generator.cxx +++ b/Source/cmGlobalVisualStudio8Generator.cxx @@ -65,11 +65,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = vs8generatorName; entry.Brief = "Generates Visual Studio 8 2005 project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 8 2005 Win64\" will create project files for " - "the x64 processor."; } virtual void GetGenerators(std::vector<std::string>& names) const { @@ -147,7 +142,6 @@ void cmGlobalVisualStudio8Generator { entry.Name = cmGlobalVisualStudio8Generator::GetActualName(); entry.Brief = "Generates Visual Studio 8 2005 project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmGlobalVisualStudio9Generator.cxx b/Source/cmGlobalVisualStudio9Generator.cxx index fba6ed1..aadf982 100644 --- a/Source/cmGlobalVisualStudio9Generator.cxx +++ b/Source/cmGlobalVisualStudio9Generator.cxx @@ -70,11 +70,6 @@ public: virtual void GetDocumentation(cmDocumentationEntry& entry) const { entry.Name = vs9generatorName; entry.Brief = "Generates Visual Studio 9 2008 project files."; - entry.Full = - "It is possible to append a space followed by the platform name " - "to create project files for a specific target platform. E.g. " - "\"Visual Studio 9 2008 Win64\" will create project files for " - "the x64 processor; \"Visual Studio 9 2008 IA64\" for Itanium."; } virtual void GetGenerators(std::vector<std::string>& names) const { diff --git a/Source/cmGlobalWatcomWMakeGenerator.cxx b/Source/cmGlobalWatcomWMakeGenerator.cxx index e3cebc4..6ae8775 100644 --- a/Source/cmGlobalWatcomWMakeGenerator.cxx +++ b/Source/cmGlobalWatcomWMakeGenerator.cxx @@ -62,5 +62,4 @@ void cmGlobalWatcomWMakeGenerator { entry.Name = cmGlobalWatcomWMakeGenerator::GetActualName(); entry.Brief = "Generates Watcom WMake makefiles."; - entry.Full = ""; } diff --git a/Source/cmGlobalXCodeGenerator.cxx b/Source/cmGlobalXCodeGenerator.cxx index 5a0fb07..c8b6832 100644 --- a/Source/cmGlobalXCodeGenerator.cxx +++ b/Source/cmGlobalXCodeGenerator.cxx @@ -3671,7 +3671,6 @@ void cmGlobalXCodeGenerator::GetDocumentation(cmDocumentationEntry& entry) { entry.Name = cmGlobalXCodeGenerator::GetActualName(); entry.Brief = "Generate Xcode project files."; - entry.Full = ""; } //---------------------------------------------------------------------------- diff --git a/Source/cmIfCommand.h b/Source/cmIfCommand.h index f794b78..f2633ad 100644 --- a/Source/cmIfCommand.h +++ b/Source/cmIfCommand.h @@ -66,187 +66,10 @@ public: virtual const char* GetName() const { return "if";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Conditionally execute a group of commands."; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " if(expression)\n" - " # then section.\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " elseif(expression2)\n" - " # elseif section.\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " else(expression)\n" - " # else section.\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endif(expression)\n" - "Evaluates the given expression. If the result is true, the commands " - "in the THEN section are invoked. Otherwise, the commands in the " - "else section are invoked. The elseif and else sections are " - "optional. You may have multiple elseif clauses. Note that " - "the expression in the else and endif clause is optional. Long " - "expressions can be used and there is a traditional order of " - "precedence. " - "Parenthetical expressions are evaluated first followed by unary " - "operators such as EXISTS, COMMAND, and DEFINED. " - "Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES " - "will be evaluated. Then NOT operators and finally AND, OR operators " - "will be evaluated. Possible expressions are:\n" - " if(<constant>)\n" - "True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number. " - "False if the constant is 0, OFF, NO, FALSE, N, IGNORE, NOTFOUND, '', " - "or ends in the suffix '-NOTFOUND'. " - "Named boolean constants are case-insensitive. " - "If the argument is not one of these constants, " - "it is treated as a variable:" - "\n" - " if(<variable>)\n" - "True if the variable is defined to a value that is not a false " - "constant. False otherwise. " - "(Note macro arguments are not variables.)" - "\n" - " if(NOT <expression>)\n" - "True if the expression is not true." - "\n" - " if(<expr1> AND <expr2>)\n" - "True if both expressions would be considered true individually." - "\n" - " if(<expr1> OR <expr2>)\n" - "True if either expression would be considered true individually." - "\n" - " if(COMMAND command-name)\n" - "True if the given name is a command, macro or function that can be " - "invoked.\n" - " if(POLICY policy-id)\n" - "True if the given name is an existing policy " - "(of the form CMP<NNNN>).\n" - " if(TARGET target-name)\n" - "True if the given name is an existing target, built or imported.\n" - " if(EXISTS file-name)\n" - " if(EXISTS directory-name)\n" - "True if the named file or directory exists. " - "Behavior is well-defined only for full paths.\n" - " if(file1 IS_NEWER_THAN file2)\n" - "True if file1 is newer than file2 or if one of the two files " - "doesn't exist. " - "Behavior is well-defined only for full paths. " - "If the file time stamps are exactly the same, an " - "IS_NEWER_THAN comparison returns true, so that any dependent " - "build operations will occur in the event of a tie. " - "This includes the case of passing the same file name for both " - "file1 and file2.\n" - " if(IS_DIRECTORY directory-name)\n" - "True if the given name is a directory. " - "Behavior is well-defined only for full paths.\n" - " if(IS_SYMLINK file-name)\n" - "True if the given name is a symbolic link. " - "Behavior is well-defined only for full paths.\n" - " if(IS_ABSOLUTE path)\n" - "True if the given path is an absolute path.\n" - " if(<variable|string> MATCHES regex)\n" - "True if the given string or variable's value matches the given " - "regular expression.\n" - " if(<variable|string> LESS <variable|string>)\n" - " if(<variable|string> GREATER <variable|string>)\n" - " if(<variable|string> EQUAL <variable|string>)\n" - "True if the given string or variable's value is a valid number and " - "the inequality or equality is true.\n" - " if(<variable|string> STRLESS <variable|string>)\n" - " if(<variable|string> STRGREATER <variable|string>)\n" - " if(<variable|string> STREQUAL <variable|string>)\n" - "True if the given string or variable's value is lexicographically " - "less (or greater, or equal) than the string or variable on the right.\n" - " if(<variable|string> VERSION_LESS <variable|string>)\n" - " if(<variable|string> VERSION_EQUAL <variable|string>)\n" - " if(<variable|string> VERSION_GREATER <variable|string>)\n" - "Component-wise integer version number comparison (version format is " - "major[.minor[.patch[.tweak]]]).\n" - " if(DEFINED <variable>)\n" - "True if the given variable is defined. It does not matter if the " - "variable is true or false just if it has been set.\n" - " if((expression) AND (expression OR (expression)))\n" - "The expressions inside the parenthesis are evaluated first and " - "then the remaining expression is evaluated as in the previous " - "examples. Where there are nested parenthesis the innermost are " - "evaluated as part of evaluating the expression " - "that contains them." - "\n" - - "The if command was written very early in CMake's history, predating " - "the ${} variable evaluation syntax, and for convenience evaluates " - "variables named by its arguments as shown in the above signatures. " - "Note that normal variable evaluation with ${} applies before the " - "if command even receives the arguments. " - "Therefore code like\n" - " set(var1 OFF)\n" - " set(var2 \"var1\")\n" - " if(${var2})\n" - "appears to the if command as\n" - " if(var1)\n" - "and is evaluated according to the if(<variable>) case " - "documented above. " - "The result is OFF which is false. " - "However, if we remove the ${} from the example then the command sees\n" - " if(var2)\n" - "which is true because var2 is defined to \"var1\" which is not " - "a false constant." - "\n" - "Automatic evaluation applies in the other cases whenever the " - "above-documented signature accepts <variable|string>:\n" - - "1) The left hand argument to MATCHES is first checked to see " - "if it is a defined variable, if so the variable's value is " - "used, otherwise the original value is used. \n" - - "2) If the left hand argument to MATCHES is missing it returns " - "false without error \n" - - "3) Both left and right hand arguments to LESS GREATER EQUAL " - "are independently tested to see if they are defined variables, " - "if so their defined values are used otherwise the original " - "value is used. \n" - - "4) Both left and right hand arguments to STRLESS STREQUAL " - "STRGREATER are independently tested to see if they are defined " - "variables, if so their defined values are used otherwise the " - "original value is used. \n" - - "5) Both left and right hand argumemnts to VERSION_LESS " - "VERSION_EQUAL VERSION_GREATER are independently tested to see " - "if they are defined variables, if so their defined values are " - "used otherwise the original value is used. \n" - - "6) The right hand argument to NOT is tested to see if it is a " - "boolean constant, if so the value is used, otherwise it is " - "assumed to be a variable and it is dereferenced. \n" - - "7) The left and right hand arguments to AND OR are " - "independently tested to see if they are boolean constants, if " - "so they are used as such, otherwise they are assumed to be " - "variables and are dereferenced. \n" - ; - } - // this is a shared function for both If and Else to determine if the // arguments were valid, and if so, was the response true. If there is // an error, the errorString will be set. diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h index 8ff8b20..267723d 100644 --- a/Source/cmIncludeCommand.h +++ b/Source/cmIncludeCommand.h @@ -48,41 +48,6 @@ public: */ virtual const char* GetName() const {return "include";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load and run CMake code from a file or module."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]\n" - " [NO_POLICY_SCOPE])\n" - "Load and run CMake code from the file given. " - "Variable reads and writes access the scope of the caller " - "(dynamic scoping). " - "If OPTIONAL is present, then no error " - "is raised if the file does not exist. If RESULT_VARIABLE is given " - "the variable will be set to the full filename which " - "has been included or NOTFOUND if it failed.\n" - "If a module is specified instead of a file, the file with name " - "<modulename>.cmake is searched first in CMAKE_MODULE_PATH, then in the " - "CMake module directory. There is one exception to this: if the file " - "which calls include() is located itself in the CMake module directory, " - "then first the CMake module directory is searched and " - "CMAKE_MODULE_PATH afterwards. See also policy CMP0017." - "\n" - "See the cmake_policy() command documentation for discussion of the " - "NO_POLICY_SCOPE option." - ; - } - cmTypeMacro(cmIncludeCommand, cmCommand); }; diff --git a/Source/cmIncludeDirectoryCommand.h b/Source/cmIncludeDirectoryCommand.h index 77a340a..c621dcb 100644 --- a/Source/cmIncludeDirectoryCommand.h +++ b/Source/cmIncludeDirectoryCommand.h @@ -43,44 +43,6 @@ public: */ virtual const char* GetName() const { return "include_directories";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Add include directories to the build."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n" - "Add the given directories to those the compiler uses to search " - "for include files. Relative paths are interpreted as relative to " - "the current source directory. \n" - "The include directories are added to the directory property " - "INCLUDE_DIRECTORIES for the current CMakeLists file. " - "They are also added to the target property INCLUDE_DIRECTORIES " - "for each target in the current CMakeLists file. " - "The target property values are the ones used by the generators." - "\n" - "By default the directories are appended onto the current list of " - "directories. " - "This default behavior can be changed by setting " - "CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. " - "By using AFTER or BEFORE explicitly, you can select between " - "appending and prepending, independent of the default. " - "\n" - "If the SYSTEM option is given, the compiler will be told the " - "directories are meant as system include directories on some " - "platforms (signalling this setting might achieve effects such as " - "the compiler skipping warnings, or these fixed-install system files " - "not being considered in dependency calculations - see compiler docs)."; - } - cmTypeMacro(cmIncludeDirectoryCommand, cmCommand); protected: diff --git a/Source/cmIncludeExternalMSProjectCommand.h b/Source/cmIncludeExternalMSProjectCommand.h index d5cec01..8ca674f 100644 --- a/Source/cmIncludeExternalMSProjectCommand.h +++ b/Source/cmIncludeExternalMSProjectCommand.h @@ -44,38 +44,6 @@ public: */ virtual const char* GetName() const {return "include_external_msproject";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Include an external Microsoft project file in a workspace."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include_external_msproject(projectname location\n" - " [TYPE projectTypeGUID]\n" - " [GUID projectGUID]\n" - " [PLATFORM platformName]\n" - " dep1 dep2 ...)\n" - "Includes an external Microsoft project in the generated workspace " - "file. Currently does nothing on UNIX. This will create a " - "target named [projectname]. This can be used in the add_dependencies " - "command to make things depend on the external project." - "\n" - "TYPE, GUID and PLATFORM are optional parameters that allow one " - "to specify the type of project, id (GUID) of the project and " - "the name of the target platform. " - "This is useful for projects requiring values other than the default " - "(e.g. WIX projects). " - "These options are not supported by the Visual Studio 6 generator."; - } - cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand); }; diff --git a/Source/cmIncludeRegularExpressionCommand.h b/Source/cmIncludeRegularExpressionCommand.h index 2e41775..0c5fa6f 100644 --- a/Source/cmIncludeRegularExpressionCommand.h +++ b/Source/cmIncludeRegularExpressionCommand.h @@ -43,30 +43,6 @@ public: */ virtual const char* GetName() const {return "include_regular_expression";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set the regular expression used for dependency checking."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " include_regular_expression(regex_match [regex_complain])\n" - "Set the regular expressions used in dependency checking. Only files " - "matching regex_match will be traced as dependencies. Only files " - "matching regex_complain will generate warnings if they cannot be " - "found " - "(standard header paths are not searched). The defaults are:\n" - " regex_match = \"^.*$\" (match everything)\n" - " regex_complain = \"^$\" (match empty string only)"; - } - cmTypeMacro(cmIncludeRegularExpressionCommand, cmCommand); }; diff --git a/Source/cmInstallCommand.h b/Source/cmInstallCommand.h index 6509501..9db2490 100644 --- a/Source/cmInstallCommand.h +++ b/Source/cmInstallCommand.h @@ -43,307 +43,6 @@ public: */ virtual const char* GetName() const { return "install";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Specify rules to run at install time."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command generates installation rules for a project. " - "Rules specified by calls to this command within a source directory " - "are executed in order during installation. " - "The order across directories is not defined." - "\n" - "There are multiple signatures for this command. Some of them define " - "installation properties for files and targets. Properties common to " - "multiple signatures are covered here but they are valid only for " - "signatures that specify them.\n" - "DESTINATION arguments specify " - "the directory on disk to which a file will be installed. " - "If a full path (with a leading slash or drive letter) is given it " - "is used directly. If a relative path is given it is interpreted " - "relative to the value of CMAKE_INSTALL_PREFIX. The prefix can " - "be relocated at install time using DESTDIR mechanism explained in the " - "CMAKE_INSTALL_PREFIX variable documentation.\n" - "PERMISSIONS arguments specify permissions for installed files. " - "Valid permissions are " - "OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, " - "GROUP_READ, GROUP_WRITE, GROUP_EXECUTE, " - "WORLD_READ, WORLD_WRITE, WORLD_EXECUTE, " - "SETUID, and SETGID. " - "Permissions that do not make sense on certain platforms are ignored " - "on those platforms.\n" - "The CONFIGURATIONS argument specifies a list of build configurations " - "for which the install rule applies (Debug, Release, etc.).\n" - "The COMPONENT argument specifies an installation component name " - "with which the install rule is associated, such as \"runtime\" or " - "\"development\". During component-specific installation only " - "install rules associated with the given component name will be " - "executed. During a full installation all components are installed." - " If COMPONENT is not provided a default component \"Unspecified\" is" - " created. The default component name may be controlled with the " - "CMAKE_INSTALL_DEFAULT_COMPONENT_NAME variable.\n" - "The RENAME argument specifies a name for an installed file that " - "may be different from the original file. Renaming is allowed only " - "when a single file is installed by the command.\n" - "The OPTIONAL argument specifies that it is not an error if the " - "file to be installed does not exist. " - "\n" - "The TARGETS signature:\n" - " install(TARGETS targets... [EXPORT <export-name>]\n" - " [[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE|\n" - " PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]\n" - " [DESTINATION <dir>]\n" - " [INCLUDES DESTINATION [<dir> ...]]\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>]\n" - " [OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP]\n" - " ] [...])\n" - "The TARGETS form specifies rules for installing targets from a " - "project. There are five kinds of target files that may be " - "installed: ARCHIVE, LIBRARY, RUNTIME, FRAMEWORK, and BUNDLE. " - - "Executables are treated as RUNTIME targets, except that those " - "marked with the MACOSX_BUNDLE property are treated as BUNDLE " - "targets on OS X. " - "Static libraries are always treated as ARCHIVE targets. " - "Module libraries are always treated as LIBRARY targets. " - "For non-DLL platforms shared libraries are treated as LIBRARY " - "targets, except that those marked with the FRAMEWORK property " - "are treated as FRAMEWORK targets on OS X. " - "For DLL platforms the DLL part of a shared library is treated as " - "a RUNTIME target and the corresponding import library is treated as " - "an ARCHIVE target. " - "All Windows-based systems including Cygwin are DLL platforms. " - "The ARCHIVE, LIBRARY, RUNTIME, and FRAMEWORK " - "arguments change the type of target to which the subsequent " - "properties " - "apply. If none is given the installation properties apply to " - "all target types. If only one is given then only targets of that " - "type will be installed (which can be used to install just a DLL or " - "just an import library)." - "The INCLUDES DESTINATION specifies a list of directories which will " - "be added to the INTERFACE_INCLUDE_DIRECTORIES of the <targets> when " - "exported by install(EXPORT). If a relative path is specified, it is " - "treated as relative to the $<INSTALL_PREFIX>." - "\n" - "The PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE arguments cause " - "subsequent properties to be applied to installing a FRAMEWORK " - "shared library target's associated files on non-Apple platforms. " - "Rules defined by these arguments are ignored on Apple platforms " - "because the associated files are installed into the appropriate " - "locations inside the framework folder. " - "See documentation of the PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE " - "target properties for details." - "\n" - "Either NAMELINK_ONLY or NAMELINK_SKIP may be specified as a LIBRARY " - "option. " - "On some platforms a versioned shared library has a symbolic link " - "such as\n" - " lib<name>.so -> lib<name>.so.1\n" - "where \"lib<name>.so.1\" is the soname of the library and " - "\"lib<name>.so\" is a \"namelink\" allowing linkers to find the " - "library when given \"-l<name>\". " - "The NAMELINK_ONLY option causes installation of only the namelink " - "when a library target is installed. " - "The NAMELINK_SKIP option causes installation of library files other " - "than the namelink when a library target is installed. " - "When neither option is given both portions are installed. " - "On platforms where versioned shared libraries do not have namelinks " - "or when a library is not versioned the NAMELINK_SKIP option installs " - "the library and the NAMELINK_ONLY option installs nothing. " - "See the VERSION and SOVERSION target properties for details on " - "creating versioned shared libraries." - "\n" - "One or more groups of properties may be specified in a single call " - "to the TARGETS form of this command. A target may be installed more " - "than once to different locations. Consider hypothetical " - "targets \"myExe\", \"mySharedLib\", and \"myStaticLib\". The code\n" - " install(TARGETS myExe mySharedLib myStaticLib\n" - " RUNTIME DESTINATION bin\n" - " LIBRARY DESTINATION lib\n" - " ARCHIVE DESTINATION lib/static)\n" - " install(TARGETS mySharedLib DESTINATION /some/full/path)\n" - "will install myExe to <prefix>/bin and myStaticLib to " - "<prefix>/lib/static. " - "On non-DLL platforms mySharedLib will be installed to <prefix>/lib " - "and /some/full/path. On DLL platforms the mySharedLib DLL will be " - "installed to <prefix>/bin and /some/full/path and its import library " - "will be installed to <prefix>/lib/static and /some/full/path." - "\n" - "The EXPORT option associates the installed target files with an " - "export called <export-name>. " - "It must appear before any RUNTIME, LIBRARY, or ARCHIVE options. " - "To actually install the export file itself, call install(EXPORT). " - "See documentation of the install(EXPORT ...) signature below for " - "details." - "\n" - "Installing a target with EXCLUDE_FROM_ALL set to true has " - "undefined behavior." - "\n" - "The FILES signature:\n" - " install(FILES files... DESTINATION <dir>\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>]\n" - " [RENAME <name>] [OPTIONAL])\n" - "The FILES form specifies rules for installing files for a " - "project. File names given as relative paths are interpreted with " - "respect to the current source directory. Files installed by this " - "form are by default given permissions OWNER_WRITE, OWNER_READ, " - "GROUP_READ, and WORLD_READ if no PERMISSIONS argument is given." - "\n" - "The PROGRAMS signature:\n" - " install(PROGRAMS files... DESTINATION <dir>\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>]\n" - " [RENAME <name>] [OPTIONAL])\n" - "The PROGRAMS form is identical to the FILES form except that the " - "default permissions for the installed file also include " - "OWNER_EXECUTE, GROUP_EXECUTE, and WORLD_EXECUTE. " - "This form is intended to install programs that are not targets, " - "such as shell scripts. Use the TARGETS form to install targets " - "built within the project." - "\n" - "The DIRECTORY signature:\n" - " install(DIRECTORY dirs... DESTINATION <dir>\n" - " [FILE_PERMISSIONS permissions...]\n" - " [DIRECTORY_PERMISSIONS permissions...]\n" - " [USE_SOURCE_PERMISSIONS] [OPTIONAL]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [COMPONENT <component>] [FILES_MATCHING]\n" - " [[PATTERN <pattern> | REGEX <regex>]\n" - " [EXCLUDE] [PERMISSIONS permissions...]] [...])\n" - "The DIRECTORY form installs contents of one or more directories " - "to a given destination. " - "The directory structure is copied verbatim to the destination. " - "The last component of each directory name is appended to the " - "destination directory but a trailing slash may be used to " - "avoid this because it leaves the last component empty. " - "Directory names given as relative paths are interpreted with " - "respect to the current source directory. " - "If no input directory names are given the destination directory " - "will be created but nothing will be installed into it. " - "The FILE_PERMISSIONS and DIRECTORY_PERMISSIONS options specify " - "permissions given to files and directories in the destination. " - "If USE_SOURCE_PERMISSIONS is specified and FILE_PERMISSIONS is not, " - "file permissions will be copied from the source directory structure. " - "If no permissions are specified files will be given the default " - "permissions specified in the FILES form of the command, and the " - "directories will be given the default permissions specified in the " - "PROGRAMS form of the command.\n" - - "Installation of directories may be controlled with fine granularity " - "using the PATTERN or REGEX options. These \"match\" options specify a " - "globbing pattern or regular expression to match directories or files " - "encountered within input directories. They may be used to apply " - "certain options (see below) to a subset of the files and directories " - "encountered. " - "The full path to each input file or directory " - "(with forward slashes) is matched against the expression. " - "A PATTERN will match only complete file names: the portion of the " - "full path matching the pattern must occur at the end of the file name " - "and be preceded by a slash. " - "A REGEX will match any portion of the full path but it may use " - "'/' and '$' to simulate the PATTERN behavior. " - "By default all files and directories are installed whether " - "or not they are matched. " - "The FILES_MATCHING option may be given before the first match option " - "to disable installation of files (but not directories) not matched by " - "any expression. For example, the code\n" - " install(DIRECTORY src/ DESTINATION include/myproj\n" - " FILES_MATCHING PATTERN \"*.h\")\n" - "will extract and install header files from a source tree.\n" - "Some options may follow a PATTERN or REGEX expression and are " - "applied only to files or directories matching them. " - "The EXCLUDE option will skip the matched file or directory. " - "The PERMISSIONS option overrides the permissions setting for the " - "matched file or directory. " - "For example the code\n" - " install(DIRECTORY icons scripts/ DESTINATION share/myproj\n" - " PATTERN \"CVS\" EXCLUDE\n" - " PATTERN \"scripts/*\"\n" - " PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ\n" - " GROUP_EXECUTE GROUP_READ)\n" - "will install the icons directory to share/myproj/icons and the " - "scripts directory to share/myproj. The icons will get default file " - "permissions, the scripts will be given specific permissions, and " - "any CVS directories will be excluded." - "\n" - "The SCRIPT and CODE signature:\n" - " install([[SCRIPT <file>] [CODE <code>]] [...])\n" - "The SCRIPT form will invoke the given CMake script files during " - "installation. If the script file name is a relative path " - "it will be interpreted with respect to the current source directory. " - "The CODE form will invoke the given CMake code during installation. " - "Code is specified as a single argument inside a double-quoted string. " - "For example, the code\n" - " install(CODE \"MESSAGE(\\\"Sample install message.\\\")\")\n" - "will print a message during installation.\n" - "" - "The EXPORT signature:\n" - " install(EXPORT <export-name> DESTINATION <dir>\n" - " [NAMESPACE <namespace>] [FILE <name>.cmake]\n" - " [PERMISSIONS permissions...]\n" - " [CONFIGURATIONS [Debug|Release|...]]\n" - " [EXPORT_LINK_INTERFACE_LIBRARIES]\n" - " [COMPONENT <component>])\n" - "The EXPORT form generates and installs a CMake file containing code " - "to import targets from the installation tree into another project. " - "Target installations are associated with the export <export-name> " - "using the EXPORT option of the install(TARGETS ...) signature " - "documented above. The NAMESPACE option will prepend <namespace> to " - "the target names as they are written to the import file. " - "By default the generated file will be called <export-name>.cmake but " - "the FILE option may be used to specify a different name. The value " - "given to the FILE option must be a file name with the \".cmake\" " - "extension. " - "If a CONFIGURATIONS option is given then the file will only be " - "installed when one of the named configurations is installed. " - "Additionally, the generated import file will reference only the " - "matching target configurations. " - "The EXPORT_LINK_INTERFACE_LIBRARIES keyword, if present, causes the " - "contents of the properties matching " - "(IMPORTED_)?LINK_INTERFACE_LIBRARIES(_<CONFIG>)? to be exported, when " - "policy CMP0022 is NEW. " - "If a COMPONENT option is specified that does not match that given " - "to the targets associated with <export-name> the behavior is " - "undefined. " - "If a library target is included in the export but " - "a target to which it links is not included the behavior is " - "unspecified." - "\n" - "The EXPORT form is useful to help outside projects use targets built " - "and installed by the current project. For example, the code\n" - " install(TARGETS myexe EXPORT myproj DESTINATION bin)\n" - " install(EXPORT myproj NAMESPACE mp_ DESTINATION lib/myproj)\n" - "will install the executable myexe to <prefix>/bin and code to import " - "it in the file \"<prefix>/lib/myproj/myproj.cmake\". " - "An outside project may load this file with the include command " - "and reference the myexe executable from the installation tree using " - "the imported target name mp_myexe as if the target were built " - "in its own tree." - "\n" - "NOTE: This command supercedes the INSTALL_TARGETS command and the " - "target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. " - "It also replaces the FILES forms of the INSTALL_FILES and " - "INSTALL_PROGRAMS commands. " - "The processing order of these install rules relative to those " - "generated by INSTALL_TARGETS, INSTALL_FILES, and INSTALL_PROGRAMS " - "commands is not defined.\n" - ; - } - cmTypeMacro(cmInstallCommand, cmCommand); private: diff --git a/Source/cmInstallFilesCommand.h b/Source/cmInstallFilesCommand.h index bb0a6cc..5583fe4 100644 --- a/Source/cmInstallFilesCommand.h +++ b/Source/cmInstallFilesCommand.h @@ -44,14 +44,6 @@ public: virtual const char* GetName() const { return "install_files";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the install(FILES ) command instead."; - } - - /** * This is called at the end after all the information * specified by the command is accumulated. Most commands do * not implement this method. At this point, reading and @@ -60,37 +52,6 @@ public: virtual void FinalPass(); virtual bool HasFinalPass() const { return !this->IsFilesForm; } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command has been superceded by the install command. It " - "is provided for compatibility with older CMake code. " - "The FILES form is directly replaced by the FILES form of the " - "install command. The regexp form can be expressed " - "more clearly using the GLOB form of the file command.\n" - " install_files(<dir> extension file file ...)\n" - "Create rules to install the listed files with the given extension " - "into the given directory. " - "Only files existing in the current source tree or its corresponding " - "location in the binary tree may be listed. " - "If a file specified already has an extension, that extension will be " - "removed first. This is useful for providing lists of source files " - "such as foo.cxx when you want the corresponding foo.h to be " - "installed. A typical extension is '.h'.\n" - " install_files(<dir> regexp)\n" - "Any files in the current source directory that match the regular " - "expression will be installed.\n" - " install_files(<dir> FILES file file ...)\n" - "Any files listed after the FILES keyword will be " - "installed explicitly from the names given. Full paths are allowed in " - "this form.\n" - "The directory <dir> is relative to the installation prefix, which " - "is stored in the variable CMAKE_INSTALL_PREFIX."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmInstallProgramsCommand.h b/Source/cmInstallProgramsCommand.h index 27a0498..95acfa2 100644 --- a/Source/cmInstallProgramsCommand.h +++ b/Source/cmInstallProgramsCommand.h @@ -44,14 +44,6 @@ public: virtual const char* GetName() const { return "install_programs";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the install(PROGRAMS ) command instead."; - } - - /** * This is called at the end after all the information * specified by the command is accumulated. Most commands do * not implement this method. At this point, reading and @@ -61,33 +53,6 @@ public: virtual bool HasFinalPass() const { return true; } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command has been superceded by the install command. It " - "is provided for compatibility with older CMake code. " - "The FILES form is directly replaced by the PROGRAMS form of the " - "INSTALL command. The regexp form can be expressed more clearly " - "using the GLOB form of the FILE command.\n" - " install_programs(<dir> file1 file2 [file3 ...])\n" - " install_programs(<dir> FILES file1 [file2 ...])\n" - "Create rules to install the listed programs into the given directory. " - "Use the FILES argument to guarantee that the file list version of " - "the command will be used even when there is only one argument.\n" - " install_programs(<dir> regexp)\n" - "In the second form any program in the current source directory that " - "matches the regular expression will be installed.\n" - "This command is intended to install programs that are not built " - "by cmake, such as shell scripts. See the TARGETS form of " - "the INSTALL command to " - "create installation rules for targets built by cmake.\n" - "The directory <dir> is relative to the installation prefix, which " - "is stored in the variable CMAKE_INSTALL_PREFIX."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmInstallTargetsCommand.h b/Source/cmInstallTargetsCommand.h index c47b387..2aa34db 100644 --- a/Source/cmInstallTargetsCommand.h +++ b/Source/cmInstallTargetsCommand.h @@ -44,30 +44,6 @@ public: */ virtual const char* GetName() const { return "install_targets";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the install(TARGETS ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command has been superceded by the install command. It " - "is provided for compatibility with older CMake code.\n" - " install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)\n" - "Create rules to install the listed targets into the given directory. " - "The directory <dir> is relative to the installation prefix, which " - "is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY " - "is specified, then on systems with special runtime files " - "(Windows DLL), the files will be copied to that directory."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmLinkDirectoriesCommand.h b/Source/cmLinkDirectoriesCommand.h index 9218f44..c6eb40c 100644 --- a/Source/cmLinkDirectoriesCommand.h +++ b/Source/cmLinkDirectoriesCommand.h @@ -45,33 +45,6 @@ public: */ virtual const char* GetName() const { return "link_directories";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Specify directories in which the linker will look for libraries."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " link_directories(directory1 directory2 ...)\n" - "Specify the paths in which the linker should search for libraries. " - "The command will apply only to targets created after it is called. " - "Relative paths given to this command are interpreted as relative to " - "the current source directory, see CMP0015. \n" - "Note that this command is rarely necessary. Library locations " - "returned by find_package() and find_library() are absolute paths. " - "Pass these absolute library file paths directly to the " - "target_link_libraries() command. CMake will ensure the linker finds " - "them." - ; - } - cmTypeMacro(cmLinkDirectoriesCommand, cmCommand); private: void AddLinkDir(std::string const& dir); diff --git a/Source/cmLinkLibrariesCommand.h b/Source/cmLinkLibrariesCommand.h index c450a1c..74de23c 100644 --- a/Source/cmLinkLibrariesCommand.h +++ b/Source/cmLinkLibrariesCommand.h @@ -44,31 +44,6 @@ public: */ virtual const char* GetName() const { return "link_libraries";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the target_link_libraries() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Link libraries to all targets added later.\n" - " link_libraries(library1 <debug | optimized> library2 ...)\n" - "Specify a list of libraries to be linked into " - "any following targets (typically added with the add_executable " - "or add_library calls). This command is passed " - "down to all subdirectories. " - "The debug and optimized strings may be used to indicate that " - "the next library listed is to be used only for that specific " - "type of build."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmListCommand.h b/Source/cmListCommand.h index 5523633..0cb5da2 100644 --- a/Source/cmListCommand.h +++ b/Source/cmListCommand.h @@ -46,66 +46,6 @@ public: */ virtual const char* GetName() const { return "list";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "List operations."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " list(LENGTH <list> <output variable>)\n" - " list(GET <list> <element index> [<element index> ...]\n" - " <output variable>)\n" - " list(APPEND <list> [<element> ...])\n" - " list(FIND <list> <value> <output variable>)\n" - " list(INSERT <list> <element_index> <element> [<element> ...])\n" - " list(REMOVE_ITEM <list> <value> [<value> ...])\n" - " list(REMOVE_AT <list> <index> [<index> ...])\n" - " list(REMOVE_DUPLICATES <list>)\n" - " list(REVERSE <list>)\n" - " list(SORT <list>)\n" - "LENGTH will return a given list's length.\n" - "GET will return list of elements specified by indices from the list.\n" - "APPEND will append elements to the list.\n" - "FIND will return the index of the element specified in the list or -1 " - "if it wasn't found.\n" - "INSERT will insert elements to the list to the specified location.\n" - "REMOVE_AT and REMOVE_ITEM will remove items from the list. The " - "difference is that REMOVE_ITEM will remove the given items, while " - "REMOVE_AT will remove the items at the given indices.\n" - "REMOVE_DUPLICATES will remove duplicated items in the list.\n" - "REVERSE reverses the contents of the list in-place.\n" - "SORT sorts the list in-place alphabetically.\n" - "The list subcommands APPEND, INSERT, REMOVE_AT, REMOVE_ITEM, " - "REMOVE_DUPLICATES, REVERSE and SORT may create new values for " - "the list within the current CMake variable scope. Similar to " - "the SET command, the LIST command creates new variable values " - "in the current scope, even if the list itself is actually " - "defined in a parent scope. To propagate the results of these " - "operations upwards, use SET with PARENT_SCOPE, SET with CACHE " - "INTERNAL, or some other means of value propagation.\n" - "NOTES: A list in cmake is a ; separated group of strings. " - "To create a list the set command can be used. For example, " - "set(var a b c d e) creates a list with a;b;c;d;e, and " - "set(var \"a b c d e\") creates a string or a list with one " - "item in it.\n" - "When specifying index values, if <element index> is 0 or" - " greater, it is indexed from the " - "beginning of the list, with 0 representing the first list element. " - "If <element index> is -1 or lesser, it is indexed from the end of " - "the list, with -1 representing the last list element. Be careful " - "when counting with negative indices: they do not start from 0. " - "-0 is equivalent to 0, the first list element.\n" - ; - } - cmTypeMacro(cmListCommand, cmCommand); protected: bool HandleLengthCommand(std::vector<std::string> const& args); diff --git a/Source/cmLoadCacheCommand.h b/Source/cmLoadCacheCommand.h index f55cbb3..c8f7236 100644 --- a/Source/cmLoadCacheCommand.h +++ b/Source/cmLoadCacheCommand.h @@ -42,39 +42,6 @@ public: */ virtual const char* GetName() const { return "load_cache";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load in the values from another project's CMake cache."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " load_cache(pathToCacheFile READ_WITH_PREFIX\n" - " prefix entry1...)\n" - "Read the cache and store the requested entries in variables with " - "their name prefixed with the given prefix. " - "This only reads the values, and does not create entries in the local " - "project's cache.\n" - " load_cache(pathToCacheFile [EXCLUDE entry1...]\n" - " [INCLUDE_INTERNALS entry1...])\n" - "Load in the values from another cache and store them in the local " - "project's cache as internal entries. This is useful for a project " - "that depends on another project built in a different tree. " - "EXCLUDE option can be used to provide a list of entries to be " - "excluded. " - "INCLUDE_INTERNALS can be used to provide a list of internal entries " - "to be included. Normally, no internal entries are brought in. Use " - "of this form of the command is strongly discouraged, but it is " - "provided for backward compatibility."; - } - cmTypeMacro(cmLoadCacheCommand, cmCommand); protected: diff --git a/Source/cmLoadCommandCommand.cxx b/Source/cmLoadCommandCommand.cxx index b2acf06..84dd299 100644 --- a/Source/cmLoadCommandCommand.cxx +++ b/Source/cmLoadCommandCommand.cxx @@ -71,23 +71,6 @@ public: */ virtual const char* GetName() const { return info.Name; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - if (this->info.GetTerseDocumentation) - { - cmLoadedCommand::InstallSignalHandlers(info.Name); - const char* ret = info.GetTerseDocumentation(); - cmLoadedCommand::InstallSignalHandlers(info.Name, 1); - return ret; - } - else - { - return "LoadedCommand without any additional documentation"; - } - } static const char* LastName; static void TrapsForSignals(int sig) { @@ -120,24 +103,6 @@ public: } } - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - if (this->info.GetFullDocumentation) - { - cmLoadedCommand::InstallSignalHandlers(info.Name); - const char* ret = info.GetFullDocumentation(); - cmLoadedCommand::InstallSignalHandlers(info.Name, 1); - return ret; - } - else - { - return "LoadedCommand without any additional documentation"; - } - } - cmTypeMacro(cmLoadedCommand, cmCommand); cmLoadedCommandInfo info; diff --git a/Source/cmLoadCommandCommand.h b/Source/cmLoadCommandCommand.h index f0b34ee..918f32b 100644 --- a/Source/cmLoadCommandCommand.h +++ b/Source/cmLoadCommandCommand.h @@ -42,31 +42,6 @@ public: */ virtual const char* GetName() const {return "load_command";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Load a command into a running CMake."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " load_command(COMMAND_NAME <loc1> [loc2 ...])\n" - "The given locations are searched for a library whose name is " - "cmCOMMAND_NAME. If found, it is loaded as a module and the command " - "is added to the set of available CMake commands. Usually, " - "TRY_COMPILE is used before this command to compile the module. " - "If the command is successfully loaded a variable named\n" - " CMAKE_LOADED_COMMAND_<COMMAND_NAME>\n" - "will be set to the full path of the module that was loaded. " - "Otherwise the variable will not be set."; - } - cmTypeMacro(cmLoadCommandCommand, cmCommand); }; diff --git a/Source/cmMacroCommand.cxx b/Source/cmMacroCommand.cxx index 8ba612c..fd6537f 100644 --- a/Source/cmMacroCommand.cxx +++ b/Source/cmMacroCommand.cxx @@ -67,24 +67,6 @@ public: */ virtual const char* GetName() const { return this->Args[0].c_str(); } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - std::string docs = "Macro named: "; - docs += this->GetName(); - return docs.c_str(); - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return this->GetTerseDocumentation(); - } - cmTypeMacro(cmMacroHelperCommand, cmCommand); std::vector<std::string> Args; diff --git a/Source/cmMacroCommand.h b/Source/cmMacroCommand.h index aedbb4d..4c585d8 100644 --- a/Source/cmMacroCommand.h +++ b/Source/cmMacroCommand.h @@ -59,50 +59,6 @@ public: */ virtual const char* GetName() const { return "macro";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Start recording a macro for later invocation as a command."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " macro(<name> [arg1 [arg2 [arg3 ...]]])\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endmacro(<name>)\n" - "Define a macro named <name> that takes arguments named " - "arg1 arg2 arg3 (...). Commands listed after macro, " - "but before the matching endmacro, are not invoked until the macro " - "is invoked. When it is invoked, the commands recorded in the " - "macro are first modified by replacing formal parameters (${arg1}) " - "with the arguments passed, and then invoked as normal commands. In " - "addition to referencing the formal parameters you can reference " - "the values ${ARGC} which will be set to the number of arguments " - "passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} " - "... which " - "will have the actual values of the arguments passed in. This " - "facilitates creating macros with optional arguments. Additionally " - "${ARGV} holds the list of all arguments given to the macro and " - "${ARGN} " - "holds the list of arguments past the last expected argument. " - "Note that the parameters to a macro and values such as ARGN " - "are not variables in the usual CMake sense. They are string " - "replacements much like the C preprocessor would do with a macro. " - "If you want true CMake variables and/or better CMake scope control " - "you should look at the function command." - "\n" - "See the cmake_policy() command documentation for the behavior of " - "policies inside macros." - ; - } cmTypeMacro(cmMacroCommand, cmCommand); }; diff --git a/Source/cmMakeDirectoryCommand.h b/Source/cmMakeDirectoryCommand.h index a0f866a..49a4009 100644 --- a/Source/cmMakeDirectoryCommand.h +++ b/Source/cmMakeDirectoryCommand.h @@ -51,26 +51,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the file(MAKE_DIRECTORY ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " make_directory(directory)\n" - "Creates the specified directory. Full paths should be given. Any " - "parent directories that do not exist will also be created. Use with " - "care."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmMakefile.cxx b/Source/cmMakefile.cxx index 40e55c2..a390e06 100644 --- a/Source/cmMakefile.cxx +++ b/Source/cmMakefile.cxx @@ -21,9 +21,7 @@ #include "cmCacheManager.h" #include "cmFunctionBlocker.h" #include "cmListFileCache.h" -#include "cmDocumentGeneratorExpressions.h" #include "cmCommandArgumentParserHelper.h" -#include "cmDocumentCompileDefinitions.h" #include "cmGeneratorExpression.h" #include "cmTest.h" #ifdef CMAKE_BUILD_WITH_CMAKE @@ -1778,14 +1776,6 @@ void cmMakefile::AddDefinition(const char* name, const char* value) return; } -#ifdef CMAKE_STRICT - if (this->GetCMakeInstance()) - { - this->GetCMakeInstance()-> - RecordPropertyAccess(name,cmProperty::VARIABLE); - } -#endif - this->Internal->VarStack.top().Set(name, value); if (this->Internal->VarUsageStack.size() && this->VariableInitialized(name)) @@ -2448,13 +2438,6 @@ bool cmMakefile::IsDefinitionSet(const char* name) const const char* cmMakefile::GetDefinition(const char* name) const { -#ifdef CMAKE_STRICT - if (this->GetCMakeInstance()) - { - this->GetCMakeInstance()-> - RecordPropertyAccess(name,cmProperty::VARIABLE); - } -#endif if (this->WarnUnused) { this->Internal->VarUsageStack.top().insert(name); @@ -4039,243 +4022,14 @@ void cmMakefile::RaiseScope(const char *var, const char *varDef) void cmMakefile::DefineProperties(cmake *cm) { cm->DefineProperty - ("ADDITIONAL_MAKE_CLEAN_FILES", cmProperty::DIRECTORY, - "Additional files to clean during the make clean stage.", - "A list of files that will be cleaned as a part of the " - "\"make clean\" stage. "); - - cm->DefineProperty - ("CLEAN_NO_CUSTOM", cmProperty::DIRECTORY, - "Should the output of custom commands be left.", - "If this is true then the outputs of custom commands for this " - "directory will not be removed during the \"make clean\" stage. "); - - cm->DefineProperty - ("LISTFILE_STACK", cmProperty::DIRECTORY, - "The current stack of listfiles being processed.", - "This property is mainly useful when trying to debug errors " - "in your CMake scripts. It returns a list of what list files " - "are currently being processed, in order. So if one listfile " - "does an INCLUDE command then that is effectively pushing " - "the included listfile onto the stack.", false); - - cm->DefineProperty - ("TEST_INCLUDE_FILE", cmProperty::DIRECTORY, - "A cmake file that will be included when ctest is run.", - "If you specify TEST_INCLUDE_FILE, that file will be " - "included and processed when ctest is run on the directory."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::DIRECTORY, - "Preprocessor definitions for compiling a directory's sources.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\"). " - "This property will be initialized in each directory by its value " - "in the directory's parent.\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does).\n" - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::DIRECTORY, - "Per-configuration preprocessor definitions in a directory.", - "This is the configuration-specific version of COMPILE_DEFINITIONS. " - "This property will be initialized in each directory by its value " - "in the directory's parent.\n"); - - cm->DefineProperty - ("IMPLICIT_DEPENDS_INCLUDE_TRANSFORM", cmProperty::DIRECTORY, - "Specify #include line transforms for dependencies in a directory.", - "This property specifies rules to transform macro-like #include lines " - "during implicit dependency scanning of C and C++ source files. " - "The list of rules must be semicolon-separated with each entry of " - "the form \"A_MACRO(%)=value-with-%\" (the % must be literal). " - "During dependency scanning occurrences of A_MACRO(...) on #include " - "lines will be replaced by the value given with the macro argument " - "substituted for '%'. For example, the entry\n" - " MYDIR(%)=<mydir/%>\n" - "will convert lines of the form\n" - " #include MYDIR(myheader.h)\n" - "to\n" - " #include <mydir/myheader.h>\n" - "allowing the dependency to be followed.\n" - "This property applies to sources in all targets within a directory. " - "The property value is initialized in each directory by its value " - "in the directory's parent."); - - cm->DefineProperty - ("EXCLUDE_FROM_ALL", cmProperty::DIRECTORY, - "Exclude the directory from the all target of its parent.", - "A property on a directory that indicates if its targets are excluded " - "from the default build target. If it is not, then with a Makefile " - "for example typing make will cause the targets to be built. " - "The same concept applies to the default build of other generators.", - false); - - cm->DefineProperty - ("PARENT_DIRECTORY", cmProperty::DIRECTORY, - "Source directory that added current subdirectory.", - "This read-only property specifies the source directory that " - "added the current source directory as a subdirectory of the build. " - "In the top-level directory the value is the empty-string.", false); - - cm->DefineProperty - ("INCLUDE_REGULAR_EXPRESSION", cmProperty::DIRECTORY, - "Include file scanning regular expression.", - "This read-only property specifies the regular expression used " - "during dependency scanning to match include files that should " - "be followed. See the include_regular_expression command.", false); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION", cmProperty::DIRECTORY, - "Enable interprocedural optimization for targets in a directory.", - "If set to true, enables interprocedural optimizations " - "if they are known to be supported by the compiler."); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION_<CONFIG>", cmProperty::DIRECTORY, - "Per-configuration interprocedural optimization for a directory.", - "This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. " - "If set, this property overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("VARIABLES", cmProperty::DIRECTORY, - "List of variables defined in the current directory.", - "This read-only property specifies the list of CMake variables " - "currently defined. " - "It is intended for debugging purposes.", false); - - cm->DefineProperty - ("CACHE_VARIABLES", cmProperty::DIRECTORY, - "List of cache variables available in the current directory.", - "This read-only property specifies the list of CMake cache " - "variables currently defined. " - "It is intended for debugging purposes.", false); - - cm->DefineProperty - ("MACROS", cmProperty::DIRECTORY, - "List of macro commands available in the current directory.", - "This read-only property specifies the list of CMake macros " - "currently defined. " - "It is intended for debugging purposes. " - "See the macro command.", false); - - cm->DefineProperty - ("DEFINITIONS", cmProperty::DIRECTORY, - "For CMake 2.4 compatibility only. Use COMPILE_DEFINITIONS instead.", - "This read-only property specifies the list of flags given so far " - "to the add_definitions command. " - "It is intended for debugging purposes. " - "Use the COMPILE_DEFINITIONS instead.", false); - - cm->DefineProperty - ("INCLUDE_DIRECTORIES", cmProperty::DIRECTORY, - "List of preprocessor include file search directories.", - "This property specifies the list of directories given " - "so far to the include_directories command. " - "This property exists on directories and targets. " - "In addition to accepting values from the include_directories " - "command, values may be set directly on any directory or any " - "target using the set_property command. " - "A target gets its initial value for this property from the value " - "of the directory property. " - "A directory gets its initial value from its parent directory if " - "it has one. " - "Both directory and target property values are adjusted by calls " - "to the include_directories command." - "\n" - "The target property values are used by the generators to set " - "the include paths for the compiler. " - "See also the include_directories command."); - - cm->DefineProperty - ("COMPILE_OPTIONS", cmProperty::DIRECTORY, - "List of options to pass to the compiler.", - "This property specifies the list of directories given " - "so far for this property. " - "This property exists on directories and targets." - "\n" - "The target property values are used by the generators to set " - "the options for the compiler.\n" - "Contents of COMPILE_OPTIONS may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("LINK_DIRECTORIES", cmProperty::DIRECTORY, - "List of linker search directories.", - "This read-only property specifies the list of directories given " - "so far to the link_directories command. " - "It is intended for debugging purposes.", false); - - cm->DefineProperty ("RULE_LAUNCH_COMPILE", cmProperty::DIRECTORY, - "Specify a launcher for compile rules.", - "See the global property of the same name for details. " - "This overrides the global property for a directory.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_LINK", cmProperty::DIRECTORY, - "Specify a launcher for link rules.", - "See the global property of the same name for details. " - "This overrides the global property for a directory.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_CUSTOM", cmProperty::DIRECTORY, - "Specify a launcher for custom rules.", - "See the global property of the same name for details. " - "This overrides the global property for a directory.", - true); - - cm->DefineProperty - ("VS_GLOBAL_SECTION_PRE_<section>", cmProperty::DIRECTORY, - "Specify a preSolution global section in Visual Studio.", - "Setting a property like this generates an entry of the following form " - "in the solution file:\n" - " GlobalSection(<section>) = preSolution\n" - " <contents based on property value>\n" - " EndGlobalSection\n" - "The property must be set to a semicolon-separated list of key=value " - "pairs. Each such pair will be transformed into an entry in the solution " - "global section. Whitespace around key and value is ignored. List " - "elements which do not contain an equal sign are skipped." - "\n" - "This property only works for Visual Studio 7 and above; it is ignored " - "on other generators. The property only applies when set on a directory " - "whose CMakeLists.txt contains a project() command."); - cm->DefineProperty - ("VS_GLOBAL_SECTION_POST_<section>", cmProperty::DIRECTORY, - "Specify a postSolution global section in Visual Studio.", - "Setting a property like this generates an entry of the following form " - "in the solution file:\n" - " GlobalSection(<section>) = postSolution\n" - " <contents based on property value>\n" - " EndGlobalSection\n" - "The property must be set to a semicolon-separated list of key=value " - "pairs. Each such pair will be transformed into an entry in the solution " - "global section. Whitespace around key and value is ignored. List " - "elements which do not contain an equal sign are skipped." - "\n" - "This property only works for Visual Studio 7 and above; it is ignored " - "on other generators. The property only applies when set on a directory " - "whose CMakeLists.txt contains a project() command." - "\n" - "Note that CMake generates postSolution sections ExtensibilityGlobals " - "and ExtensibilityAddIns by default. If you set the corresponding " - "property, it will override the default section. For example, setting " - "VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default " - "contents of the ExtensibilityGlobals section, while keeping " - "ExtensibilityAddIns on its default."); + "", "", true); } //---------------------------------------------------------------------------- diff --git a/Source/cmMarkAsAdvancedCommand.h b/Source/cmMarkAsAdvancedCommand.h index adfc553..b65e4a8 100644 --- a/Source/cmMarkAsAdvancedCommand.h +++ b/Source/cmMarkAsAdvancedCommand.h @@ -43,33 +43,6 @@ public: virtual const char* GetName() const {return "mark_as_advanced";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Mark cmake cached variables as advanced."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " mark_as_advanced([CLEAR|FORCE] VAR [VAR2 ...])\n" - "Mark the named cached variables as advanced. An advanced variable " - "will not be displayed in any of the cmake GUIs unless the show " - "advanced option is on. " - "If CLEAR is the first argument advanced variables are changed back " - "to unadvanced. " - "If FORCE is the first argument, then the variable is made advanced. " - "If neither FORCE nor CLEAR is specified, new values will be marked as " - "advanced, but if the variable already has an advanced/non-advanced " - "state, it will not be changed.\n" - "It does nothing in script mode."; - } - - /** * This determines if the command is invoked when in script mode. * mark_as_advanced() will have no effect in script mode, but this will * make many of the modules usable in cmake/ctest scripts, (among them diff --git a/Source/cmMathCommand.h b/Source/cmMathCommand.h index dc0ceb3..c826ef1 100644 --- a/Source/cmMathCommand.h +++ b/Source/cmMathCommand.h @@ -43,28 +43,6 @@ public: */ virtual const char* GetName() const { return "math";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Mathematical expressions."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " math(EXPR <output variable> <math expression>)\n" - "EXPR evaluates mathematical expression and returns result in the " - "output variable. Example mathematical expression is " - "'5 * ( 10 + 13 )'. Supported operators are " - "+ - * / % | & ^ ~ << >> * / %. They have the same meaning " - " as they do in C code."; - } - cmTypeMacro(cmMathCommand, cmCommand); protected: diff --git a/Source/cmMessageCommand.h b/Source/cmMessageCommand.h index a053bdd..fec9a32 100644 --- a/Source/cmMessageCommand.h +++ b/Source/cmMessageCommand.h @@ -46,47 +46,6 @@ public: */ virtual bool IsScriptable() const { return true; } - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Display a message to the user."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " message([<mode>] \"message to display\" ...)\n" - "The optional <mode> keyword determines the type of message:\n" - " (none) = Important information\n" - " STATUS = Incidental information\n" - " WARNING = CMake Warning, continue processing\n" - " AUTHOR_WARNING = CMake Warning (dev), continue processing\n" - " SEND_ERROR = CMake Error, continue processing,\n" - " but skip generation\n" - " FATAL_ERROR = CMake Error, stop processing and generation\n" - " DEPRECATION = CMake Deprecation Error or Warning if variable\n" - " CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED\n" - " is enabled, respectively, else no message.\n" - "The CMake command-line tool displays STATUS messages on stdout " - "and all other message types on stderr. " - "The CMake GUI displays all messages in its log area. " - "The interactive dialogs (ccmake and CMakeSetup) show STATUS messages " - "one at a time on a status line and other messages in interactive " - "pop-up boxes." - "\n" - "CMake Warning and Error message text displays using a simple " - "markup language. " - "Non-indented text is formatted in line-wrapped paragraphs delimited " - "by newlines. " - "Indented text is considered pre-formatted." - ; - } - cmTypeMacro(cmMessageCommand, cmCommand); }; diff --git a/Source/cmOptionCommand.h b/Source/cmOptionCommand.h index 7d02400..89e3ac1 100644 --- a/Source/cmOptionCommand.h +++ b/Source/cmOptionCommand.h @@ -43,29 +43,6 @@ public: virtual const char* GetName() const {return "option";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Provides an option that the user can optionally select."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " option(<option_variable> \"help string describing option\"\n" - " [initial value])\n" - "Provide an option for the user to select as ON or OFF. If no " - "initial value is provided, OFF is used.\n" - "If you have options that depend on the values of other " - "options, see the module help for CMakeDependentOption." - ; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } diff --git a/Source/cmOutputRequiredFilesCommand.h b/Source/cmOutputRequiredFilesCommand.h index 1d7e394..d43b229 100644 --- a/Source/cmOutputRequiredFilesCommand.h +++ b/Source/cmOutputRequiredFilesCommand.h @@ -42,30 +42,6 @@ public: */ virtual const char* GetName() const { return "output_required_files";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Approximate C preprocessor dependency scanning."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "This command exists only because ancient CMake versions provided it. " - "CMake handles preprocessor dependency scanning automatically using a " - "more advanced scanner.\n" - " output_required_files(srcfile outputfile)\n" - "Outputs a list of all the source files that are required by the " - "specified srcfile. This list is written into outputfile. This is " - "similar to writing out the dependencies for srcfile except that it " - "jumps from .h files into .cxx, .c and .cpp files if possible."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmPolicies.cxx b/Source/cmPolicies.cxx index d07645c..6ede28b 100644 --- a/Source/cmPolicies.cxx +++ b/Source/cmPolicies.cxx @@ -935,52 +935,6 @@ cmPolicies::GetPolicyStatus(cmPolicies::PolicyID id) return pos->second->Status; } -void cmPolicies::GetDocumentation(std::vector<cmDocumentationEntry>& v) -{ - // now loop over all the policies and set them as appropriate - std::map<cmPolicies::PolicyID,cmPolicy *>::iterator i - = this->Policies.begin(); - for (;i != this->Policies.end(); ++i) - { - cmOStringStream full; - full << i->second->LongDescription; - full << "\nThis policy was introduced in CMake version "; - full << i->second->GetVersionString() << "."; - if(i->first != cmPolicies::CMP0000) - { - full << " " - << "CMake version " << cmVersion::GetCMakeVersion() << " "; - // add in some more text here based on status - switch (i->second->Status) - { - case cmPolicies::WARN: - full << "warns when the policy is not set and uses OLD behavior. " - << "Use the cmake_policy command to set it to OLD or NEW " - << "explicitly."; - break; - case cmPolicies::OLD: - full << "defaults to the OLD behavior for this policy."; - break; - case cmPolicies::NEW: - full << "defaults to the NEW behavior for this policy."; - break; - case cmPolicies::REQUIRED_IF_USED: - full << "requires the policy to be set to NEW if you use it. " - << "Use the cmake_policy command to set it to NEW."; - break; - case cmPolicies::REQUIRED_ALWAYS: - full << "requires the policy to be set to NEW. " - << "Use the cmake_policy command to set it to NEW."; - break; - } - } - cmDocumentationEntry e(i->second->IDString.c_str(), - i->second->ShortDescription.c_str(), - full.str().c_str()); - v.push_back(e); - } -} - //---------------------------------------------------------------------------- std::string cmPolicies::GetRequiredAlwaysPolicyError(cmPolicies::PolicyID id) diff --git a/Source/cmPolicies.h b/Source/cmPolicies.h index e33171b..a9d1b49 100644 --- a/Source/cmPolicies.h +++ b/Source/cmPolicies.h @@ -116,9 +116,6 @@ public: ///! return an error string for when a required policy is unspecified std::string GetRequiredAlwaysPolicyError(cmPolicies::PolicyID id); - ///! Get docs for policies - void GetDocumentation(std::vector<cmDocumentationEntry>& v); - /** Represent a set of policy values. */ typedef std::map<PolicyID, PolicyStatus> PolicyMap; diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h index 9547c4c..f7d086d 100644 --- a/Source/cmProjectCommand.h +++ b/Source/cmProjectCommand.h @@ -45,41 +45,6 @@ public: */ virtual const char* GetName() const {return "project";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a name for the entire project."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " project(<projectname> [languageName1 languageName2 ... ] )\n" - "Sets the name of the project. " - "Additionally this sets the variables <projectName>_BINARY_DIR and " - "<projectName>_SOURCE_DIR to the respective values.\n" - "Optionally you can specify which languages your project supports. " - "Example languages are CXX (i.e. C++), C, Fortran, etc. " - "By default C and CXX are enabled. E.g. if you do not have a " - "C++ compiler, you can disable the check for it by explicitly listing " - "the languages you want to support, e.g. C. By using the special " - "language \"NONE\" all checks for any language can be disabled. " - "If a variable exists called CMAKE_PROJECT_<projectName>_INCLUDE, " - "the file pointed to by that variable will be included as the last step " - "of the project command." - "\n" - "The top-level CMakeLists.txt file for a project must contain a " - "literal, direct call to the project() command; loading one through " - "the include() command is not sufficient. " - "If no such call exists CMake will implicitly add one to the top that " - "enables the default languages (C and CXX)."; - } - cmTypeMacro(cmProjectCommand, cmCommand); }; diff --git a/Source/cmPropertyDefinition.cxx b/Source/cmPropertyDefinition.cxx index b80c863..abc57ce 100644 --- a/Source/cmPropertyDefinition.cxx +++ b/Source/cmPropertyDefinition.cxx @@ -12,20 +12,10 @@ #include "cmPropertyDefinition.h" #include "cmSystemTools.h" -cmDocumentationEntry cmPropertyDefinition::GetDocumentation() const -{ - cmDocumentationEntry e; - e.Name = this->Name; - e.Brief = this->ShortDescription; - e.Full = this->FullDescription; - return e; -} - void cmPropertyDefinition ::DefineProperty(const char *name, cmProperty::ScopeType scope, const char *shortDescription, const char *fullDescription, - const char *sec, bool chain) { this->Name = name; @@ -39,9 +29,5 @@ void cmPropertyDefinition { this->FullDescription = fullDescription; } - if (sec) - { - this->DocumentationSection = sec; - } } diff --git a/Source/cmPropertyDefinition.h b/Source/cmPropertyDefinition.h index 296366d..1b6a7a6 100644 --- a/Source/cmPropertyDefinition.h +++ b/Source/cmPropertyDefinition.h @@ -30,22 +30,14 @@ public: void DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - const char *DocumentationSection, bool chained); - /// Get the documentation string - cmDocumentationEntry GetDocumentation() const; - /// Default constructor cmPropertyDefinition() { this->Chained = false; }; /// Is the property chained? bool IsChained() const { return this->Chained; }; - /// Get the section if any - const std::string &GetDocumentationSection() const { - return this->DocumentationSection; }; - /// Get the scope cmProperty::ScopeType GetScope() const { return this->Scope; }; @@ -62,7 +54,6 @@ protected: std::string Name; std::string ShortDescription; std::string FullDescription; - std::string DocumentationSection; cmProperty::ScopeType Scope; bool Chained; }; diff --git a/Source/cmPropertyDefinitionMap.cxx b/Source/cmPropertyDefinitionMap.cxx index 20fa07c..db29504 100644 --- a/Source/cmPropertyDefinitionMap.cxx +++ b/Source/cmPropertyDefinitionMap.cxx @@ -17,7 +17,6 @@ void cmPropertyDefinitionMap ::DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - const char *DocumentationSection, bool chain) { if (!name) @@ -31,64 +30,7 @@ void cmPropertyDefinitionMap { prop = &(*this)[name]; prop->DefineProperty(name,scope,ShortDescription, FullDescription, - DocumentationSection, chain); - } -} - -void cmPropertyDefinitionMap -::GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>& v) const -{ - for(cmPropertyDefinitionMap::const_iterator j = this->begin(); - j != this->end(); ++j) - { - // add a section if needed - std::string secName = j->second.GetDocumentationSection(); - // if a section was not specified then use the scope - if (!secName.size()) - { - switch (j->second.GetScope()) - { - case cmProperty::GLOBAL: - secName = "Properties of Global Scope"; - break; - case cmProperty::TARGET: - secName = "Properties on Targets"; - break; - case cmProperty::SOURCE_FILE: - secName = "Properties on Source Files"; - break; - case cmProperty::DIRECTORY: - secName = "Properties on Directories"; - break; - case cmProperty::TEST: - secName = "Properties on Tests"; - break; - case cmProperty::CACHE: - secName = "Properties on Cache Entries"; - break; - case cmProperty::VARIABLE: - secName = "Variables"; - break; - case cmProperty::CACHED_VARIABLE: - secName = "Cached Variables"; - break; - default: - secName = "Properties of Unknown Scope"; - break; - } - } - if (!v[secName]) - { - v[secName] = new - cmDocumentationSection(secName.c_str(), - cmSystemTools::UpperCase(secName).c_str()); - } - cmDocumentationEntry e = j->second.GetDocumentation(); - if (e.Brief.size() || e.Full.size()) - { - v[secName]->Append(e); - } + chain); } } diff --git a/Source/cmPropertyDefinitionMap.h b/Source/cmPropertyDefinitionMap.h index 007e265..736e243 100644 --- a/Source/cmPropertyDefinitionMap.h +++ b/Source/cmPropertyDefinitionMap.h @@ -24,7 +24,6 @@ public: void DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - const char *DocumentaitonSection, bool chain); // has a named property been defined @@ -32,9 +31,6 @@ public: // is a named property set to chain bool IsPropertyChained(const char *name); - - void GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>&) const; }; #endif diff --git a/Source/cmPropertyMap.cxx b/Source/cmPropertyMap.cxx index 78f378a..e94e3e9 100644 --- a/Source/cmPropertyMap.cxx +++ b/Source/cmPropertyMap.cxx @@ -40,19 +40,7 @@ void cmPropertyMap::SetProperty(const char *name, const char *value, this->erase(name); return; } -#ifdef CMAKE_STRICT - if (!this->CMakeInstance) - { - cmSystemTools::Error("CMakeInstance not set on a property map!"); - abort(); - } - else - { - this->CMakeInstance->RecordPropertyAccess(name,scope); - } -#else (void)scope; -#endif cmProperty *prop = this->GetOrCreateProperty(name); prop->Set(name,value); @@ -66,19 +54,7 @@ void cmPropertyMap::AppendProperty(const char* name, const char* value, { return; } -#ifdef CMAKE_STRICT - if (!this->CMakeInstance) - { - cmSystemTools::Error("CMakeInstance not set on a property map!"); - abort(); - } - else - { - this->CMakeInstance->RecordPropertyAccess(name,scope); - } -#else (void)scope; -#endif cmProperty *prop = this->GetOrCreateProperty(name); prop->Append(name,value,asString); @@ -95,19 +71,6 @@ const char *cmPropertyMap return 0; } - // has the property been defined? -#ifdef CMAKE_STRICT - if (!this->CMakeInstance) - { - cmSystemTools::Error("CMakeInstance not set on a property map!"); - abort(); - } - else - { - this->CMakeInstance->RecordPropertyAccess(name,scope); - } -#endif - cmPropertyMap::const_iterator it = this->find(name); if (it == this->end()) { diff --git a/Source/cmQTWrapCPPCommand.h b/Source/cmQTWrapCPPCommand.h index 4863402..868eb91 100644 --- a/Source/cmQTWrapCPPCommand.h +++ b/Source/cmQTWrapCPPCommand.h @@ -46,27 +46,6 @@ public: * The name of the command as specified in CMakeList.txt. */ virtual const char* GetName() const { return "qt_wrap_cpp";} - - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create Qt Wrappers."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " qt_wrap_cpp(resultingLibraryName DestName\n" - " SourceLists ...)\n" - "Produce moc files for all the .h files listed in the SourceLists. " - "The moc files will be added to the library using the DestName " - "source list."; - } }; diff --git a/Source/cmQTWrapUICommand.h b/Source/cmQTWrapUICommand.h index b15c5cd..3406dac 100644 --- a/Source/cmQTWrapUICommand.h +++ b/Source/cmQTWrapUICommand.h @@ -44,30 +44,6 @@ public: * The name of the command as specified in CMakeList.txt. */ virtual const char* GetName() const { return "qt_wrap_ui";} - - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Create Qt user interfaces Wrappers."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " qt_wrap_ui(resultingLibraryName HeadersDestName\n" - " SourcesDestName SourceLists ...)\n" - "Produce .h and .cxx files for all the .ui files listed " - "in the SourceLists. " - "The .h files will be added to the library using the HeadersDestName" - "source list. " - "The .cxx files will be added to the library using the SourcesDestName" - "source list."; - } }; diff --git a/Source/cmRST.cxx b/Source/cmRST.cxx new file mode 100644 index 0000000..72c42d6 --- /dev/null +++ b/Source/cmRST.cxx @@ -0,0 +1,435 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2013 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#include "cmRST.h" + +#include "cmSystemTools.h" + +#include <ctype.h> + +//---------------------------------------------------------------------------- +cmRST::cmRST(std::ostream& os, std::string const& docroot): + OS(os), + DocRoot(docroot), + IncludeDepth(0), + OutputLinePending(false), + Markup(MarkupNone), + Directive(DirectiveNone), + CMakeDirective("^.. (cmake:)?(" + "command|variable" + ")::[ \t]+([^ \t\n]+)$"), + CMakeModuleDirective("^.. cmake-module::[ \t]+([^ \t\n]+)$"), + ParsedLiteralDirective("^.. parsed-literal::[ \t]*(.*)$"), + CodeBlockDirective("^.. code-block::[ \t]*(.*)$"), + ReplaceDirective("^.. (\\|[^|]+\\|) replace::[ \t]*(.*)$"), + IncludeDirective("^.. include::[ \t]+([^ \t\n]+)$"), + TocTreeDirective("^.. toctree::[ \t]*(.*)$"), + CMakeRole("(:cmake)?:(" + "command|generator|variable|module|policy|" + "prop_cache|prop_dir|prop_gbl|prop_sf|prop_test|prop_tgt|" + "manual" + "):`(<*([^`<]|[^` \t]<)*)([ \t]+<[^`]*>)?`"), + Substitution("(^|[^A-Za-z0-9_])" + "((\\|[^| \t\r\n]([^|\r\n]*[^| \t\r\n])?\\|)(__|_|))" + "([^A-Za-z0-9_]|$)") +{ +} + +//---------------------------------------------------------------------------- +bool cmRST::ProcessFile(std::string const& fname, bool isModule) +{ + std::ifstream fin(fname.c_str()); + if(fin) + { + this->DocDir = cmSystemTools::GetFilenamePath(fname); + if(isModule) + { + this->ProcessModule(fin); + } + else + { + this->ProcessRST(fin); + } + this->OutputLinePending = true; + return true; + } + return false; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessRST(std::istream& is) +{ + std::string line; + while(cmSystemTools::GetLineFromStream(is, line)) + { + this->ProcessLine(line); + } + this->Reset(); +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessModule(std::istream& is) +{ + std::string line; + std::string rst; + while(cmSystemTools::GetLineFromStream(is, line)) + { + if(rst == "#") + { + if(line == "#") + { + this->ProcessLine(""); + continue; + } + else if(line.substr(0, 2) == "# ") + { + this->ProcessLine(line.substr(2, line.npos)); + continue; + } + else + { + rst = ""; + this->Reset(); + this->OutputLinePending = true; + } + } + if(line == "#.rst:") + { + rst = "#"; + } + } + if(rst == "#") + { + this->Reset(); + } +} + +//---------------------------------------------------------------------------- +void cmRST::Reset() +{ + if(!this->MarkupLines.empty()) + { + this->UnindentLines(this->MarkupLines); + } + switch(this->Directive) + { + case DirectiveNone: break; + case DirectiveParsedLiteral: this->ProcessDirectiveParsedLiteral(); break; + case DirectiveCodeBlock: this->ProcessDirectiveCodeBlock(); break; + case DirectiveReplace: this->ProcessDirectiveReplace(); break; + case DirectiveTocTree: this->ProcessDirectiveTocTree(); break; + } + this->Markup = MarkupNone; + this->Directive = DirectiveNone; + this->MarkupLines.clear(); +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessLine(std::string const& line) +{ + // A line starting in .. is an explicit markup start. + if(line == ".." || (line.size() >= 3 && line[0] == '.' && + line[1] == '.' && isspace(line[2]))) + { + this->Reset(); + this->Markup = (line.find_first_not_of(" \t", 2) == line.npos ? + MarkupEmpty : MarkupNormal); + if(this->CMakeDirective.find(line)) + { + // Output cmake domain directives and their content normally. + this->NormalLine(line); + } + else if(this->CMakeModuleDirective.find(line)) + { + // Process cmake-module directive: scan .cmake file comments. + std::string file = this->CMakeModuleDirective.match(1); + if(file.empty() || !this->ProcessInclude(file, IncludeModule)) + { + this->NormalLine(line); + } + } + else if(this->ParsedLiteralDirective.find(line)) + { + // Record the literal lines to output after whole block. + this->Directive = DirectiveParsedLiteral; + this->MarkupLines.push_back(this->ParsedLiteralDirective.match(1)); + } + else if(this->CodeBlockDirective.find(line)) + { + // Record the literal lines to output after whole block. + // Ignore the language spec and record the opening line as blank. + this->Directive = DirectiveCodeBlock; + this->MarkupLines.push_back(""); + } + else if(this->ReplaceDirective.find(line)) + { + // Record the replace directive content. + this->Directive = DirectiveReplace; + this->ReplaceName = this->ReplaceDirective.match(1); + this->MarkupLines.push_back(this->ReplaceDirective.match(2)); + } + else if(this->IncludeDirective.find(line)) + { + // Process the include directive or output the directive and its + // content normally if it fails. + std::string file = this->IncludeDirective.match(1); + if(file.empty() || !this->ProcessInclude(file, IncludeNormal)) + { + this->NormalLine(line); + } + } + else if(this->TocTreeDirective.find(line)) + { + // Record the toctree entries to process after whole block. + this->Directive = DirectiveTocTree; + this->MarkupLines.push_back(this->TocTreeDirective.match(1)); + } + } + // An explicit markup start followed nothing but whitespace and a + // blank line does not consume any indented text following. + else if(this->Markup == MarkupEmpty && line.empty()) + { + this->NormalLine(line); + } + // Indented lines following an explicit markup start are explicit markup. + else if(this->Markup && (line.empty() || isspace(line[0]))) + { + this->Markup = MarkupNormal; + // Record markup lines if the start line was recorded. + if(!this->MarkupLines.empty()) + { + this->MarkupLines.push_back(line); + } + } + // Print non-markup lines. + else + { + this->NormalLine(line); + } +} + +//---------------------------------------------------------------------------- +void cmRST::NormalLine(std::string const& line) +{ + this->Reset(); + this->OutputLine(line); +} + +//---------------------------------------------------------------------------- +void cmRST::OutputLine(std::string const& line_in) +{ + if(this->OutputLinePending) + { + this->OS << "\n"; + this->OutputLinePending = false; + } + std::string line = this->ReplaceSubstitutions(line_in); + std::string::size_type pos = 0; + while(this->CMakeRole.find(line.c_str()+pos)) + { + this->OS << line.substr(pos, this->CMakeRole.start()); + std::string text = this->CMakeRole.match(3); + // If a command reference has no explicit target and + // no explicit "(...)" then add "()" to the text. + if(this->CMakeRole.match(2) == "command" && + this->CMakeRole.match(5).empty() && + text.find_first_of("()") == text.npos) + { + text += "()"; + } + this->OS << "``" << text << "``"; + pos += this->CMakeRole.end(); + } + this->OS << line.substr(pos) << "\n"; +} + +//---------------------------------------------------------------------------- +std::string cmRST::ReplaceSubstitutions(std::string const& line) +{ + std::string out; + std::string::size_type pos = 0; + while(this->Substitution.find(line.c_str()+pos)) + { + std::string::size_type start = this->Substitution.start(2); + std::string::size_type end = this->Substitution.end(2); + std::string substitute = this->Substitution.match(3); + std::map<cmStdString, cmStdString>::iterator + replace = this->Replace.find(substitute); + if(replace != this->Replace.end()) + { + std::pair<std::set<cmStdString>::iterator, bool> replaced = + this->Replaced.insert(substitute); + if(replaced.second) + { + substitute = this->ReplaceSubstitutions(replace->second); + this->Replaced.erase(replaced.first); + } + } + out += line.substr(pos, start); + out += substitute; + pos += end; + } + out += line.substr(pos); + return out; +} + +//---------------------------------------------------------------------------- +bool cmRST::ProcessInclude(std::string file, IncludeType type) +{ + bool found = false; + if(this->IncludeDepth < 10) + { + cmRST r(this->OS, this->DocRoot); + r.IncludeDepth = this->IncludeDepth + 1; + r.OutputLinePending = this->OutputLinePending; + if(type != IncludeTocTree) + { + r.Replace = this->Replace; + } + if(file[0] == '/') + { + file = this->DocRoot + file; + } + else + { + file = this->DocDir + "/" + file; + } + found = r.ProcessFile(file, type == IncludeModule); + if(type != IncludeTocTree) + { + this->Replace = r.Replace; + } + this->OutputLinePending = r.OutputLinePending; + } + return found; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveParsedLiteral() +{ + // Output markup lines as literal text. + for(std::vector<std::string>::iterator i = this->MarkupLines.begin(); + i != this->MarkupLines.end(); ++i) + { + std::string line = *i; + if(!line.empty()) + { + line = " " + line; + } + this->OutputLine(line); + } + this->OutputLinePending = true; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveCodeBlock() +{ + // Treat markup lines the same as a parsed literal. + this->ProcessDirectiveParsedLiteral(); +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveReplace() +{ + // Record markup lines as replacement text. + std::string& replacement = this->Replace[this->ReplaceName]; + const char* sep = ""; + for(std::vector<std::string>::iterator i = this->MarkupLines.begin(); + i != this->MarkupLines.end(); ++i) + { + replacement += sep; + replacement += *i; + sep = " "; + } + this->ReplaceName = ""; +} + +//---------------------------------------------------------------------------- +void cmRST::ProcessDirectiveTocTree() +{ + // Process documents referenced by toctree directive. + for(std::vector<std::string>::iterator i = this->MarkupLines.begin(); + i != this->MarkupLines.end(); ++i) + { + if(!i->empty() && i->find_first_of(":") == i->npos) + { + this->ProcessInclude(*i + ".rst", IncludeTocTree); + } + } +} + +//---------------------------------------------------------------------------- +void cmRST::UnindentLines(std::vector<std::string>& lines) +{ + // Remove the common indentation from the second and later lines. + std::string indentText; + std::string::size_type indentEnd = 0; + bool first = true; + for(size_t i = 1; i < lines.size(); ++i) + { + std::string const& line = lines[i]; + + // Do not consider empty lines. + if(line.empty()) + { + continue; + } + + // Record indentation on first non-empty line. + if(first) + { + first = false; + indentEnd = line.find_first_not_of(" \t"); + indentText = line.substr(0, indentEnd); + continue; + } + + // Truncate indentation to match that on this line. + if(line.size() < indentEnd) + { + indentEnd = line.size(); + } + for(std::string::size_type j = 0; j != indentEnd; ++j) + { + if(line[j] != indentText[j]) + { + indentEnd = j; + break; + } + } + } + + // Update second and later lines. + for(size_t i = 1; i < lines.size(); ++i) + { + std::string& line = lines[i]; + if(!line.empty()) + { + line = line.substr(indentEnd); + } + } + + // Drop leading blank lines. + size_t leadingEmpty = 0; + for(size_t i = 0; i < lines.size() && lines[i].empty(); ++i) + { + ++leadingEmpty; + } + lines.erase(lines.begin(), lines.begin()+leadingEmpty); + + // Drop trailing blank lines. + size_t trailingEmpty = 0; + for(size_t i = lines.size(); i > 0 && lines[i-1].empty(); --i) + { + ++trailingEmpty; + } + lines.erase(lines.end()-trailingEmpty, lines.end()); +} diff --git a/Source/cmRST.h b/Source/cmRST.h new file mode 100644 index 0000000..9352941 --- /dev/null +++ b/Source/cmRST.h @@ -0,0 +1,83 @@ +/*============================================================================ + CMake - Cross Platform Makefile Generator + Copyright 2000-2013 Kitware, Inc., Insight Software Consortium + + Distributed under the OSI-approved BSD License (the "License"); + see accompanying file Copyright.txt for details. + + This software is distributed WITHOUT ANY WARRANTY; without even the + implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the License for more information. +============================================================================*/ +#ifndef _cmRST_h +#define _cmRST_h + +#include "cmStandardIncludes.h" + +#include <cmsys/RegularExpression.hxx> + +class cmRST +{ +public: + cmRST(std::ostream& os, std::string const& docroot); + bool ProcessFile(std::string const& fname, bool isModule = false); +private: + enum IncludeType + { + IncludeNormal, + IncludeModule, + IncludeTocTree + }; + enum MarkupType + { + MarkupNone, + MarkupNormal, + MarkupEmpty + }; + enum DirectiveType + { + DirectiveNone, + DirectiveParsedLiteral, + DirectiveCodeBlock, + DirectiveReplace, + DirectiveTocTree + }; + + void ProcessRST(std::istream& is); + void ProcessModule(std::istream& is); + void Reset(); + void ProcessLine(std::string const& line); + void NormalLine(std::string const& line); + void OutputLine(std::string const& line); + std::string ReplaceSubstitutions(std::string const& line); + bool ProcessInclude(std::string file, IncludeType type); + void ProcessDirectiveParsedLiteral(); + void ProcessDirectiveCodeBlock(); + void ProcessDirectiveReplace(); + void ProcessDirectiveTocTree(); + static void UnindentLines(std::vector<std::string>& lines); + + std::ostream& OS; + std::string DocRoot; + int IncludeDepth; + bool OutputLinePending; + MarkupType Markup; + DirectiveType Directive; + cmsys::RegularExpression CMakeDirective; + cmsys::RegularExpression CMakeModuleDirective; + cmsys::RegularExpression ParsedLiteralDirective; + cmsys::RegularExpression CodeBlockDirective; + cmsys::RegularExpression ReplaceDirective; + cmsys::RegularExpression IncludeDirective; + cmsys::RegularExpression TocTreeDirective; + cmsys::RegularExpression CMakeRole; + cmsys::RegularExpression Substitution; + + std::vector<std::string> MarkupLines; + std::string DocDir; + std::map<cmStdString, cmStdString> Replace; + std::set<cmStdString> Replaced; + std::string ReplaceName; +}; + +#endif diff --git a/Source/cmRemoveCommand.h b/Source/cmRemoveCommand.h index 5aedc26..ad73908 100644 --- a/Source/cmRemoveCommand.h +++ b/Source/cmRemoveCommand.h @@ -47,26 +47,6 @@ public: */ virtual const char* GetName() const {return "remove";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the list(REMOVE_ITEM ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " remove(VAR VALUE VALUE ...)\n" - "Removes VALUE from the variable VAR. " - "This is typically used to remove entries from a vector " - "(e.g. semicolon separated list). VALUE is expanded."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmRemoveDefinitionsCommand.h b/Source/cmRemoveDefinitionsCommand.h index 18f6171..4e291fc 100644 --- a/Source/cmRemoveDefinitionsCommand.h +++ b/Source/cmRemoveDefinitionsCommand.h @@ -44,25 +44,6 @@ public: */ virtual const char* GetName() const {return "remove_definitions";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Removes -D define flags added by add_definitions."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " remove_definitions(-DFOO -DBAR ...)\n" - "Removes flags (added by add_definitions) from the compiler command " - "line for sources in the current directory and below."; - } - cmTypeMacro(cmRemoveDefinitionsCommand, cmCommand); }; diff --git a/Source/cmReturnCommand.h b/Source/cmReturnCommand.h index a6e87ef..2822b62 100644 --- a/Source/cmReturnCommand.h +++ b/Source/cmReturnCommand.h @@ -47,32 +47,6 @@ public: */ virtual const char* GetName() const {return "return";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Return from a file, directory or function."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " return()\n" - "Returns from a file, directory or function. When this command is " - "encountered in an included file (via include() or find_package()), " - "it causes processing of the current file to stop and control is " - "returned to the including file. If it is encountered in a file which " - "is not included by another file, e.g. a CMakeLists.txt, control is " - "returned to the parent directory if there is one. " - "If return is called in a function, control is returned to the caller " - "of the function. Note that a macro " - "is not a function and does not handle return like a function does."; - } - cmTypeMacro(cmReturnCommand, cmCommand); }; diff --git a/Source/cmSeparateArgumentsCommand.h b/Source/cmSeparateArgumentsCommand.h index d62baf7..ce02360 100644 --- a/Source/cmSeparateArgumentsCommand.h +++ b/Source/cmSeparateArgumentsCommand.h @@ -47,43 +47,6 @@ public: */ virtual const char* GetName() const {return "separate_arguments";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Parse space-separated arguments into a semicolon-separated list."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " separate_arguments(<var> <UNIX|WINDOWS>_COMMAND \"<args>\")\n" - "Parses a unix- or windows-style command-line string \"<args>\" and " - "stores a semicolon-separated list of the arguments in <var>. " - "The entire command line must be given in one \"<args>\" argument." - "\n" - "The UNIX_COMMAND mode separates arguments by unquoted whitespace. " - "It recognizes both single-quote and double-quote pairs. " - "A backslash escapes the next literal character (\\\" is \"); " - "there are no special escapes (\\n is just n)." - "\n" - "The WINDOWS_COMMAND mode parses a windows command-line using the " - "same syntax the runtime library uses to construct argv at startup. " - "It separates arguments by whitespace that is not double-quoted. " - "Backslashes are literal unless they precede double-quotes. " - "See the MSDN article \"Parsing C Command-Line Arguments\" for details." - "\n" - " separate_arguments(VARIABLE)\n" - "Convert the value of VARIABLE to a semi-colon separated list. " - "All spaces are replaced with ';'. This helps with generating " - "command lines."; - } - cmTypeMacro(cmSeparateArgumentsCommand, cmCommand); }; diff --git a/Source/cmSetCommand.h b/Source/cmSetCommand.h index fe1d58d..6cef0a0 100644 --- a/Source/cmSetCommand.h +++ b/Source/cmSetCommand.h @@ -47,114 +47,6 @@ public: */ virtual const char* GetName() const {return "set";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a CMake, cache or environment variable to a given value."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set(<variable> <value>\n" - " [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])\n" - "Within CMake sets <variable> to the value <value>. " - "<value> is expanded before <variable> is set to it. " - "Normally, set will set a regular CMake variable. " - "If CACHE is present, then the <variable> is put in the cache " - "instead, unless it is already in the cache. " - "See section 'Variable types in CMake' below for details of " - "regular and cache variables and their interactions. " - "If CACHE is used, <type> and <docstring> are required. <type> is used " - "by the CMake GUI to choose a widget with which the user sets a value. " - "The value for <type> may be one of\n" - " FILEPATH = File chooser dialog.\n" - " PATH = Directory chooser dialog.\n" - " STRING = Arbitrary string.\n" - " BOOL = Boolean ON/OFF checkbox.\n" - " INTERNAL = No GUI entry (used for persistent variables).\n" - "If <type> is INTERNAL, the cache variable is marked as internal, " - "and will not be shown to the user in tools like cmake-gui. " - "This is intended for values that should be persisted in the cache, " - "but which users should not normally change. INTERNAL implies FORCE." - "\n" - "Normally, set(...CACHE...) creates cache variables, but does not " - "modify them. " - "If FORCE is specified, the value of the cache variable is set, even " - "if the variable is already in the cache. This should normally be " - "avoided, as it will remove any changes to the cache variable's value " - "by the user.\n" - "If PARENT_SCOPE is present, the variable will be set in the scope " - "above the current scope. Each new directory or function creates a new " - "scope. This command will set the value of a variable into the parent " - "directory or calling function (whichever is applicable to the case at " - "hand). PARENT_SCOPE cannot be combined with CACHE.\n" - "If <value> is not specified then the variable is removed " - "instead of set. See also: the unset() command.\n" - " set(<variable> <value1> ... <valueN>)\n" - "In this case <variable> is set to a semicolon separated list of " - "values.\n" - "<variable> can be an environment variable such as:\n" - " set( ENV{PATH} /home/martink )\n" - "in which case the environment variable will be set.\n" - "*** Variable types in CMake ***\n" - "In CMake there are two types of variables: normal variables and cache " - "variables. Normal variables are meant for the internal use of the " - "script (just like variables in most programming languages); they are " - "not persisted across CMake runs. " - "Cache variables (unless set with INTERNAL) are mostly intended for " - "configuration settings where the first CMake run determines a " - "suitable default value, which the user can then override, by editing " - "the cache with tools such as ccmake or cmake-gui. " - "Cache variables are stored in the CMake cache file, and " - "are persisted across CMake runs. \n" - "Both types can exist at the same time with the same name " - "but different values. " - "When ${FOO} is evaluated, CMake first looks for " - "a normal variable 'FOO' in scope and uses it if set. " - "If and only if no normal variable exists then it falls back to the " - "cache variable 'FOO'.\n" - "Some examples:\n" - "The code 'set(FOO \"x\")' sets the normal variable 'FOO'. It does not " - "touch the cache, but it will hide any existing cache value 'FOO'.\n" - "The code 'set(FOO \"x\" CACHE ...)' checks for 'FOO' in the cache, " - "ignoring any normal variable of the same name. If 'FOO' is in the " - "cache then nothing happens to either the normal variable or the cache " - "variable. If 'FOO' is not in the cache, then it is added to the " - "cache.\n" - "Finally, whenever a cache variable is added or modified by a command, " - "CMake also *removes* the normal variable of the same name from the " - "current scope so that an immediately following evaluation of " - "it will expose the newly cached value.\n" - "Normally projects should avoid using normal and cache variables of " - "the same name, as this interaction can be hard to follow. " - "However, in some situations it can be useful. " - "One example (used by some projects):" - "\n" - "A project has a subproject in its source tree. The child project has " - "its own CMakeLists.txt, which is included from the parent " - "CMakeLists.txt using add_subdirectory(). " - "Now, if the parent and the child project provide the same option " - "(for example a compiler option), the parent gets the first chance " - "to add a user-editable option to the cache. " - "Normally, the child would then use the same value " - "that the parent uses. " - "However, it may be necessary to hard-code the value for the child " - "project's option while still allowing the user to edit the value used " - "by the parent project. The parent project can achieve this simply by " - "setting a normal variable with the same name as the option in a scope " - "sufficient to hide the option's cache variable from the child " - "completely. The parent has already set the cache variable, so the " - "child's set(...CACHE...) will do nothing, and evaluating the option " - "variable will use the value from the normal variable, which hides the " - "cache variable."; - } - cmTypeMacro(cmSetCommand, cmCommand); }; diff --git a/Source/cmSetDirectoryPropertiesCommand.h b/Source/cmSetDirectoryPropertiesCommand.h index 8a50c60..6240598 100644 --- a/Source/cmSetDirectoryPropertiesCommand.h +++ b/Source/cmSetDirectoryPropertiesCommand.h @@ -40,14 +40,6 @@ public: virtual const char* GetName() const { return "set_directory_properties";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a property of the directory."; - } - - /** * Static entry point for use by other commands */ static bool RunCommand(cmMakefile *mf, @@ -55,21 +47,6 @@ public: std::vector<std::string>::const_iterator aitend, std::string &errors); - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_directory_properties(PROPERTIES prop1 value1 prop2 value2)\n" - "Set a property for the current directory and subdirectories. If the " - "property is not found, CMake will report an error. The properties " - "include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, " - "INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. " - "ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned " - "as a part of \"make clean\" stage."; - } - cmTypeMacro(cmSetDirectoryPropertiesCommand, cmCommand); }; diff --git a/Source/cmSetPropertyCommand.h b/Source/cmSetPropertyCommand.h index 830299d..5470314 100644 --- a/Source/cmSetPropertyCommand.h +++ b/Source/cmSetPropertyCommand.h @@ -37,53 +37,6 @@ public: virtual const char* GetName() const { return "set_property";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a named property in a given scope."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_property(<GLOBAL |\n" - " DIRECTORY [dir] |\n" - " TARGET [target1 [target2 ...]] |\n" - " SOURCE [src1 [src2 ...]] |\n" - " TEST [test1 [test2 ...]] |\n" - " CACHE [entry1 [entry2 ...]]>\n" - " [APPEND] [APPEND_STRING]\n" - " PROPERTY <name> [value1 [value2 ...]])\n" - "Set one property on zero or more objects of a scope. " - "The first argument determines the scope in which the property " - "is set. It must be one of the following:\n" - "GLOBAL scope is unique and does not accept a name.\n" - "DIRECTORY scope defaults to the current directory but another " - "directory (already processed by CMake) may be named by full or " - "relative path.\n" - "TARGET scope may name zero or more existing targets.\n" - "SOURCE scope may name zero or more source files. " - "Note that source file properties are visible only to targets " - "added in the same directory (CMakeLists.txt).\n" - "TEST scope may name zero or more existing tests.\n" - "CACHE scope must name zero or more cache existing entries.\n" - "The required PROPERTY option is immediately followed by the name " - "of the property to set. Remaining arguments are used to " - "compose the property value in the form of a semicolon-separated " - "list. " - "If the APPEND option is given the list is appended to any " - "existing property value." - "If the APPEND_STRING option is given the string is append to any " - "existing property value as string, i.e. it results in a longer " - "string and not a list of strings." - ; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } diff --git a/Source/cmSetSourceFilesPropertiesCommand.h b/Source/cmSetSourceFilesPropertiesCommand.h index f7009e7..8541a96 100644 --- a/Source/cmSetSourceFilesPropertiesCommand.h +++ b/Source/cmSetSourceFilesPropertiesCommand.h @@ -34,31 +34,6 @@ public: */ virtual const char* GetName() const { return "set_source_files_properties";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Source files can have properties that affect how they are built."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_source_files_properties([file1 [file2 [...]]]\n" - " PROPERTIES prop1 value1\n" - " [prop2 value2 [...]])\n" - "Set properties associated with source files using a key/value " - "paired list. " - "See properties documentation for those known to CMake. " - "Unrecognized properties are ignored. " - "Source file properties are visible only to targets " - "added in the same directory (CMakeLists.txt)."; - } - cmTypeMacro(cmSetSourceFilesPropertiesCommand, cmCommand); static bool RunCommand(cmMakefile *mf, diff --git a/Source/cmSetTargetPropertiesCommand.h b/Source/cmSetTargetPropertiesCommand.h index cf9c193..6221a18 100644 --- a/Source/cmSetTargetPropertiesCommand.h +++ b/Source/cmSetTargetPropertiesCommand.h @@ -35,133 +35,12 @@ public: virtual const char* GetName() const { return "set_target_properties";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Targets can have properties that affect how they are built."; - } - - /** * Used by this command and cmSetPropertiesCommand */ static bool SetOneTarget(const char *tname, std::vector<std::string> &propertyPairs, cmMakefile *mf); - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_target_properties(target1 target2 ...\n" - " PROPERTIES prop1 value1\n" - " prop2 value2 ...)\n" - "Set properties on a target. The syntax for the command is to " - "list all the files you want " - "to change, and then provide the values you want to set next. " - "You can use any prop value pair you want and " - "extract it later with the GET_TARGET_PROPERTY command.\n" - "Properties that affect the name of a target's output file are " - "as follows. " - "The PREFIX and SUFFIX properties override the default target name " - "prefix (such as \"lib\") and suffix (such as \".so\"). " - "IMPORT_PREFIX and IMPORT_SUFFIX are the equivalent properties for " - "the import library corresponding to a DLL " - "(for SHARED library targets). " - "OUTPUT_NAME sets the real name of a target when it is built and " - "can be used to help create two targets of the same name even though " - "CMake requires unique logical target names. There is also a " - "<CONFIG>_OUTPUT_NAME that can set the output name on a " - "per-configuration basis. " - "<CONFIG>_POSTFIX sets a postfix for the real name of the target " - "when it is built under the configuration named by <CONFIG> " - "(in upper-case, such as \"DEBUG_POSTFIX\"). The value of " - "this property is initialized when the target is created to the " - "value of the variable CMAKE_<CONFIG>_POSTFIX (except for executable " - "targets because earlier CMake versions which did not use this " - "variable for executables)." - "\n" - "The LINK_FLAGS property can be used to add extra flags to the " - "link step of a target. LINK_FLAGS_<CONFIG> will add to the " - "configuration <CONFIG>, " - "for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. " - "DEFINE_SYMBOL sets the name of the preprocessor symbol defined when " - "compiling sources in a shared library. " - "If not set here then it is set to target_EXPORTS by default " - "(with some substitutions if the target is not a valid C " - "identifier). This is useful for headers to know whether they are " - "being included from inside their library or outside to properly " - "setup dllexport/dllimport decorations. " - "The COMPILE_FLAGS property sets additional compiler flags used " - "to build sources within the target. It may also be used to pass " - "additional preprocessor definitions." - "\n" - "The LINKER_LANGUAGE property is used to change the tool " - "used to link an executable or shared library. The default is " - "set the language to match the files in the library. CXX and C " - "are common values for this property." - "\n" - "For shared libraries VERSION and SOVERSION can be used to specify " - "the build version and API version respectively. When building or " - "installing appropriate symlinks are created if the platform " - "supports symlinks and the linker supports so-names. " - "If only one of both is specified the missing is assumed to have " - "the same version number. " - "For executables VERSION can be used to specify the build version. " - "When building or installing appropriate symlinks are created if " - "the platform supports symlinks. " - "For shared libraries and executables on Windows the VERSION " - "attribute is parsed to extract a \"major.minor\" version number. " - "These numbers are used as the image version of the binary. " - "\n" - "There are a few properties used to specify RPATH rules. " - "INSTALL_RPATH is a semicolon-separated list specifying the rpath " - "to use in installed targets (for platforms that support it). " - "INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will " - "append directories in the linker search path and outside the " - "project to the INSTALL_RPATH. " - "SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic " - "generation of an rpath allowing the target to run from the " - "build tree. " - "BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link " - "the target in the build tree with the INSTALL_RPATH. This takes " - "precedence over SKIP_BUILD_RPATH and avoids the need for relinking " - "before installation. INSTALL_NAME_DIR is a string specifying the " - "directory portion of the \"install_name\" field of shared libraries " - "on Mac OSX to use in the installed targets. " - "When the target is created the values of " - "the variables CMAKE_INSTALL_RPATH, " - "CMAKE_INSTALL_RPATH_USE_LINK_PATH, CMAKE_SKIP_BUILD_RPATH, " - "CMAKE_BUILD_WITH_INSTALL_RPATH, and CMAKE_INSTALL_NAME_DIR " - "are used to initialize these properties.\n" - "PROJECT_LABEL can be used to change the name of " - "the target in an IDE like visual studio. VS_KEYWORD can be set " - "to change the visual studio keyword, for example Qt integration " - "works better if this is set to Qt4VSv1.0.\n" - "VS_SCC_PROJECTNAME, VS_SCC_LOCALPATH, VS_SCC_PROVIDER and " - "VS_SCC_AUXPATH can be set " - "to add support for source control bindings in a Visual Studio " - "project file.\n" - "VS_GLOBAL_<variable> can be set to add a Visual Studio " - "project-specific global variable. " - "Qt integration works better if VS_GLOBAL_QtVersion is set to " - "the Qt version FindQt4.cmake found. For example, \"4.7.3\"\n" - "The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the " - "old way to specify CMake scripts to run before and after " - "installing a target. They are used only when the old " - "INSTALL_TARGETS command is used to install the target. Use the " - "INSTALL command instead." - "\n" - "The EXCLUDE_FROM_DEFAULT_BUILD property is used by the visual " - "studio generators. If it is set to 1 the target will not be " - "part of the default build when you select \"Build Solution\". " - "This can also be set on a per-configuration basis using " - "EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>." - ; - } - cmTypeMacro(cmSetTargetPropertiesCommand, cmCommand); }; diff --git a/Source/cmSetTestsPropertiesCommand.h b/Source/cmSetTestsPropertiesCommand.h index f2f2611..9e85495 100644 --- a/Source/cmSetTestsPropertiesCommand.h +++ b/Source/cmSetTestsPropertiesCommand.h @@ -34,41 +34,6 @@ public: */ virtual const char* GetName() const { return "set_tests_properties";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set a property of the tests."; - } - - /** - * Longer documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2" - " value2)\n" - "Set a property for the tests. If the property is not found, CMake " - "will report an error. Generator expressions will be expanded the same " - "as supported by the test's add_test call. The properties include:\n" - "WILL_FAIL: If set to true, this will invert the pass/fail flag of the" - " test.\n" - "PASS_REGULAR_EXPRESSION: If set, the test output will be checked " - "against the specified regular expressions and at least one of the" - " regular " - "expressions has to match, otherwise the test will fail.\n" - " Example: PASS_REGULAR_EXPRESSION \"TestPassed;All ok\"\n" - "FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of " - "specified regular expressions, the test will fail.\n" - " Example: PASS_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"\n" - "Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a " - "list of regular expressions.\n" - "TIMEOUT: Setting this will limit the test runtime to the number of " - "seconds specified.\n"; - } - cmTypeMacro(cmSetTestsPropertiesCommand, cmCommand); static bool SetOneTest(const char *tname, diff --git a/Source/cmSiteNameCommand.h b/Source/cmSiteNameCommand.h index 52a63bc..eb9d4d8 100644 --- a/Source/cmSiteNameCommand.h +++ b/Source/cmSiteNameCommand.h @@ -47,23 +47,6 @@ public: */ virtual const char* GetName() const {return "site_name";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Set the given variable to the name of the computer."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " site_name(variable)\n"; - } - cmTypeMacro(cmSiteNameCommand, cmCommand); }; diff --git a/Source/cmSourceFile.cxx b/Source/cmSourceFile.cxx index 8bb7d96..d747309 100644 --- a/Source/cmSourceFile.cxx +++ b/Source/cmSourceFile.cxx @@ -16,7 +16,6 @@ #include "cmMakefile.h" #include "cmSystemTools.h" #include "cmake.h" -#include "cmDocumentCompileDefinitions.h" //---------------------------------------------------------------------------- cmSourceFile::cmSourceFile(cmMakefile* mf, const char* name): @@ -382,176 +381,3 @@ void cmSourceFile::SetCustomCommand(cmCustomCommand* cc) this->CustomCommand = cc; delete old; } - -//---------------------------------------------------------------------------- -void cmSourceFile::DefineProperties(cmake *cm) -{ - // define properties - cm->DefineProperty - ("ABSTRACT", cmProperty::SOURCE_FILE, - "Is this source file an abstract class.", - "A property on a source file that indicates if the source file " - "represents a class that is abstract. This only makes sense for " - "languages that have a notion of an abstract class and it is " - "only used by some tools that wrap classes into other languages."); - - cm->DefineProperty - ("COMPILE_FLAGS", cmProperty::SOURCE_FILE, - "Additional flags to be added when compiling this source file.", - "These flags will be added to the list of compile flags when " - "this source file builds. Use COMPILE_DEFINITIONS to pass additional " - "preprocessor definitions."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::SOURCE_FILE, - "Preprocessor definitions for compiling a source file.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\").\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does). Xcode does not support per-configuration " - "definitions on source files.\n" - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::SOURCE_FILE, - "Per-configuration preprocessor definitions on a source file.", - "This is the configuration-specific version of " - "COMPILE_DEFINITIONS. Note that Xcode does not support " - "per-configuration source file flags so this property will " - "be ignored by the Xcode generator."); - - cm->DefineProperty - ("EXTERNAL_OBJECT", cmProperty::SOURCE_FILE, - "If set to true then this is an object file.", - "If this property is set to true then the source file " - "is really an object file and should not be compiled. " - "It will still be linked into the target though."); - - cm->DefineProperty - ("Fortran_FORMAT", cmProperty::SOURCE_FILE, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This property tells CMake whether a given Fortran source file " - "uses fixed-format or free-format. " - "CMake will pass the corresponding format flag to the compiler. " - "Consider using the target-wide Fortran_FORMAT property if all " - "source files in a target share the same format."); - - cm->DefineProperty - ("GENERATED", cmProperty::SOURCE_FILE, - "Is this source file generated as part of the build process.", - "If a source file is generated by the build process CMake will " - "handle it differently in terms of dependency checking etc. " - "Otherwise having a non-existent source file could create problems."); - - cm->DefineProperty - ("HEADER_FILE_ONLY", cmProperty::SOURCE_FILE, - "Is this source file only a header file.", - "A property on a source file that indicates if the source file " - "is a header file with no associated implementation. This is " - "set automatically based on the file extension and is used by " - "CMake to determine if certain dependency information should be " - "computed."); - - cm->DefineProperty - ("KEEP_EXTENSION", cmProperty::SOURCE_FILE, - "Make the output file have the same extension as the source file.", - "If this property is set then the file extension of the output " - "file will be the same as that of the source file. Normally " - "the output file extension is computed based on the language " - "of the source file, for example .cxx will go to a .o extension."); - - cm->DefineProperty - ("LABELS", cmProperty::SOURCE_FILE, - "Specify a list of text labels associated with a source file.", - "This property has meaning only when the source file is listed in " - "a target whose LABELS property is also set. " - "No other semantics are currently specified."); - - cm->DefineProperty - ("LANGUAGE", cmProperty::SOURCE_FILE, - "What programming language is the file.", - "A property that can be set to indicate what programming language " - "the source file is. If it is not set the language is determined " - "based on the file extension. Typical values are CXX C etc. Setting " - "this property for a file means this file will be compiled. " - "Do not set this for headers or files that should not be compiled."); - - cm->DefineProperty - ("LOCATION", cmProperty::SOURCE_FILE, - "The full path to a source file.", - "A read only property on a SOURCE FILE that contains the full path " - "to the source file."); - - cm->DefineProperty - ("MACOSX_PACKAGE_LOCATION", cmProperty::SOURCE_FILE, - "Place a source file inside a Mac OS X bundle, CFBundle, or framework.", - "Executable targets with the MACOSX_BUNDLE property set are built " - "as Mac OS X application bundles on Apple platforms. " - "Shared library targets with the FRAMEWORK property set are built " - "as Mac OS X frameworks on Apple platforms. " - "Module library targets with the BUNDLE property set are built " - "as Mac OS X CFBundle bundles on Apple platforms. " - "Source files listed in the target with this property set will " - "be copied to a directory inside the bundle or framework content " - "folder specified by the property value. " - "For bundles the content folder is \"<name>.app/Contents\". " - "For frameworks the content folder is " - "\"<name>.framework/Versions/<version>\". " - "For cfbundles the content folder is " - "\"<name>.bundle/Contents\" (unless the extension is changed). " - "See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target " - "properties for specifying files meant for Headers, PrivateHeaders, " - "or Resources directories."); - - cm->DefineProperty - ("OBJECT_DEPENDS", cmProperty::SOURCE_FILE, - "Additional files on which a compiled object file depends.", - "Specifies a semicolon-separated list of full-paths to files on which " - "any object files compiled from this source file depend. " - "An object file will be recompiled if any of the named files is newer " - "than it.\n" - "This property need not be used to specify the dependency of a " - "source file on a generated header file that it includes. " - "Although the property was originally introduced for this purpose, it " - "is no longer necessary. " - "If the generated header file is created by a custom command in the " - "same target as the source file, the automatic dependency scanning " - "process will recognize the dependency. " - "If the generated header file is created by another target, an " - "inter-target dependency should be created with the add_dependencies " - "command (if one does not already exist due to linking relationships)."); - - cm->DefineProperty - ("OBJECT_OUTPUTS", cmProperty::SOURCE_FILE, - "Additional outputs for a Makefile rule.", - "Additional outputs created by compilation of this source file. " - "If any of these outputs is missing the object will be recompiled. " - "This is supported only on Makefile generators and will be ignored " - "on other generators."); - - cm->DefineProperty - ("SYMBOLIC", cmProperty::SOURCE_FILE, - "Is this just a name for a rule.", - "If SYMBOLIC (boolean) is set to true the build system will be " - "informed that the source file is not actually created on disk but " - "instead used as a symbolic name for a build rule."); - - cm->DefineProperty - ("WRAP_EXCLUDE", cmProperty::SOURCE_FILE, - "Exclude this source file from any code wrapping techniques.", - "Some packages can wrap source files into alternate languages " - "to provide additional functionality. For example, C++ code " - "can be wrapped into Java or Python etc using SWIG etc. " - "If WRAP_EXCLUDE is set to true (1 etc) that indicates that " - "this source file should not be wrapped."); -} - diff --git a/Source/cmSourceFile.h b/Source/cmSourceFile.h index 6c68b87..4440b05 100644 --- a/Source/cmSourceFile.h +++ b/Source/cmSourceFile.h @@ -90,9 +90,6 @@ public: // Get the properties cmPropertyMap &GetProperties() { return this->Properties; }; - // Define the properties - static void DefineProperties(cmake *cm); - /** * Check whether the given source file location could refer to this * source. diff --git a/Source/cmSourceGroupCommand.h b/Source/cmSourceGroupCommand.h index 9f6b7e4..5d8b48c 100644 --- a/Source/cmSourceGroupCommand.h +++ b/Source/cmSourceGroupCommand.h @@ -43,36 +43,6 @@ public: */ virtual const char* GetName() const {return "source_group";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Define a grouping for sources in the makefile."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " source_group(name [REGULAR_EXPRESSION regex] " - "[FILES src1 src2 ...])\n" - "Defines a group into which sources will be placed in project files. " - "This is mainly used to setup file tabs in Visual Studio. " - "Any file whose name is listed or matches the regular expression will " - "be placed in this group. If a file matches multiple groups, the LAST " - "group that explicitly lists the file will be favored, if any. If no " - "group explicitly lists the file, the LAST group whose regular " - "expression matches the file will be favored.\n" - "The name of the group may contain backslashes to specify subgroups:\n" - " source_group(outer\\\\inner ...)\n" - "For backwards compatibility, this command also supports the " - "format:\n" - " source_group(name regex)"; - } - cmTypeMacro(cmSourceGroupCommand, cmCommand); }; diff --git a/Source/cmStandardIncludes.h b/Source/cmStandardIncludes.h index a4aec2e..d09b304 100644 --- a/Source/cmStandardIncludes.h +++ b/Source/cmStandardIncludes.h @@ -321,14 +321,12 @@ struct cmDocumentationEntry { std::string Name; std::string Brief; - std::string Full; cmDocumentationEntry(){}; - cmDocumentationEntry(const char *doc[3]) + cmDocumentationEntry(const char *doc[2]) { if (doc[0]) this->Name = doc[0]; - if (doc[1]) this->Brief = doc[1]; - if (doc[2]) this->Full = doc[2]; }; - cmDocumentationEntry(const char *n, const char *b, const char *f) - { if (n) this->Name = n; if (b) this->Brief = b; if (f) this->Full = f; }; + if (doc[1]) this->Brief = doc[1];}; + cmDocumentationEntry(const char *n, const char *b) + { if (n) this->Name = n; if (b) this->Brief = b; }; }; /** Data structure to represent a single command line. */ diff --git a/Source/cmStringCommand.h b/Source/cmStringCommand.h index f584cfd..0e833c4 100644 --- a/Source/cmStringCommand.h +++ b/Source/cmStringCommand.h @@ -52,136 +52,6 @@ public: */ virtual const char* GetName() const { return "string";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "String operations."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " string(REGEX MATCH <regular_expression>\n" - " <output variable> <input> [<input>...])\n" - " string(REGEX MATCHALL <regular_expression>\n" - " <output variable> <input> [<input>...])\n" - " string(REGEX REPLACE <regular_expression>\n" - " <replace_expression> <output variable>\n" - " <input> [<input>...])\n" - " string(REPLACE <match_string>\n" - " <replace_string> <output variable>\n" - " <input> [<input>...])\n" - " string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512>\n" - " <output variable> <input>)\n" - " string(COMPARE EQUAL <string1> <string2> <output variable>)\n" - " string(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n" - " string(COMPARE LESS <string1> <string2> <output variable>)\n" - " string(COMPARE GREATER <string1> <string2> <output variable>)\n" - " string(ASCII <number> [<number> ...] <output variable>)\n" - " string(CONFIGURE <string1> <output variable>\n" - " [@ONLY] [ESCAPE_QUOTES])\n" - " string(TOUPPER <string1> <output variable>)\n" - " string(TOLOWER <string1> <output variable>)\n" - " string(LENGTH <string> <output variable>)\n" - " string(SUBSTRING <string> <begin> <length> <output variable>)\n" - " string(STRIP <string> <output variable>)\n" - " string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]\n" - " [RANDOM_SEED <seed>] <output variable>)\n" - " string(FIND <string> <substring> <output variable> [REVERSE])\n" - " string(TIMESTAMP <output variable> [<format string>] [UTC])\n" - " string(MAKE_C_IDENTIFIER <input string> <output variable>)\n" - "REGEX MATCH will match the regular expression once and store the " - "match in the output variable.\n" - "REGEX MATCHALL will match the regular expression as many times as " - "possible and store the matches in the output variable as a list.\n" - "REGEX REPLACE will match the regular expression as many times as " - "possible and substitute the replacement expression for the match " - "in the output. The replace expression may refer to paren-delimited " - "subexpressions of the match using \\1, \\2, ..., \\9. Note that " - "two backslashes (\\\\1) are required in CMake code to get a " - "backslash through argument parsing.\n" - "REPLACE will replace all occurrences of match_string in the input with " - "replace_string and store the result in the output.\n" - "MD5, SHA1, SHA224, SHA256, SHA384, and SHA512 " - "will compute a cryptographic hash of the input string.\n" - "COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and " - "store true or false in the output variable.\n" - "ASCII will convert all numbers into corresponding ASCII characters.\n" - "CONFIGURE will transform a string like CONFIGURE_FILE transforms " - "a file.\n" - "TOUPPER/TOLOWER will convert string to upper/lower characters.\n" - "LENGTH will return a given string's length.\n" - "SUBSTRING will return a substring of a given string. If length is " - "-1 the remainder of the string starting at begin will be returned.\n" - "STRIP will return a substring of a given string with leading " - "and trailing spaces removed.\n" - "RANDOM will return a random string of given length consisting of " - "characters from the given alphabet. Default length is 5 " - "characters and default alphabet is all numbers and upper and " - "lower case letters. If an integer RANDOM_SEED is given, its " - "value will be used to seed the random number generator.\n" - "FIND will return the position where the given substring was found " - "in the supplied string. If the REVERSE flag was used, the command " - "will search for the position of the last occurrence of the " - "specified substring.\n" - "The following characters have special meaning in regular expressions:\n" - " ^ Matches at beginning of input\n" - " $ Matches at end of input\n" - " . Matches any single character\n" - " [ ] Matches any character(s) inside the brackets\n" - " [^ ] Matches any character(s) not inside the brackets\n" - " - Inside brackets, specifies an inclusive range between\n" - " characters on either side e.g. [a-f] is [abcdef]\n" - " To match a literal - using brackets, make it the first\n" - " or the last character e.g. [+*/-] matches basic\n" - " mathematical operators.\n" - " * Matches preceding pattern zero or more times\n" - " + Matches preceding pattern one or more times\n" - " ? Matches preceding pattern zero or once only\n" - " | Matches a pattern on either side of the |\n" - " () Saves a matched subexpression, which can be referenced \n" - " in the REGEX REPLACE operation. Additionally it is saved\n" - " by all regular expression-related commands, including \n" - " e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9).\n" - "*, + and ? have higher precedence than concatenation. | has lower " - "precedence than concatenation. This means that the regular expression " - "\"^ab+d$\" matches \"abbd\" but not \"ababd\", and the regular " - "expression \"^(ab|cd)$\" matches \"ab\" but not \"abd\".\n" - "TIMESTAMP will write a string representation of " - "the current date and/or time to the output variable.\n" - "Should the command be unable to obtain a timestamp " - "the output variable will be set to the empty string \"\".\n" - "The optional UTC flag requests the current date/time " - "representation to be in Coordinated Universal Time (UTC) " - "rather than local time.\n" - "The optional <format string> may contain the following " - "format specifiers: \n" - " %d The day of the current month (01-31).\n" - " %H The hour on a 24-hour clock (00-23).\n" - " %I The hour on a 12-hour clock (01-12).\n" - " %j The day of the current year (001-366).\n" - " %m The month of the current year (01-12).\n" - " %M The minute of the current hour (00-59).\n" - " %S The second of the current minute.\n" - " 60 represents a leap second. (00-60)\n" - " %U The week number of the current year (00-53).\n" - " %w The day of the current week. 0 is Sunday. (0-6)\n" - " %y The last two digits of the current year (00-99)\n" - " %Y The current year. \n" - "Unknown format specifiers will be ignored " - "and copied to the output as-is.\n" - "If no explicit <format string> is given it will default to:\n" - " %Y-%m-%dT%H:%M:%S for local time.\n" - " %Y-%m-%dT%H:%M:%SZ for UTC.\n" - "MAKE_C_IDENTIFIER will write a string which can be used as an " - "identifier in C."; - } - cmTypeMacro(cmStringCommand, cmCommand); static void ClearMatches(cmMakefile* mf); static void StoreMatches(cmMakefile* mf, cmsys::RegularExpression& re); diff --git a/Source/cmSubdirCommand.h b/Source/cmSubdirCommand.h index 618d5ff..8be8335 100644 --- a/Source/cmSubdirCommand.h +++ b/Source/cmSubdirCommand.h @@ -44,40 +44,6 @@ public: */ virtual const char* GetName() const { return "subdirs";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the add_subdirectory() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Add a list of subdirectories to the build.\n" - " subdirs(dir1 dir2 ..." - "[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]\n" - " [PREORDER] )\n" - "Add a list of subdirectories to the build. The add_subdirectory " - "command should be used instead of subdirs although subdirs will " - "still work. " - "This will cause any CMakeLists.txt files in the sub directories " - "to be processed by CMake. Any directories after the PREORDER flag " - "are traversed first by makefile builds, the PREORDER flag has no " - "effect on IDE projects. " - " Any directories after the EXCLUDE_FROM_ALL marker " - "will not be included in the top level makefile or project file. " - "This is useful for having CMake create makefiles or projects for " - "a set of examples in a project. You would want CMake to " - "generate makefiles or project files for all the examples at " - "the same time, but you would not want them to show up in the " - "top level project or be built each time make is run from the top."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmSubdirDependsCommand.h b/Source/cmSubdirDependsCommand.h index b274d01..e6f1f8f 100644 --- a/Source/cmSubdirDependsCommand.h +++ b/Source/cmSubdirDependsCommand.h @@ -44,25 +44,6 @@ public: */ virtual const char* GetName() const { return "subdir_depends";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Does nothing."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " subdir_depends(subdir dep1 dep2 ...)\n" - "Does not do anything. This command used to help projects order " - "parallel builds correctly. This functionality is now automatic."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmSystemTools.cxx b/Source/cmSystemTools.cxx index 9ec4938..cbd4632 100644 --- a/Source/cmSystemTools.cxx +++ b/Source/cmSystemTools.cxx @@ -200,6 +200,13 @@ std::string cmSystemTools::EscapeQuotes(const char* str) return result; } +std::string cmSystemTools::HelpFileName(std::string name) +{ + cmSystemTools::ReplaceString(name, "<", ""); + cmSystemTools::ReplaceString(name, ">", ""); + return name; +} + std::string cmSystemTools::TrimWhitespace(const std::string& s) { std::string::const_iterator start = s.begin(); diff --git a/Source/cmSystemTools.h b/Source/cmSystemTools.h index 9d7dae9..cbc1140 100644 --- a/Source/cmSystemTools.h +++ b/Source/cmSystemTools.h @@ -49,6 +49,9 @@ public: ///! Escape quotes in a string. static std::string EscapeQuotes(const char* str); + /** Map help document name to file name. */ + static std::string HelpFileName(std::string); + /** * Returns a string that has whitespace removed from the start and the end. */ diff --git a/Source/cmTarget.cxx b/Source/cmTarget.cxx index d03ed49..5e10e25 100644 --- a/Source/cmTarget.cxx +++ b/Source/cmTarget.cxx @@ -16,9 +16,6 @@ #include "cmLocalGenerator.h" #include "cmGlobalGenerator.h" #include "cmComputeLinkInformation.h" -#include "cmDocumentCompileDefinitions.h" -#include "cmDocumentGeneratorExpressions.h" -#include "cmDocumentLocationUndefined.h" #include "cmListFileCache.h" #include "cmGeneratorExpression.h" #include "cmGeneratorExpressionDAGChecker.h" @@ -219,1387 +216,14 @@ cmTarget::cmTarget() void cmTarget::DefineProperties(cmake *cm) { cm->DefineProperty - ("AUTOMOC", cmProperty::TARGET, - "Should the target be processed with automoc (for Qt projects).", - "AUTOMOC is a boolean specifying whether CMake will handle " - "the Qt moc preprocessor automatically, i.e. without having to use " - "the QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are " - "supported. " - "When this property is set to TRUE, CMake will scan the source files " - "at build time and invoke moc accordingly. " - "If an #include statement like #include \"moc_foo.cpp\" is found, " - "the Q_OBJECT class declaration is expected in the header, and moc is " - "run on the header file. " - "If an #include statement like #include \"foo.moc\" is found, " - "then a Q_OBJECT is expected in the current source file and moc " - "is run on the file itself. " - "Additionally, all header files are parsed for Q_OBJECT macros, " - "and if found, moc is also executed on those files. The resulting " - "moc files, which are not included as shown above in any of the source " - "files are included in a generated <targetname>_automoc.cpp file, " - "which is compiled as part of the target." - "This property is initialized by the value of the variable " - "CMAKE_AUTOMOC if it is set when a target is created.\n" - "Additional command line options for moc can be set via the " - "AUTOMOC_MOC_OPTIONS property.\n" - "By setting the CMAKE_AUTOMOC_RELAXED_MODE variable to TRUE the rules " - "for searching the files which will be processed by moc can be relaxed. " - "See the documentation for this variable for more details.\n" - "The global property AUTOMOC_TARGETS_FOLDER can be used to group the " - "automoc targets together in an IDE, e.g. in MSVS."); - - cm->DefineProperty - ("AUTOMOC_MOC_OPTIONS", cmProperty::TARGET, - "Additional options for moc when using automoc (see the AUTOMOC property)", - "This property is only used if the AUTOMOC property is set to TRUE for " - "this target. In this case, it holds additional command line options " - "which will be used when moc is executed during the build, i.e. it is " - "equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() " - "macro.\n" - "By default it is empty."); - - cm->DefineProperty - ("BUILD_WITH_INSTALL_RPATH", cmProperty::TARGET, - "Should build tree targets have install tree rpaths.", - "BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link " - "the target in the build tree with the INSTALL_RPATH. This takes " - "precedence over SKIP_BUILD_RPATH and avoids the need for relinking " - "before installation. " - "This property is initialized by the value of the variable " - "CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("COMPILE_FLAGS", cmProperty::TARGET, - "Additional flags to use when compiling this target's sources.", - "The COMPILE_FLAGS property sets additional compiler flags used " - "to build sources within the target. Use COMPILE_DEFINITIONS " - "to pass additional preprocessor definitions." - "\n" - "This property is deprecated. Use the COMPILE_OPTIONS property or the " - "target_compile_options command instead."); - - cm->DefineProperty - ("COMPILE_DEFINITIONS", cmProperty::TARGET, - "Preprocessor definitions for compiling a target's sources.", - "The COMPILE_DEFINITIONS property may be set to a " - "semicolon-separated list of preprocessor " - "definitions using the syntax VAR or VAR=value. Function-style " - "definitions are not supported. CMake will automatically escape " - "the value correctly for the native build system (note that CMake " - "language syntax may require escapes to specify some values). " - "This property may be set on a per-configuration basis using the name " - "COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name " - "(ex. \"COMPILE_DEFINITIONS_DEBUG\").\n" - "CMake will automatically drop some definitions that " - "are not supported by the native build tool. " - "The VS6 IDE does not support definition values with spaces " - "(but NMake does).\n" - "Contents of COMPILE_DEFINITIONS may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER); - - cm->DefineProperty - ("COMPILE_DEFINITIONS_<CONFIG>", cmProperty::TARGET, - "Per-configuration preprocessor definitions on a target.", - "This is the configuration-specific version of COMPILE_DEFINITIONS."); - - cm->DefineProperty - ("COMPILE_OPTIONS", cmProperty::TARGET, - "List of options to pass to the compiler.", - "This property specifies the list of options specified " - "so far for this property. " - "This property exists on directories and targets." - "\n" - "The target property values are used by the generators to set " - "the options for the compiler.\n" - "Contents of COMPILE_OPTIONS may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_COMPILE_OPTIONS", cmProperty::TARGET, - "List of interface options to pass to the compiler.", - "Targets may populate this property to publish the compile options " - "required to compile against the headers for the target. Consuming " - "targets can add entries to their own COMPILE_OPTIONS property such " - "as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_OPTIONS> to use the " - "compile options specified in the interface of 'foo'." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("DEFINE_SYMBOL", cmProperty::TARGET, - "Define a symbol when compiling this target's sources.", - "DEFINE_SYMBOL sets the name of the preprocessor symbol defined when " - "compiling sources in a shared library. " - "If not set here then it is set to target_EXPORTS by default " - "(with some substitutions if the target is not a valid C " - "identifier). This is useful for headers to know whether they are " - "being included from inside their library or outside to properly " - "setup dllexport/dllimport decorations. "); - - cm->DefineProperty - ("DEBUG_POSTFIX", cmProperty::TARGET, - "See target property <CONFIG>_POSTFIX.", - "This property is a special case of the more-general <CONFIG>_POSTFIX " - "property for the DEBUG configuration."); - - cm->DefineProperty - ("<CONFIG>_POSTFIX", cmProperty::TARGET, - "Postfix to append to the target file name for configuration <CONFIG>.", - "When building with configuration <CONFIG> the value of this property " - "is appended to the target file name built on disk. " - "For non-executable targets, this property is initialized by the value " - "of the variable CMAKE_<CONFIG>_POSTFIX if it is set when a target is " - "created. " - "This property is ignored on the Mac for Frameworks and App Bundles."); - - cm->DefineProperty - ("EchoString", cmProperty::TARGET, - "A message to be displayed when the target is built.", - "A message to display on some generators (such as makefiles) when " - "the target is built."); - - cm->DefineProperty - ("BUNDLE", cmProperty::TARGET, - "This target is a CFBundle on the Mac.", - "If a module library target has this property set to true it will " - "be built as a CFBundle when built on the mac. It will have the " - "directory structure required for a CFBundle and will be suitable " - "to be used for creating Browser Plugins or other application " - "resources."); - - cm->DefineProperty - ("BUNDLE_EXTENSION", cmProperty::TARGET, - "The file extension used to name a BUNDLE target on the Mac.", - "The default value is \"bundle\" - you can also use \"plugin\" or " - "whatever file extension is required by the host app for your " - "bundle."); - - cm->DefineProperty - ("EXCLUDE_FROM_DEFAULT_BUILD", cmProperty::TARGET, - "Exclude target from \"Build Solution\".", - "This property is only used by Visual Studio generators 7 and above. " - "When set to TRUE, the target will not be built when you press " - "\"Build Solution\"."); - - cm->DefineProperty - ("EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>", cmProperty::TARGET, - "Per-configuration version of target exclusion from \"Build Solution\". ", - "This is the configuration-specific version of " - "EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD " - "is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes " - "precedence in configurations for which it has a value."); - - cm->DefineProperty - ("FRAMEWORK", cmProperty::TARGET, - "This target is a framework on the Mac.", - "If a shared library target has this property set to true it will " - "be built as a framework when built on the mac. It will have the " - "directory structure required for a framework and will be suitable " - "to be used with the -framework option"); - - cm->DefineProperty - ("HAS_CXX", cmProperty::TARGET, - "Link the target using the C++ linker tool (obsolete).", - "This is equivalent to setting the LINKER_LANGUAGE property to CXX. " - "See that property's documentation for details."); - - cm->DefineProperty - ("IMPLICIT_DEPENDS_INCLUDE_TRANSFORM", cmProperty::TARGET, - "Specify #include line transforms for dependencies in a target.", - "This property specifies rules to transform macro-like #include lines " - "during implicit dependency scanning of C and C++ source files. " - "The list of rules must be semicolon-separated with each entry of " - "the form \"A_MACRO(%)=value-with-%\" (the % must be literal). " - "During dependency scanning occurrences of A_MACRO(...) on #include " - "lines will be replaced by the value given with the macro argument " - "substituted for '%'. For example, the entry\n" - " MYDIR(%)=<mydir/%>\n" - "will convert lines of the form\n" - " #include MYDIR(myheader.h)\n" - "to\n" - " #include <mydir/myheader.h>\n" - "allowing the dependency to be followed.\n" - "This property applies to sources in the target on which it is set."); - - cm->DefineProperty - ("IMPORT_PREFIX", cmProperty::TARGET, - "What comes before the import library name.", - "Similar to the target property PREFIX, but used for import libraries " - "(typically corresponding to a DLL) instead of regular libraries. " - "A target property that can be set to override the prefix " - "(such as \"lib\") on an import library name."); - - cm->DefineProperty - ("IMPORT_SUFFIX", cmProperty::TARGET, - "What comes after the import library name.", - "Similar to the target property SUFFIX, but used for import libraries " - "(typically corresponding to a DLL) instead of regular libraries. " - "A target property that can be set to override the suffix " - "(such as \".lib\") on an import library name."); - - cm->DefineProperty - ("IMPORTED", cmProperty::TARGET, - "Read-only indication of whether a target is IMPORTED.", - "The boolean value of this property is true for targets created with " - "the IMPORTED option to add_executable or add_library. " - "It is false for targets built within the project."); - - cm->DefineProperty - ("IMPORTED_CONFIGURATIONS", cmProperty::TARGET, - "Configurations provided for an IMPORTED target.", - "Set this to the list of configuration names available for an " - "IMPORTED target. " - "The names correspond to configurations defined in the project from " - "which the target is imported. " - "If the importing project uses a different set of configurations " - "the names may be mapped using the MAP_IMPORTED_CONFIG_<CONFIG> " - "property. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_IMPLIB", cmProperty::TARGET, - "Full path to the import library for an IMPORTED target.", - "Set this to the location of the \".lib\" part of a windows DLL. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_IMPLIB_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_IMPLIB property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("IMPORTED_LINK_DEPENDENT_LIBRARIES", cmProperty::TARGET, - "Dependent shared libraries of an imported shared library.", - "Shared libraries may be linked to other shared libraries as part " - "of their implementation. On some platforms the linker searches " - "for the dependent libraries of shared libraries they are including " - "in the link. " - "Set this property to the list of dependent shared libraries of an " - "imported library. " - "The list " - "should be disjoint from the list of interface libraries in the " - "INTERFACE_LINK_LIBRARIES property. On platforms requiring " - "dependent shared libraries to be found at link time CMake uses this " - "list to add appropriate files or paths to the link command line. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES.", - "Configuration names correspond to those provided by the project " - "from which the target is imported. " - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LIBRARIES", cmProperty::TARGET, - "Transitive link interface of an IMPORTED target.", - "Set this to the list of libraries whose interface is included when " - "an IMPORTED library target is linked to another target. " - "The libraries will be included on the link line for the target. " - "Unlike the LINK_INTERFACE_LIBRARIES property, this property applies " - "to all imported target types, including STATIC libraries. " - "This property is ignored for non-imported targets.\n" - "This property is ignored if the target also has a non-empty " - "INTERFACE_LINK_LIBRARIES property.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES.", - "Configuration names correspond to those provided by the project " - "from which the target is imported. " - "If set, this property completely overrides the generic property " - "for the named configuration.\n" - "This property is ignored if the target also has a non-empty " - "INTERFACE_LINK_LIBRARIES property.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LANGUAGES", cmProperty::TARGET, - "Languages compiled into an IMPORTED static library.", - "Set this to the list of languages of source files compiled to " - "produce a STATIC IMPORTED library (such as \"C\" or \"CXX\"). " - "CMake accounts for these languages when computing how to link a " - "target to the imported library. " - "For example, when a C executable links to an imported C++ static " - "library CMake chooses the C++ linker to satisfy language runtime " - "dependencies of the static library. " - "\n" - "This property is ignored for targets that are not STATIC libraries. " - "This property is ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES.", - "Configuration names correspond to those provided by the project " - "from which the target is imported. " - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_MULTIPLICITY", cmProperty::TARGET, - "Repetition count for cycles of IMPORTED static libraries.", - "This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets."); - cm->DefineProperty - ("IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY.", - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("IMPORTED_LOCATION", cmProperty::TARGET, - "Full path to the main file on disk for an IMPORTED target.", - "Set this to the location of an IMPORTED target file on disk. " - "For executables this is the location of the executable file. " - "For bundles on OS X this is the location of the executable file " - "inside Contents/MacOS under the application bundle folder. " - "For static libraries and modules this is the location of the " - "library or module. " - "For shared libraries on non-DLL platforms this is the location of " - "the shared library. " - "For frameworks on OS X this is the location of the library file " - "symlink just inside the framework folder. " - "For DLLs this is the location of the \".dll\" part of the library. " - "For UNKNOWN libraries this is the location of the file to be linked. " - "Ignored for non-imported targets." - "\n" - "Projects may skip IMPORTED_LOCATION if the configuration-specific " - "property IMPORTED_LOCATION_<CONFIG> is set. " - "To get the location of an imported target read one of the " - "LOCATION or LOCATION_<CONFIG> properties."); - - cm->DefineProperty - ("IMPORTED_LOCATION_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_LOCATION property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("IMPORTED_SONAME", cmProperty::TARGET, - "The \"soname\" of an IMPORTED target of shared library type.", - "Set this to the \"soname\" embedded in an imported shared library. " - "This is meaningful only on platforms supporting the feature. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_SONAME_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_SONAME property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("IMPORTED_NO_SONAME", cmProperty::TARGET, - "Specifies that an IMPORTED shared library target has no \"soname\". ", - "Set this property to true for an imported shared library file that " - "has no \"soname\" field. " - "CMake may adjust generated link commands for some platforms to prevent " - "the linker from using the path to the library in place of its missing " - "soname. " - "Ignored for non-imported targets."); - - cm->DefineProperty - ("IMPORTED_NO_SONAME_<CONFIG>", cmProperty::TARGET, - "<CONFIG>-specific version of IMPORTED_NO_SONAME property.", - "Configuration names correspond to those provided by the project " - "from which the target is imported."); - - cm->DefineProperty - ("EXCLUDE_FROM_ALL", cmProperty::TARGET, - "Exclude the target from the all target.", - "A property on a target that indicates if the target is excluded " - "from the default build target. If it is not, then with a Makefile " - "for example typing make will cause this target to be built. " - "The same concept applies to the default build of other generators. " - "Installing a target with EXCLUDE_FROM_ALL set to true has " - "undefined behavior."); - - cm->DefineProperty - ("LINK_LIBRARIES", cmProperty::TARGET, - "List of direct link dependencies.", - "This property specifies the list of libraries or targets which will be " - "used for linking. " - "In addition to accepting values from the target_link_libraries " - "command, values may be set directly on any target using the " - "set_property command. " - "\n" - "The target property values are used by the generators to set " - "the link libraries for the compiler. " - "See also the target_link_libraries command.\n" - "Contents of LINK_LIBRARIES may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INCLUDE_DIRECTORIES", cmProperty::TARGET, - "List of preprocessor include file search directories.", - "This property specifies the list of directories given " - "so far to the include_directories command. " - "This property exists on directories and targets. " - "In addition to accepting values from the include_directories " - "command, values may be set directly on any directory or any " - "target using the set_property command. " - "A target gets its initial value for this property from the value " - "of the directory property. " - "A directory gets its initial value from its parent directory if " - "it has one. " - "Both directory and target property values are adjusted by calls " - "to the include_directories command." - "\n" - "The target property values are used by the generators to set " - "the include paths for the compiler. " - "See also the include_directories command.\n" - "Contents of INCLUDE_DIRECTORIES may use \"generator expressions\" with " - "the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INSTALL_NAME_DIR", cmProperty::TARGET, - "Mac OSX directory name for installed targets.", - "INSTALL_NAME_DIR is a string specifying the " - "directory portion of the \"install_name\" field of shared libraries " - "on Mac OSX to use in the installed targets. "); - - cm->DefineProperty - ("INSTALL_RPATH", cmProperty::TARGET, - "The rpath to use for installed targets.", - "A semicolon-separated list specifying the rpath " - "to use in installed targets (for platforms that support it). " - "This property is initialized by the value of the variable " - "CMAKE_INSTALL_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("INSTALL_RPATH_USE_LINK_PATH", cmProperty::TARGET, - "Add paths to linker search and installed rpath.", - "INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will " - "append directories in the linker search path and outside the " - "project to the INSTALL_RPATH. " - "This property is initialized by the value of the variable " - "CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a target is " - "created."); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION", cmProperty::TARGET, - "Enable interprocedural optimization for a target.", - "If set to true, enables interprocedural optimizations " - "if they are known to be supported by the compiler."); - - cm->DefineProperty - ("INTERPROCEDURAL_OPTIMIZATION_<CONFIG>", cmProperty::TARGET, - "Per-configuration interprocedural optimization for a target.", - "This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. " - "If set, this property overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("LABELS", cmProperty::TARGET, - "Specify a list of text labels associated with a target.", - "Target label semantics are currently unspecified."); - - cm->DefineProperty - ("LINK_FLAGS", cmProperty::TARGET, - "Additional flags to use when linking this target.", - "The LINK_FLAGS property can be used to add extra flags to the " - "link step of a target. LINK_FLAGS_<CONFIG> will add to the " - "configuration <CONFIG>, " - "for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO. "); - - cm->DefineProperty - ("LINK_FLAGS_<CONFIG>", cmProperty::TARGET, - "Per-configuration linker flags for a target.", - "This is the configuration-specific version of LINK_FLAGS."); - -#define CM_LINK_SEARCH_SUMMARY \ - "Some linkers support switches such as -Bstatic and -Bdynamic " \ - "to determine whether to use static or shared libraries for -lXXX " \ - "options. CMake uses these options to set the link type for " \ - "libraries whose full paths are not known or (in some cases) are in " \ - "implicit link directories for the platform. " - - cm->DefineProperty - ("LINK_SEARCH_START_STATIC", cmProperty::TARGET, - "Assume the linker looks for static libraries by default.", - CM_LINK_SEARCH_SUMMARY - "By default the linker search type is assumed to be -Bdynamic at " - "the beginning of the library list. This property switches the " - "assumption to -Bstatic. It is intended for use when linking an " - "executable statically (e.g. with the GNU -static option). " - "See also LINK_SEARCH_END_STATIC."); - - cm->DefineProperty - ("LINK_SEARCH_END_STATIC", cmProperty::TARGET, - "End a link line such that static system libraries are used.", - CM_LINK_SEARCH_SUMMARY - "By default CMake adds an option at the end of the library list (if " - "necessary) to set the linker search type back to its starting type. " - "This property switches the final linker search type to -Bstatic " - "regardless of how it started. " - "See also LINK_SEARCH_START_STATIC."); - - cm->DefineProperty - ("LINKER_LANGUAGE", cmProperty::TARGET, - "Specifies language whose compiler will invoke the linker.", - "For executables, shared libraries, and modules, this sets the " - "language whose compiler is used to link the target " - "(such as \"C\" or \"CXX\"). " - "A typical value for an executable is the language of the source " - "file providing the program entry point (main). " - "If not set, the language with the highest linker preference " - "value is the default. " - "See documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables." - "\n" - "If this property is not set by the user, it will be calculated at " - "generate-time by CMake." - ); - - cm->DefineProperty - ("LOCATION", cmProperty::TARGET, - "Read-only location of a target on disk.", - "For an imported target, this read-only property returns the value of " - "the LOCATION_<CONFIG> property for an unspecified configuration " - "<CONFIG> provided by the target.\n" - "For a non-imported target, this property is provided for compatibility " - "with CMake 2.4 and below. " - "It was meant to get the location of an executable target's output file " - "for use in add_custom_command. " - "The path may contain a build-system-specific portion that " - "is replaced at build time with the configuration getting built " - "(such as \"$(ConfigurationName)\" in VS). " - "In CMake 2.6 and above add_custom_command automatically recognizes a " - "target name in its COMMAND and DEPENDS options and computes the " - "target location. " - "In CMake 2.8.4 and above add_custom_command recognizes generator " - "expressions to refer to target locations anywhere in the command. " - "Therefore this property is not needed for creating custom commands." - CM_LOCATION_UNDEFINED_BEHAVIOR("reading this property")); - - cm->DefineProperty - ("LOCATION_<CONFIG>", cmProperty::TARGET, - "Read-only property providing a target location on disk.", - "A read-only property that indicates where a target's main file is " - "located on disk for the configuration <CONFIG>. " - "The property is defined only for library and executable targets. " - "An imported target may provide a set of configurations different " - "from that of the importing project. " - "By default CMake looks for an exact-match but otherwise uses an " - "arbitrary available configuration. " - "Use the MAP_IMPORTED_CONFIG_<CONFIG> property to map imported " - "configurations explicitly." - CM_LOCATION_UNDEFINED_BEHAVIOR("reading this property")); - - cm->DefineProperty - ("LINK_DEPENDS", cmProperty::TARGET, - "Additional files on which a target binary depends for linking.", - "Specifies a semicolon-separated list of full-paths to files on which " - "the link rule for this target depends. " - "The target binary will be linked if any of the named files is newer " - "than it." - "\n" - "This property is ignored by non-Makefile generators. " - "It is intended to specify dependencies on \"linker scripts\" for " - "custom Makefile link rules."); - - cm->DefineProperty - ("LINK_DEPENDS_NO_SHARED", cmProperty::TARGET, - "Do not depend on linked shared library files.", - "Set this property to true to tell CMake generators not to add " - "file-level dependencies on the shared library files linked by " - "this target. " - "Modification to the shared libraries will not be sufficient to " - "re-link this target. " - "Logical target-level dependencies will not be affected so the " - "linked shared libraries will still be brought up to date before " - "this target is built." - "\n" - "This property is initialized by the value of the variable " - "CMAKE_LINK_DEPENDS_NO_SHARED if it is set when a target is " - "created."); - - cm->DefineProperty - ("LINK_INTERFACE_LIBRARIES", cmProperty::TARGET, - "List public interface libraries for a shared library or executable.", - "By default linking to a shared library target transitively " - "links to targets with which the library itself was linked. " - "For an executable with exports (see the ENABLE_EXPORTS property) " - "no default transitive link dependencies are used. " - "This property replaces the default transitive link dependencies with " - "an explicit list. " - "When the target is linked into another target the libraries " - "listed (and recursively their link interface libraries) will be " - "provided to the other target also. " - "If the list is empty then no transitive link dependencies will be " - "incorporated when this target is linked into another target even if " - "the default set is non-empty. " - "This property is initialized by the value of the variable " - "CMAKE_LINK_INTERFACE_LIBRARIES if it is set when a target is " - "created. " - "This property is ignored for STATIC libraries.\n" - "This property is overriden by the INTERFACE_LINK_LIBRARIES property if " - "policy CMP0022 is NEW.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("LINK_INTERFACE_LIBRARIES_<CONFIG>", cmProperty::TARGET, - "Per-configuration list of public interface libraries for a target.", - "This is the configuration-specific version of " - "LINK_INTERFACE_LIBRARIES. " - "If set, this property completely overrides the generic property " - "for the named configuration.\n" - "This property is overriden by the INTERFACE_LINK_LIBRARIES property if " - "policy CMP0022 is NEW.\n" - "This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead."); - - cm->DefineProperty - ("INTERFACE_LINK_LIBRARIES", cmProperty::TARGET, - "List public interface libraries for a shared library or executable.", - "This property contains the list of transitive link dependencies. " - "When the target is linked into another target the libraries " - "listed (and recursively their link interface libraries) will be " - "provided to the other target also. " - "This property is overriden by the LINK_INTERFACE_LIBRARIES or " - "LINK_INTERFACE_LIBRARIES_<CONFIG> property if " - "policy CMP0022 is OLD or unset.\n" - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_INCLUDE_DIRECTORIES", cmProperty::TARGET, - "List of public include directories for a library.", - "Targets may populate this property to publish the include directories " - "required to compile against the headers for the target. Consuming " - "targets can add entries to their own INCLUDE_DIRECTORIES property such " - "as $<TARGET_PROPERTY:foo,INTERFACE_INCLUDE_DIRECTORIES> to use the " - "include directories specified in the interface of 'foo'." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_SYSTEM_INCLUDE_DIRECTORIES", cmProperty::TARGET, - "List of public system include directories for a library.", - "Targets may populate this property to publish the include directories " - "which contain system headers, and therefore should not result in " - "compiler warnings. Consuming targets will then mark the same include " - "directories as system headers." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("INTERFACE_COMPILE_DEFINITIONS", cmProperty::TARGET, - "List of public compile definitions for a library.", - "Targets may populate this property to publish the compile definitions " - "required to compile against the headers for the target. Consuming " - "targets can add entries to their own COMPILE_DEFINITIONS property such " - "as $<TARGET_PROPERTY:foo,INTERFACE_COMPILE_DEFINITIONS> to use the " - "compile definitions specified in the interface of 'foo'." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS); - - cm->DefineProperty - ("LINK_INTERFACE_MULTIPLICITY", cmProperty::TARGET, - "Repetition count for STATIC libraries with cyclic dependencies.", - "When linking to a STATIC library target with cyclic dependencies the " - "linker may need to scan more than once through the archives in the " - "strongly connected component of the dependency graph. " - "CMake by default constructs the link line so that the linker will " - "scan through the component at least twice. " - "This property specifies the minimum number of scans if it is larger " - "than the default. " - "CMake uses the largest value specified by any target in a component."); - cm->DefineProperty - ("LINK_INTERFACE_MULTIPLICITY_<CONFIG>", cmProperty::TARGET, - "Per-configuration repetition count for cycles of STATIC libraries.", - "This is the configuration-specific version of " - "LINK_INTERFACE_MULTIPLICITY. " - "If set, this property completely overrides the generic property " - "for the named configuration."); - - cm->DefineProperty - ("MAP_IMPORTED_CONFIG_<CONFIG>", cmProperty::TARGET, - "Map from project configuration to IMPORTED target's configuration.", - "Set this to the list of configurations of an imported target that " - "may be used for the current project's <CONFIG> configuration. " - "Targets imported from another project may not provide the same set " - "of configuration names available in the current project. " - "Setting this property tells CMake what imported configurations are " - "suitable for use when building the <CONFIG> configuration. " - "The first configuration in the list found to be provided by the " - "imported target is selected. If this property is set and no matching " - "configurations are available, then the imported target is considered " - "to be not found. This property is ignored for non-imported targets.\n" - "This property is initialized by the value of the variable " - "CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> if it is set when a target is " - "created.", - false /* TODO: make this chained */ ); - - cm->DefineProperty - ("NO_SYSTEM_FROM_IMPORTED", cmProperty::TARGET, - "Do not treat includes from IMPORTED target interfaces as SYSTEM.", - "The contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets " - "are treated as SYSTEM includes by default. If this property is " - "enabled, the contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED " - "targets are not treated as system includes. " - "This property is initialized by the value of the variable " - "CMAKE_NO_SYSTEM_FROM_IMPORTED if it is set when a target is " - "created."); - - cm->DefineProperty - ("OSX_ARCHITECTURES", cmProperty::TARGET, - "Target specific architectures for OS X.", - "The OSX_ARCHITECTURES property sets the target binary architecture " - "for targets on OS X. " - "This property is initialized by the value of the variable " - "CMAKE_OSX_ARCHITECTURES if it is set when a target is created. " - "Use OSX_ARCHITECTURES_<CONFIG> to set the binary architectures on a " - "per-configuration basis. " - "<CONFIG> is an upper-case name (ex: \"OSX_ARCHITECTURES_DEBUG\")."); - - cm->DefineProperty - ("OSX_ARCHITECTURES_<CONFIG>", cmProperty::TARGET, - "Per-configuration OS X binary architectures for a target.", - "This property is the configuration-specific version of " - "OSX_ARCHITECTURES."); - - cm->DefineProperty - ("NAME", cmProperty::TARGET, - "Logical name for the target.", - "Read-only logical name for the target as used by CMake."); - - cm->DefineProperty - ("EXPORT_NAME", cmProperty::TARGET, - "Exported name for target files.", - "This sets the name for the IMPORTED target generated when it this " - "target is is exported. " - "If not set, the logical target name is used by default."); - - cm->DefineProperty - ("OUTPUT_NAME", cmProperty::TARGET, - "Output name for target files.", - "This sets the base name for output files created for an executable or " - "library target. " - "If not set, the logical target name is used by default."); - - cm->DefineProperty - ("OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration target file base name.", - "This is the configuration-specific version of OUTPUT_NAME."); - - cm->DefineProperty - ("ALIASED_TARGET", cmProperty::TARGET, - "Name of target aliased by this target.", - "If this is an ALIAS target, this property contains the name of the " - "target aliased."); - - cm->DefineProperty - ("<CONFIG>_OUTPUT_NAME", cmProperty::TARGET, - "Old per-configuration target file base name.", - "This is a configuration-specific version of OUTPUT_NAME. " - "Use OUTPUT_NAME_<CONFIG> instead."); - - cm->DefineProperty - ("PDB_NAME", cmProperty::TARGET, - "Output name for MS debug symbols .pdb file from linker.", - "Set the base name for debug symbols file created for an " - "executable or shared library target. " - "If not set, the logical target name is used by default. " - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - - cm->DefineProperty - ("PDB_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration name for MS debug symbols .pdb file. ", - "This is the configuration-specific version of PDB_NAME. " - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - - cm->DefineProperty - ("PRE_INSTALL_SCRIPT", cmProperty::TARGET, - "Deprecated install support.", - "The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the " - "old way to specify CMake scripts to run before and after " - "installing a target. They are used only when the old " - "INSTALL_TARGETS command is used to install the target. Use the " - "INSTALL command instead."); - - cm->DefineProperty - ("PREFIX", cmProperty::TARGET, - "What comes before the library name.", - "A target property that can be set to override the prefix " - "(such as \"lib\") on a library name."); - - cm->DefineProperty - ("<LANG>_VISIBILITY_PRESET", cmProperty::TARGET, - "Value for symbol visibility compile flags", - "The <LANG>_VISIBILITY_PRESET property determines the value passed in " - "a visibility related compile option, such as -fvisibility= for <LANG>. " - "This property only has an affect for libraries and executables with " - "exports. This property is initialized by the value of the variable " - "CMAKE_<LANG>_VISIBILITY_PRESET if it is set when a target is created."); - - cm->DefineProperty - ("VISIBILITY_INLINES_HIDDEN", cmProperty::TARGET, - "Whether to add a compile flag to hide symbols of inline functions", - "The VISIBILITY_INLINES_HIDDEN property determines whether a flag for " - "hiding symbols for inline functions. the value passed used in " - "a visibility related compile option, such as -fvisibility=. This " - "property only has an affect for libraries and executables with " - "exports. This property is initialized by the value of the variable " - "CMAKE_VISIBILITY_INLINES_HIDDEN if it is set when a target is " - "created."); - - cm->DefineProperty - ("POSITION_INDEPENDENT_CODE", cmProperty::TARGET, - "Whether to create a position-independent target", - "The POSITION_INDEPENDENT_CODE property determines whether position " - "independent executables or shared libraries will be created. " - "This property is true by default for SHARED and MODULE library " - "targets and false otherwise. " - "This property is initialized by the value of the variable " - "CMAKE_POSITION_INDEPENDENT_CODE if it is set when a target is " - "created."); - - cm->DefineProperty - ("INTERFACE_POSITION_INDEPENDENT_CODE", cmProperty::TARGET, - "Whether consumers need to create a position-independent target", - "The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of " - "this target whether they must set their POSITION_INDEPENDENT_CODE " - "property to ON. If this property is set to ON, then the " - "POSITION_INDEPENDENT_CODE property on all consumers will be set to " - "ON. Similarly, if this property is set to OFF, then the " - "POSITION_INDEPENDENT_CODE property on all consumers will be set to " - "OFF. If this property is undefined, then consumers will determine " - "their POSITION_INDEPENDENT_CODE property by other means. Consumers " - "must ensure that the targets that they link to have a consistent " - "requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property."); - - cm->DefineProperty - ("COMPATIBLE_INTERFACE_BOOL", cmProperty::TARGET, - "Properties which must be compatible with their link interface", - "The COMPATIBLE_INTERFACE_BOOL property may contain a list of properties" - "for this target which must be consistent when evaluated as a boolean " - "in the INTERFACE of all linked dependees. For example, if a " - "property \"FOO\" appears in the list, then for each dependee, the " - "\"INTERFACE_FOO\" property content in all of its dependencies must be " - "consistent with each other, and with the \"FOO\" property in the " - "dependee. Consistency in this sense has the meaning that if the " - "property is set, then it must have the same boolean value as all " - "others, and if the property is not set, then it is ignored. Note that " - "for each dependee, the set of properties from this property must not " - "intersect with the set of properties from the " - "COMPATIBLE_INTERFACE_STRING property."); - - cm->DefineProperty - ("COMPATIBLE_INTERFACE_STRING", cmProperty::TARGET, - "Properties which must be string-compatible with their link interface", - "The COMPATIBLE_INTERFACE_STRING property may contain a list of " - "properties for this target which must be the same when evaluated as " - "a string in the INTERFACE of all linked dependees. For example, " - "if a property \"FOO\" appears in the list, then for each dependee, the " - "\"INTERFACE_FOO\" property content in all of its dependencies must be " - "equal with each other, and with the \"FOO\" property in the dependee. " - "If the property is not set, then it is ignored. Note that for each " - "dependee, the set of properties from this property must not intersect " - "with the set of properties from the COMPATIBLE_INTERFACE_BOOL " - "property."); - - cm->DefineProperty - ("POST_INSTALL_SCRIPT", cmProperty::TARGET, - "Deprecated install support.", - "The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the " - "old way to specify CMake scripts to run before and after " - "installing a target. They are used only when the old " - "INSTALL_TARGETS command is used to install the target. Use the " - "INSTALL command instead."); - - cm->DefineProperty - ("PRIVATE_HEADER", cmProperty::TARGET, - "Specify private header files in a FRAMEWORK shared library target.", - "Shared library targets marked with the FRAMEWORK property generate " - "frameworks on OS X and normal shared libraries on other platforms. " - "This property may be set to a list of header files to be placed " - "in the PrivateHeaders directory inside the framework folder. " - "On non-Apple platforms these headers may be installed using the " - "PRIVATE_HEADER option to the install(TARGETS) command."); - - cm->DefineProperty - ("PUBLIC_HEADER", cmProperty::TARGET, - "Specify public header files in a FRAMEWORK shared library target.", - "Shared library targets marked with the FRAMEWORK property generate " - "frameworks on OS X and normal shared libraries on other platforms. " - "This property may be set to a list of header files to be placed " - "in the Headers directory inside the framework folder. " - "On non-Apple platforms these headers may be installed using the " - "PUBLIC_HEADER option to the install(TARGETS) command."); - - cm->DefineProperty - ("RESOURCE", cmProperty::TARGET, - "Specify resource files in a FRAMEWORK shared library target.", - "Shared library targets marked with the FRAMEWORK property generate " - "frameworks on OS X and normal shared libraries on other platforms. " - "This property may be set to a list of files to be placed " - "in the Resources directory inside the framework folder. " - "On non-Apple platforms these files may be installed using the " - "RESOURCE option to the install(TARGETS) command."); - - cm->DefineProperty ("RULE_LAUNCH_COMPILE", cmProperty::TARGET, - "Specify a launcher for compile rules.", - "See the global property of the same name for details. " - "This overrides the global and directory property for a target.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_LINK", cmProperty::TARGET, - "Specify a launcher for link rules.", - "See the global property of the same name for details. " - "This overrides the global and directory property for a target.", - true); + "", "", true); cm->DefineProperty ("RULE_LAUNCH_CUSTOM", cmProperty::TARGET, - "Specify a launcher for custom rules.", - "See the global property of the same name for details. " - "This overrides the global and directory property for a target.", - true); - - cm->DefineProperty - ("SKIP_BUILD_RPATH", cmProperty::TARGET, - "Should rpaths be used for the build tree.", - "SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic " - "generation of an rpath allowing the target to run from the " - "build tree. " - "This property is initialized by the value of the variable " - "CMAKE_SKIP_BUILD_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("NO_SONAME", cmProperty::TARGET, - "Whether to set \"soname\" when linking a shared library or module.", - "Enable this boolean property if a generated shared library or module " - "should not have \"soname\" set. Default is to set \"soname\" on all " - "shared libraries and modules as long as the platform supports it. " - "Generally, use this property only for leaf private libraries or " - "plugins. If you use it on normal shared libraries which other targets " - "link against, on some platforms a linker will insert a full path to " - "the library (as specified at link time) into the dynamic section of " - "the dependent binary. Therefore, once installed, dynamic loader may " - "eventually fail to locate the library for the binary."); - - cm->DefineProperty - ("SOVERSION", cmProperty::TARGET, - "What version number is this target.", - "For shared libraries VERSION and SOVERSION can be used to specify " - "the build version and API version respectively. When building or " - "installing appropriate symlinks are created if the platform " - "supports symlinks and the linker supports so-names. " - "If only one of both is specified the missing is assumed to have " - "the same version number. " - "SOVERSION is ignored if NO_SONAME property is set. " - "For shared libraries and executables on Windows the VERSION " - "attribute is parsed to extract a \"major.minor\" version number. " - "These numbers are used as the image version of the binary. "); - - cm->DefineProperty - ("STATIC_LIBRARY_FLAGS", cmProperty::TARGET, - "Extra flags to use when linking static libraries.", - "Extra flags to use when linking a static library."); - - cm->DefineProperty - ("STATIC_LIBRARY_FLAGS_<CONFIG>", cmProperty::TARGET, - "Per-configuration flags for creating a static library.", - "This is the configuration-specific version of STATIC_LIBRARY_FLAGS."); - - cm->DefineProperty - ("SUFFIX", cmProperty::TARGET, - "What comes after the target name.", - "A target property that can be set to override the suffix " - "(such as \".so\" or \".exe\") on the name of a library, module or " - "executable."); - - cm->DefineProperty - ("TYPE", cmProperty::TARGET, - "The type of the target.", - "This read-only property can be used to test the type of the given " - "target. It will be one of STATIC_LIBRARY, MODULE_LIBRARY, " - "SHARED_LIBRARY, EXECUTABLE or one of the internal target types."); - - cm->DefineProperty - ("VERSION", cmProperty::TARGET, - "What version number is this target.", - "For shared libraries VERSION and SOVERSION can be used to specify " - "the build version and API version respectively. When building or " - "installing appropriate symlinks are created if the platform " - "supports symlinks and the linker supports so-names. " - "If only one of both is specified the missing is assumed to have " - "the same version number. " - "For executables VERSION can be used to specify the build version. " - "When building or installing appropriate symlinks are created if " - "the platform supports symlinks. " - "For shared libraries and executables on Windows the VERSION " - "attribute is parsed to extract a \"major.minor\" version number. " - "These numbers are used as the image version of the binary. "); - - - cm->DefineProperty - ("WIN32_EXECUTABLE", cmProperty::TARGET, - "Build an executable with a WinMain entry point on windows.", - "When this property is set to true the executable when linked " - "on Windows will be created with a WinMain() entry point instead " - "of just main(). " - "This makes it a GUI executable instead of a console application. " - "See the CMAKE_MFC_FLAG variable documentation to configure use " - "of MFC for WinMain executables. " - "This property is initialized by the value of the variable " - "CMAKE_WIN32_EXECUTABLE if it is set when a target is created."); - - cm->DefineProperty - ("MACOSX_BUNDLE", cmProperty::TARGET, - "Build an executable as an application bundle on Mac OS X.", - "When this property is set to true the executable when built " - "on Mac OS X will be created as an application bundle. " - "This makes it a GUI executable that can be launched from " - "the Finder. " - "See the MACOSX_BUNDLE_INFO_PLIST target property for information " - "about creation of the Info.plist file for the application bundle. " - "This property is initialized by the value of the variable " - "CMAKE_MACOSX_BUNDLE if it is set when a target is created."); - - cm->DefineProperty - ("MACOSX_BUNDLE_INFO_PLIST", cmProperty::TARGET, - "Specify a custom Info.plist template for a Mac OS X App Bundle.", - "An executable target with MACOSX_BUNDLE enabled will be built as an " - "application bundle on Mac OS X. " - "By default its Info.plist file is created by configuring a template " - "called MacOSXBundleInfo.plist.in located in the CMAKE_MODULE_PATH. " - "This property specifies an alternative template file name which " - "may be a full path.\n" - "The following target properties may be set to specify content to " - "be configured into the file:\n" - " MACOSX_BUNDLE_INFO_STRING\n" - " MACOSX_BUNDLE_ICON_FILE\n" - " MACOSX_BUNDLE_GUI_IDENTIFIER\n" - " MACOSX_BUNDLE_LONG_VERSION_STRING\n" - " MACOSX_BUNDLE_BUNDLE_NAME\n" - " MACOSX_BUNDLE_SHORT_VERSION_STRING\n" - " MACOSX_BUNDLE_BUNDLE_VERSION\n" - " MACOSX_BUNDLE_COPYRIGHT\n" - "CMake variables of the same name may be set to affect all targets " - "in a directory that do not have each specific property set. " - "If a custom Info.plist is specified by this property it may of course " - "hard-code all the settings instead of using the target properties."); - - cm->DefineProperty - ("MACOSX_FRAMEWORK_INFO_PLIST", cmProperty::TARGET, - "Specify a custom Info.plist template for a Mac OS X Framework.", - "A library target with FRAMEWORK enabled will be built as a " - "framework on Mac OS X. " - "By default its Info.plist file is created by configuring a template " - "called MacOSXFrameworkInfo.plist.in located in the CMAKE_MODULE_PATH. " - "This property specifies an alternative template file name which " - "may be a full path.\n" - "The following target properties may be set to specify content to " - "be configured into the file:\n" - " MACOSX_FRAMEWORK_ICON_FILE\n" - " MACOSX_FRAMEWORK_IDENTIFIER\n" - " MACOSX_FRAMEWORK_SHORT_VERSION_STRING\n" - " MACOSX_FRAMEWORK_BUNDLE_VERSION\n" - "CMake variables of the same name may be set to affect all targets " - "in a directory that do not have each specific property set. " - "If a custom Info.plist is specified by this property it may of course " - "hard-code all the settings instead of using the target properties."); - - cm->DefineProperty - ("MACOSX_RPATH", cmProperty::TARGET, - "Whether to use rpaths on Mac OS X.", - "When this property is set to true, the directory portion of the" - "\"install_name\" field of shared libraries will default to \"@rpath\"." - "Runtime paths will also be embedded in binaries using this target." - "This property is initialized by the value of the variable " - "CMAKE_MACOSX_RPATH if it is set when a target is created."); - - cm->DefineProperty - ("ENABLE_EXPORTS", cmProperty::TARGET, - "Specify whether an executable exports symbols for loadable modules.", - "Normally an executable does not export any symbols because it is " - "the final program. It is possible for an executable to export " - "symbols to be used by loadable modules. When this property is " - "set to true CMake will allow other targets to \"link\" to the " - "executable with the TARGET_LINK_LIBRARIES command. " - "On all platforms a target-level dependency on the executable is " - "created for targets that link to it. " - "For DLL platforms an import library will be created for the " - "exported symbols and then used for linking. " - "All Windows-based systems including Cygwin are DLL platforms. " - "For non-DLL platforms that require all symbols to be resolved at " - "link time, such as Mac OS X, the module will \"link\" to the " - "executable using a flag like \"-bundle_loader\". " - "For other non-DLL platforms the link rule is simply ignored since " - "the dynamic loader will automatically bind symbols when the " - "module is loaded. " - ); - - cm->DefineProperty - ("Fortran_FORMAT", cmProperty::TARGET, - "Set to FIXED or FREE to indicate the Fortran source layout.", - "This property tells CMake whether the Fortran source files " - "in a target use fixed-format or free-format. " - "CMake will pass the corresponding format flag to the compiler. " - "Use the source-specific Fortran_FORMAT property to change the " - "format of a specific source file. " - "If the variable CMAKE_Fortran_FORMAT is set when a target " - "is created its value is used to initialize this property."); - - cm->DefineProperty - ("Fortran_MODULE_DIRECTORY", cmProperty::TARGET, - "Specify output directory for Fortran modules provided by the target.", - "If the target contains Fortran source files that provide modules " - "and the compiler supports a module output directory this specifies " - "the directory in which the modules will be placed. " - "When this property is not set the modules will be placed in the " - "build directory corresponding to the target's source directory. " - "If the variable CMAKE_Fortran_MODULE_DIRECTORY is set when a target " - "is created its value is used to initialize this property." - "\n" - "Note that some compilers will automatically search the module output " - "directory for modules USEd during compilation but others will not. " - "If your sources USE modules their location must be specified by " - "INCLUDE_DIRECTORIES regardless of this property."); - - cm->DefineProperty - ("GNUtoMS", cmProperty::TARGET, - "Convert GNU import library (.dll.a) to MS format (.lib).", - "When linking a shared library or executable that exports symbols " - "using GNU tools on Windows (MinGW/MSYS) with Visual Studio installed " - "convert the import library (.dll.a) from GNU to MS format (.lib). " - "Both import libraries will be installed by install(TARGETS) and " - "exported by install(EXPORT) and export() to be linked by applications " - "with either GNU- or MS-compatible tools." - "\n" - "If the variable CMAKE_GNUtoMS is set when a target " - "is created its value is used to initialize this property. " - "The variable must be set prior to the first command that enables " - "a language such as project() or enable_language(). " - "CMake provides the variable as an option to the user automatically " - "when configuring on Windows with GNU tools."); - - cm->DefineProperty - ("XCODE_ATTRIBUTE_<an-attribute>", cmProperty::TARGET, - "Set Xcode target attributes directly.", - "Tell the Xcode generator to set '<an-attribute>' to a given value " - "in the generated Xcode project. Ignored on other generators."); - - cm->DefineProperty - ("GENERATOR_FILE_NAME", cmProperty::TARGET, - "Generator's file for this target.", - "An internal property used by some generators to record the name of the " - "project or dsp file associated with this target. Note that at configure " - "time, this property is only set for targets created by " - "include_external_msproject()."); - - cm->DefineProperty - ("SOURCES", cmProperty::TARGET, - "Source names specified for a target.", - "Read-only list of sources specified for a target. " - "The names returned are suitable for passing to the " - "set_source_files_properties command."); - - cm->DefineProperty - ("FOLDER", cmProperty::TARGET, - "Set the folder name. Use to organize targets in an IDE.", - "Targets with no FOLDER property will appear as top level " - "entities in IDEs like Visual Studio. Targets with the same " - "FOLDER property value will appear next to each other in a " - "folder of that name. To nest folders, use FOLDER values such " - "as 'GUI/Dialogs' with '/' characters separating folder levels."); - - cm->DefineProperty - ("PROJECT_LABEL", cmProperty::TARGET, - "Change the name of a target in an IDE.", - "Can be used to change the name of the target in an IDE " - "like Visual Studio. "); - cm->DefineProperty - ("VS_KEYWORD", cmProperty::TARGET, - "Visual Studio project keyword.", - "Can be set to change the visual studio keyword, for example " - "Qt integration works better if this is set to Qt4VSv1.0. "); - cm->DefineProperty - ("VS_SCC_PROVIDER", cmProperty::TARGET, - "Visual Studio Source Code Control Provider.", - "Can be set to change the visual studio source code control " - "provider property."); - cm->DefineProperty - ("VS_SCC_LOCALPATH", cmProperty::TARGET, - "Visual Studio Source Code Control Local Path.", - "Can be set to change the visual studio source code control " - "local path property."); - cm->DefineProperty - ("VS_SCC_PROJECTNAME", cmProperty::TARGET, - "Visual Studio Source Code Control Project.", - "Can be set to change the visual studio source code control " - "project name property."); - cm->DefineProperty - ("VS_SCC_AUXPATH", cmProperty::TARGET, - "Visual Studio Source Code Control Aux Path.", - "Can be set to change the visual studio source code control " - "auxpath property."); - cm->DefineProperty - ("VS_GLOBAL_PROJECT_TYPES", cmProperty::TARGET, - "Visual Studio project type(s).", - "Can be set to one or more UUIDs recognized by Visual Studio " - "to indicate the type of project. This value is copied " - "verbatim into the generated project file. Example for a " - "managed C++ unit testing project:\n" - " {3AC096D0-A1C2-E12C-1390-A8335801FDAB};" - "{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}\n" - "UUIDs are semicolon-delimited."); - cm->DefineProperty - ("VS_GLOBAL_KEYWORD", cmProperty::TARGET, - "Visual Studio project keyword.", - "Sets the \"keyword\" attribute for a generated Visual Studio " - "project. Defaults to \"Win32Proj\". You may wish to override " - "this value with \"ManagedCProj\", for example, in a Visual " - "Studio managed C++ unit test project."); - cm->DefineProperty - ("VS_GLOBAL_ROOTNAMESPACE", cmProperty::TARGET, - "Visual Studio project root namespace.", - "Sets the \"RootNamespace\" attribute for a generated Visual Studio " - "project. The attribute will be generated only if this is set."); - cm->DefineProperty - ("VS_DOTNET_TARGET_FRAMEWORK_VERSION", cmProperty::TARGET, - "Specify the .NET target framework version.", - "Used to specify the .NET target framework version for C++/CLI. " - "For example, \"v4.5\"."); - cm->DefineProperty - ("VS_DOTNET_REFERENCES", cmProperty::TARGET, - "Visual Studio managed project .NET references", - "Adds one or more semicolon-delimited .NET references to a " - "generated Visual Studio project. For example, \"System;" - "System.Windows.Forms\"."); - cm->DefineProperty - ("VS_WINRT_EXTENSIONS", cmProperty::TARGET, - "Visual Studio project C++/CX language extensions for Windows Runtime", - "Can be set to enable C++/CX language extensions."); - cm->DefineProperty - ("VS_WINRT_REFERENCES", cmProperty::TARGET, - "Visual Studio project Windows Runtime Metadata references", - "Adds one or more semicolon-delimited WinRT references to a " - "generated Visual Studio project. For example, \"Windows;" - "Windows.UI.Core\"."); - cm->DefineProperty - ("VS_GLOBAL_<variable>", cmProperty::TARGET, - "Visual Studio project-specific global variable.", - "Tell the Visual Studio generator to set the global variable " - "'<variable>' to a given value in the generated Visual Studio " - "project. Ignored on other generators. Qt integration works " - "better if VS_GLOBAL_QtVersion is set to the version " - "FindQt4.cmake found. For example, \"4.7.3\""); - -#define CM_TARGET_FILE_TYPES_DOC \ - "There are three kinds of target files that may be built: " \ - "archive, library, and runtime. " \ - "Executables are always treated as runtime targets. " \ - "Static libraries are always treated as archive targets. " \ - "Module libraries are always treated as library targets. " \ - "For non-DLL platforms shared libraries are treated as library " \ - "targets. " \ - "For DLL platforms the DLL part of a shared library is treated as " \ - "a runtime target and the corresponding import library is treated as " \ - "an archive target. " \ - "All Windows-based systems including Cygwin are DLL platforms." - -#define CM_TARGET_OUTDIR_DOC(TYPE, type) \ - "This property specifies the directory into which " #type " target " \ - "files should be built. " \ - "Multi-configuration generators (VS, Xcode) append " \ - "a per-configuration subdirectory to the specified directory. " \ - CM_TARGET_FILE_TYPES_DOC " " \ - "This property is initialized by the value of the variable " \ - "CMAKE_" #TYPE "_OUTPUT_DIRECTORY if it is set when a target is created." - -#define CM_TARGET_OUTDIR_CONFIG_DOC(TYPE) \ - "This is a per-configuration version of " #TYPE "_OUTPUT_DIRECTORY, " \ - "but multi-configuration generators (VS, Xcode) do NOT append " \ - "a per-configuration subdirectory to the specified directory. " \ - "This property is initialized by the value of the variable " \ - "CMAKE_" #TYPE "_OUTPUT_DIRECTORY_<CONFIG> " \ - "if it is set when a target is created." - - cm->DefineProperty - ("ARCHIVE_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory in which to build ARCHIVE target files.", - CM_TARGET_OUTDIR_DOC(ARCHIVE, archive)); - cm->DefineProperty - ("ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for ARCHIVE target files.", - CM_TARGET_OUTDIR_CONFIG_DOC(ARCHIVE)); - cm->DefineProperty - ("LIBRARY_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory in which to build LIBRARY target files.", - CM_TARGET_OUTDIR_DOC(LIBRARY, library)); - cm->DefineProperty - ("LIBRARY_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for LIBRARY target files.", - CM_TARGET_OUTDIR_CONFIG_DOC(LIBRARY)); - cm->DefineProperty - ("RUNTIME_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory in which to build RUNTIME target files.", - CM_TARGET_OUTDIR_DOC(RUNTIME, runtime)); - cm->DefineProperty - ("RUNTIME_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for RUNTIME target files.", - CM_TARGET_OUTDIR_CONFIG_DOC(RUNTIME)); - - cm->DefineProperty - ("PDB_OUTPUT_DIRECTORY", cmProperty::TARGET, - "Output directory for MS debug symbols .pdb file from linker.", - "This property specifies the directory into which the MS debug symbols " - "will be placed by the linker. " - "This property is initialized by the value of the variable " - "CMAKE_PDB_OUTPUT_DIRECTORY if it is set when a target is created." - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - cm->DefineProperty - ("PDB_OUTPUT_DIRECTORY_<CONFIG>", cmProperty::TARGET, - "Per-configuration output directory for MS debug symbols .pdb files.", - "This is a per-configuration version of PDB_OUTPUT_DIRECTORY, " - "but multi-configuration generators (VS, Xcode) do NOT append " - "a per-configuration subdirectory to the specified directory. " - "This property is initialized by the value of the variable " - "CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> " - "if it is set when a target is created." - "\n" - "This property is not implemented by the Visual Studio 6 generator."); - - cm->DefineProperty - ("ARCHIVE_OUTPUT_NAME", cmProperty::TARGET, - "Output name for ARCHIVE target files.", - "This property specifies the base name for archive target files. " - "It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. " - CM_TARGET_FILE_TYPES_DOC); - cm->DefineProperty - ("ARCHIVE_OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration output name for ARCHIVE target files.", - "This is the configuration-specific version of ARCHIVE_OUTPUT_NAME."); - cm->DefineProperty - ("LIBRARY_OUTPUT_NAME", cmProperty::TARGET, - "Output name for LIBRARY target files.", - "This property specifies the base name for library target files. " - "It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. " - CM_TARGET_FILE_TYPES_DOC); - cm->DefineProperty - ("LIBRARY_OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration output name for LIBRARY target files.", - "This is the configuration-specific version of LIBRARY_OUTPUT_NAME."); - cm->DefineProperty - ("RUNTIME_OUTPUT_NAME", cmProperty::TARGET, - "Output name for RUNTIME target files.", - "This property specifies the base name for runtime target files. " - "It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. " - CM_TARGET_FILE_TYPES_DOC); - cm->DefineProperty - ("RUNTIME_OUTPUT_NAME_<CONFIG>", cmProperty::TARGET, - "Per-configuration output name for RUNTIME target files.", - "This is the configuration-specific version of RUNTIME_OUTPUT_NAME."); + "", "", true); } void cmTarget::SetType(TargetType type, const char* name) @@ -6964,13 +5588,16 @@ void checkPropertyConsistency(cmTarget *depender, cmTarget *dependee, std::vector<std::string> props; cmSystemTools::ExpandListArgument(prop, props); + std::string pdir = + dependee->GetMakefile()->GetRequiredDefinition("CMAKE_ROOT"); + pdir += "/Help/prop_tgt/"; for(std::vector<std::string>::iterator pi = props.begin(); pi != props.end(); ++pi) { - if (depender->GetMakefile()->GetCMakeInstance() - ->IsPropertyDefined(pi->c_str(), - cmProperty::TARGET)) + std::string pname = cmSystemTools::HelpFileName(*pi); + std::string pfile = pdir + pname + ".rst"; + if(cmSystemTools::FileExists(pfile.c_str(), true)) { cmOStringStream e; e << "Target \"" << dependee->GetName() << "\" has property \"" diff --git a/Source/cmTargetCompileDefinitionsCommand.h b/Source/cmTargetCompileDefinitionsCommand.h index 585485d..7405e90 100644 --- a/Source/cmTargetCompileDefinitionsCommand.h +++ b/Source/cmTargetCompileDefinitionsCommand.h @@ -38,41 +38,6 @@ public: */ virtual const char* GetName() const { return "target_compile_definitions";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add compile definitions to a target."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_compile_definitions(<target> " - "<INTERFACE|PUBLIC|PRIVATE> [items1...]\n" - " [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])\n" - "Specify compile definitions to use when compiling a given target. " - "The named <target> must have been created by a command such as " - "add_executable or add_library and must not be an IMPORTED target. " - "The INTERFACE, PUBLIC and PRIVATE keywords are required to specify " - "the scope of the following arguments. PRIVATE and PUBLIC items will " - "populate the COMPILE_DEFINITIONS property of <target>. PUBLIC and " - "INTERFACE items will populate the INTERFACE_COMPILE_DEFINITIONS " - "property of <target>. " - "The following arguments specify compile definitions. " - "Repeated calls for the same <target> append items in the order called." - "\n" - "Arguments to target_compile_definitions may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetCompileDefinitionsCommand, cmTargetPropCommandBase); private: diff --git a/Source/cmTargetCompileOptionsCommand.h b/Source/cmTargetCompileOptionsCommand.h index b9afd71..3713e5a 100644 --- a/Source/cmTargetCompileOptionsCommand.h +++ b/Source/cmTargetCompileOptionsCommand.h @@ -38,43 +38,6 @@ public: */ virtual const char* GetName() const { return "target_compile_options";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add compile options to a target."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_compile_options(<target> [BEFORE] " - "<INTERFACE|PUBLIC|PRIVATE> [items1...]\n" - " [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])\n" - "Specify compile options to use when compiling a given target. " - "The named <target> must have been created by a command such as " - "add_executable or add_library and must not be an IMPORTED target. " - "If BEFORE is specified, the content will be prepended to the property " - "instead of being appended.\n" - "The INTERFACE, PUBLIC and PRIVATE keywords are required to specify " - "the scope of the following arguments. PRIVATE and PUBLIC items will " - "populate the COMPILE_OPTIONS property of <target>. PUBLIC and " - "INTERFACE items will populate the INTERFACE_COMPILE_OPTIONS " - "property of <target>. " - "The following arguments specify compile opitions. " - "Repeated calls for the same <target> append items in the order called." - "\n" - "Arguments to target_compile_options may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetCompileOptionsCommand, cmTargetPropCommandBase); private: diff --git a/Source/cmTargetIncludeDirectoriesCommand.h b/Source/cmTargetIncludeDirectoriesCommand.h index fcc37f0..6863ee5 100644 --- a/Source/cmTargetIncludeDirectoriesCommand.h +++ b/Source/cmTargetIncludeDirectoriesCommand.h @@ -39,53 +39,6 @@ public: */ virtual const char* GetName() const { return "target_include_directories";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Add include directories to a target."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_include_directories(<target> [SYSTEM] [BEFORE] " - "<INTERFACE|PUBLIC|PRIVATE> [items1...]\n" - " [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])\n" - "Specify include directories or targets to use when compiling a given " - "target. " - "The named <target> must have been created by a command such as " - "add_executable or add_library and must not be an IMPORTED target.\n" - "If BEFORE is specified, the content will be prepended to the property " - "instead of being appended.\n" - "The INTERFACE, PUBLIC and PRIVATE keywords are required to specify " - "the scope of the following arguments. PRIVATE and PUBLIC items will " - "populate the INCLUDE_DIRECTORIES property of <target>. PUBLIC and " - "INTERFACE items will populate the INTERFACE_INCLUDE_DIRECTORIES " - "property of <target>. " - "The following arguments specify include directories. Specified " - "include directories may be absolute paths or relative paths. " - "Repeated calls for the same <target> append items in the order called." - "If SYSTEM is specified, the compiler will be told the " - "directories are meant as system include directories on some " - "platforms (signalling this setting might achieve effects such as " - "the compiler skipping warnings, or these fixed-install system files " - "not being considered in dependency calculations - see compiler " - "docs). If SYSTEM is used together with PUBLIC or INTERFACE, the " - "INTERFACE_SYSTEM_INCLUDE_DIRECTORIES target property will be " - "populated with the specified directories." - "\n" - "Arguments to target_include_directories may use \"generator " - "expressions\" with the syntax \"$<...>\". " - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetIncludeDirectoriesCommand, cmTargetPropCommandBase); private: diff --git a/Source/cmTargetLinkLibrariesCommand.h b/Source/cmTargetLinkLibrariesCommand.h index f2b2543..6fbf722 100644 --- a/Source/cmTargetLinkLibrariesCommand.h +++ b/Source/cmTargetLinkLibrariesCommand.h @@ -13,7 +13,6 @@ #define cmTargetLinkLibrariesCommand_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" /** \class cmTargetLinkLibrariesCommand * \brief Specify a list of libraries to link into executables. @@ -45,151 +44,6 @@ public: */ virtual const char* GetName() const { return "target_link_libraries";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return - "Link a target to given libraries."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " target_link_libraries(<target> [item1 [item2 [...]]]\n" - " [[debug|optimized|general] <item>] ...)\n" - "Specify libraries or flags to use when linking a given target. " - "The named <target> must have been created in the current directory " - "by a command such as add_executable or add_library. " - "The remaining arguments specify library names or flags. " - "Repeated calls for the same <target> append items in the order called." - "\n" - "If a library name matches that of another target in the project " - "a dependency will automatically be added in the build system to make " - "sure the library being linked is up-to-date before the target links. " - "Item names starting with '-', but not '-l' or '-framework', are " - "treated as linker flags." - "\n" - "A \"debug\", \"optimized\", or \"general\" keyword indicates that " - "the library immediately following it is to be used only for the " - "corresponding build configuration. " - "The \"debug\" keyword corresponds to the Debug configuration " - "(or to configurations named in the DEBUG_CONFIGURATIONS global " - "property if it is set). " - "The \"optimized\" keyword corresponds to all other configurations. " - "The \"general\" keyword corresponds to all configurations, and is " - "purely optional (assumed if omitted). " - "Higher granularity may be achieved for per-configuration rules " - "by creating and linking to IMPORTED library targets. " - "See the IMPORTED mode of the add_library command for more " - "information. " - "\n" - "Library dependencies are transitive by default. " - "When this target is linked into another target then the libraries " - "linked to this target will appear on the link line for the other " - "target too. " - "See the INTERFACE_LINK_LIBRARIES target property to override the " - "set of transitive link dependencies for a target. " - "Calls to other signatures of this command may set the property " - "making any libraries linked exclusively by this signature private." - "\n" - "CMake will also propagate \"usage requirements\" from linked library " - "targets. " - "Usage requirements affect compilation of sources in the <target>. " - "They are specified by properties defined on linked targets. " - "During generation of the build system, CMake integrates " - "usage requirement property values with the corresponding " - "build properties for <target>:\n" - " INTERFACE_COMPILE_DEFINITONS: Appends to COMPILE_DEFINITONS\n" - " INTERFACE_INCLUDE_DIRECTORIES: Appends to INCLUDE_DIRECTORIES\n" - " INTERFACE_POSITION_INDEPENDENT_CODE: Sets POSITION_INDEPENDENT_CODE\n" - " or checked for consistency with existing value\n" - "\n" - "If an <item> is a library in a Mac OX framework, the Headers " - "directory of the framework will also be processed as a \"usage " - "requirement\". This has the same effect as passing the framework " - "directory as an include directory." - " target_link_libraries(<target>\n" - " <PRIVATE|PUBLIC|INTERFACE> <lib> ...\n" - " [<PRIVATE|PUBLIC|INTERFACE> <lib> ... ] ...])\n" - "The PUBLIC, PRIVATE and INTERFACE keywords can be used to specify " - "both the link dependencies and the link interface in one command. " - "Libraries and targets following PUBLIC are linked to, and are " - "made part of the link interface. Libraries and targets " - "following PRIVATE are linked to, but are not made part of the " - "link interface. Libraries following INTERFACE are appended " - "to the link interface and are not used for linking <target>." - "\n" - " target_link_libraries(<target> LINK_INTERFACE_LIBRARIES\n" - " [[debug|optimized|general] <lib>] ...)\n" - "The LINK_INTERFACE_LIBRARIES mode appends the libraries " - "to the INTERFACE_LINK_LIBRARIES target property instead of using them " - "for linking. If policy CMP0022 is not NEW, then this mode also " - "appends libraries to the LINK_INTERFACE_LIBRARIES and its " - "per-configuration equivalent. This signature " - "is for compatibility only. Prefer the INTERFACE mode instead. " - "Libraries specified as \"debug\" are wrapped in a generator " - "expression to correspond to debug builds. If policy CMP0022 is not " - "NEW, the libraries are also appended to the " - "LINK_INTERFACE_LIBRARIES_DEBUG property (or to the properties " - "corresponding to configurations listed in the DEBUG_CONFIGURATIONS " - "global property if it is set). " - "Libraries specified as \"optimized\" are appended to the " - "INTERFACE_LINK_LIBRARIES property. If policy CMP0022 is not NEW, " - "they are also appended to the LINK_INTERFACE_LIBRARIES property. " - "Libraries specified as \"general\" (or without any keyword) are " - "treated as if specified for both \"debug\" and \"optimized\"." - "\n" - " target_link_libraries(<target>\n" - " <LINK_PRIVATE|LINK_PUBLIC>\n" - " [[debug|optimized|general] <lib>] ...\n" - " [<LINK_PRIVATE|LINK_PUBLIC>\n" - " [[debug|optimized|general] <lib>] ...])\n" - "The LINK_PUBLIC and LINK_PRIVATE modes can be used to specify both " - "the link dependencies and the link interface in one command. This " - "signature is for compatibility only. Prefer the PUBLIC or PRIVATE " - "keywords instead. " - "Libraries and targets following LINK_PUBLIC are linked to, and are " - "made part of the INTERFACE_LINK_LIBRARIES. If policy CMP0022 is not " - "NEW, they are also made part of the LINK_INTERFACE_LIBRARIES. " - "Libraries and targets following LINK_PRIVATE are linked to, but are " - "not made part of the INTERFACE_LINK_LIBRARIES (or " - "LINK_INTERFACE_LIBRARIES)." - "\n" - "The library dependency graph is normally acyclic (a DAG), but in the " - "case of mutually-dependent STATIC libraries CMake allows the graph " - "to contain cycles (strongly connected components). " - "When another target links to one of the libraries CMake repeats " - "the entire connected component. " - "For example, the code\n" - " add_library(A STATIC a.c)\n" - " add_library(B STATIC b.c)\n" - " target_link_libraries(A B)\n" - " target_link_libraries(B A)\n" - " add_executable(main main.c)\n" - " target_link_libraries(main A)\n" - "links 'main' to 'A B A B'. " - "(" - "While one repetition is usually sufficient, pathological object " - "file and symbol arrangements can require more. " - "One may handle such cases by manually repeating the component in " - "the last target_link_libraries call. " - "However, if two archives are really so interdependent they should " - "probably be combined into a single archive." - ")" - "\n" - "Arguments to target_link_libraries may use \"generator expressions\" " - "with the syntax \"$<...>\". Note however, that generator expressions " - "will not be used in OLD handling of CMP0003 or CMP0004." - "\n" - CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS - ; - } - cmTypeMacro(cmTargetLinkLibrariesCommand, cmCommand); private: void LinkLibraryTypeSpecifierWarning(int left, int right); diff --git a/Source/cmTargetPropCommandBase.h b/Source/cmTargetPropCommandBase.h index 690582f..c402836 100644 --- a/Source/cmTargetPropCommandBase.h +++ b/Source/cmTargetPropCommandBase.h @@ -14,7 +14,6 @@ #define cmTargetPropCommandBase_h #include "cmCommand.h" -#include "cmDocumentGeneratorExpressions.h" class cmTarget; diff --git a/Source/cmTest.cxx b/Source/cmTest.cxx index 0904431..9cda978 100644 --- a/Source/cmTest.cxx +++ b/Source/cmTest.cxx @@ -92,114 +92,3 @@ void cmTest::AppendProperty(const char* prop, const char* value, bool asString) } this->Properties.AppendProperty(prop, value, cmProperty::TEST, asString); } - -//---------------------------------------------------------------------------- -void cmTest::DefineProperties(cmake *cm) -{ - cm->DefineProperty - ("ATTACHED_FILES", cmProperty::TEST, - "Attach a list of files to a dashboard submission.", - "Set this property to a list of files that will be encoded and " - "submitted to the dashboard as an addition to the test result."); - - cm->DefineProperty - ("ATTACHED_FILES_ON_FAIL", cmProperty::TEST, - "Attach a list of files to a dashboard submission if the test fails.", - "Same as ATTACHED_FILES, but these files will only be included if the " - "test does not pass."); - - cm->DefineProperty - ("COST", cmProperty::TEST, - "Set this to a floating point value. Tests in a test set will be " - "run in descending order of cost.", "This property describes the cost " - "of a test. You can explicitly set this value; tests with higher COST " - "values will run first."); - - cm->DefineProperty - ("DEPENDS", cmProperty::TEST, - "Specifies that this test should only be run after the specified " - "list of tests.", - "Set this to a list of tests that must finish before this test is run."); - - cm->DefineProperty - ("ENVIRONMENT", cmProperty::TEST, - "Specify environment variables that should be defined for running " - "a test.", - "If set to a list of environment variables and values of the form " - "MYVAR=value those environment variables will be defined while " - "running the test. The environment is restored to its previous state " - "after the test is done."); - - cm->DefineProperty - ("FAIL_REGULAR_EXPRESSION", cmProperty::TEST, - "If the output matches this regular expression the test will fail.", - "If set, if the output matches one of " - "specified regular expressions, the test will fail." - "For example: FAIL_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\""); - - cm->DefineProperty - ("LABELS", cmProperty::TEST, - "Specify a list of text labels associated with a test.", - "The list is reported in dashboard submissions."); - - cm->DefineProperty - ("RESOURCE_LOCK", cmProperty::TEST, - "Specify a list of resources that are locked by this test.", - "If multiple tests specify the same resource lock, they are guaranteed " - "not to run concurrently."); - - cm->DefineProperty - ("MEASUREMENT", cmProperty::TEST, - "Specify a CDASH measurement and value to be reported for a test.", - "If set to a name then that name will be reported to CDASH as a " - "named measurement with a value of 1. You may also specify a value " - "by setting MEASUREMENT to \"measurement=value\"."); - - cm->DefineProperty - ("PASS_REGULAR_EXPRESSION", cmProperty::TEST, - "The output must match this regular expression for the test to pass.", - "If set, the test output will be checked " - "against the specified regular expressions and at least one of the" - " regular expressions has to match, otherwise the test will fail."); - - cm->DefineProperty - ("PROCESSORS", cmProperty::TEST, - "How many process slots this test requires", - "Denotes the number of processors that this test will require. This is " - "typically used for MPI tests, and should be used in conjunction with " - "the ctest_test PARALLEL_LEVEL option."); - - cm->DefineProperty - ("REQUIRED_FILES", cmProperty::TEST, - "List of files required to run the test.", - "If set to a list of files, the test will not be run unless all of the " - "files exist."); - - cm->DefineProperty - ("RUN_SERIAL", cmProperty::TEST, - "Do not run this test in parallel with any other test.", - "Use this option in conjunction with the ctest_test PARALLEL_LEVEL " - "option to specify that this test should not be run in parallel with " - "any other tests."); - - cm->DefineProperty - ("TIMEOUT", cmProperty::TEST, - "How many seconds to allow for this test.", - "This property if set will limit a test to not take more than " - "the specified number of seconds to run. If it exceeds that the " - "test process will be killed and ctest will move to the next test. " - "This setting takes precedence over " - "CTEST_TESTING_TIMEOUT."); - - cm->DefineProperty - ("WILL_FAIL", cmProperty::TEST, - "If set to true, this will invert the pass/fail flag of the test.", - "This property can be used for tests that are expected to fail and " - "return a non zero return code."); - - cm->DefineProperty - ("WORKING_DIRECTORY", cmProperty::TEST, - "The directory from which the test executable will be called.", - "If this is not set it is called from the directory the test executable " - "is located in."); -} diff --git a/Source/cmTest.h b/Source/cmTest.h index 73ac133..1fe8fc0 100644 --- a/Source/cmTest.h +++ b/Source/cmTest.h @@ -52,9 +52,6 @@ public: bool GetPropertyAsBool(const char *prop) const; cmPropertyMap &GetProperties() { return this->Properties; }; - // Define the properties - static void DefineProperties(cmake *cm); - /** Get the cmMakefile instance that owns this test. */ cmMakefile *GetMakefile() { return this->Makefile;}; diff --git a/Source/cmTryCompileCommand.h b/Source/cmTryCompileCommand.h index a20594c..8e6bbc1 100644 --- a/Source/cmTryCompileCommand.h +++ b/Source/cmTryCompileCommand.h @@ -42,81 +42,6 @@ public: */ virtual const char* GetName() const { return "try_compile";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Try building some code."; - } - - /** - * More documentation. */ - virtual const char* GetFullDocumentation() const - { - return - " try_compile(RESULT_VAR <bindir> <srcdir>\n" - " <projectName> [targetName] [CMAKE_FLAGS flags...]\n" - " [OUTPUT_VARIABLE <var>])\n" - "Try building a project. In this form, srcdir should contain a " - "complete CMake project with a CMakeLists.txt file and all sources. " - "The bindir and srcdir will not be deleted after this command is run. " - "Specify targetName to build a specific target instead of the 'all' or " - "'ALL_BUILD' target." - "\n" - " try_compile(RESULT_VAR <bindir> <srcfile|SOURCES srcfile...>\n" - " [CMAKE_FLAGS flags...]\n" - " [COMPILE_DEFINITIONS flags...]\n" - " [LINK_LIBRARIES libs...]\n" - " [OUTPUT_VARIABLE <var>]\n" - " [COPY_FILE <fileName> [COPY_FILE_ERROR <var>]])\n" - "Try building an executable from one or more source files. " - "In this form the user need only supply one or more source files " - "that include a definition for 'main'. " - "CMake will create a CMakeLists.txt file to build the source(s) " - "as an executable. " - "Specify COPY_FILE to get a copy of the linked executable at the " - "given fileName and optionally COPY_FILE_ERROR to capture any error." - "\n" - "In this version all files in bindir/CMakeFiles/CMakeTmp " - "will be cleaned automatically. For debugging, --debug-trycompile can " - "be passed to cmake to avoid this clean. However, multiple sequential " - "try_compile operations reuse this single output directory. If you " - "use --debug-trycompile, you can only debug one try_compile call at a " - "time. The recommended procedure is to configure with cmake all the " - "way through once, then delete the cache entry associated with " - "the try_compile call of interest, and then re-run cmake again with " - "--debug-trycompile." - "\n" - "Some extra flags that can be included are, " - "INCLUDE_DIRECTORIES, LINK_DIRECTORIES, and LINK_LIBRARIES. " - "COMPILE_DEFINITIONS are -Ddefinition that will be passed to the " - "compile line.\n" - "The srcfile signature also accepts a LINK_LIBRARIES argument which " - "may contain a list of libraries or IMPORTED targets which will be " - "linked to in the generated project. If LINK_LIBRARIES is specified " - "as a parameter to try_compile, then any LINK_LIBRARIES passed as " - "CMAKE_FLAGS will be ignored.\n" - "try_compile creates a CMakeList.txt " - "file on the fly that looks like this:\n" - " add_definitions( <expanded COMPILE_DEFINITIONS from calling " - "cmake>)\n" - " include_directories(${INCLUDE_DIRECTORIES})\n" - " link_directories(${LINK_DIRECTORIES})\n" - " add_executable(cmTryCompileExec sources)\n" - " target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})\n" - "In both versions of the command, " - "if OUTPUT_VARIABLE is specified, then the " - "output from the build process is stored in the given variable. " - "The success or failure of the try_compile, i.e. TRUE or FALSE " - "respectively, is returned in " - "RESULT_VAR. CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags " - "to the cmake that is run during the build. " - "Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build " - "configuration." - ; - } - cmTypeMacro(cmTryCompileCommand, cmCoreTryCompile); }; diff --git a/Source/cmTryRunCommand.h b/Source/cmTryRunCommand.h index 13b9973..d0bf9ce 100644 --- a/Source/cmTryRunCommand.h +++ b/Source/cmTryRunCommand.h @@ -42,63 +42,6 @@ public: */ virtual const char* GetName() const { return "try_run";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Try compiling and then running some code."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR\n" - " bindir srcfile [CMAKE_FLAGS <Flags>]\n" - " [COMPILE_DEFINITIONS <flags>]\n" - " [COMPILE_OUTPUT_VARIABLE comp]\n" - " [RUN_OUTPUT_VARIABLE run]\n" - " [OUTPUT_VARIABLE var]\n" - " [ARGS <arg1> <arg2>...])\n" - "Try compiling a srcfile. Return TRUE or FALSE for success or failure " - "in COMPILE_RESULT_VAR. Then if the compile succeeded, run the " - "executable and return its exit code in RUN_RESULT_VAR. " - "If the executable was built, but failed to run, then RUN_RESULT_VAR " - "will be set to FAILED_TO_RUN. " - "COMPILE_OUTPUT_VARIABLE specifies the variable where the output from " - "the compile step goes. RUN_OUTPUT_VARIABLE specifies the variable " - "where the output from the running executable goes.\n" - "For compatibility reasons OUTPUT_VARIABLE is still supported, which " - "gives you the output from the compile and run step combined.\n" - "Cross compiling issues\n" - "When cross compiling, the executable compiled in the first step " - "usually cannot be run on the build host. try_run() checks the " - "CMAKE_CROSSCOMPILING variable to detect whether CMake is in " - "crosscompiling mode. If that's the case, it will still try to compile " - "the executable, but it will not try to run the executable. Instead it " - "will create cache variables which must be filled by the user or by " - "presetting them in some CMake script file to the values the " - "executable would have produced if it had been run on its actual " - "target platform. These variables are RUN_RESULT_VAR (explanation see " - "above) and if RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) was used, an " - "additional cache variable " - "RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT." - "This is intended to hold stdout and stderr from the executable.\n" - "In order to make cross compiling your project easier, use try_run " - "only if really required. If you use try_run, use RUN_OUTPUT_VARIABLE " - "(or OUTPUT_VARIABLE) only if really required. Using them will require " - "that when crosscompiling, the cache variables will have to be set " - "manually to the output of the executable. You can also \"guard\" the " - "calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an " - "easy-to-preset alternative for this case.\n" - "Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose a build " - "configuration." - ; - } - cmTypeMacro(cmTryRunCommand, cmCoreTryCompile); private: void RunExecutable(const std::string& runArgs, diff --git a/Source/cmUnsetCommand.h b/Source/cmUnsetCommand.h index a477f19..2308139 100644 --- a/Source/cmUnsetCommand.h +++ b/Source/cmUnsetCommand.h @@ -47,33 +47,6 @@ public: */ virtual const char* GetName() const {return "unset";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Unset a variable, cache variable, or environment variable."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " unset(<variable> [CACHE | PARENT_SCOPE])\n" - "Removes the specified variable causing it to become undefined. " - "If CACHE is present then the variable is removed from the cache " - "instead of the current scope.\n" - "If PARENT_SCOPE is present then the variable is removed from the " - "scope above the current scope. See the same option in the set() " - "command for further details.\n" - "<variable> can be an environment variable such as:\n" - " unset(ENV{LD_LIBRARY_PATH})\n" - "in which case the variable will be removed from the current " - "environment."; - } - cmTypeMacro(cmUnsetCommand, cmCommand); }; diff --git a/Source/cmUseMangledMesaCommand.h b/Source/cmUseMangledMesaCommand.h index 2f52960..aac7814 100644 --- a/Source/cmUseMangledMesaCommand.h +++ b/Source/cmUseMangledMesaCommand.h @@ -48,27 +48,6 @@ public: virtual const char* GetName() const { return "use_mangled_mesa";} /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Copy mesa headers for use in combination with system GL."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY)\n" - "The path to mesa includes, should contain gl_mangle.h. " - "The mesa headers are copied to the specified output directory. " - "This allows mangled mesa headers to override other GL headers by " - "being added to the include directory path earlier."; - } - - /** * This determines if the command is invoked when in script mode. */ virtual bool IsScriptable() const { return true; } diff --git a/Source/cmUtilitySourceCommand.h b/Source/cmUtilitySourceCommand.h index 195f605..0a0653c 100644 --- a/Source/cmUtilitySourceCommand.h +++ b/Source/cmUtilitySourceCommand.h @@ -46,35 +46,6 @@ public: */ virtual const char* GetName() const { return "utility_source";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Specify the source tree of a third-party utility."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " utility_source(cache_entry executable_name\n" - " path_to_source [file1 file2 ...])\n" - "When a third-party utility's source is included in the distribution, " - "this command specifies its location and name. The cache entry will " - "not be set unless the path_to_source and all listed files exist. It " - "is assumed that the source tree of the utility will have been built " - "before it is needed.\n" - "When cross compiling CMake will print a warning if a utility_source() " - "command is executed, because in many cases it is used to build an " - "executable which is executed later on. This doesn't work when " - "cross compiling, since the executable can run only on their target " - "platform. So in this case the cache entry has to be adjusted manually " - "so it points to an executable which is runnable on the build host."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h index c86f43d..1032745 100644 --- a/Source/cmVariableRequiresCommand.h +++ b/Source/cmVariableRequiresCommand.h @@ -41,34 +41,6 @@ public: */ virtual const char* GetName() const { return "variable_requires";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the if() command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - "Assert satisfaction of an option's required variables.\n" - " variable_requires(TEST_VARIABLE RESULT_VARIABLE\n" - " REQUIRED_VARIABLE1\n" - " REQUIRED_VARIABLE2 ...)\n" - "The first argument (TEST_VARIABLE) is the name of the variable to be " - "tested, if that variable is false nothing else is done. If " - "TEST_VARIABLE is true, then " - "the next argument (RESULT_VARIABLE) is a variable that is set to true " - "if all the required variables are set. " - "The rest of the arguments are variables that must be true or not " - "set to NOTFOUND to avoid an error. If any are not true, an error " - "is reported."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmVariableWatchCommand.h b/Source/cmVariableWatchCommand.h index 545535c..fb6062c 100644 --- a/Source/cmVariableWatchCommand.h +++ b/Source/cmVariableWatchCommand.h @@ -56,27 +56,6 @@ public: */ virtual const char* GetName() const { return "variable_watch";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Watch the CMake variable for change."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " variable_watch(<variable name> [<command to execute>])\n" - "If the specified variable changes, the message will be printed about " - "the variable being changed. If the command is specified, the command " - "will be executed. The command will receive the following arguments:" - " COMMAND(<variable> <access> <value> <current list file> <stack>)"; - } - cmTypeMacro(cmVariableWatchCommand, cmCommand); protected: diff --git a/Source/cmWhileCommand.h b/Source/cmWhileCommand.h index 1bdf27a..45badd0 100644 --- a/Source/cmWhileCommand.h +++ b/Source/cmWhileCommand.h @@ -68,32 +68,6 @@ public: */ virtual const char* GetName() const { return "while";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Evaluate a group of commands while a condition is true"; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " while(condition)\n" - " COMMAND1(ARGS ...)\n" - " COMMAND2(ARGS ...)\n" - " ...\n" - " endwhile(condition)\n" - "All commands between while and the matching endwhile are recorded " - "without being invoked. Once the endwhile is evaluated, the " - "recorded list of commands is invoked as long as the condition " - "is true. The condition is evaluated using the same logic as the " - "if command."; - } - cmTypeMacro(cmWhileCommand, cmCommand); }; diff --git a/Source/cmWriteFileCommand.h b/Source/cmWriteFileCommand.h index 771ef5a..84a38fc 100644 --- a/Source/cmWriteFileCommand.h +++ b/Source/cmWriteFileCommand.h @@ -46,32 +46,6 @@ public: */ virtual const char* GetName() const { return "write_file";} - /** - * Succinct documentation. - */ - virtual const char* GetTerseDocumentation() const - { - return "Deprecated. Use the file(WRITE ) command instead."; - } - - /** - * More documentation. - */ - virtual const char* GetFullDocumentation() const - { - return - " write_file(filename \"message to write\"... [APPEND])\n" - "The first argument is the file name, the rest of the arguments are " - "messages to write. If the argument APPEND is specified, then " - "the message will be appended.\n" - "NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as " - "this one but add some more functionality.\n" - "NOTE 2: When using write_file the produced file cannot be used as an " - "input to CMake (CONFIGURE_FILE, source file ...) because it will " - "lead to an infinite loop. Use configure_file if you want to generate " - "input files to CMake."; - } - /** This command is kept for compatibility with older CMake versions. */ virtual bool IsDiscouraged() const { diff --git a/Source/cmake.cxx b/Source/cmake.cxx index d2961c0..d11a40b 100644 --- a/Source/cmake.cxx +++ b/Source/cmake.cxx @@ -10,7 +10,6 @@ See the License for more information. ============================================================================*/ #include "cmake.h" -#include "cmDocumentVariables.h" #include "cmCacheManager.h" #include "cmMakefile.h" #include "cmLocalGenerator.h" @@ -20,7 +19,7 @@ #include "cmFileTimeComparison.h" #include "cmSourceFile.h" #include "cmTest.h" -#include "cmDocumentationFormatterText.h" +#include "cmDocumentationFormatter.h" #if defined(CMAKE_BUILD_WITH_CMAKE) # include "cmGraphVizWriter.h" @@ -219,12 +218,8 @@ void cmake::InitializeProperties() this->PropertyDefinitions.clear(); // initialize properties - cmCacheManager::DefineProperties(this); - cmSourceFile::DefineProperties(this); cmTarget::DefineProperties(this); cmMakefile::DefineProperties(this); - cmTest::DefineProperties(this); - cmake::DefineProperties(this); } void cmake::CleanupCommandsAndMacros() @@ -1865,11 +1860,6 @@ int cmake::Generate() { return -1; } - if (this->GetProperty("REPORT_UNDEFINED_PROPERTIES")) - { - this->ReportUndefinedPropertyAccesses - (this->GetProperty("REPORT_UNDEFINED_PROPERTIES")); - } // Save the cache again after a successful Generate so that any internal // variables created during Generate are saved. (Specifically target GUIDs // for the Visual Studio and Xcode generators.) @@ -2000,45 +1990,6 @@ void cmake::UpdateProgress(const char *msg, float prog) } } -void cmake::GetCommandDocumentation(std::vector<cmDocumentationEntry>& v, - bool withCurrentCommands, - bool withCompatCommands) const -{ - for(RegisteredCommandsMap::const_iterator j = this->Commands.begin(); - j != this->Commands.end(); ++j) - { - if ((( withCompatCommands == false) && ( (*j).second->IsDiscouraged())) - || ((withCurrentCommands == false) && (!(*j).second->IsDiscouraged())) - || (!((*j).second->ShouldAppearInDocumentation())) - ) - { - continue; - } - - cmDocumentationEntry e((*j).second->GetName(), - (*j).second->GetTerseDocumentation(), - (*j).second->GetFullDocumentation()); - v.push_back(e); - } -} - -void cmake::GetPolicyDocumentation(std::vector<cmDocumentationEntry>& v) -{ - this->Policies->GetDocumentation(v); -} - -void cmake::GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>& v) -{ - // loop over the properties and put them into the doc structure - std::map<cmProperty::ScopeType, cmPropertyDefinitionMap>::iterator i; - i = this->PropertyDefinitions.begin(); - for (;i != this->PropertyDefinitions.end(); ++i) - { - i->second.GetPropertiesDocumentation(v); - } -} - void cmake::GetGeneratorDocumentation(std::vector<cmDocumentationEntry>& v) { for(RegisteredGeneratorsVector::const_iterator i = @@ -2422,216 +2373,13 @@ void cmake::GenerateGraphViz(const char* fileName) const #endif } -void cmake::DefineProperties(cmake *cm) -{ - cm->DefineProperty - ("REPORT_UNDEFINED_PROPERTIES", cmProperty::GLOBAL, - "If set, report any undefined properties to this file.", - "If this property is set to a filename then when CMake runs " - "it will report any properties or variables that were accessed " - "but not defined into the filename specified in this property." - ); - - cm->DefineProperty - ("TARGET_SUPPORTS_SHARED_LIBS", cmProperty::GLOBAL, - "Does the target platform support shared libraries.", - "TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target " - "platform supports shared libraries. Basically all current general " - "general purpose OS do so, the exception are usually embedded systems " - "with no or special OSs."); - - cm->DefineProperty - ("TARGET_ARCHIVES_MAY_BE_SHARED_LIBS", cmProperty::GLOBAL, - "Set if shared libraries may be named like archives.", - "On AIX shared libraries may be named \"lib<name>.a\". " - "This property is set to true on such platforms."); - - cm->DefineProperty - ("FIND_LIBRARY_USE_LIB64_PATHS", cmProperty::GLOBAL, - "Whether FIND_LIBRARY should automatically search lib64 directories.", - "FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the " - "FIND_LIBRARY command should automatically search the lib64 variant of " - "directories called lib in the search path when building 64-bit " - "binaries."); - cm->DefineProperty - ("FIND_LIBRARY_USE_OPENBSD_VERSIONING", cmProperty::GLOBAL, - "Whether FIND_LIBRARY should find OpenBSD-style shared libraries.", - "This property is a boolean specifying whether the FIND_LIBRARY " - "command should find shared libraries with OpenBSD-style versioned " - "extension: \".so.<major>.<minor>\". " - "The property is set to true on OpenBSD and false on other platforms."); - cm->DefineProperty - ("ENABLED_FEATURES", cmProperty::GLOBAL, - "List of features which are enabled during the CMake run.", - "List of features which are enabled during the CMake run. By default " - "it contains the names of all packages which were found. This is " - "determined using the <NAME>_FOUND variables. Packages which are " - "searched QUIET are not listed. A project can add its own features to " - "this list. " - "This property is used by the macros in FeatureSummary.cmake."); - cm->DefineProperty - ("DISABLED_FEATURES", cmProperty::GLOBAL, - "List of features which are disabled during the CMake run.", - "List of features which are disabled during the CMake run. By default " - "it contains the names of all packages which were not found. This is " - "determined using the <NAME>_FOUND variables. Packages which are " - "searched QUIET are not listed. A project can add its own features to " - "this list. " - "This property is used by the macros in FeatureSummary.cmake."); - cm->DefineProperty - ("PACKAGES_FOUND", cmProperty::GLOBAL, - "List of packages which were found during the CMake run.", - "List of packages which were found during the CMake run. Whether a " - "package has been found is determined using the <NAME>_FOUND variables."); - cm->DefineProperty - ("PACKAGES_NOT_FOUND", cmProperty::GLOBAL, - "List of packages which were not found during the CMake run.", - "List of packages which were not found during the CMake run. Whether a " - "package has been found is determined using the <NAME>_FOUND variables."); - - cm->DefineProperty( - "__CMAKE_DELETE_CACHE_CHANGE_VARS_", cmProperty::GLOBAL, - "Internal property", - "Used to detect compiler changes, Do not set."); - - cm->DefineProperty( - "DEBUG_CONFIGURATIONS", cmProperty::GLOBAL, - "Specify which configurations are for debugging.", - "The value must be a semi-colon separated list of configuration names. " - "Currently this property is used only by the target_link_libraries " - "command (see its documentation for details). " - "Additional uses may be defined in the future. " - "\n" - "This property must be set at the top level of the project and before " - "the first target_link_libraries command invocation. " - "If any entry in the list does not match a valid configuration for " - "the project the behavior is undefined."); - - cm->DefineProperty( - "GLOBAL_DEPENDS_DEBUG_MODE", cmProperty::GLOBAL, - "Enable global target dependency graph debug mode.", - "CMake automatically analyzes the global inter-target dependency graph " - "at the beginning of native build system generation. " - "This property causes it to display details of its analysis to stderr."); - - cm->DefineProperty( - "GLOBAL_DEPENDS_NO_CYCLES", cmProperty::GLOBAL, - "Disallow global target dependency graph cycles.", - "CMake automatically analyzes the global inter-target dependency graph " - "at the beginning of native build system generation. " - "It reports an error if the dependency graph contains a cycle that " - "does not consist of all STATIC library targets. " - "This property tells CMake to disallow all cycles completely, even " - "among static libraries."); - - cm->DefineProperty( - "ALLOW_DUPLICATE_CUSTOM_TARGETS", cmProperty::GLOBAL, - "Allow duplicate custom targets to be created.", - "Normally CMake requires that all targets built in a project have " - "globally unique logical names (see policy CMP0002). " - "This is necessary to generate meaningful project file names in " - "Xcode and VS IDE generators. " - "It also allows the target names to be referenced unambiguously.\n" - "Makefile generators are capable of supporting duplicate custom target " - "names. " - "For projects that care only about Makefile generators and do " - "not wish to support Xcode or VS IDE generators, one may set this " - "property to true to allow duplicate custom targets. " - "The property allows multiple add_custom_target command calls in " - "different directories to specify the same target name. " - "However, setting this property will cause non-Makefile generators " - "to produce an error and refuse to generate the project." - ); - - cm->DefineProperty - ("IN_TRY_COMPILE", cmProperty::GLOBAL, - "Read-only property that is true during a try-compile configuration.", - "True when building a project inside a TRY_COMPILE or TRY_RUN command."); - cm->DefineProperty - ("ENABLED_LANGUAGES", cmProperty::GLOBAL, - "Read-only property that contains the list of currently " - "enabled languages", - "Set to list of currently enabled languages."); - - cm->DefineProperty - ("RULE_LAUNCH_COMPILE", cmProperty::GLOBAL, - "Specify a launcher for compile rules.", - "Makefile generators prefix compiler commands with the given " - "launcher command line. " - "This is intended to allow launchers to intercept build problems " - "with high granularity. " - "Non-Makefile generators currently ignore this property."); - cm->DefineProperty - ("RULE_LAUNCH_LINK", cmProperty::GLOBAL, - "Specify a launcher for link rules.", - "Makefile generators prefix link and archive commands with the given " - "launcher command line. " - "This is intended to allow launchers to intercept build problems " - "with high granularity. " - "Non-Makefile generators currently ignore this property."); - cm->DefineProperty - ("RULE_LAUNCH_CUSTOM", cmProperty::GLOBAL, - "Specify a launcher for custom rules.", - "Makefile generators prefix custom commands with the given " - "launcher command line. " - "This is intended to allow launchers to intercept build problems " - "with high granularity. " - "Non-Makefile generators currently ignore this property."); - - cm->DefineProperty - ("RULE_MESSAGES", cmProperty::GLOBAL, - "Specify whether to report a message for each make rule.", - "This property specifies whether Makefile generators should add a " - "progress message describing what each build rule does. " - "If the property is not set the default is ON. " - "Set the property to OFF to disable granular messages and report only " - "as each target completes. " - "This is intended to allow scripted builds to avoid the build time " - "cost of detailed reports. " - "If a CMAKE_RULE_MESSAGES cache entry exists its value initializes " - "the value of this property. " - "Non-Makefile generators currently ignore this property."); - - cm->DefineProperty - ("USE_FOLDERS", cmProperty::GLOBAL, - "Use the FOLDER target property to organize targets into folders.", - "If not set, CMake treats this property as OFF by default. " - "CMake generators that are capable of organizing into a " - "hierarchy of folders use the values of the FOLDER target " - "property to name those folders. See also the documentation " - "for the FOLDER target property."); - - cm->DefineProperty - ("AUTOMOC_TARGETS_FOLDER", cmProperty::GLOBAL, - "Name of FOLDER for *_automoc targets that are added automatically by " - "CMake for targets for which AUTOMOC is enabled.", - "If not set, CMake uses the FOLDER property of the parent target as a " - "default value for this property. See also the documentation for the " - "FOLDER target property and the AUTOMOC target property."); - - cm->DefineProperty - ("PREDEFINED_TARGETS_FOLDER", cmProperty::GLOBAL, - "Name of FOLDER for targets that are added automatically by CMake.", - "If not set, CMake uses \"CMakePredefinedTargets\" as a default " - "value for this property. Targets such as INSTALL, PACKAGE and " - "RUN_TESTS will be organized into this FOLDER. See also the " - "documentation for the FOLDER target property."); - - // ================================================================ - // define variables as well - // ================================================================ - cmDocumentVariables::DefineVariables(cm); -} - - void cmake::DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - bool chained, const char *docSection) + bool chained) { this->PropertyDefinitions[scope].DefineProperty(name,scope,ShortDescription, FullDescription, - docSection, chained); } @@ -2646,112 +2394,6 @@ cmPropertyDefinition *cmake return 0; } -void cmake::RecordPropertyAccess(const char *name, - cmProperty::ScopeType scope) -{ - this->AccessedProperties.insert - (std::pair<cmStdString,cmProperty::ScopeType>(name,scope)); -} - -void cmake::ReportUndefinedPropertyAccesses(const char *filename) -{ - if(!this->GlobalGenerator) - { return; } - FILE *progFile = fopen(filename,"w"); - if(!progFile) - { return; } - - // what are the enabled languages? - std::vector<std::string> enLangs; - this->GlobalGenerator->GetEnabledLanguages(enLangs); - - // Common configuration names. - // TODO: Compute current configuration(s). - std::vector<std::string> enConfigs; - enConfigs.push_back(""); - enConfigs.push_back("DEBUG"); - enConfigs.push_back("RELEASE"); - enConfigs.push_back("MINSIZEREL"); - enConfigs.push_back("RELWITHDEBINFO"); - - // take all the defined properties and add definitions for all the enabled - // languages - std::set<std::pair<cmStdString,cmProperty::ScopeType> > aliasedProperties; - std::map<cmProperty::ScopeType, cmPropertyDefinitionMap>::iterator i; - i = this->PropertyDefinitions.begin(); - for (;i != this->PropertyDefinitions.end(); ++i) - { - cmPropertyDefinitionMap::iterator j; - for (j = i->second.begin(); j != i->second.end(); ++j) - { - // TODO: What if both <LANG> and <CONFIG> appear? - if (j->first.find("<CONFIG>") != std::string::npos) - { - std::vector<std::string>::const_iterator k; - for (k = enConfigs.begin(); k != enConfigs.end(); ++k) - { - std::string tmp = j->first; - cmSystemTools::ReplaceString(tmp, "<CONFIG>", k->c_str()); - // add alias - aliasedProperties.insert - (std::pair<cmStdString,cmProperty::ScopeType>(tmp,i->first)); - } - } - if (j->first.find("<LANG>") != std::string::npos) - { - std::vector<std::string>::const_iterator k; - for (k = enLangs.begin(); k != enLangs.end(); ++k) - { - std::string tmp = j->first; - cmSystemTools::ReplaceString(tmp, "<LANG>", k->c_str()); - // add alias - aliasedProperties.insert - (std::pair<cmStdString,cmProperty::ScopeType>(tmp,i->first)); - } - } - } - } - - std::set<std::pair<cmStdString,cmProperty::ScopeType> >::const_iterator ap; - ap = this->AccessedProperties.begin(); - for (;ap != this->AccessedProperties.end(); ++ap) - { - if (!this->IsPropertyDefined(ap->first.c_str(),ap->second) && - aliasedProperties.find(std::pair<cmStdString,cmProperty::ScopeType> - (ap->first,ap->second)) == - aliasedProperties.end()) - { - const char *scopeStr = ""; - switch (ap->second) - { - case cmProperty::TARGET: - scopeStr = "TARGET"; - break; - case cmProperty::SOURCE_FILE: - scopeStr = "SOURCE_FILE"; - break; - case cmProperty::DIRECTORY: - scopeStr = "DIRECTORY"; - break; - case cmProperty::TEST: - scopeStr = "TEST"; - break; - case cmProperty::VARIABLE: - scopeStr = "VARIABLE"; - break; - case cmProperty::CACHED_VARIABLE: - scopeStr = "CACHED_VARIABLE"; - break; - default: - scopeStr = "unknown"; - break; - } - fprintf(progFile, "%s with scope %s\n", ap->first.c_str(), scopeStr); - } - } - fclose(progFile); -} - bool cmake::IsPropertyDefined(const char *name, cmProperty::ScopeType scope) { return this->PropertyDefinitions[scope].IsPropertyDefined(name); @@ -3164,7 +2806,7 @@ void cmake::IssueMessage(cmake::MessageType t, std::string const& text, // Add the message text. { msg << ":\n"; - cmDocumentationFormatterText formatter; + cmDocumentationFormatter formatter; formatter.SetIndent(" "); formatter.PrintFormatted(msg, text.c_str()); } diff --git a/Source/cmake.h b/Source/cmake.h index d33ba34..73e5109 100644 --- a/Source/cmake.h +++ b/Source/cmake.h @@ -269,20 +269,7 @@ class cmake ///! Get the variable watch object cmVariableWatch* GetVariableWatch() { return this->VariableWatch; } - /** Get the documentation entries for the supported commands. - * If withCurrentCommands is true, the documentation for the - * recommended set of commands is included. - * If withCompatCommands is true, the documentation for discouraged - * (compatibility) commands is included. - * You probably don't want to set both to false. - */ - void GetCommandDocumentation(std::vector<cmDocumentationEntry>& entries, - bool withCurrentCommands = true, - bool withCompatCommands = true) const; - void GetPropertiesDocumentation(std::map<std::string, - cmDocumentationSection *>&); void GetGeneratorDocumentation(std::vector<cmDocumentationEntry>&); - void GetPolicyDocumentation(std::vector<cmDocumentationEntry>& entries); ///! Set/Get a property of this target file void SetProperty(const char *prop, const char *value); @@ -343,8 +330,7 @@ class cmake void DefineProperty(const char *name, cmProperty::ScopeType scope, const char *ShortDescription, const char *FullDescription, - bool chain = false, - const char *variableGroup = 0); + bool chain = false); // get property definition cmPropertyDefinition *GetPropertyDefinition @@ -358,13 +344,6 @@ class cmake debugging configurations.*/ std::vector<std::string> const& GetDebugConfigs(); - // record accesses of properties and variables - void RecordPropertyAccess(const char *name, cmProperty::ScopeType scope); - void ReportUndefinedPropertyAccesses(const char *filename); - - // Define the properties - static void DefineProperties(cmake *cm); - void SetCMakeEditCommand(const char* s) { this->CMakeEditCommand = s; @@ -484,52 +463,12 @@ private: }; #define CMAKE_STANDARD_OPTIONS_TABLE \ - {"-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.\n" \ - "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:\n" \ - " Visual Studio >= 10\n" \ - " Xcode >= 3.0\n" \ - "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."} - - -#define CMAKE_STANDARD_INTRODUCTION \ - {0, \ - "CMake is a cross-platform build system generator. Projects " \ - "specify their build process with platform-independent CMake listfiles " \ - "included 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.", 0} + {"-C <initial-cache>", "Pre-load a script to populate the cache."}, \ + {"-D <var>:<type>=<value>", "Create a cmake cache entry."}, \ + {"-U <globbing_expr>", "Remove matching entries from CMake cache."}, \ + {"-G <generator-name>", "Specify a build system generator."},\ + {"-T <toolset-name>", "Specify toolset name if supported by generator."}, \ + {"-Wno-dev", "Suppress developer warnings."},\ + {"-Wdev", "Enable developer warnings."} + #endif diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx index 73c76e4..6e2125f 100644 --- a/Source/cmakemain.cxx +++ b/Source/cmakemain.cxx @@ -28,33 +28,20 @@ #ifdef CMAKE_BUILD_WITH_CMAKE //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " cmake - Cross-Platform Makefile Generator.", 0}, - {0,0,0} + " cmake - Cross-Platform Makefile Generator."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, " cmake [options] <path-to-source>\n" - " cmake [options] <path-to-existing-build>", 0}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = -{ - {0, - "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 option " - "will cause cmake to interactively prompt for such settings.", 0}, - CMAKE_STANDARD_INTRODUCTION, - {0,0,0} + " cmake [options] <path-to-existing-build>"}, + {0,0} }; #define CMAKE_BUILD_OPTIONS \ @@ -70,198 +57,52 @@ static const char * cmDocumentationDescription[][3] = " -- = Pass remaining options to the native tool.\n" //---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = +static const char * cmDocumentationOptions[][2] = { CMAKE_STANDARD_OPTIONS_TABLE, - {"-E", "CMake command mode.", - "For true platform independence, CMake provides a list of commands " - "that can be used on all systems. Run with -E help for the usage " - "information. Commands available are: chdir, compare_files, copy, " - "copy_directory, copy_if_different, echo, echo_append, environment, " - "make_directory, md5sum, remove, remove_directory, rename, tar, time, " - "touch, touch_nocreate. In addition, some platform specific commands " - "are available. " - "On Windows: comspec, delete_regv, write_regv. " - "On UNIX: create_symlink."}, - {"-i", "Run in wizard mode.", - "Wizard mode runs cmake interactively without a GUI. The user is " - "prompted to answer questions about the project configuration. " - "The answers are used to set cmake cache values."}, - {"-L[A][H]", "List non-advanced cached variables.", - "List cache variables will run CMake and list all the variables from the " - "CMake cache that are not marked as INTERNAL or ADVANCED. This will " - "effectively display current CMake settings, which can then be changed " - "with -D option. Changing some of the variables may result in more " - "variables being created. If A is specified, then it will display also " - "advanced variables. If H is specified, it will also display help for " - "each variable."}, - {"--build <dir>", "Build a CMake-generated project binary tree.", - "This abstracts a native build tool's command-line interface with the " - "following options:\n" - CMAKE_BUILD_OPTIONS - "Run cmake --build with no options for quick help."}, - {"-N", "View mode only.", - "Only load the cache. Do not actually run configure and generate steps."}, - {"-P <file>", "Process script mode.", - "Process the given cmake file as a script written in the CMake language. " - "No configure or generate step is performed and the cache is not" - " modified. If variables are defined using -D, this must be done " - "before the -P argument."}, - {"--find-package", "Run in pkg-config like mode.", - "Search a package using find_package() and print the resulting flags " - "to stdout. This can be used to use cmake instead of pkg-config to find " - "installed libraries in plain Makefile-based projects or in " - "autoconf-based projects (via share/aclocal/cmake.m4)."}, + {"-E", "CMake command mode."}, + {"-i", "Run in wizard mode."}, + {"-L[A][H]", "List non-advanced cached variables."}, + {"--build <dir>", "Build a CMake-generated project binary tree."}, + {"-N", "View mode only."}, + {"-P <file>", "Process script mode."}, + {"--find-package", "Run in pkg-config like mode."}, {"--graphviz=[file]", "Generate graphviz of dependencies, see " - "CMakeGraphVizOptions.cmake for more.", - "Generate a graphviz input file that will contain all the library and " - "executable dependencies in the project. See the documentation for " - "CMakeGraphVizOptions.cmake for more details. "}, - {"--system-information [file]", "Dump information about this system.", - "Dump a wide range of information about the current system. If run " - "from the top of a binary tree for a CMake project it will dump " - "additional information such as the cache, log files etc."}, + "CMakeGraphVizOptions.cmake for more."}, + {"--system-information [file]", "Dump information about this system."}, {"--debug-trycompile", "Do not delete the try_compile build tree. Only " - "useful on one try_compile at a time.", - "Do not delete the files and directories created for try_compile calls. " - "This is useful in debugging failed try_compiles. It may however " - "change the results of the try-compiles as old junk from a previous " - "try-compile may cause a different test to either pass or fail " - "incorrectly. This option is best used for one try-compile at a time, " - "and only when debugging." }, - {"--debug-output", "Put cmake in a debug mode.", - "Print extra stuff during the cmake run like stack traces with " - "message(send_error ) calls."}, - {"--trace", "Put cmake in trace mode.", - "Print a trace of all calls made and from where with " - "message(send_error ) calls."}, - {"--warn-uninitialized", "Warn about uninitialized values.", - "Print a warning when an uninitialized variable is used."}, - {"--warn-unused-vars", "Warn about unused variables.", - "Find variables that are declared or set, but not used."}, - {"--no-warn-unused-cli", "Don't warn about command line options.", - "Don't find variables that are declared on the command line, but not " - "used."}, + "useful on one try_compile at a time."}, + {"--debug-output", "Put cmake in a debug mode."}, + {"--trace", "Put cmake in trace mode."}, + {"--warn-uninitialized", "Warn about uninitialized values."}, + {"--warn-unused-vars", "Warn about unused variables."}, + {"--no-warn-unused-cli", "Don't warn about command line options."}, {"--check-system-vars", "Find problems with variable usage in system " - "files.", "Normally, unused and uninitialized variables are searched for " - "only in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to " - "warn about other files as well."}, - {"--help-command cmd [file]", "Print help for a single command and exit.", - "Full documentation specific to the given command is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-command-list [file]", "List available listfile commands and exit.", - "The list contains all commands for which help may be obtained by using " - "the --help-command argument followed by a command name. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-commands [file]", "Print help for all commands and exit.", - "Full documentation specific for all current commands is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-compatcommands [file]", "Print help for compatibility commands. ", - "Full documentation specific for all compatibility commands is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-module module [file]", "Print help for a single module and exit.", - "Full documentation specific to the given module is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-module-list [file]", "List available modules and exit.", - "The list contains all modules for which help may be obtained by using " - "the --help-module argument followed by a module name. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-modules [file]", "Print help for all modules and exit.", - "Full documentation for all modules is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, + "files."}, + {"--help-command cmd [file]", "Print help for a single command and exit."}, + {"--help-command-list [file]", "List available listfile commands and exit."}, + {"--help-commands [file]", "Print help for all commands and exit."}, + {"--help-compatcommands [file]", "Print help for compatibility commands. "}, + {"--help-module module [file]", "Print help for a single module and exit."}, + {"--help-module-list [file]", "List available modules and exit."}, + {"--help-modules [file]", "Print help for all modules and exit."}, {"--help-custom-modules [file]" , "Print help for all custom modules and " - "exit.", - "Full documentation for all custom modules is displayed. " - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, + "exit."}, {"--help-policy cmp [file]", - "Print help for a single policy and exit.", - "Full documentation specific to the given policy is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-policies [file]", "Print help for all policies and exit.", - "Full documentation for all policies is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, + "Print help for a single policy and exit."}, + {"--help-policy-list [file]", "List available policies and exit."}, + {"--help-policies [file]", "Print help for all policies and exit."}, {"--help-property prop [file]", - "Print help for a single property and exit.", - "Full documentation specific to the given property is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-property-list [file]", "List available properties and exit.", - "The list contains all properties for which help may be obtained by using " - "the --help-property argument followed by a property name. If a file is " - "specified, the help is written into it." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-properties [file]", "Print help for all properties and exit.", - "Full documentation for all properties is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, + "Print help for a single property and exit."}, + {"--help-property-list [file]", "List available properties and exit."}, + {"--help-properties [file]", "Print help for all properties and exit."}, {"--help-variable var [file]", - "Print help for a single variable and exit.", - "Full documentation specific to the given variable is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variable-list [file]", "List documented variables and exit.", - "The list contains all variables for which help may be obtained by using " - "the --help-variable argument followed by a variable name. If a file is " - "specified, the help is written into it." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {"--help-variables [file]", "Print help for all variables and exit.", - "Full documentation for all variables is displayed." - "If a file is specified, the documentation is written into and the output " - "format is determined depending on the filename suffix. Supported are man " - "page, HTML, DocBook and plain text."}, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "ccmake", 0}, - {0, "cpack", 0}, - {0, "ctest", 0}, - {0, "cmakecommands", 0}, - {0, "cmakecompat", 0}, - {0, "cmakemodules", 0}, - {0, "cmakeprops", 0}, - {0, "cmakevars", 0}, - {0, 0, 0} + "Print help for a single variable and exit."}, + {"--help-variable-list [file]", "List documented variables and exit."}, + {"--help-variables [file]", "Print help for all variables and exit."}, + {0,0} }; -//---------------------------------------------------------------------------- -static const char * cmDocumentationNOTE[][3] = -{ - {0, - "CMake no longer configures a project when run with no arguments. " - "In order to configure the project in the current directory, run\n" - " cmake .", 0}, - {0,0,0} -}; #endif int do_cmake(int ac, char** av); @@ -375,57 +216,18 @@ int do_cmake(int ac, char** av) args.push_back(av[i]); } hcm.SetCacheArgs(args); - const char* modulePath = hcm.GetCacheDefinition("CMAKE_MODULE_PATH"); - if (modulePath) - { - doc.SetCMakeModulePath(modulePath); - } - std::vector<cmDocumentationEntry> commands; - std::vector<cmDocumentationEntry> policies; - std::vector<cmDocumentationEntry> compatCommands; std::vector<cmDocumentationEntry> generators; - std::map<std::string,cmDocumentationSection *> propDocs; - hcm.GetPolicyDocumentation(policies); - hcm.GetCommandDocumentation(commands, true, false); - hcm.GetCommandDocumentation(compatCommands, false, true); - hcm.GetPropertiesDocumentation(propDocs); hcm.GetGeneratorDocumentation(generators); doc.SetName("cmake"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.AppendSection("Generators",generators); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Commands",commands); - doc.SetSection("Policies",policies); - doc.AppendSection("Compatibility Commands",compatCommands); - doc.SetSections(propDocs); - - cmDocumentationEntry e; - e.Brief = - "variables defined by cmake, that give information about the project, " - "and cmake"; - doc.PrependSection("Variables that Provide Information",e); - - doc.SetSeeAlsoList(cmDocumentationSeeAlso); - int result = doc.PrintRequestedDocumentation(std::cout)? 0:1; - - // If we were run with no arguments, but a CMakeLists.txt file - // exists, the user may have been trying to use the old behavior - // of cmake to build a project in-source. Print a message - // explaining the change to standard error and return an error - // condition in case the program is running from a script. - if((ac == 1) && cmSystemTools::FileExists("CMakeLists.txt")) - { - doc.ClearSections(); - doc.SetSection("NOTE", cmDocumentationNOTE); - doc.Print(cmDocumentation::UsageForm, 0, std::cerr); - return 1; - } - return result; + + return doc.PrintRequestedDocumentation(std::cout)? 0:1; } #else if ( ac == 1 ) diff --git a/Source/ctest.cxx b/Source/ctest.cxx index ece68f5..6e3a86b 100644 --- a/Source/ctest.cxx +++ b/Source/ctest.cxx @@ -20,253 +20,98 @@ #include "CTest/cmCTestLaunch.h" //---------------------------------------------------------------------------- -static const char * cmDocumentationName[][3] = +static const char * cmDocumentationName[][2] = { {0, - " ctest - Testing driver provided by CMake.", 0}, - {0,0,0} + " ctest - Testing driver provided by CMake."}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationUsage[][3] = +static const char * cmDocumentationUsage[][2] = { {0, - " ctest [options]", 0}, - {0,0,0} + " ctest [options]"}, + {0,0} }; //---------------------------------------------------------------------------- -static const char * cmDocumentationDescription[][3] = -{ - {0, - "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 program will run the tests and report results.", 0}, - {0,0,0} -}; - //---------------------------------------------------------------------------- -static const char * cmDocumentationOptions[][3] = +static const char * cmDocumentationOptions[][2] = { - {"-C <cfg>, --build-config <cfg>", "Choose configuration to test.", - "Some CMake-generated build trees can have multiple build configurations " - "in the same tree. This option can be used to specify which one should " - "be tested. Example configurations are \"Debug\" and \"Release\"."}, - {"-V,--verbose", "Enable verbose output from tests.", - "Test output is normally suppressed and only summary information is " - "displayed. This option will show all test output."}, - {"-VV,--extra-verbose", "Enable more verbose output from tests.", - "Test output is normally suppressed and only summary information is " - "displayed. This option will show even more test output."}, - {"--debug", "Displaying more verbose internals of CTest.", - "This feature will result in a large number of output that is mostly " - "useful for debugging dashboard problems."}, - {"--output-on-failure", "Output anything outputted by the test program " - "if the test should fail. This option can also be enabled by setting " - "the environment variable CTEST_OUTPUT_ON_FAILURE"}, - {"-F", "Enable failover.", "This option allows ctest to resume a test " - "set execution that was previously interrupted. If no interruption " - "occurred, the -F option will have no effect."}, + {"-C <cfg>, --build-config <cfg>", "Choose configuration to test."}, + {"-V,--verbose", "Enable verbose output from tests."}, + {"-VV,--extra-verbose", "Enable more verbose output from tests."}, + {"--debug", "Displaying more verbose internals of CTest."}, + {"--output-on-failure"}, + {"-F", "Enable failover."}, {"-j <jobs>, --parallel <jobs>", "Run the tests in parallel using the" - "given number of jobs.", - "This option tells ctest to run the tests in parallel using given " - "number of jobs. This option can also be set by setting " - "the environment variable CTEST_PARALLEL_LEVEL."}, - {"-Q,--quiet", "Make ctest quiet.", - "This option will suppress all the output. The output log file will " - "still be generated if the --output-log is specified. Options such " - "as --verbose, --extra-verbose, and --debug are ignored if --quiet is " - "specified."}, - {"-O <file>, --output-log <file>", "Output to log file", - "This option tells ctest to write all its output to a log file."}, - {"-N,--show-only", "Disable actual execution of tests.", - "This option tells ctest to list the tests that would be run but not " - "actually run them. Useful in conjunction with the -R and -E options."}, + "given number of jobs."}, + {"-Q,--quiet", "Make ctest quiet."}, + {"-O <file>, --output-log <file>", "Output to log file"}, + {"-N,--show-only", "Disable actual execution of tests."}, {"-L <regex>, --label-regex <regex>", "Run tests with labels matching " - "regular expression.", - "This option tells ctest to run only the tests whose labels match the " - "given regular expression."}, + "regular expression."}, {"-R <regex>, --tests-regex <regex>", "Run tests matching regular " - "expression.", - "This option tells ctest to run only the tests whose names match the " - "given regular expression."}, + "expression."}, {"-E <regex>, --exclude-regex <regex>", "Exclude tests matching regular " - "expression.", - "This option tells ctest to NOT run the tests whose names match the " - "given regular expression."}, + "expression."}, {"-LE <regex>, --label-exclude <regex>", "Exclude tests with labels " - "matching regular expression.", - "This option tells ctest to NOT run the tests whose labels match the " - "given regular expression."}, - {"-D <dashboard>, --dashboard <dashboard>", "Execute dashboard test", - "This option tells ctest to act as a Dart client and perform " - "a dashboard test. All tests are <Mode><Test>, where Mode can be " - "Experimental, Nightly, and Continuous, and Test can be Start, Update, " - "Configure, Build, Test, Coverage, and Submit."}, - {"-D <var>:<type>=<value>", "Define a variable for script mode", - "Pass in variable values on the command line. Use in " - "conjunction with -S to pass variable values to a dashboard script. " - "Parsing -D arguments as variable values is only attempted if " - "the value following -D does not match any of the known dashboard " - "types."}, - {"-M <model>, --test-model <model>", "Sets the model for a dashboard", - "This option tells ctest to act as a Dart client " - "where the TestModel can be Experimental, " - "Nightly, and Continuous. Combining -M and -T is similar to -D"}, + "matching regular expression."}, + {"-D <dashboard>, --dashboard <dashboard>", "Execute dashboard test"}, + {"-D <var>:<type>=<value>", "Define a variable for script mode"}, + {"-M <model>, --test-model <model>", "Sets the model for a dashboard"}, {"-T <action>, --test-action <action>", "Sets the dashboard action to " - "perform", - "This option tells ctest to act as a Dart client " - "and perform some action such as start, build, test etc. " - "Combining -M and -T is similar to -D"}, - {"--track <track>", "Specify the track to submit dashboard to", - "Submit dashboard to specified track instead of default one. By " - "default, the dashboard is submitted to Nightly, Experimental, or " - "Continuous track, but by specifying this option, the track can be " - "arbitrary."}, + "perform"}, + {"--track <track>", "Specify the track to submit dashboard to"}, {"-S <script>, --script <script>", "Execute a dashboard for a " - "configuration", - "This option tells ctest to load in a configuration script which sets " - "a number of parameters such as the binary and source directories. Then " - "ctest will do what is required to create and run a dashboard. This " - "option basically sets up a dashboard and then runs ctest -D with the " - "appropriate options."}, + "configuration"}, {"-SP <script>, --script-new-process <script>", "Execute a dashboard for a " - "configuration", - "This option does the same operations as -S but it will do them in a " - "separate process. This is primarily useful in cases where the script " - "may modify the environment and you do not want the modified environment " - "to impact other -S scripts."}, - {"-A <file>, --add-notes <file>", "Add a notes file with submission", - "This option tells ctest to include a notes file when submitting " - "dashboard. "}, + "configuration"}, + {"-A <file>, --add-notes <file>", "Add a notes file with submission"}, {"-I [Start,End,Stride,test#,test#|Test file], --tests-information", - "Run a specific number of tests by number.", - "This option causes ctest to run tests starting at number Start, ending " - "at number End, and incrementing by Stride. Any additional numbers after " - "Stride are considered individual test numbers. Start, End,or stride " - "can be empty. Optionally a file can be given that contains the same " - "syntax as the command line."}, - {"-U, --union", "Take the Union of -I and -R", - "When both -R and -I are specified by default the intersection of " - "tests are run. By specifying -U the union of tests is run instead."}, - {"--rerun-failed", "Run only the tests that failed previously", - "This option tells ctest to perform only the tests that failed during its " - "previous run. When this option is specified, ctest ignores all other " - "options intended to modify the list of tests to run " - "(-L, -R, -E, -LE, -I, etc). In the event that CTest runs and no tests " - "fail, subsequent calls to ctest with the --rerun-failed option will " - "run the set of tests that most recently failed (if any)."}, - {"--max-width <width>", "Set the max width for a test name to output", - "Set the maximum width for each test name to show in the output. This " - "allows the user to widen the output to avoid clipping the test name which " - "can be very annoying."}, - {"--interactive-debug-mode [0|1]", "Set the interactive mode to 0 or 1.", - "This option causes ctest to run tests in either an interactive mode or " - "a non-interactive mode. On Windows this means that in non-interactive " - "mode, all system debug pop up windows are blocked. In dashboard mode " - "(Experimental, Nightly, Continuous), the default is non-interactive. " - "When just running tests not for a dashboard the default is to allow " - "popups and interactive " - "debugging."}, - {"--no-label-summary", "Disable timing summary information for labels.", - "This option tells ctest not to print summary information for each label " - "associated with the tests run. If there are no labels on the " - "tests, nothing extra is printed."}, - {"--build-and-test", "Configure, build and run a test.", - "This option tells ctest to configure (i.e. run cmake on), build, and or " - "execute a test. The configure and test steps are optional. The arguments " - "to this command line are the source and binary directories. By default " - "this will run CMake on the Source/Bin directories specified unless " - "--build-nocmake is specified. Both --build-makeprogram and " - "--build-generator MUST be provided to use --build-and-test. If " - "--test-command is specified then that will be run after the build is " - "complete. Other options that affect this mode are --build-target " - "--build-nocmake, --build-run-dir, " - "--build-two-config, --build-exe-dir, --build-project," - "--build-noclean, --build-options"}, - {"--build-target", "Specify a specific target to build.", - "This option goes with the --build-and-test option, if left out the all " - "target is built." }, - {"--build-nocmake", "Run the build without running cmake first.", - "Skip the cmake step." }, - {"--build-run-dir", "Specify directory to run programs from.", - "Directory where programs will be after it has been compiled." }, - {"--build-two-config", "Run CMake twice", "" }, - {"--build-exe-dir", "Specify the directory for the executable.", "" }, - {"--build-generator", "Specify the generator to use.", "" }, - {"--build-generator-toolset", "Specify the generator-specific toolset.",""}, - {"--build-project", "Specify the name of the project to build.", "" }, - {"--build-makeprogram", "Specify the make program to use.", "" }, - {"--build-noclean", "Skip the make clean step.", "" }, + "Run a specific number of tests by number."}, + {"-U, --union", "Take the Union of -I and -R"}, + {"--rerun-failed", "Run only the tests that failed previously"}, + {"--max-width <width>", "Set the max width for a test name to output"}, + {"--interactive-debug-mode [0|1]", "Set the interactive mode to 0 or 1."}, + {"--no-label-summary", "Disable timing summary information for labels."}, + {"--build-and-test", "Configure, build and run a test."}, + {"--build-target", "Specify a specific target to build."}, + {"--build-nocmake", "Run the build without running cmake first."}, + {"--build-run-dir", "Specify directory to run programs from."}, + {"--build-two-config", "Run CMake twice"}, + {"--build-exe-dir", "Specify the directory for the executable."}, + {"--build-generator", "Specify the generator to use."}, + {"--build-generator-toolset", "Specify the generator-specific toolset."}, + {"--build-project", "Specify the name of the project to build."}, + {"--build-makeprogram", "Specify the make program to use."}, + {"--build-noclean", "Skip the make clean step."}, {"--build-config-sample", - "A sample executable to use to determine the configuration", - "A sample executable to use to determine the configuration that " - "should be used. e.g. Debug/Release/etc" }, - {"--build-options", "Add extra options to the build step.", - "This option must be the last option with the exception of --test-command" - }, + "A sample executable to use to determine the configuration"}, + {"--build-options", "Add extra options to the build step."}, - {"--test-command", "The test to run with the --build-and-test option.", "" - }, - {"--test-timeout", "The time limit in seconds, internal use only.", "" - }, - {"--tomorrow-tag", "Nightly or experimental starts with next day tag.", - "This is useful if the build will not finish in one day." }, + {"--test-command", "The test to run with the --build-and-test option."}, + {"--test-timeout", "The time limit in seconds, internal use only."}, + {"--tomorrow-tag", "Nightly or experimental starts with next day tag."}, {"--ctest-config", "The configuration file used to initialize CTest state " - "when submitting dashboards.", - "This option tells CTest to use different initialization file instead of " - "CTestConfiguration.tcl. This way multiple initialization files can be " - "used for example to submit to multiple dashboards." }, - {"--overwrite", "Overwrite CTest configuration option.", - "By default ctest uses configuration options from configuration file. " - "This option will overwrite the configuration option." }, - {"--extra-submit <file>[;<file>]", "Submit extra files to the dashboard.", - "This option will submit extra files to the dashboard." }, - {"--force-new-ctest-process", "Run child CTest instances as new processes", - "By default CTest will run child CTest instances within the same process. " - "If this behavior is not desired, this argument will enforce new " - "processes for child CTest processes." }, - {"--schedule-random", "Use a random order for scheduling tests", - "This option will run the tests in a random order. It is commonly used to " - "detect implicit dependencies in a test suite." }, - {"--submit-index", "Submit individual dashboard tests with specific index", - "This option allows performing the same CTest action (such as test) " - "multiple times and submit all stages to the same dashboard (Dart2 " - "required). Each execution requires different index." }, - {"--timeout <seconds>", "Set a global timeout on all tests.", - "This option will set a global timeout on all tests that do not already " - "have a timeout set on them."}, - {"--stop-time <time>", "Set a time at which all tests should stop running.", - "Set a real time of day at which all tests should timeout. Example: " - "7:00:00 -0400. Any time format understood by the curl date parser is " - "accepted. Local time is assumed if no timezone is specified."}, - {"--http1.0", "Submit using HTTP 1.0.", - "This option will force CTest to use HTTP 1.0 to submit files to the " - "dashboard, instead of HTTP 1.1."}, - {"--no-compress-output", "Do not compress test output when submitting.", - "This flag will turn off automatic compression of test output. Use this " - "to maintain compatibility with an older version of CDash which doesn't " - "support compressed test output."}, - {"--print-labels", "Print all available test labels.", - "This option will not run any tests, it will simply print the list of " - "all labels associated with the test set."}, - {"--help-command <cmd> [<file>]", "Show help for a single command and exit.", - "Prints the help for the command to stdout or to the specified file." }, - {"--help-command-list [<file>]", "List available commands and exit.", - "Prints the list of all available listfile commands to stdout or the " - "specified file." }, - {"--help-commands [<file>]", "Print help for all commands and exit.", - "Prints the help for all commands to stdout or to the specified file." }, - {0,0,0} -}; - -//---------------------------------------------------------------------------- -static const char * cmDocumentationSeeAlso[][3] = -{ - {0, "cmake", 0}, - {0, "ccmake", 0}, - {0, 0, 0} + "when submitting dashboards."}, + {"--overwrite", "Overwrite CTest configuration option."}, + {"--extra-submit <file>[;<file>]", "Submit extra files to the dashboard."}, + {"--force-new-ctest-process", "Run child CTest instances as new processes"}, + {"--schedule-random", "Use a random order for scheduling tests"}, + {"--submit-index", "Submit individual dashboard tests with specific index"}, + {"--timeout <seconds>", "Set a global timeout on all tests."}, + {"--stop-time <time>", + "Set a time at which all tests should stop running."}, + {"--http1.0", "Submit using HTTP 1.0."}, + {"--no-compress-output", "Do not compress test output when submitting."}, + {"--print-labels", "Print all available test labels."}, + {"--help-command <cmd> [<file>]", + "Show help for a single command and exit."}, + {"--help-command-list [<file>]", "List available commands and exit."}, + {"--help-commands [<file>]", "Print help for all commands and exit."}, + {0,0} }; // this is a test driver program for cmCTest. @@ -309,20 +154,15 @@ int main (int argc, char *argv[]) if(doc.CheckOptions(argc, argv)) { // Construct and print requested documentation. - std::vector<cmDocumentationEntry> commands; cmCTestScriptHandler* ch = static_cast<cmCTestScriptHandler*>(inst.GetHandler("script")); ch->CreateCMake(); - ch->GetCommandDocumentation(commands); doc.SetShowGenerators(false); doc.SetName("ctest"); doc.SetSection("Name",cmDocumentationName); doc.SetSection("Usage",cmDocumentationUsage); - doc.SetSection("Description",cmDocumentationDescription); doc.PrependSection("Options",cmDocumentationOptions); - doc.SetSection("Commands",commands); - doc.SetSeeAlsoList(cmDocumentationSeeAlso); #ifdef cout # undef cout #endif |