summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2022-01-14 17:49:21 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2022-01-19 16:21:35 (GMT)
commit0c2d234bc9be8fbdad5b14d3d5e66026a5d6e2fc (patch)
tree0973142d9cf229a49d9d624f1cf03cb673f956f3 /Help/manual
parenta0e78cc30c9c3ab71ef6030cc30e4be51468ffb4 (diff)
downloadCMake-0c2d234bc9be8fbdad5b14d3d5e66026a5d6e2fc.zip
CMake-0c2d234bc9be8fbdad5b14d3d5e66026a5d6e2fc.tar.gz
CMake-0c2d234bc9be8fbdad5b14d3d5e66026a5d6e2fc.tar.bz2
CMakePresets: Allow files included from CMakePresets.json to be anywhere
There are some valid use cases for allowing these files to be outside the project directory. Relax the restriction, and include a strong warning in the documentation.
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-presets.7.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index 474e1aa..e702d97 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -37,10 +37,9 @@ a file may be included multiple times from the same file or from different
files. If ``CMakePresets.json`` and ``CMakeUserPresets.json`` are both present,
``CMakeUserPresets.json`` implicitly includes ``CMakePresets.json``, even with
no ``include`` field, in all versions of the format. Files directly or
-indirectly included from ``CMakePresets.json`` must be inside the project
-directory. This restriction does not apply to ``CMakeUserPresets.json`` and
-files that it includes, unless those files are also included by
-``CMakePresets.json``.
+indirectly included from ``CMakePresets.json`` should be guaranteed to be
+provided by the project. ``CMakeUserPresets.json`` may include files from
+anywhere.
Format
======