Skip to contentSkip to conversation

docs: hw-vuln: SRBDS: Fix "Title underline too short" warnings during build

PATCH In review Salvatore Bonaccorso 2 participants 2 messages Jun 9, 2020 – Jun 11, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: hw-vuln: SRBDS: Fix "Title underline too short" warnings during build

Some of the title underlining did not have the correct length causing a few warnings when building the htmldocs. Line up each of the title underlinings with the text they are under.

Fixes 7222a1b5b874 ("x86/speculation: Add SRBDS vulnerability and mitigation documentation")
Cc Mark Gross <[email protected]>
Cc Josh Poimboeuf <[email protected]>
Cc Borislav Petkov <[email protected]>
Cc Tony Luck <[email protected]>
Cc Thomas Gleixner <[email protected]>
---
 .../hw-vuln/special-register-buffer-data-sampling.rst       | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst +3 -3
index 47b1b3afac99..3b1ce68d2456 100644
@@ -14,7 +14,7 @@ to the core through the special register mechanism that is susceptible
 to MDS attacks.
 
 Affected processors
---------------------
+-------------------
 Core models (desktop, mobile, Xeon-E3) that implement RDRAND and/or RDSEED may
 be affected.
 
@@ -59,7 +59,7 @@ executed on another core or sibling thread using MDS techniques.
 
 
 Mitigation mechanism
--------------------
+--------------------
 Intel will release microcode updates that modify the RDRAND, RDSEED, and
 EGETKEY instructions to overwrite secret special register data in the shared
 staging buffer before the secret data can be accessed by another logical
@@ -118,7 +118,7 @@ with the option "srbds=".  The option for this is:
   ============= =============================================================
 
 SRBDS System Information
------------------------
+------------------------
 The Linux kernel provides vulnerability status information through sysfs.  For
 SRBDS this can be accessed by the following sysfs file:
 /sys/devices/system/cpu/vulnerabilities/srbds
Signature · 1 line
2.27.0
#1 lore raw

Ack

Thanks!

--mark

Quoted 51 lines · Salvatore Bonaccorso

Some of the title underlining did not have the correct length causing a few warnings when building the htmldocs. Line up each of the title underlinings with the text they are under.

Fixes 7222a1b5b874 ("x86/speculation: Add SRBDS vulnerability and mitigation documentation")
Cc Mark Gross <[email protected]>
Cc Josh Poimboeuf <[email protected]>
Cc Borislav Petkov <[email protected]>
Cc Tony Luck <[email protected]>
Cc Thomas Gleixner <[email protected]>
---
 .../hw-vuln/special-register-buffer-data-sampling.rst       | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst +3 -3
index 47b1b3afac99..3b1ce68d2456 100644
@@ -14,7 +14,7 @@ to the core through the special register mechanism that is susceptible
 to MDS attacks.
 
 Affected processors
---------------------
+-------------------
 Core models (desktop, mobile, Xeon-E3) that implement RDRAND and/or RDSEED may
 be affected.
 
@@ -59,7 +59,7 @@ executed on another core or sibling thread using MDS techniques.
 
 
 Mitigation mechanism
--------------------
+--------------------
 Intel will release microcode updates that modify the RDRAND, RDSEED, and
 EGETKEY instructions to overwrite secret special register data in the shared
 staging buffer before the secret data can be accessed by another logical
@@ -118,7 +118,7 @@ with the option "srbds=".  The option for this is:
   ============= =============================================================
 
 SRBDS System Information
------------------------
+------------------------
 The Linux kernel provides vulnerability status information through sysfs.  For
 SRBDS this can be accessed by the following sysfs file:
 /sys/devices/system/cpu/vulnerabilities/srbds
Signature · 1 line
2.27.0