Re: [PATCH] Fixed the Warning: Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst:92: WARNING: Unexpected indentation.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Harsh Mishra <hmisraji07@xxxxxxxxx> writes:

> ------
>
> Dear Maintainers and Mentors,
> I have successfully compeleted the task "Documentation Task" under "Linux Kernel Bug Fixing Spring 2023" Mentee Application. 
> I have also solved a minor documentation warning in Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst .
> Please have a look into it 
> Regards,
> Harsh Mishra

Thank you for working to improve our documentation!

That said, I do have a few requests, starting with:

- Please read Documentation/process/submitting-patches.rst for
  information on how your changelog should be written.  Among other
  things, the changelog should be *above* the '---' line, briefly
  describe the problem and why it needs to be fixed, and not contain
  extraneous information.

> Signed-off-by: Harsh Mishra <hmisraji07@xxxxxxxxx>
> ---
>  Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst b/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst
> index ec6e9f5bcf9e..d0fd6cf44911 100644
> --- a/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst
> +++ b/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst
> @@ -88,5 +88,4 @@ 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.:
> -        kvm.mitigate_smt_rsb=1
> +using the boolean module parameter mitigate_smt_rsb, e.g.: kvm.mitigate_smt_rsb=1

This is not a terrible fix, but may not be the best one.  Most likely,
the author wanted this as a literal block:

  ...the boolean module parameter mitigate_smt_rsb, e.g.::

	kvm.mitigate_smt_rsb=1

Thanks,

jon



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux