Browse Source

Merge topic 'presets-graphviz-docs-and-release-note'

890bc3d2a2 presets: Fix graphviz support documentation

Acked-by: Kitware Robot <[email protected]>
Acked-by: Alex <[email protected]>
Merge-request: !9702
Craig Scott 1 year ago
parent
commit
a48097f7ae
2 changed files with 8 additions and 4 deletions
  1. 3 4
      Help/manual/cmake-presets.7.rst
  2. 5 0
      Help/release/dev/presets-graphviz.rst

+ 3 - 4
Help/manual/cmake-presets.7.rst

@@ -267,16 +267,15 @@ that may contain the following fields:
   :variable:`CMAKE_TOOLCHAIN_FILE` value. It is allowed in preset files
   specifying version ``3`` or above.
 
-  ``graphviz``
+``graphviz``
   An optional string representing the path to the graphviz input file,
   that will contain all the library and executable dependencies
   in the project. See the documentation for :module:`CMakeGraphVizOptions`
   for more details.
 
   This field supports `macro expansion`_. If a relative path is specified,
-  it is calculated relative to the build directory, and if not found,
-  relative to the source directory. It is allowed in preset files
-  specifying version ``10`` or above.
+  it is calculated relative to the current working directory. It is allowed
+  in preset files specifying version ``10`` or above.
 
 ``binaryDir``
   An optional string representing the path to the output binary directory.

+ 5 - 0
Help/release/dev/presets-graphviz.rst

@@ -0,0 +1,5 @@
+presets-graphviz
+----------------
+
+* Preset files may now request graphviz output using the ``graphviz`` key
+  in a configure preset.