summaryrefslogtreecommitdiffstats
path: root/Source/cmMakefile.cxx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-16 18:38:23 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:36 (GMT)
commit399e9c46d88c12507f1a762e69225c5ab9f4ac08 (patch)
treeb220aa74b78aaccdb819e7a4d76a78dea3654b1f /Source/cmMakefile.cxx
parent6035c0458e511bae94959ff4e01800dd14384fc2 (diff)
downloadCMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.zip
CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.gz
CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.bz2
Drop builtin property documentation
Drop all DefineProperty calls for non-chained properties. Drop the documentation from the chained ones. The documentation for all properties is now in Help/prop_*/*.rst files.
Diffstat (limited to 'Source/cmMakefile.cxx')
-rw-r--r--Source/cmMakefile.cxx237
1 files changed, 3 insertions, 234 deletions
diff --git a/Source/cmMakefile.cxx b/Source/cmMakefile.cxx
index 063d560..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
@@ -4024,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);
}
//----------------------------------------------------------------------------