openstack/ironic-inspector
Code Issues Proposed changes

Link to configuration options

Browse Source 
This commit provides a link to the rendered value of configuration
options in the documentation in the format of
:oslo.config:option:`group.option`.

Change-Id: I496b15298b3597940c6fb6e2a1436bfd23b15a4f
This commit is contained in:
cid 2024-08-06 10:54:31 +01:00
parent 43248710fa
commit e3e23b6ae8
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/user/usage.rst
View File

@ -427,8 +427,9 @@ Boot mode
The current boot mode (BIOS or UEFI) can be detected and recorded as The current boot mode (BIOS or UEFI) can be detected and recorded as
``boot_mode`` capability in Ironic. It will make some drivers to change their ``boot_mode`` capability in Ironic. It will make some drivers to change their
behaviour to account for this capability. Set the ``[capabilities]boot_mode`` behaviour to account for this capability.
configuration option to ``True`` to enable. Set the :oslo.config:option:`capabilities.boot_mode` configuration option to
``True`` to enable.
CPU capabilities CPU capabilities
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
@ -447,8 +448,8 @@ capabilities:
* ``cpu_hugepages_1g`` huge pages (1 GiB) support. * ``cpu_hugepages_1g`` huge pages (1 GiB) support.
It is possible to define your own rules for detecting CPU capabilities. It is possible to define your own rules for detecting CPU capabilities.
Set the ``[capabilities]cpu_flags`` configuration option to a mapping between Set the :oslo.config:option:`capabilities.cpu_flags` configuration option
a CPU flag and a capability, for example:: to a mapping between a CPU flag and a capability, for example::
cpu_flags = aes:cpu_aes,svm:cpu_vt,vmx:cpu_vt cpu_flags = aes:cpu_aes,svm:cpu_vt,vmx:cpu_vt