From e3e23b6ae8505a5491d541e28fab566ac19f4de6 Mon Sep 17 00:00:00 2001 From: cid Date: Tue, 6 Aug 2024 10:54:31 +0100 Subject: [PATCH] Link to configuration options 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 --- doc/source/user/usage.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/source/user/usage.rst b/doc/source/user/usage.rst index dbcf3ed48..e1af01107 100644 --- a/doc/source/user/usage.rst +++ b/doc/source/user/usage.rst @@ -427,8 +427,9 @@ Boot mode 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 -behaviour to account for this capability. Set the ``[capabilities]boot_mode`` -configuration option to ``True`` to enable. +behaviour to account for this capability. +Set the :oslo.config:option:`capabilities.boot_mode` configuration option to +``True`` to enable. CPU capabilities ^^^^^^^^^^^^^^^^ @@ -447,8 +448,8 @@ capabilities: * ``cpu_hugepages_1g`` huge pages (1 GiB) support. It is possible to define your own rules for detecting CPU capabilities. -Set the ``[capabilities]cpu_flags`` configuration option to a mapping between -a CPU flag and a capability, for example:: +Set the :oslo.config:option:`capabilities.cpu_flags` configuration option +to a mapping between a CPU flag and a capability, for example:: cpu_flags = aes:cpu_aes,svm:cpu_vt,vmx:cpu_vt