Merge topic 'AddDocumentationForEclipseVariables'

7b3a1069 Help: Document Eclipse-generator related variables (#15827)
This commit is contained in:
Brad King 2016-04-18 08:57:32 -04:00 committed by CMake Topic Stage
commit de3c7bd799
5 changed files with 44 additions and 0 deletions

View File

@ -116,6 +116,10 @@ Variables that Change Behavior
/variable/CMAKE_DEBUG_TARGET_PROPERTIES
/variable/CMAKE_DEPENDS_IN_PROJECT_ONLY
/variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName
/variable/CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES
/variable/CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT
/variable/CMAKE_ECLIPSE_MAKE_ARGUMENTS
/variable/CMAKE_ECLIPSE_VERSION
/variable/CMAKE_ERROR_DEPRECATED
/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
/variable/CMAKE_EXPORT_COMPILE_COMMANDS

View File

@ -0,0 +1,10 @@
CMAKE_ECLIPSE_GENERATE_LINKED_RESOURCES
---------------------------------------
This cache variable is used by the Eclipse project generator. See
:manual:`cmake-generators(7)`.
The Eclipse project generator generates so-called linked resources
e.g. to the subproject root dirs in the source tree or to the source files
of targets.
This can be disabled by setting this variable to FALSE.

View File

@ -0,0 +1,11 @@
CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT
-------------------------------------
This cache variable is used by the Eclipse project generator. See
:manual:`cmake-generators(7)`.
If this variable is set to TRUE, the Eclipse project generator will generate
an Eclipse project in :variable:`CMAKE_SOURCE_DIR` . This project can then
be used in Eclipse e.g. for the version control functionality.
:variable:`CMAKE_ECLIPSE_GENERATE_SOURCE_PROJECT` defaults to FALSE; so
nothing is written into the source directory.

View File

@ -0,0 +1,9 @@
CMAKE_ECLIPSE_MAKE_ARGUMENTS
----------------------------
This cache variable is used by the Eclipse project generator. See
:manual:`cmake-generators(7)`.
This variable holds arguments which are used when Eclipse invokes the make
tool. By default it is initialized to hold flags to enable parallel builds
(using -j typically).

View File

@ -0,0 +1,10 @@
CMAKE_ECLIPSE_VERSION
---------------------
This cache variable is used by the Eclipse project generator. See
:manual:`cmake-generators(7)`.
When using the Eclipse project generator, CMake tries to find the Eclipse
executable and detect the version of it. Depending on the version it finds,
some features are enabled or disabled. If CMake doesn't find
Eclipse, it assumes the oldest supported version, Eclipse Callisto (3.2).