diff options
author | Craig Scott <craig.scott@crascit.com> | 2021-09-05 08:12:14 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2021-09-23 11:56:33 (GMT) |
commit | 84e02be51c5c725c033e54276e6e41be8bd1b96d (patch) | |
tree | 554d3dc1db656babba182c28d6aa0475e606a535 /CompileFlags.cmake | |
parent | 96c38493849f05724ec5c2b2e0152c5c86c3b5b0 (diff) | |
download | CMake-84e02be51c5c725c033e54276e6e41be8bd1b96d.zip CMake-84e02be51c5c725c033e54276e6e41be8bd1b96d.tar.gz CMake-84e02be51c5c725c033e54276e6e41be8bd1b96d.tar.bz2 |
Help: Restructure the find_package() docs
The explanation of the basic and full signatures was interwoven tightly
with that of the Module and Config search modes. Config mode is
supported by both signatures, which made the structure of the
command documentation a bit confusing.
Add a section at the start which unambiguously describes the two
modes, including the fallback functionality between them. Move the
text about this out of the basic signature section, leaving just a
description of the basic syntax with a note that it is supported by both
search modes. This makes the basic signature section more focused.
Drop the Module and Config mode parts of the titles for the basic and
full signature sections. Those are now more precisely covered by the
new opening section, so the Basic Signature and Full Signature sections
are now clearer in what they cover.
Swap the order of the Search Procedure and Version Selection sections
to improve the logical flow. Also add "Config Mode" to their titles to
make it clearer what they apply to. Add a note at the start of both
sections to highlight their relationship to the basic and full signatures.
Diffstat (limited to 'CompileFlags.cmake')
0 files changed, 0 insertions, 0 deletions