diff options
author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 15:17:36 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-15 18:12:03 (GMT) |
commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/build_command.rst | |
parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
download | CMake-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/build_command.rst')
-rw-r--r-- | Help/command/build_command.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Help/command/build_command.rst b/Help/command/build_command.rst new file mode 100644 index 0000000..f4a56f0 --- /dev/null +++ b/Help/command/build_command.rst @@ -0,0 +1,37 @@ +build_command +------------- + +Get the command line to build this project. + +:: + + build_command(<variable> + [CONFIGURATION <config>] + [PROJECT_NAME <projname>] + [TARGET <target>]) + +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. + +If CONFIGURATION is omitted, CMake chooses a reasonable default value +for multi-configuration generators. CONFIGURATION is ignored for +single-configuration generators. + +If PROJECT_NAME is omitted, the resulting command line will build the +top level PROJECT in the current build tree. + +If TARGET is omitted, the resulting command line will build +everything, effectively using build target 'all' or 'ALL_BUILD'. + +:: + + build_command(<cachevariable> <makecommand>) + +This second signature is deprecated, but still available for backwards +compatibility. Use the first signature instead. + +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. |