Documentation fixes for next-20230215
Subsystems (5)
cover Documentation fixes for next-20230215
Here are fixes for documentation (htmldocs) warnings as reported for next-20230215. The changelog below should be self-explanatory.
Each patch can be applied separately by respective maintainers.
Bagas Sanjaya (3):
Documentation: hw-vuln: Wrap mitigate_smt_rsb example in literal code
block
Documentation: bpf: Add missing line break separator in node_data
struct code block
Documentation: amd-pstate: disambiguate user space sections
Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst | 3 ++- Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++---- Documentation/bpf/graph_ds_impl.rst | 1 + 3 files changed, 7 insertions(+), 5 deletions(-)
base-commit: 9d9019bcea1aac7eed64a1a4966282b6b7b141c8
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/3 Documentation: hw-vuln: Wrap mitigate_smt_rsb example in literal code block
Stephen Rothwell reported htmldocs warning when making htmldocs from Linus's Tree:
Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst:92: ERROR: Unexpected indentation.
Fix the warning by formatting example of mitigate_smt_rsb module parameter as literal code block.
--- Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst +2 -1
@@ -88,5 +88,6 @@ capability to override those interceptions, but since this is not common, the mitigation that covers this path is not enabled by default. The mitigation for the KVM_CAP_X86_DISABLE_EXITS capability can be turned on -using the boolean module parameter mitigate_smt_rsb, e.g.: +using the boolean module parameter mitigate_smt_rsb, e.g.:: + kvm.mitigate_smt_rsb=1
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 2/3 Documentation: bpf: Add missing line break separator in node_data struct code block
In reply to Bagas SanjayaStephen Rothwell reported htmldocs warning when merging bpf-next tree, which was the same warning as reported by kernel test robot:
Documentation/bpf/graph_ds_impl.rst:62: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 12 supplied.
The error is due to Sphinx confuses node_data struct declaration with code-block directive option.
Fix the warning by separating the code-block marker with node_data struct declaration.
--- Documentation/bpf/graph_ds_impl.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/bpf/graph_ds_impl.rst +1 -0
@@ -60,6 +60,7 @@ The new-style data structures are intrusive and are defined similarly to their vanilla kernel counterparts: .. code-block:: c + struct node_data { long key; long data;
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Alexei Starovoitov
AppliedRe: [PATCH 2/3] Documentation: bpf: Add missing line break separator in node_data struct code block
Quoted 28 lines · Bagas Sanjaya
Stephen Rothwell reported htmldocs warning when merging bpf-next tree, which was the same warning as reported by kernel test robot:
Documentation/bpf/graph_ds_impl.rst:62: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 12 supplied.The error is due to Sphinx confuses
node_datastruct declaration with code-block directive option.Fix the warning by separating the code-block marker with
node_datastruct declaration.Fixes c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")Reported-by Stephen Rothwell <[email protected]>Reported-by kernel test robot <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>--- Documentation/bpf/graph_ds_impl.rst | 1 + 1 file changed, 1 insertion(+)Documentation/bpf/graph_ds_impl.rst +0
-0
Documentation/bpf/graph_ds_impl.rst The new-style data structures are intrusive and are defined similarly to their · line 64
Quoted 5 lines
Documentation/bpf/graph_ds_impl.rst +1
-0@@ -60,6 +60,7 @@ The new-style data structures are intrusive and are defined similarly to their vanilla kernel counterparts: .. code-block:: c + struct node_data {
Applied to bpf-next.
PATCH 3/3 Documentation: amd-pstate: disambiguate user space sections
In reply to Bagas Sanjayakernel test robot reported htmldocs warning:
Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance in Documentation/admin-guide/pm/amd-pstate.rst
The documentation contains two sections with the same "User Space Interface in ``sysfs``" title. The first one deals with per-policy sysfs and the second one is about general attributes (currently only global attributes are documented).
Disambiguate title text of both sections to fix the warning.
--- Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/admin-guide/pm/amd-pstate.rst +4 -4
@@ -230,8 +230,8 @@ with :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond to the request from AMD P-States. -User Space Interface in ``sysfs`` -================================== +User Space Interface in ``sysfs`` - Per-policy control +====================================================== ``amd-pstate`` exposes several global attributes (files) in ``sysfs`` to control its functionality at the system level. They are located in the
@@ -339,8 +339,8 @@ processor must provide at least nominal performance requested and go higher if c operating conditions allow. -User Space Interface in ``sysfs`` -================================= +User Space Interface in ``sysfs`` - General +=========================================== Global Attributes -----------------
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections
Quoted 9 lines · Bagas Sanjaya
kernel test robot reported htmldocs warning:
Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance inDocumentation/admin-guide/pm/amd-pstate.rstThe documentation contains two sections with the same "User Space Interface in ``sysfs``" title. The first one deals with per-policy sysfs and the second one is about general attributes (currently only global attributes are documented).
Quoted 5 lines
Disambiguate title text of both sections to fix the warning.
Fixes b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")Reported-by kernel test robot <[email protected]>
Quoted 34 lines
Signed-off-by Bagas Sanjaya <[email protected]>--- Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/admin-guide/pm/amd-pstate.rst +4
-4@@ -230,8 +230,8 @@ with :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond to the request from AMD P-States. -User Space Interface in ``sysfs`` -================================== +User Space Interface in ``sysfs`` - Per-policy control +====================================================== ``amd-pstate`` exposes several global attributes (files) in ``sysfs`` to control its functionality at the system level. They are located in the@@ -339,8 +339,8 @@ processor must provide at least nominal performance requested and go higher if c operating conditions allow. -User Space Interface in ``sysfs`` -================================= +User Space Interface in ``sysfs`` - General +=========================================== Global Attributes -----------------Signature · 1 line
An old man doll... just what I always wanted! - Clara
Thanks,
Wyes
Re: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections
In reply to Bagas SanjayaQuoted 9 lines · Bagas Sanjaya
kernel test robot reported htmldocs warning:
Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance inDocumentation/admin-guide/pm/amd-pstate.rstThe documentation contains two sections with the same "User Space Interface in ``sysfs``" title. The first one deals with per-policy sysfs and the second one is about general attributes (currently only global attributes are documented).
Quoted 6 lines
Disambiguate title text of both sections to fix the warning.
Fixes b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")Reported-by kernel test robot <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>
Quoted 33 lines
--- Documentation/admin-guide/pm/amd-pstate.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/admin-guide/pm/amd-pstate.rst +4
-4@@ -230,8 +230,8 @@ with :c:macro:`MSR_AMD_CPPC_ENABLE` or ``cppc_set_enable``, it will respond to the request from AMD P-States. -User Space Interface in ``sysfs`` -================================== +User Space Interface in ``sysfs`` - Per-policy control +====================================================== ``amd-pstate`` exposes several global attributes (files) in ``sysfs`` to control its functionality at the system level. They are located in the@@ -339,8 +339,8 @@ processor must provide at least nominal performance requested and go higher if c operating conditions allow. -User Space Interface in ``sysfs`` -================================= +User Space Interface in ``sysfs`` - General +=========================================== Global Attributes -----------------Signature · 1 line
An old man doll... just what I always wanted! - Clara
Rafael J. Wysocki
AppliedRe: [PATCH 3/3] Documentation: amd-pstate: disambiguate user space sections
Quoted 11 lines · Huang Rui
Quoted 9 lines · Bagas Sanjaya
kernel test robot reported htmldocs warning:
Documentation/admin-guide/pm/amd-pstate.rst:343: WARNING: duplicate label admin-guide/pm/amd-pstate:user space interface in ``sysfs``, other instance inDocumentation/admin-guide/pm/amd-pstate.rstThe documentation contains two sections with the same "User Space Interface in ``sysfs``" title. The first one deals with per-policy sysfs and the second one is about general attributes (currently only global attributes are documented).
Quoted 8 lines
Quoted 6 lines
Disambiguate title text of both sections to fix the warning.
Fixes b9e6a2d47b2565 ("Documentation: amd-pstate: introduce new global sysfs attributes")Reported-by kernel test robot <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>Acked-by Huang Rui <[email protected]>
Applied as 6.3 material, thanks!
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Hello:
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Quoted 5 lines · On Wed, 15 Feb 2023 19:32:50 +0700 you wrote:
Here are fixes for documentation (htmldocs) warnings as reported for next-20230215. The changelog below should be self-explanatory.
Each patch can be applied separately by respective maintainers.
Quoted 8 lines
Bagas Sanjaya (3):
Documentation: hw-vuln: Wrapmitigate_smt_rsbexample in literal code
block
Documentation: bpf: Add missing line break separator innode_data
struct code block
Documentation: amd-pstate: disambiguate user space sections[...]
Here is the summary with links:
- [1/3] Documentation: hw-vuln: Wrap mitigate_smt_rsb example in literal code block (no matching commit)
- [2/3] Documentation: bpf: Add missing line break separator in node_data struct code block
https://git.kernel.org/bpf/bpf-next/c/e2d323a1f009
- [3/3] Documentation: amd-pstate: disambiguate user space sections (no matching commit)
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html