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/generator | |
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/generator')
-rw-r--r-- | Help/generator/CodeBlocks - Ninja.rst | 11 | ||||
-rw-r--r-- | Help/generator/CodeBlocks - Unix Makefiles.rst | 11 | ||||
-rw-r--r-- | Help/generator/Eclipse CDT4 - Ninja.rst | 11 | ||||
-rw-r--r-- | Help/generator/Eclipse CDT4 - Unix Makefiles.rst | 11 | ||||
-rw-r--r-- | Help/generator/KDevelop3 - Unix Makefiles.rst | 13 | ||||
-rw-r--r-- | Help/generator/KDevelop3.rst | 13 | ||||
-rw-r--r-- | Help/generator/Ninja.rst | 8 | ||||
-rw-r--r-- | Help/generator/Sublime Text 2 - Ninja.rst | 11 | ||||
-rw-r--r-- | Help/generator/Sublime Text 2 - Unix Makefiles.rst | 11 | ||||
-rw-r--r-- | Help/generator/Unix Makefiles.rst | 8 |
10 files changed, 108 insertions, 0 deletions
diff --git a/Help/generator/CodeBlocks - Ninja.rst b/Help/generator/CodeBlocks - Ninja.rst new file mode 100644 index 0000000..0253af6 --- /dev/null +++ b/Help/generator/CodeBlocks - Ninja.rst @@ -0,0 +1,11 @@ +CodeBlocks - Ninja +------------------ + +Generates CodeBlocks project files. + +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. diff --git a/Help/generator/CodeBlocks - Unix Makefiles.rst b/Help/generator/CodeBlocks - Unix Makefiles.rst new file mode 100644 index 0000000..0a29835 --- /dev/null +++ b/Help/generator/CodeBlocks - Unix Makefiles.rst @@ -0,0 +1,11 @@ +CodeBlocks - Unix Makefiles +--------------------------- + +Generates CodeBlocks project files. + +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. diff --git a/Help/generator/Eclipse CDT4 - Ninja.rst b/Help/generator/Eclipse CDT4 - Ninja.rst new file mode 100644 index 0000000..270011f --- /dev/null +++ b/Help/generator/Eclipse CDT4 - Ninja.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - Ninja +-------------------- + +Generates Eclipse CDT 4.0 project files. + +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/Help/generator/Eclipse CDT4 - Unix Makefiles.rst b/Help/generator/Eclipse CDT4 - Unix Makefiles.rst new file mode 100644 index 0000000..c3449a7 --- /dev/null +++ b/Help/generator/Eclipse CDT4 - Unix Makefiles.rst @@ -0,0 +1,11 @@ +Eclipse CDT4 - Unix Makefiles +----------------------------- + +Generates Eclipse CDT 4.0 project files. + +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/Help/generator/KDevelop3 - Unix Makefiles.rst b/Help/generator/KDevelop3 - Unix Makefiles.rst new file mode 100644 index 0000000..2a29a2e --- /dev/null +++ b/Help/generator/KDevelop3 - Unix Makefiles.rst @@ -0,0 +1,13 @@ +KDevelop3 - Unix Makefiles +-------------------------- + +Generates KDevelop 3 project files. + +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. diff --git a/Help/generator/KDevelop3.rst b/Help/generator/KDevelop3.rst new file mode 100644 index 0000000..788d557 --- /dev/null +++ b/Help/generator/KDevelop3.rst @@ -0,0 +1,13 @@ +KDevelop3 +--------- + +Generates KDevelop 3 project files. + +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. diff --git a/Help/generator/Ninja.rst b/Help/generator/Ninja.rst new file mode 100644 index 0000000..08f74fb --- /dev/null +++ b/Help/generator/Ninja.rst @@ -0,0 +1,8 @@ +Ninja +----- + +Generates build.ninja files (experimental). + +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. diff --git a/Help/generator/Sublime Text 2 - Ninja.rst b/Help/generator/Sublime Text 2 - Ninja.rst new file mode 100644 index 0000000..b7a2b88 --- /dev/null +++ b/Help/generator/Sublime Text 2 - Ninja.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - Ninja +---------------------- + +Generates Sublime Text 2 project files. + +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. diff --git a/Help/generator/Sublime Text 2 - Unix Makefiles.rst b/Help/generator/Sublime Text 2 - Unix Makefiles.rst new file mode 100644 index 0000000..67d329e --- /dev/null +++ b/Help/generator/Sublime Text 2 - Unix Makefiles.rst @@ -0,0 +1,11 @@ +Sublime Text 2 - Unix Makefiles +------------------------------- + +Generates Sublime Text 2 project files. + +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. diff --git a/Help/generator/Unix Makefiles.rst b/Help/generator/Unix Makefiles.rst new file mode 100644 index 0000000..97d74a8 --- /dev/null +++ b/Help/generator/Unix Makefiles.rst @@ -0,0 +1,8 @@ +Unix Makefiles +-------------- + +Generates standard UNIX makefiles. + +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. |