CMake/Help/variable/CMAKE_LIST_FILE_NAME.rst
Brad King 5fdd917f8a Help: Update Sphinx versionadded directives for 4.0 release
Run the script:

    Utilities/Sphinx/update_versions.py --since v3.31.0 --overwrite

Manually renumber `3.32` to `4.0` since the script is meant for
minor version increments.  Also filter out changes to documents
that were added for long-existing variables.
2025-02-05 09:17:06 -05:00

24 lines
860 B
ReStructuredText

CMAKE_LIST_FILE_NAME
--------------------
.. versionadded:: 4.0
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``.