← Back to branch summary

~ubuntu-branches/ubuntu/utopic/cmake/utopic

« back to all changes in this revision

Viewing changes to Source/cmDocumentVariables.cxx

  • Committer: Package Import Robot
  • Author(s): Harald Sitter
  • Date: 2013-10-10 12:54:39 UTC
  • mfrom: (1.14.7)
  • Revision ID: package-import@ubuntu.com-20131010125439-h0ahaj004on6oj92
Tags: 2.8.12-0ubuntu1
https://launchpad.net/bugs/1246701
New upstream release LP: #1246701

Show diffs side-by-side

added added

removed removed

Lines of Context:
Source/cmDocumentVariables.cxx
10
10
  cm->DefineProperty
11
11
    ("CMAKE_AR", cmProperty::VARIABLE,
12
12
     "Name of archiving tool for static libraries.",
13
 
     "This specifies name of the program that creates archive "
 
13
     "This specifies the name of the program that creates archive "
14
14
     "or static libraries.",false,
15
15
     "Variables that Provide Information");
16
16
 
19
19
     "The full path to the cmake executable.",
20
20
     "This is the full path to the CMake executable cmake which is "
21
21
     "useful from custom commands that want to use the cmake -E "
22
 
     "option for portable system commands. "
 
22
     "option for portable system commands.  "
23
23
     "(e.g. /usr/local/bin/cmake", false,
24
24
     "Variables that Provide Information");
25
25
  cm->DefineProperty
27
27
     "The path to the top level of the build tree.",
28
28
     "This is the full path to the top level of the current CMake "
29
29
     "build tree. For an in-source build, this would be the same "
30
 
     "as CMAKE_SOURCE_DIR. ", false,
 
30
     "as CMAKE_SOURCE_DIR.", false,
31
31
     "Variables that Provide Information");
32
32
  cm->DefineProperty
33
33
    ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
34
34
     "The path to the top level of the source tree.",
35
35
     "This is the full path to the top level of the current CMake "
36
36
     "source tree. For an in-source build, this would be the same "
37
 
     "as CMAKE_BINARY_DIR. ", false,
 
37
     "as CMAKE_BINARY_DIR.", false,
38
38
     "Variables that Provide Information");
39
39
  cm->DefineProperty
40
40
    ("CMAKE_CURRENT_BINARY_DIR", cmProperty::VARIABLE,
42
42
     "This the full path to the build directory that is currently "
43
43
     "being processed by cmake.  Each directory added by "
44
44
     "add_subdirectory will create a binary directory in the build "
45
 
     "tree, and as it is being processed this variable will be set. "
 
45
     "tree, and as it is being processed this variable will be set.  "
46
46
     "For in-source builds this is the current source directory "
47
47
     "being processed.", false,
48
48
     "Variables that Provide Information");
100
100
 
101
101
  cm->DefineProperty
102
102
    ("CMAKE_SCRIPT_MODE_FILE", cmProperty::VARIABLE,
103
 
     "Full path to the -P script file currently being processed. ",
 
103
     "Full path to the -P script file currently being processed.",
104
104
     "When run in -P script mode, CMake sets this variable to the full "
105
105
     "path of the script file. When run to configure a CMakeLists.txt "
106
106
     "file, this variable is not set.", false,
108
108
 
109
109
  cm->DefineProperty
110
110
    ("CMAKE_ARGC", cmProperty::VARIABLE,
111
 
     "Number of command line arguments passed to CMake in script mode. ",
 
111
     "Number of command line arguments passed to CMake in script mode.",
112
112
     "When run in -P script mode, CMake sets this variable to the number "
113
 
     "of command line arguments. See also CMAKE_ARGV0, 1, 2 ... ", false,
 
113
     "of command line arguments. See also CMAKE_ARGV0, 1, 2 ...", false,
114
114
     "Variables that Provide Information");
115
115
 
116
116
  cm->DefineProperty
117
117
    ("CMAKE_ARGV0", cmProperty::VARIABLE,
118
 
     "Command line argument passed to CMake in script mode. ",
 
118
     "Command line argument passed to CMake in script mode.",
119
119
     "When run in -P script mode, CMake sets this variable to "
120
120
     "the first command line argument. It then also sets CMAKE_ARGV1, "
121
121
     "CMAKE_ARGV2, ... and so on, up to the number of command line arguments "
129
129
     " needed to build the output of CMake.   If the "
130
130
     "generator selected was Visual Studio 6, the "
131
131
     "CMAKE_BUILD_TOOL will be set to msdev, for "
132
 
     "Unix makefiles it will be set to make or gmake, "
 
132
     "Unix Makefiles it will be set to make or gmake, "
133
133
     "and for Visual Studio 7 it set to devenv.  For "
134
 
     "Nmake Makefiles the value is nmake. This can be "
 
134
     "NMake Makefiles the value is nmake. This can be "
135
135
     "useful for adding special flags and commands based"
136
 
     " on the final build environment. ", false,
 
136
     " on the final build environment.", false,
137
137
     "Variables that Provide Information");
138
138
  cm->DefineProperty
139
139
    ("CMAKE_CROSSCOMPILING", cmProperty::VARIABLE,
152
152
  cm->DefineProperty
153
153
    ("CMAKE_CACHE_MAJOR_VERSION", cmProperty::VARIABLE,
154
154
     "Major version of CMake used to create the CMakeCache.txt file",
155
 
     "This is stores the major version of CMake used to "
 
155
     "This stores the major version of CMake used to "
156
156
     "write a CMake cache file. It is only different when "
157
157
     "a different version of CMake is run on a previously "
158
158
     "created cache file.", false,
160
160
  cm->DefineProperty
161
161
    ("CMAKE_CACHE_MINOR_VERSION", cmProperty::VARIABLE,
162
162
     "Minor version of CMake used to create the CMakeCache.txt file",
163
 
     "This is stores the minor version of CMake used to "
 
163
     "This stores the minor version of CMake used to "
164
164
     "write a CMake cache file. It is only different when "
165
165
     "a different version of CMake is run on a previously "
166
166
     "created cache file.", false,
169
169
  cm->DefineProperty
170
170
    ("CMAKE_CACHE_PATCH_VERSION", cmProperty::VARIABLE,
171
171
     "Patch version of CMake used to create the CMakeCache.txt file",
172
 
     "This is stores the patch version of CMake used to "
 
172
     "This stores the patch version of CMake used to "
173
173
     "write a CMake cache file. It is only different when "
174
174
     "a different version of CMake is run on a previously "
175
175
     "created cache file.", false,
270
270
  cm->DefineProperty
271
271
    ("CMAKE_LINK_LIBRARY_SUFFIX", cmProperty::VARIABLE,
272
272
     "The suffix for libraries that you link to.",
273
 
     "The suffix to use for the end of a library, .lib on Windows.",false,
 
273
     "The suffix to use for the end of a library filename, .lib on Windows."
 
274
     ,false,
274
275
     "Variables that Provide Information");
275
276
  cm->DefineProperty
276
277
    ("CMAKE_EXECUTABLE_SUFFIX", cmProperty::VARIABLE,
277
278
     "The suffix for executables on this platform.",
278
 
     "The suffix to use for the end of an executable if any, "
 
279
     "The suffix to use for the end of an executable filename if any, "
279
280
     ".exe on Windows."
280
281
     "\n"
281
282
     "CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>."
344
345
 
345
346
  cm->DefineProperty
346
347
    ("CMAKE_PARENT_LIST_FILE", cmProperty::VARIABLE,
347
 
     "Full path to the parent listfile of the one currently being processed.",
348
 
     "As CMake processes the listfiles in your project this "
349
 
     "variable will always be set to the listfile that included "
350
 
     "or somehow invoked the one currently being "
351
 
     "processed. See also CMAKE_CURRENT_LIST_FILE.",false,
 
348
     "Full path to the CMake file that included the current one.",
 
349
     "While processing a CMake file loaded by include() or find_package() "
 
350
     "this variable contains the full path to the file including it.  "
 
351
     "The top of the include stack is always the CMakeLists.txt for the "
 
352
     "current directory.  "
 
353
     "See also CMAKE_CURRENT_LIST_FILE.",false,
352
354
     "Variables that Provide Information");
353
355
 
354
356
  cm->DefineProperty
391
393
  cm->DefineProperty
392
394
    ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
393
395
     "Source directory for project.",
394
 
     "This is the top level source directory for the project. "
 
396
     "This is the top level source directory for the project.  "
395
397
     "It corresponds to the source directory given to "
396
398
     "cmake-gui or ccmake.",false,
397
399
     "Variables that Provide Information");
417
419
    ("PROJECT_NAME", cmProperty::VARIABLE,
418
420
     "Name of the project given to the project command.",
419
421
     "This is the name given to the most "
420
 
     "recent PROJECT command. ",false,
 
422
     "recent PROJECT command.",false,
421
423
     "Variables that Provide Information");
422
424
  cm->DefineProperty
423
425
    ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE,
452
454
     ,false, "Variables that Provide Information");
453
455
  cm->DefineProperty
454
456
    ("CMAKE_IMPORT_LIBRARY_SUFFIX", cmProperty::VARIABLE,
455
 
     "The suffix for import  libraries that you link to.",
456
 
     "The suffix to use for the end of an import library if used "
 
457
     "The suffix for import libraries that you link to.",
 
458
     "The suffix to use for the end of an import library filename if used "
457
459
     "on this platform."
458
460
     "\n"
459
461
     "CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
468
470
  cm->DefineProperty
469
471
    ("CMAKE_SHARED_LIBRARY_SUFFIX", cmProperty::VARIABLE,
470
472
     "The suffix for shared libraries that you link to.",
471
 
     "The suffix to use for the end of a shared library, .dll on Windows."
 
473
     "The suffix to use for the end of a shared library filename, "
 
474
     ".dll on Windows."
472
475
     "\n"
473
476
     "CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
474
477
     ,false, "Variables that Provide Information");
482
485
  cm->DefineProperty
483
486
    ("CMAKE_SHARED_MODULE_SUFFIX", cmProperty::VARIABLE,
484
487
     "The suffix for shared libraries that you link to.",
485
 
     "The suffix to use for the end of a loadable module on this platform"
 
488
     "The suffix to use for the end of a loadable module filename "
 
489
     "on this platform"
486
490
     "\n"
487
491
     "CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>."
488
492
     ,false, "Variables that Provide Information");
496
500
  cm->DefineProperty
497
501
    ("CMAKE_STATIC_LIBRARY_SUFFIX", cmProperty::VARIABLE,
498
502
     "The suffix for static libraries that you link to.",
499
 
     "The suffix to use for the end of a static library, .lib on Windows."
 
503
     "The suffix to use for the end of a static library filename, "
 
504
     ".lib on Windows."
500
505
     "\n"
501
506
     "CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>."
502
507
     ,false, "Variables that Provide Information");
509
514
     "analysis of libraries linked by a target.",
510
515
     false,
511
516
     "Variables that Provide Information");
 
517
  cm->DefineProperty
 
518
    ("CMAKE_MINIMUM_REQUIRED_VERSION", cmProperty::VARIABLE,
 
519
     "Version specified to cmake_minimum_required command",
 
520
     "Variable containing the VERSION component specified in the "
 
521
     "cmake_minimum_required command.",
 
522
     false,
 
523
     "Variables that Provide Information");
512
524
 
513
525
 
514
526
  // Variables defined by cmake, that change the behavior
538
550
     "By default, automoc behaves exactly as described in the documentation "
539
551
     "of the AUTOMOC target property.  "
540
552
     "When set to TRUE, it accepts more input and tries to find the correct "
541
 
     "input file for moc even if it differs from the documented behaviour. "
 
553
     "input file for moc even if it differs from the documented behaviour.  "
542
554
     "In this mode it e.g. also checks whether a header file is intended to "
543
555
     "be processed by moc when a \"foo.moc\" file has been included.\n"
544
556
     "Relaxed mode has to be enabled for KDE4 compatibility.",
551
563
     "If an install() command is used without the COMPONENT argument, "
552
564
     "these files will be grouped into a default component. The name of this "
553
565
     "default install component will be taken from this variable.  "
554
 
     "It defaults to \"Unspecified\". ",
 
566
     "It defaults to \"Unspecified\".",
555
567
     false,
556
568
     "Variables That Change Behavior");
557
569
 
577
589
 
578
590
    cm->DefineProperty
579
591
    ("CMAKE_CONFIGURATION_TYPES",  cmProperty::VARIABLE,
580
 
     "Specifies the available build types.",
581
 
     "This specifies what build types will be available such as "
582
 
     "Debug, Release, RelWithDebInfo etc. This has reasonable defaults "
583
 
     "on most platforms. But can be extended to provide other "
584
 
     "build types. See also CMAKE_BUILD_TYPE.",
585
 
     false,
 
592
     "Specifies the available build types on multi-config generators.",
 
593
     "This specifies what build types (configurations) will be available "
 
594
     "such as Debug, Release, RelWithDebInfo etc.  "
 
595
     "This has reasonable defaults on most platforms, "
 
596
     "but can be extended to provide other build types.  "
 
597
     "See also CMAKE_BUILD_TYPE for details of managing configuration data, "
 
598
     "and CMAKE_CFG_INTDIR."
 
599
     ,false,
586
600
     "Variables That Change Behavior");
587
601
 
588
602
    cm->DefineProperty
589
603
    ("CMAKE_BUILD_TYPE",  cmProperty::VARIABLE,
590
 
     "Specifies the build type for make based generators.",
591
 
     "This specifies what build type will be built in this tree. "
592
 
     " Possible values are empty, Debug, Release, RelWithDebInfo"
593
 
     " and MinSizeRel. This variable is only supported for "
594
 
     "make based generators. If this variable is supported, "
595
 
     "then CMake will also provide initial values for the "
596
 
     "variables with the name "
597
 
     " CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]."
598
 
     " For example, if CMAKE_BUILD_TYPE is Debug, then "
599
 
     "CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.",false,
 
604
     "Specifies the build type on single-configuration generators.",
 
605
     "This statically specifies what build type (configuration) "
 
606
     "will be built in this build tree. Possible values are "
 
607
     "empty, Debug, Release, RelWithDebInfo and MinSizeRel.  "
 
608
     "This variable is only meaningful to single-configuration generators "
 
609
     "(such as make and Ninja) i.e. "
 
610
     "those which choose a single configuration "
 
611
     "when CMake runs to generate a build tree as opposed to "
 
612
     "multi-configuration generators which offer selection of the build "
 
613
     "configuration within the generated build environment.  "
 
614
     "There are many per-config properties and variables "
 
615
     "(usually following clean SOME_VAR_<CONFIG> order conventions), "
 
616
     "such as CMAKE_C_FLAGS_<CONFIG>, specified as uppercase: "
 
617
     "CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL].  "
 
618
     "For example, in a build tree configured "
 
619
     "to build type Debug, CMake will see to having "
 
620
     "CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS settings.  "
 
621
     "See also CMAKE_CONFIGURATION_TYPES."
 
622
     ,false,
600
623
     "Variables That Change Behavior");
601
624
 
602
625
  cm->DefineProperty
616
639
    ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE,
617
640
     "Install directory used by install.",
618
641
     "If \"make install\" is invoked or INSTALL is built"
619
 
     ", this directory is pre-pended onto all install "
 
642
     ", this directory is prepended onto all install "
620
643
     "directories. This variable defaults to /usr/local"
621
644
     " on UNIX and c:/Program Files on Windows.\n"
622
645
     "On UNIX one can use the DESTDIR mechanism in order"
623
 
     " to relocate the whole installation. "
 
646
     " to relocate the whole installation.  "
624
647
     "DESTDIR means DESTination DIRectory. It is "
625
648
     "commonly used by makefile users "
626
 
     "in order to install software at non-default location. "
 
649
     "in order to install software at non-default location.  "
627
650
     "It is usually invoked like this:\n"
628
651
     " make DESTDIR=/home/john install\n"
629
652
     "which will install the concerned software using the"
630
 
     " installation prefix, e.g. \"/usr/local\" pre-pended with "
 
653
     " installation prefix, e.g. \"/usr/local\" prepended with "
631
654
     "the DESTDIR value which finally gives \"/home/john/usr/local\".\n"
632
655
     "WARNING: DESTDIR may not be used on Windows because installation"
633
656
     " prefix usually contains a drive letter like in \"C:/Program Files\""
634
 
     " which cannot be pre-pended with some other prefix."
 
657
     " which cannot be prepended with some other prefix."
 
658
     "\n"
 
659
     "The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH "
 
660
     "so that find_package, find_program, find_library, find_path, and "
 
661
     "find_file will search the prefix for other software."
635
662
     ,false,
636
663
     "Variables That Change Behavior");
637
664
 
638
665
  cm->DefineProperty
639
666
    ("CMAKE_SKIP_INSTALL_ALL_DEPENDENCY", cmProperty::VARIABLE,
640
667
     "Don't make the install target depend on the all target.",
641
 
     "By default, the \"install\" target depends on the \"all\" target. "
 
668
     "By default, the \"install\" target depends on the \"all\" target.  "
642
669
     "This has the effect, that when \"make install\" is invoked or INSTALL "
643
670
     "is built, first the \"all\" target is built, then the installation "
644
 
     "starts. "
 
671
     "starts.  "
645
672
     "If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency "
646
673
     "is not created, so the installation process will start immediately, "
647
674
     "independent from whether the project has been completely built or not."
658
685
     "Variables That Change Behavior");
659
686
 
660
687
  cm->DefineProperty
 
688
    ("CMAKE_WARN_DEPRECATED", cmProperty::VARIABLE,
 
689
     "Whether to issue deprecation warnings for macros and functions.",
 
690
     "If TRUE, this can be used by macros and functions to issue "
 
691
     "deprecation warnings.  This variable is FALSE by default.",
 
692
     false,
 
693
     "Variables That Change Behavior");
 
694
 
 
695
  cm->DefineProperty
 
696
    ("CMAKE_ERROR_DEPRECATED", cmProperty::VARIABLE,
 
697
     "Whether to issue deprecation errors for macros and functions.",
 
698
     "If TRUE, this can be used by macros and functions to issue "
 
699
     "fatal errors when deprecated macros or functions are used.  This "
 
700
     "variable is FALSE by default.",
 
701
     false,
 
702
     "Variables That Change Behavior");
 
703
 
 
704
  cm->DefineProperty
661
705
    ("CMAKE_PREFIX_PATH", cmProperty::VARIABLE,
662
706
     "Path used for searching by FIND_XXX(), with appropriate suffixes added.",
663
707
     "Specifies a path which will be used by the FIND_XXX() commands. It "
709
753
     "adds /bin to each of the directories in the path, FIND_LIBRARY() "
710
754
     "appends /lib to each of the directories, and FIND_PATH() and "
711
755
     "FIND_FILE() append /include . By default this contains the standard "
712
 
     "directories for the current system. It is NOT intended "
 
756
     "directories for the current system and the CMAKE_INSTALL_PREFIX.  "
 
757
     "It is NOT intended "
713
758
     "to be modified by the project, use CMAKE_PREFIX_PATH for this. See also "
714
759
     "CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
715
760
     "CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYSTEM_IGNORE_PATH.", false,
724
769
     "directories contain incompatible but possibly linkable libraries. For "
725
770
     "example, on cross-compiled cluster environments, this allows a user to "
726
771
     "ignore directories containing libraries meant for the front-end "
727
 
     "machine that modules like FindX11 (and others) would normally search. "
 
772
     "machine that modules like FindX11 (and others) would normally search.  "
728
773
     "By default this contains a list of directories containing incompatible "
729
 
     "binaries for the host system. "
 
774
     "binaries for the host system.  "
730
775
     "See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH, "
731
776
     "CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH.", false,
732
777
     "Variables That Change Behavior");
740
785
     "directories contain incompatible but possibly linkable libraries. For "
741
786
     "example, on cross-compiled cluster environments, this allows a user to "
742
787
     "ignore directories containing libraries meant for the front-end "
743
 
     "machine that modules like FindX11 (and others) would normally search. "
744
 
     "By default this is empty; it is intended to be set by the project. "
 
788
     "machine that modules like FindX11 (and others) would normally search.  "
 
789
     "By default this is empty; it is intended to be set by the project.  "
745
790
     "Note that CMAKE_IGNORE_PATH takes a list of directory names, NOT a "
746
791
     "list of prefixes. If you want to ignore paths under prefixes (bin, "
747
 
     "include, lib, etc.), you'll need to specify them explicitly. "
 
792
     "include, lib, etc.), you'll need to specify them explicitly.  "
748
793
     "See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, CMAKE_INCLUDE_PATH, "
749
794
     "CMAKE_PROGRAM_PATH.", false,
750
795
     "Variables That Change Behavior");
791
836
     "although that package is installed.\n"
792
837
     "This switch should be used during the initial CMake run. Otherwise if "
793
838
     "the package has already been found in a previous CMake run, the "
794
 
     "variables which have been stored in the cache will still be there. "
795
 
     "In the case it is recommended to remove the cache variables for "
 
839
     "variables which have been stored in the cache will still be there.  "
 
840
     "In that case it is recommended to remove the cache variables for "
796
841
     "this package from the cache using the cache editor or cmake -U", false,
797
842
     "Variables That Change Behavior");
798
843
 
878
923
  cm->DefineProperty
879
924
    ("CMAKE_COLOR_MAKEFILE", cmProperty::VARIABLE,
880
925
     "Enables color output when using the Makefile generator.",
881
 
     "When enabled, the generated Makefiles will produce colored output. "
 
926
     "When enabled, the generated Makefiles will produce colored output.  "
882
927
     "Default is ON.",false,
883
928
     "Variables That Change Behavior");
884
929
 
888
933
      " an ABSOLUTE DESTINATION path.",
889
934
      "This variable is defined by CMake-generated cmake_install.cmake "
890
935
      "scripts."
891
 
      " It can be used (read-only) by program or script that source those"
 
936
      " It can be used (read-only) by programs or scripts that source those"
892
937
      " install scripts. This is used by some CPack generators (e.g. RPM).",
893
938
      false,
894
939
      "Variables That Change Behavior");
898
943
      "Ask cmake_install.cmake script to warn each time a file with "
899
944
      "absolute INSTALL DESTINATION is encountered.",
900
945
      "This variable is used by CMake-generated cmake_install.cmake"
901
 
      " scripts. If ones set this variable to ON while running the"
 
946
      " scripts. If one sets this variable to ON while running the"
902
947
      " script, it may get warning messages from the script.", false,
903
948
      "Variables That Change Behavior");
904
949
 
909
954
      "The fatal error is emitted before the installation of "
910
955
      "the offending file takes place."
911
956
      " This variable is used by CMake-generated cmake_install.cmake"
912
 
      " scripts. If ones set this variable to ON while running the"
 
957
      " scripts. If one sets this variable to ON while running the"
913
958
      " script, it may get fatal error messages from the script.",false,
914
959
      "Variables That Change Behavior");
915
960
 
918
963
     "Enables tracing output for target properties.",
919
964
     "This variable can be populated with a list of properties to generate "
920
965
     "debug output for when evaluating target properties.  Currently it can "
921
 
     "only be used when evaluating the INCLUDE_DIRECTORIES target property.  "
922
 
     "In that case, it outputs a backtrace for each include directory in "
923
 
     "the build.  Default is unset.",false,"Variables That Change Behavior");
 
966
     "only be used when evaluating the INCLUDE_DIRECTORIES, "
 
967
     "COMPILE_DEFINITIONS and COMPILE_OPTIONS target properties.  "
 
968
     "In that case, it outputs a backtrace for each entry in the target "
 
969
     "property.  Default is unset.", false, "Variables That Change Behavior");
924
970
 
925
971
  // Variables defined by CMake that describe the system
926
972
 
929
975
     "Name of system cmake is compiling for.",
930
976
     "This variable is the composite of CMAKE_SYSTEM_NAME "
931
977
     "and CMAKE_SYSTEM_VERSION, like this "
932
 
     "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. "
 
978
     "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}.  "
933
979
     "If CMAKE_SYSTEM_VERSION is not set, then "
934
980
     "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.",false,
935
981
     "Variables That Describe the System");
940
986
     "which CMake is targeting.   On systems that "
941
987
     "have the uname command, this variable is set "
942
988
     "to the output of uname -s.  Linux, Windows, "
943
 
     " and Darwin for Mac OSX are the values found "
 
989
     " and Darwin for Mac OS X are the values found "
944
990
     " on the big three operating systems."  ,false,
945
991
     "Variables That Describe the System");
946
992
  cm->DefineProperty
999
1045
 
1000
1046
  cm->DefineProperty
1001
1047
    ("APPLE", cmProperty::VARIABLE,
1002
 
     "True if running on Mac OSX.",
1003
 
     "Set to true on Mac OSX.",false,
 
1048
     "True if running on Mac OS X.",
 
1049
     "Set to true on Mac OS X."
 
1050
     ,false,
1004
1051
     "Variables That Describe the System");
1005
1052
 
1006
1053
  cm->DefineProperty
1007
1054
    ("BORLAND", cmProperty::VARIABLE,
1008
 
     "True if the borland compiler is being used.",
 
1055
     "True if the Borland compiler is being used.",
1009
1056
     "This is set to true if the Borland compiler is being used.",false,
1010
1057
     "Variables That Describe the System");
1011
1058
 
1012
1059
  cm->DefineProperty
1013
1060
    ("CYGWIN", cmProperty::VARIABLE,
1014
 
     "True for cygwin.",
1015
 
     "Set to true when using CYGWIN.",false,
 
1061
     "True for Cygwin.",
 
1062
     "Set to true when using Cygwin."
 
1063
     ,false,
1016
1064
     "Variables That Describe the System");
1017
1065
 
1018
1066
  cm->DefineProperty
1111
1159
 
1112
1160
  cm->DefineProperty
1113
1161
    ("CMAKE_HOST_APPLE", cmProperty::VARIABLE,
1114
 
     "True for Apple OSXoperating systems.",
1115
 
     "Set to true when the host system is Apple OSX.",
 
1162
     "True for Apple OS X operating systems.",
 
1163
     "Set to true when the host system is Apple OS X.",
1116
1164
     false,
1117
1165
     "Variables That Describe the System");
1118
1166
 
1126
1174
  cm->DefineProperty
1127
1175
    ("CMAKE_HOST_WIN32", cmProperty::VARIABLE,
1128
1176
     "True on windows systems, including win64.",
1129
 
     "Set to true when the host system is Windows and on cygwin.",false,
 
1177
     "Set to true when the host system is Windows and on Cygwin."
 
1178
     ,false,
1130
1179
     "Variables That Describe the System");
1131
1180
 
1132
1181
  cm->DefineProperty
1147
1196
     "The value must be an integer no less than 128.",false,
1148
1197
     "Variables That Describe the System");
1149
1198
 
 
1199
  cm->DefineProperty
 
1200
    ("ENV", cmProperty::VARIABLE,
 
1201
     "Access environment variables.",
 
1202
     "Use the syntax $ENV{VAR} to read environment variable VAR.  "
 
1203
     "See also the set() command to set ENV{VAR}."
 
1204
     ,false,
 
1205
     "Variables That Describe the System");
 
1206
 
1150
1207
  // Variables that affect the building of object files and
1151
1208
  // targets.
1152
1209
  //
1180
1237
    ("CMAKE_INSTALL_RPATH", cmProperty::VARIABLE,
1181
1238
     "The rpath to use for installed targets.",
1182
1239
     "A semicolon-separated list specifying the rpath "
1183
 
     "to use in installed targets (for platforms that support it). "
 
1240
     "to use in installed targets (for platforms that support it).  "
1184
1241
     "This is used to initialize the target property "
1185
1242
     "INSTALL_RPATH for all targets.",
1186
1243
     false,
1191
1248
     "Add paths to linker search and installed rpath.",
1192
1249
     "CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true "
1193
1250
     "will append directories in the linker search path and outside the "
1194
 
     "project to the INSTALL_RPATH. "
 
1251
     "project to the INSTALL_RPATH.  "
1195
1252
     "This is used to initialize the target property "
1196
1253
     "INSTALL_RPATH_USE_LINK_PATH for all targets.",
1197
1254
     false,
1199
1256
 
1200
1257
  cm->DefineProperty
1201
1258
    ("CMAKE_INSTALL_NAME_DIR", cmProperty::VARIABLE,
1202
 
     "Mac OSX directory name for installed targets.",
 
1259
     "Mac OS X directory name for installed targets.",
1203
1260
     "CMAKE_INSTALL_NAME_DIR is used to initialize the "
1204
1261
     "INSTALL_NAME_DIR property on all targets. See that target "
1205
1262
     "property for more information.",
1210
1267
    ("CMAKE_Fortran_FORMAT", cmProperty::VARIABLE,
1211
1268
     "Set to FIXED or FREE to indicate the Fortran source layout.",
1212
1269
     "This variable is used to initialize the Fortran_FORMAT "
1213
 
     "property on all the targets. "
 
1270
     "property on all the targets.  "
1214
1271
     "See that target property for additional information.",
1215
1272
     false,
1216
1273
     "Variables that Control the Build");
1219
1276
    ("CMAKE_Fortran_MODULE_DIRECTORY", cmProperty::VARIABLE,
1220
1277
     "Fortran module output directory.",
1221
1278
     "This variable is used to initialize the "
1222
 
     "Fortran_MODULE_DIRECTORY property on all the targets. "
 
1279
     "Fortran_MODULE_DIRECTORY property on all the targets.  "
1223
1280
     "See that target property for additional information.",
1224
1281
     false,
1225
1282
     "Variables that Control the Build");
1228
1285
    ("CMAKE_LIBRARY_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
1229
1286
     "Where to put all the LIBRARY targets when built.",
1230
1287
     "This variable is used to initialize the "
1231
 
     "LIBRARY_OUTPUT_DIRECTORY property on all the targets. "
 
1288
     "LIBRARY_OUTPUT_DIRECTORY property on all the targets.  "
1232
1289
     "See that target property for additional information.",
1233
1290
     false,
1234
1291
     "Variables that Control the Build");
1237
1294
    ("CMAKE_ARCHIVE_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
1238
1295
     "Where to put all the ARCHIVE targets when built.",
1239
1296
     "This variable is used to initialize the "
1240
 
     "ARCHIVE_OUTPUT_DIRECTORY property on all the targets. "
 
1297
     "ARCHIVE_OUTPUT_DIRECTORY property on all the targets.  "
1241
1298
     "See that target property for additional information.",
1242
1299
     false,
1243
1300
     "Variables that Control the Build");
1246
1303
    ("CMAKE_RUNTIME_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
1247
1304
     "Where to put all the RUNTIME targets when built.",
1248
1305
     "This variable is used to initialize the "
1249
 
     "RUNTIME_OUTPUT_DIRECTORY property on all the targets. "
 
1306
     "RUNTIME_OUTPUT_DIRECTORY property on all the targets.  "
1250
1307
     "See that target property for additional information.",
1251
1308
     false,
1252
1309
     "Variables that Control the Build");
1253
1310
 
1254
1311
  cm->DefineProperty
1255
1312
    ("CMAKE_PDB_OUTPUT_DIRECTORY", cmProperty::VARIABLE,
1256
 
     "Where to put all the MS debug symbol files.",
 
1313
     "Where to put all the MS debug symbol files from linker.",
1257
1314
     "This variable is used to initialize the "
1258
 
     "PDB_OUTPUT_DIRECTORY property on all the targets. "
 
1315
     "PDB_OUTPUT_DIRECTORY property on all the targets.  "
1259
1316
     "See that target property for additional information.",
1260
1317
     false,
1261
1318
     "Variables that Control the Build");
1273
1330
    ("CMAKE_AUTOMOC", cmProperty::VARIABLE,
1274
1331
     "Whether to handle moc automatically for Qt targets.",
1275
1332
     "This variable is used to initialize the "
1276
 
     "AUTOMOC property on all the targets. "
 
1333
     "AUTOMOC property on all the targets.  "
1277
1334
     "See that target property for additional information.",
1278
1335
     false,
1279
1336
     "Variables that Control the Build");
1282
1339
    ("CMAKE_AUTOMOC_MOC_OPTIONS", cmProperty::VARIABLE,
1283
1340
     "Additional options for moc when using automoc (see CMAKE_AUTOMOC).",
1284
1341
     "This variable is used to initialize the "
1285
 
     "AUTOMOC_MOC_OPTIONS property on all the targets. "
 
1342
     "AUTOMOC_MOC_OPTIONS property on all the targets.  "
1286
1343
     "See that target property for additional information.",
1287
1344
     false,
1288
1345
     "Variables that Control the Build");
1359
1416
 
1360
1417
  cm->DefineProperty
1361
1418
    ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE,
1362
 
     "Linker flags used to create executables.",
1363
 
     "Flags used by the linker when creating an executable.",false,
 
1419
     "Linker flags to be used to create executables.",
 
1420
     "These flags will be used by the linker when creating an executable."
 
1421
     ,false,
1364
1422
     "Variables that Control the Build");
1365
1423
 
1366
1424
  cm->DefineProperty
1367
 
    ("CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]", cmProperty::VARIABLE,
1368
 
     "Flag used when linking an executable.",
 
1425
    ("CMAKE_EXE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE,
 
1426
     "Flags to be used when linking an executable.",
1369
1427
     "Same as CMAKE_C_FLAGS_* but used by the linker "
1370
1428
     "when creating executables.",false,
1371
1429
     "Variables that Control the Build");
 
1430
 
 
1431
  cm->DefineProperty
 
1432
    ("CMAKE_MODULE_LINKER_FLAGS", cmProperty::VARIABLE,
 
1433
     "Linker flags to be used to create modules.",
 
1434
     "These flags will be used by the linker when creating a module."
 
1435
     ,false,
 
1436
     "Variables that Control the Build");
 
1437
 
 
1438
  cm->DefineProperty
 
1439
    ("CMAKE_MODULE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE,
 
1440
     "Flags to be used when linking a module.",
 
1441
     "Same as CMAKE_C_FLAGS_* but used by the linker "
 
1442
     "when creating modules.",false,
 
1443
     "Variables that Control the Build");
 
1444
 
 
1445
  cm->DefineProperty
 
1446
    ("CMAKE_SHARED_LINKER_FLAGS", cmProperty::VARIABLE,
 
1447
     "Linker flags to be used to create shared libraries.",
 
1448
     "These flags will be used by the linker when creating a shared library."
 
1449
     ,false,
 
1450
     "Variables that Control the Build");
 
1451
 
 
1452
  cm->DefineProperty
 
1453
    ("CMAKE_SHARED_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE,
 
1454
     "Flags to be used when linking a shared library.",
 
1455
     "Same as CMAKE_C_FLAGS_* but used by the linker "
 
1456
     "when creating shared libraries.",false,
 
1457
     "Variables that Control the Build");
 
1458
 
 
1459
  cm->DefineProperty
 
1460
    ("CMAKE_STATIC_LINKER_FLAGS", cmProperty::VARIABLE,
 
1461
     "Linker flags to be used to create static libraries.",
 
1462
     "These flags will be used by the linker when creating a static library."
 
1463
     ,false,
 
1464
     "Variables that Control the Build");
 
1465
 
 
1466
  cm->DefineProperty
 
1467
    ("CMAKE_STATIC_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE,
 
1468
     "Flags to be used when linking a static library.",
 
1469
     "Same as CMAKE_C_FLAGS_* but used by the linker "
 
1470
     "when creating static libraries.",false,
 
1471
     "Variables that Control the Build");
 
1472
 
1372
1473
  cm->DefineProperty
1373
1474
    ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE,
1374
 
     "The flag used to add a library search path to a compiler.",
1375
 
     "The flag used to specify a library directory to the compiler. "
 
1475
     "The flag to be used to add a library search path to a compiler.",
 
1476
     "The flag will be used to specify a library directory to the compiler.  "
1376
1477
     "On most compilers this is \"-L\".",false,
1377
1478
     "Variables that Control the Build");
1378
1479
  cm->DefineProperty
1379
1480
    ("CMAKE_LINK_DEF_FILE_FLAG  ", cmProperty::VARIABLE,
1380
 
     "Linker flag used to specify a .def file for dll creation.",
1381
 
     "The flag used to add a .def file when creating "
1382
 
     "a dll on Windows, this is only defined on Windows.",false,
 
1481
     "Linker flag to be used to specify a .def file for dll creation.",
 
1482
     "The flag will be used to add a .def file when creating "
 
1483
     "a dll on Windows; this is only defined on Windows."
 
1484
     ,false,
1383
1485
     "Variables that Control the Build");
1384
1486
  cm->DefineProperty
1385
1487
    ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE,
1386
 
     "Flag used to link a library into an executable.",
1387
 
     "The flag used to specify a library to link to an executable.  "
 
1488
     "Flag to be used to link a library into an executable.",
 
1489
     "The flag will be used to specify a library to link to an executable.  "
1388
1490
     "On most compilers this is \"-l\".",false,
1389
1491
     "Variables that Control the Build");
1390
1492
  cm->DefineProperty
1391
1493
    ("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE,
1392
 
     "Flag used to link a library specified by a path to its file.",
1393
 
     "The flag used before a library file path is given to the linker.  "
 
1494
     "Flag to be used to link a library specified by a path to its file.",
 
1495
     "The flag will be used before a library file path is given to the "
 
1496
     "linker.  "
1394
1497
     "This is needed only on very few platforms.", false,
1395
1498
     "Variables that Control the Build");
1396
1499
  cm->DefineProperty
1397
1500
    ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE,
1398
1501
     "Use relative paths (May not work!).",
1399
 
     "If this is set to TRUE, then the CMake will use "
1400
 
     "relative paths between the source and binary tree. "
 
1502
     "If this is set to TRUE, then CMake will use "
 
1503
     "relative paths between the source and binary tree.  "
1401
1504
     "This option does not work for more complicated "
1402
1505
     "projects, and relative paths are used when possible.  "
1403
1506
     "In general, it is not possible to move CMake generated"
1431
1534
    ("CMAKE_LINK_INTERFACE_LIBRARIES", cmProperty::VARIABLE,
1432
1535
     "Default value for LINK_INTERFACE_LIBRARIES of targets.",
1433
1536
     "This variable is used to initialize the "
1434
 
     "LINK_INTERFACE_LIBRARIES property on all the targets. "
 
1537
     "LINK_INTERFACE_LIBRARIES property on all the targets.  "
1435
1538
     "See that target property for additional information.",
1436
1539
     false,
1437
1540
     "Variables that Control the Build");
1439
1542
    ("CMAKE_WIN32_EXECUTABLE", cmProperty::VARIABLE,
1440
1543
     "Default value for WIN32_EXECUTABLE of targets.",
1441
1544
     "This variable is used to initialize the "
1442
 
     "WIN32_EXECUTABLE property on all the targets. "
 
1545
     "WIN32_EXECUTABLE property on all the targets.  "
1443
1546
     "See that target property for additional information.",
1444
1547
     false,
1445
1548
     "Variables that Control the Build");
1447
1550
    ("CMAKE_MACOSX_BUNDLE", cmProperty::VARIABLE,
1448
1551
     "Default value for MACOSX_BUNDLE of targets.",
1449
1552
     "This variable is used to initialize the "
1450
 
     "MACOSX_BUNDLE property on all the targets. "
 
1553
     "MACOSX_BUNDLE property on all the targets.  "
1451
1554
     "See that target property for additional information.",
1452
1555
     false,
1453
1556
     "Variables that Control the Build");
1455
1558
    ("CMAKE_POSITION_INDEPENDENT_CODE", cmProperty::VARIABLE,
1456
1559
     "Default value for POSITION_INDEPENDENT_CODE of targets.",
1457
1560
     "This variable is used to initialize the "
1458
 
     "POSITION_INDEPENDENT_CODE property on all the targets. "
 
1561
     "POSITION_INDEPENDENT_CODE property on all the targets.  "
 
1562
     "See that target property for additional information.",
 
1563
     false,
 
1564
     "Variables that Control the Build");
 
1565
  cm->DefineProperty
 
1566
    ("CMAKE_<LANG>_VISIBILITY_PRESET", cmProperty::VARIABLE,
 
1567
     "Default value for <LANG>_VISIBILITY_PRESET of targets.",
 
1568
     "This variable is used to initialize the "
 
1569
     "<LANG>_VISIBILITY_PRESET property on all the targets.  "
 
1570
     "See that target property for additional information.",
 
1571
     false,
 
1572
     "Variables that Control the Build");
 
1573
  cm->DefineProperty
 
1574
    ("CMAKE_VISIBILITY_INLINES_HIDDEN", cmProperty::VARIABLE,
 
1575
     "Default value for VISIBILITY_INLINES_HIDDEN of targets.",
 
1576
     "This variable is used to initialize the "
 
1577
     "VISIBILITY_INLINES_HIDDEN property on all the targets.  "
1459
1578
     "See that target property for additional information.",
1460
1579
     false,
1461
1580
     "Variables that Control the Build");
1476
1595
  cm->DefineProperty
1477
1596
    ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE,
1478
1597
     "The full path to the compiler for LANG.",
1479
 
     "This is the command that will be used as the <LANG> compiler. "
 
1598
     "This is the command that will be used as the <LANG> compiler.  "
1480
1599
     "Once set, you can not change this variable.",false,
1481
1600
     "Variables for Languages");
1482
1601
 
1552
1671
    ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE,
1553
1672
     "True if the compiler is GNU.",
1554
1673
     "If the selected <LANG> compiler is the GNU "
1555
 
     "compiler then this is TRUE, if not it is FALSE. "
 
1674
     "compiler then this is TRUE, if not it is FALSE.  "
1556
1675
     "Unlike the other per-language variables, this uses the GNU syntax for "
1557
1676
     "identifying languages instead of the CMake syntax. Recognized values of "
1558
1677
     "the <LANG> suffix are:\n"
1563
1682
     "Variables for Languages");
1564
1683
 
1565
1684
  cm->DefineProperty
 
1685
     ("CMAKE_<LANG>_FLAGS", cmProperty::VARIABLE,
 
1686
      "Flags for all build types.",
 
1687
      "<LANG> flags used regardless of the value of CMAKE_BUILD_TYPE.",false,
 
1688
      "Variables for Languages");
 
1689
 
 
1690
  cm->DefineProperty
1566
1691
    ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE,
1567
1692
     "Flags for Debug build type or configuration.",
1568
1693
     "<LANG> flags used when CMAKE_BUILD_TYPE is Debug.",false,
1584
1709
  cm->DefineProperty
1585
1710
    ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE,
1586
1711
     "Flags for RelWithDebInfo type or configuration.",
1587
 
     "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. "
 
1712
     "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo.  "
1588
1713
     "Short for Release With Debug Information.",false,
1589
1714
     "Variables for Languages");
1590
1715
 
1592
1717
    ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE,
1593
1718
     "Rule variable to compile a single object file.",
1594
1719
     "This is a rule variable that tells CMake how to "
1595
 
     "compile a single object file for for the language <LANG>.",false,
 
1720
     "compile a single object file for the language <LANG>."
 
1721
     ,false,
1596
1722
     "Variables for Languages");
1597
1723
 
1598
1724
  cm->DefineProperty
1647
1773
    ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE,
1648
1774
     "File extensions that should be ignored by the build.",
1649
1775
     "This is a list of file extensions that may be "
1650
 
     "part of a project for a given language but are not compiled. ",false,
 
1776
     "part of a project for a given language but are not compiled.",false,
1651
1777
     "Variables for Languages");
1652
1778
 
1653
1779
  cm->DefineProperty
1728
1854
 
1729
1855
  cm->DefineProperty
1730
1856
    ("CMAKE_<LANG>_LINK_EXECUTABLE ", cmProperty::VARIABLE,
1731
 
     "Rule variable to link and executable.",
1732
 
     "Rule variable to link and executable for the given language.",false,
 
1857
     "Rule variable to link an executable.",
 
1858
     "Rule variable to link an executable for the given language."
 
1859
     ,false,
1733
1860
     "Variables for Languages");
1734
1861
 
1735
1862
  cm->DefineProperty
1743
1870
    ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE,
1744
1871
     "Extensions of source files for the given language.",
1745
1872
     "This is the list of extensions for a "
1746
 
     "given languages source files.",false,"Variables for Languages");
 
1873
     "given language's source files."
 
1874
     ,false,
 
1875
     "Variables for Languages");
1747
1876
 
1748
1877
  cm->DefineProperty(
1749
1878
    "CMAKE_<LANG>_COMPILER_LOADED", cmProperty::VARIABLE,
1799
1928
                     cmProperty::VARIABLE,0,0);
1800
1929
  cm->DefineProperty("CMAKE_<LANG>_CREATE_PREPROCESSED_SOURCE",
1801
1930
                     cmProperty::VARIABLE,0,0);
1802
 
  cm->DefineProperty("CMAKE_<LANG>_FLAGS",
1803
 
                     cmProperty::VARIABLE,0,0);
1804
1931
  cm->DefineProperty("CMAKE_<LANG>_FLAGS_DEBUG_INIT",
1805
1932
                     cmProperty::VARIABLE,0,0);
1806
1933
  cm->DefineProperty("CMAKE_<LANG>_FLAGS_INIT",