Re: [PATCH v5 4/4] usb: doc: add document for USB3 debug port usage

From: Ingo Molnar
Date: Thu Jan 19 2017 - 04:50:22 EST



* Lu Baolu <baolu.lu@xxxxxxxxxxxxxxx> wrote:

> Add Documentation/usb/usb3-debug-port.rst. This document includes
> the user guide for USB3 debug port.
>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> Signed-off-by: Lu Baolu <baolu.lu@xxxxxxxxxxxxxxx>
> ---
> Documentation/usb/usb3-debug-port.rst | 95 +++++++++++++++++++++++++++++++++++
> 1 file changed, 95 insertions(+)
> create mode 100644 Documentation/usb/usb3-debug-port.rst
>
> diff --git a/Documentation/usb/usb3-debug-port.rst b/Documentation/usb/usb3-debug-port.rst
> new file mode 100644
> index 0000000..70eabe4
> --- /dev/null
> +++ b/Documentation/usb/usb3-debug-port.rst
> @@ -0,0 +1,95 @@
> +===============
> +USB3 debug port
> +===============
> +
> +:Author: Lu Baolu <baolu.lu@xxxxxxxxxxxxxxx>
> +:Date: October 2016
> +
> +GENERAL
> +=======
> +
> +This is a HOWTO for using USB3 debug port on x86 systems.
> +
> +Before using any kernel debugging functionalities based on USB3

s/debugging functionalities
/debugging functionality

> +debug port, you need to check 1) whether debug port is supported
> +by the xHCI host, 2) which port is used for debugging purpose

s/debugging purpose
/debugging purposes

> +On debug target system, you need to customize a debugging kernel

s/On debug target system
On the debug target system

(There are more typos/grammar errors in the document, please re-read it.)

Thanks,

Ingo