dilim/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-07-01 20:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Help: Improve formatting for cmake_host_system_information

Browse Source 
Use the signature directive to improve formatting of links to each
sub-command, especially `QUERY WINDOWS_REGISTRY`.
This commit is contained in:
Tyler Yankee
2026-01-15 20:21:04 -05:00
parent 307c2240ad
commit d8c6bbe693
4 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Help/command/cmake_host_system_information.rst
View File

@@ -9,17 +9,18 @@ Synopsis
.. parsed-literal::
`Query host system specific information`_
cmake_host_system_information(RESULT <variable> QUERY <key> ...)
cmake_host_system_information(RESULT <variable> `QUERY`_ <key> ...)
`Query Windows registry`_
cmake_host_system_information(RESULT <variable> QUERY WINDOWS_REGISTRY <key> ...)
`Query the Windows registry`_
cmake_host_system_information(RESULT <variable> `QUERY WINDOWS_REGISTRY`_ <key> ...)
Query host system specific information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: cmake
.. signature::
cmake_host_system_information(RESULT <variable> QUERY <key> ...)
:target:
QUERY
Queries system information of the host system on which cmake runs.
One or more ``<key>`` can be provided to select the information to be
@@ -290,20 +291,19 @@ system information:
.. _man 5 os-release: https://www.freedesktop.org/software/systemd/man/latest/os-release.html
.. _various distribution-specific files: http://linuxmafia.com/faq/Admin/release-files.html
.. _Query Windows registry:
Query Windows registry
^^^^^^^^^^^^^^^^^^^^^^
Query the Windows registry
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. versionadded:: 3.24
.. code-block:: cmake
.. signature::
cmake_host_system_information(RESULT <variable>
QUERY WINDOWS_REGISTRY <key> [VALUE_NAMES|SUBKEYS|VALUE <name>]
[VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
[SEPARATOR <separator>]
[ERROR_VARIABLE <result>])
:target:
QUERY WINDOWS_REGISTRY
Performs query operations on local computer registry subkey. Returns a list of
subkeys or value names that are located under the specified subkey in the

5
Help/command/get_filename_component.rst
View File

@@ -10,9 +10,8 @@ Get a specific component of a full filename.
.. versionchanged:: 3.24
The undocumented feature offering the capability to query the ``Windows``
registry is superseded by
:ref:`cmake_host_system_information(QUERY WINDOWS_REGISTRY)<Query Windows registry>`
command.
registry is superseded by the
:command:`cmake_host_system_information(QUERY WINDOWS_REGISTRY)` command.
.. code-block:: cmake

6
Help/manual/cmake-developer.7.rst
View File

@@ -29,9 +29,9 @@ Query Windows Registry
.. versionadded:: 3.24
The :command:`cmake_host_system_information` command offers the possibility to
query the registry on the local computer. See
:ref:`cmake_host_system(QUERY_WINDOWS_REGISTRY) <Query Windows registry>` for
more information.
query the registry on the local computer. See the
:command:`cmake_host_system_information(QUERY WINDOWS_REGISTRY)` sub-command
for more information.
.. _`Find Using Windows Registry`:

3
Help/release/3.24.rst
View File

@@ -85,7 +85,8 @@ Commands
* The :command:`cmake_host_system_information` command, on Windows,
gained a ``QUERY WINDOWS_REGISTRY`` mode.
See its :ref:`Query Windows registry` section.
See its :command:`cmake_host_system_information(QUERY WINDOWS_REGISTRY)`
signature.
* The :command:`cmake_language` command gained a new
``SET_DEPENDENCY_PROVIDER`` sub-command. When a dependency provider is set,