mirror of
https://github.com/Kitware/CMake.git
synced 2026-04-23 22:58:37 -05:00
Merge topic 'rename-cmakelists'
fcbc883fa3 cmake: Allow configuration of default script names
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Acked-by: scivision <michael@scivision.dev>
Merge-request: !10059
This commit is contained in:
@@ -119,6 +119,25 @@
|
||||
Specify the installation directory, used by the
|
||||
:variable:`CMAKE_INSTALL_PREFIX` variable. Must be an absolute path.
|
||||
|
||||
.. option:: --project-file <project-file-name>
|
||||
|
||||
.. versionadded:: 3.32
|
||||
|
||||
Specify an alternate project file name.
|
||||
|
||||
This determines the top-level file processed by CMake when configuring a
|
||||
project, and the file processed by :command:`add_subdirectory`.
|
||||
|
||||
By default, this is ``CMakeLists.txt``. If set to anything else,
|
||||
``CMakeLists.txt`` will be used as a fallback whenever the specified file
|
||||
cannot be found within a project subdirectory.
|
||||
|
||||
.. note::
|
||||
|
||||
This feature is intended for temporary use by developers during an incremental
|
||||
transition and not for publication of a final product. CMake will always emit
|
||||
a warning when the project file is anything other than ``CMakeLists.txt``.
|
||||
|
||||
.. option:: -Wno-dev
|
||||
|
||||
Suppress developer warnings.
|
||||
|
||||
@@ -82,6 +82,7 @@ Variables that Provide Information
|
||||
/variable/CMAKE_LINK_LIBRARY_SUFFIX
|
||||
/variable/CMAKE_LINK_SEARCH_END_STATIC
|
||||
/variable/CMAKE_LINK_SEARCH_START_STATIC
|
||||
/variable/CMAKE_LIST_FILE_NAME
|
||||
/variable/CMAKE_MAJOR_VERSION
|
||||
/variable/CMAKE_MAKE_PROGRAM
|
||||
/variable/CMAKE_MATCH_COUNT
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
Option to specify alternate CMakeLists filename
|
||||
-----------------------------------------------
|
||||
|
||||
* Adds :option:`cmake --project-file` option to specify an alternate filename
|
||||
for CMakeLists files. This determines the top-level file processed when CMake
|
||||
is configured, and the file processed by :command:`add_subdirectory`. By
|
||||
default, this is ``CMakeLists.txt``. If set to anything else,
|
||||
``CMakeLists.txt`` will be used as a fallback if the given file cannot be
|
||||
found within a project subdirectory. The use of alternate project file names
|
||||
is intended for temporary use by developers during an incremental transition
|
||||
and not for publication of a final product. CMake will always emit a warning
|
||||
when the project file is anything other than ``CMakeLists.txt``.
|
||||
@@ -0,0 +1,23 @@
|
||||
CMAKE_LIST_FILE_NAME
|
||||
--------------------
|
||||
|
||||
.. versionadded:: 3.32
|
||||
|
||||
The name of the CMake project files. This determines the top-level file
|
||||
processed when CMake is configured, and the file processed by
|
||||
:command:`add_subdirectory`.
|
||||
|
||||
By default, this is ``CMakeLists.txt``. If set to anything else,
|
||||
``CMakeLists.txt`` will be used as a fallback whenever the specified file
|
||||
cannot be found within a project subdirectory.
|
||||
|
||||
This variable reports the value set via the :option:`cmake --project-file`
|
||||
option. The value of this variable should never be set directly by projects or
|
||||
users.
|
||||
|
||||
.. warning::
|
||||
|
||||
The use of alternate project file names is intended for temporary use by
|
||||
developers during an incremental transition and not for publication of a final
|
||||
product. CMake will always emit a warning when the project file is anything
|
||||
other than ``CMakeLists.txt``.
|
||||
Reference in New Issue
Block a user