[PATCH] usbip: tools: add in man page how to load the client's module

[PATCH] usbip: tools: add in man page how to load the client's module

[Antonio Borneo]

While the man page usbipd.8 already informs the user on which
kernel module has to be used on server side, the man page usbip.8
does not provide any equivalent information on client side.
Also, it could be hard for a newby to identify the proper usbip
client kernel module, due to the name "vhci-hcd" that has no
immediate assonance with usbip.

Add in usbip.8 the command to add the module vhci-hcd, similarly
as it's already present in usbipd.8 for usbip-host.

Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
---
 tools/usb/usbip/doc/usbip.8 | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
index a6097be25d28..81313f4913b4 100644
--- a/tools/usb/usbip/doc/usbip.8
+++ b/tools/usb/usbip/doc/usbip.8
@@ -85,6 +85,8 @@ List local USB devices.
     client:# usbip list --remote=server
         - List exportable usb devices on the server.
 
+    client:# modprobe vhci-hcd
+
     client:# usbip attach --remote=server --busid=1-2
         - Connect the remote USB device.
 
-- 
2.27.0

Re: [PATCH] usbip: tools: add in man page how to load the client's module

[Shuah Khan]

On 6/17/20 6:08 PM, Antonio Borneo wrote:
> While the man page usbipd.8 already informs the user on which
> kernel module has to be used on server side, the man page usbip.8
> does not provide any equivalent information on client side.
> Also, it could be hard for a newby to identify the proper usbip
> client kernel module, due to the name "vhci-hcd" that has no
> immediate assonance with usbip.
> 
> Add in usbip.8 the command to add the module vhci-hcd, similarly
> as it's already present in usbipd.8 for usbip-host.
> 
> Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
> ---
>   tools/usb/usbip/doc/usbip.8 | 2 ++
>   1 file changed, 2 insertions(+)
> 
> diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
> index a6097be25d28..81313f4913b4 100644
> --- a/tools/usb/usbip/doc/usbip.8
> +++ b/tools/usb/usbip/doc/usbip.8
> @@ -85,6 +85,8 @@ List local USB devices.
>       client:# usbip list --remote=server
>           - List exportable usb devices on the server.
>   

While you are making changes, please change the above to the
following. This is more accurate.

List devices exported by remote=server

> +    client:# modprobe vhci-hcd
> +

>       client:# usbip attach --remote=server --busid=1-2
>           - Connect the remote USB device.
>   
> 

thanks,
-- Shuah

[PATCH v2] usbip: tools: add in man page how to load the client's module

[Antonio Borneo]

While the man page usbipd.8 already informs the user on which
kernel module has to be used on server side, the man page usbip.8
does not provide any equivalent information on client side.
Also, it could be hard for a newbie to identify the proper usbip
client kernel module, due to the name "vhci-hcd" that has no
immediate assonance with usbip.

Add in usbip.8 the command to add the module vhci-hcd, similarly
as it's already present in usbipd.8 for usbip-host.
While there, rephrase the description of the command "usbip list
--remote=server".

Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
--

v1->v2: rephrase the description of command "usbip list ..."
        fix a typo in commit message
---
 tools/usb/usbip/doc/usbip.8 | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
index a6097be25d28..a15d20063b98 100644
--- a/tools/usb/usbip/doc/usbip.8
+++ b/tools/usb/usbip/doc/usbip.8
@@ -83,7 +83,9 @@ List local USB devices.
 .SH EXAMPLES
 
     client:# usbip list --remote=server
-        - List exportable usb devices on the server.
+        - List devices exported by remote server.
+
+    client:# modprobe vhci-hcd
 
     client:# usbip attach --remote=server --busid=1-2
         - Connect the remote USB device.

base-commit: 48778464bb7d346b47157d21ffde2af6b2d39110
-- 
2.27.0

Re: [PATCH v2] usbip: tools: add in man page how to load the client's module

[Shuah Khan]

On 6/25/20 7:17 AM, Antonio Borneo wrote:
> While the man page usbipd.8 already informs the user on which
> kernel module has to be used on server side, the man page usbip.8
> does not provide any equivalent information on client side.
> Also, it could be hard for a newbie to identify the proper usbip
> client kernel module, due to the name "vhci-hcd" that has no
> immediate assonance with usbip.
> 
> Add in usbip.8 the command to add the module vhci-hcd, similarly
> as it's already present in usbipd.8 for usbip-host.
> While there, rephrase the description of the command "usbip list
> --remote=server".
> 
> Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
> --
> 
> v1->v2: rephrase the description of command "usbip list ..."
>          fix a typo in commit message
> ---
>   tools/usb/usbip/doc/usbip.8 | 4 +++-
>   1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
> index a6097be25d28..a15d20063b98 100644
> --- a/tools/usb/usbip/doc/usbip.8
> +++ b/tools/usb/usbip/doc/usbip.8
> @@ -83,7 +83,9 @@ List local USB devices.
>   .SH EXAMPLES
>   
>       client:# usbip list --remote=server
> -        - List exportable usb devices on the server.
> +        - List devices exported by remote server.
> +
> +    client:# modprobe vhci-hcd
>   
>       client:# usbip attach --remote=server --busid=1-2
>           - Connect the remote USB device.
> 
> base-commit: 48778464bb7d346b47157d21ffde2af6b2d39110
> 

Acked-by: Shuah Khan <skhan@linuxfoundation.org>

thanks,
-- Shuah