Help: Reposition internal modules

This adds a new section in the modules index to move some internal
modules out of the main two lists - utility modules and find modules.

They are not intended to be used by projects.

Additionally, SquishTestScript is not technically deprecated module. It
is just internally used by FindSquish module and mistakenly documented
and rendered.

Issue: #26851
This commit is contained in:
Peter Kokot
2025-08-02 19:13:05 +02:00
parent 6239a7be37
commit 54486682a7
3 changed files with 19 additions and 9 deletions

View File

@@ -30,8 +30,8 @@ These modules are loaded using the :command:`include` command.
/module/CheckFortranSourceCompiles
/module/CheckFortranSourceRuns
/module/CheckFunctionExists
/module/CheckIncludeFileCXX
/module/CheckIncludeFile
/module/CheckIncludeFileCXX
/module/CheckIncludeFiles
/module/CheckIPOSupported
/module/CheckLanguage
@@ -55,7 +55,6 @@ These modules are loaded using the :command:`include` command.
/module/CMakeBackwardCompatibilityCXX
/module/CMakeDependentOption
/module/CMakeFindDependencyMacro
/module/CMakeFindPackageMode
/module/CMakeGraphVizOptions
/module/CMakePackageConfigHelpers
/module/CMakePrintHelpers
@@ -69,7 +68,6 @@ These modules are loaded using the :command:`include` command.
/module/CSharpUtilities
/module/CTest
/module/CTestCoverageCollectGCOV
/module/CTestScriptMode
/module/CTestUseLaunchers
/module/DeployQt4
/module/ExternalData
@@ -186,7 +184,6 @@ They are normally called through the :command:`find_package` command.
/module/FindOpenSSL
/module/FindOpenThreads
/module/Findosg
/module/Findosg_functions
/module/FindosgAnimation
/module/FindosgDB
/module/FindosgFX
@@ -232,8 +229,8 @@ They are normally called through the :command:`find_package` command.
/module/FindSDL_sound
/module/FindSDL_ttf
/module/FindSelfPackers
/module/FindSquish
/module/FindSQLite3
/module/FindSquish
/module/FindSubversion
/module/FindSWIG
/module/FindTCL
@@ -271,7 +268,6 @@ Deprecated Utility Modules
/module/Documentation
/module/GetPrerequisites
/module/MacroAddFileDependencies
/module/SquishTestScript
/module/TestBigEndian
/module/TestCXXAcceptsFlag
/module/Use_wxWindows
@@ -322,3 +318,16 @@ used directly.
/module/CPackProductBuild
/module/CPackRPM
/module/CPackWIX
Miscellaneous Modules
---------------------
These internal modules are not intended to be included directly in projects:
.. toctree::
:maxdepth: 1
/module/CMakeFindPackageMode
/module/CTestScriptMode
/module/Findosg_functions
/module/SquishTestScript

View File

@@ -5,9 +5,11 @@
CTestScriptMode
---------------
.. note::
This file is read by ctest in script mode (-S)
This module is not intended to be included or invoked directly by project
code. It is internally used by CTest running in script mode (-S) to
determine current system. For usage details refer to the :option:`ctest -S`.
#]=======================================================================]
# Determine the current system, so this information can be used

View File

@@ -4,7 +4,6 @@
#[=======================================================================[.rst:
SquishTestScript
----------------
.. deprecated:: 3.0
.. note::