mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-27 03:08:35 -06: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:
23
Help/variable/CMAKE_LIST_FILE_NAME.rst
Normal file
23
Help/variable/CMAKE_LIST_FILE_NAME.rst
Normal file
@@ -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