Re: [PATCH v1 1/4] tools/usbip: update documentation

[Shuah Khan <skhan@linuxfoundation.org>]

On 11/7/21 10:15 AM, Lars Gunnarsson wrote:
> This patch contains usbip protocol documentation updates for
> the implementation changes in subsequent patches.
> 
> Signed-off-by: Lars Gunnarsson <gunnarsson.lars@gmail.com>
> ---
> v1: New patch added in series.
> 
>   Documentation/usb/usbip_protocol.rst | 61 ++++++++++++++++++++++++----
>   1 file changed, 53 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/usb/usbip_protocol.rst b/Documentation/usb/usbip_protocol.rst
> index 0b8541fda4d8..1afe6d297efc 100644
> --- a/Documentation/usb/usbip_protocol.rst
> +++ b/Documentation/usb/usbip_protocol.rst
> @@ -9,6 +9,11 @@ The USB/IP protocol follows a server/client architecture. The server exports the
>   USB devices and the clients import them. The device driver for the exported
>   USB device runs on the client machine.
>   
> +Initially the server may choose to export any of its available USB devices,
> +based on the busid. The device will remain exported until it's unplugged or
> +unbound from the usbip driver. It is also possible to persistently export
> +devices on a given bus by monitor when they are plugged in.
> +

The current description is mixing export and unbound.
Let's rephrase this as follows.

"The server may choose to export any of its available USB devices based on their
busid. These devices will remain exported until they are unplugged or unexported.
Optionally, it is possible to persistently export the devices on a given bus by
monitor when they are plugged in"

I don't see tools/usb/usbip/doc updated to reflect the new commands? Please
include tools/usb/usbip/doc to both usbipd.8 and usbip.8 to describe how this
new feature can be used. Also include details on how to reverse persistent
export. Right now it is a decision made on each boot and there is no need to
be concerned about exporting devices that should no longer be exported. With
this feature, it becomes important to make sure there is clear indication that
devices are being exported in persistent manner.

I would like to see the doc updates - please add them as the second patch in
this series, so it would be easier for people to review.

thanks,
-- Shuah