Re: [PATCH 19/27] Documentation: x86: convert usb-legacy-support.txt to reST

[Mauro Carvalho Chehab <mchehab+samsung@kernel.org>]

Em Fri, 26 Apr 2019 23:31:42 +0800
Changbin Du <changbin.du@gmail.com> escreveu:

> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
> 
> Signed-off-by: Changbin Du <changbin.du@gmail.com>
> ---
>  Documentation/x86/index.rst                               | 1 +
>  .../{usb-legacy-support.txt => usb-legacy-support.rst}    | 8 ++++++--
>  2 files changed, 7 insertions(+), 2 deletions(-)
>  rename Documentation/x86/{usb-legacy-support.txt => usb-legacy-support.rst} (92%)
> 
> diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst
> index c41c17906b6d..526f7a008b8e 100644
> --- a/Documentation/x86/index.rst
> +++ b/Documentation/x86/index.rst
> @@ -25,3 +25,4 @@ Linux x86 Support
>     pti
>     microcode
>     resctrl_ui
> +   usb-legacy-support
> diff --git a/Documentation/x86/usb-legacy-support.txt b/Documentation/x86/usb-legacy-support.rst
> similarity index 92%
> rename from Documentation/x86/usb-legacy-support.txt
> rename to Documentation/x86/usb-legacy-support.rst
> index 1894cdfc69d9..19abead7f1a8 100644
> --- a/Documentation/x86/usb-legacy-support.txt
> +++ b/Documentation/x86/usb-legacy-support.rst
> @@ -1,7 +1,11 @@
> +
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==================
>  USB Legacy support
> -~~~~~~~~~~~~~~~~~~
> +==================
>  
> -Vojtech Pavlik <vojtech@suse.cz>, January 2004
> +:Author: Vojtech Pavlik <vojtech@suse.cz>, January 2004
>  
>  
>  Also known as "USB Keyboard" or "USB Mouse support" in the BIOS Setup is a

While your conversion is fine, I would do this change:

-Problem 1) can be solved by loading the USB drivers prior to loading the
-PS/2 mouse driver. Since the PS/2 mouse driver is in 2.6 compiled into
-the kernel unconditionally, this means the USB drivers need to be
-compiled-in, too.
-
-Problem 2) can currently only be solved by either disabling HIGHMEM64G
-in the kernel config or USB Legacy support in the BIOS. A BIOS update
-could help, but so far no such update exists.
-
-Problem 3) is usually fixed by a BIOS update. Check the board
-manufacturers web site. If an update is not available, disable USB
-Legacy support in the BIOS. If this alone doesn't help, try also adding
-idle=poll on the kernel command line. The BIOS may be entering the SMM
-on the HLT instruction as well.
+Problem 1)
+  Can be solved by loading the USB drivers prior to loading the
+  PS/2 mouse driver. Since the PS/2 mouse driver is in 2.6 compiled into
+  the kernel unconditionally, this means the USB drivers need to be
+  compiled-in, too.
+
+Problem 2)
+  Can currently only be solved by either disabling HIGHMEM64G
+  in the kernel config or USB Legacy support in the BIOS. A BIOS update
+  could help, but so far no such update exists.
+
+Problem 3)
+  Is usually fixed by a BIOS update. Check the board
+  manufacturers web site. If an update is not available, disable USB
+  Legacy support in the BIOS. If this alone doesn't help, try also adding
+  idle=poll on the kernel command line. The BIOS may be entering the SMM
+  on the HLT instruction as well.

As it would make easier for those reading this document in html.

In either case:

Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Thanks,
Mauro