summaryrefslogtreecommitdiffstats
path: root/Help/command/project.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/project.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/project.rst')
-rw-r--r--Help/command/project.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst
new file mode 100644
index 0000000..9b9f93f
--- /dev/null
+++ b/Help/command/project.rst
@@ -0,0 +1,27 @@
+project
+-------
+
+Set a name for the entire project.
+
+::
+
+ project(<projectname> [languageName1 languageName2 ... ] )
+
+Sets the name of the project. Additionally this sets the variables
+<projectName>_BINARY_DIR and <projectName>_SOURCE_DIR to the
+respective values.
+
+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.
+
+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).