mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

FindBISON: Update documentation

Browse Source 
- Updated and synced module documentation with other similar find
  modules.
- Documented bison_target() command indented relative to the title.
- Command arguments described as a list separately.
- Used "command" instead of "macro".
- Used lowercase style across the docs.
- Extended examples section.
This commit is contained in:
Peter Kokot
2025-04-29 06:18:15 +02:00
parent d85041c830
commit e0c4e8ecf4
6 changed files with 163 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Help/policy/CMP0088.rst
View File

@@ -6,8 +6,8 @@ CMP0088
:module:`FindBISON` runs bison in :variable:`CMAKE_CURRENT_BINARY_DIR`
when executing.
The module provides a ``BISON_TARGET`` macro which generates BISON output.
In CMake 3.13 and below the macro would generate a custom command that runs
The module provides a ``bison_target()`` command which generates BISON output.
In CMake 3.13 and below the command would generate a custom build rule that runs
``bison`` in the source directory. CMake 3.14 and later prefer to run it
in the build directory and use :variable:`CMAKE_CURRENT_BINARY_DIR` as the
``WORKING_DIRECTORY`` of its :command:`add_custom_command` invocation.
@@ -17,7 +17,7 @@ tree rather than the source.
This policy provides compatibility for projects that have not been updated
to expect the new behavior.
The ``OLD`` behavior for this policy is for ``BISON_TARGET`` to use
The ``OLD`` behavior for this policy is for ``bison_target()`` to use
the current source directory for the ``WORKING_DIRECTORY`` and where
to generate implicit files. The ``NEW`` behavior of this policy is to
use the current binary directory for the ``WORKING_DIRECTORY`` and where

2
Help/release/3.14.rst
View File

@@ -193,7 +193,7 @@ Modules
each one to the main build using the canonical pattern. This
significantly reduces the amount of boilerplate needed in a project.
* The :module:`FindBISON` module's ``BISON_TARGET`` command now runs ``bison``
* The :module:`FindBISON` module's ``bison_target()`` command now runs ``bison``
with :variable:`CMAKE_CURRENT_BINARY_DIR` as the working directory.
See policy :policy:`CMP0088`.

2
Help/release/3.4.rst
View File

@@ -117,7 +117,7 @@ Modules
useful with the :generator:`Ninja` generator to monitor CMake
superbuild progress and prevent CPU oversubscription.
* The :module:`FindBISON` module ``BISON_TARGET`` macro learned a
* The :module:`FindBISON` module ``bison_target()`` command learned a
new ``DEFINES_FILE`` option to specify a custom output header
to be generated.

2
Help/release/3.6.rst
View File

@@ -283,7 +283,7 @@ Other Changes
files in different directories use ``#include <moc_foo.cpp>`` with the
same name (because the generated ``moc_foo.cpp`` files would collide).
* The :module:`FindBISON` module ``BISON_TARGET`` macro now supports
* The :module:`FindBISON` module ``bison_target()`` command now supports
special characters by passing the ``VERBATIM`` option to internal
:command:`add_custom_command` calls. This may break clients that
added escaping manually to work around the bug.

2
Help/release/3.7.rst
View File

@@ -168,7 +168,7 @@ Modules
* The :module:`ExternalProject` module gained a ``HTTP_HEADER``
option to add http download headers.
* The :module:`FindBISON` module ``BISON_TARGET`` macro learned a new
* The :module:`FindBISON` module ``bison_target()`` command learned a new
``REPORT_FILE`` option to specify the bison ``--report-file=`` option.
* The :module:`FindBZip2` module now provides imported targets.