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

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

[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 <mgross@linux.intel.com>
Cc: Josh Poimboeuf <jpoimboe@redhat.com>
Cc: Borislav Petkov <bp@suse.de>
Cc: Tony Luck <tony.luck@intel.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: linux-kernel@vger.kernel.org
Cc: trivial@kernel.org
Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
---
 .../hw-vuln/special-register-buffer-data-sampling.rst       | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst b/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
index 47b1b3afac99..3b1ce68d2456 100644
--- a/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
+++ b/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
@@ -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
-- 
2.27.0

Re: [PATCH] docs: hw-vuln: SRBDS: Fix "Title underline too short" warnings during build

[mark gross]

Ack
Signed-off-by:Mark Gross<mgross@linux.intel.com>

Thanks!

--mark



On Tue, Jun 09, 2020 at 10:28:56PM +0200, Salvatore Bonaccorso wrote:
> 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 <mgross@linux.intel.com>
> Cc: Josh Poimboeuf <jpoimboe@redhat.com>
> Cc: Borislav Petkov <bp@suse.de>
> Cc: Tony Luck <tony.luck@intel.com>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Cc: linux-kernel@vger.kernel.org
> Cc: trivial@kernel.org
> Signed-off-by: Salvatore Bonaccorso <carnil@debian.org>
> ---
>  .../hw-vuln/special-register-buffer-data-sampling.rst       | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst b/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
> index 47b1b3afac99..3b1ce68d2456 100644
> --- a/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
> +++ b/Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst
> @@ -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
> -- 
> 2.27.0
>