Skip to contentSkip to conversation

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

PATCH Superseded Antonio Borneo 2 participants 4 messages Jun 18, 2020 – Jun 25, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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

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.

---
 tools/usb/usbip/doc/usbip.8 | 2 ++
 1 file changed, 2 insertions(+)
tools/usb/usbip/doc/usbip.8 +2 -0
index a6097be25d28..81313f4913b4 100644
@@ -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.
 
Signature · 1 line
2.27.0
maintainer
#1 lore raw
Quoted 20 lines · 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.

---
  tools/usb/usbip/doc/usbip.8 | 2 ++
  1 file changed, 2 insertions(+)
tools/usb/usbip/doc/usbip.8 +0 -0
index a6097be25d28..81313f4913b4 100644

tools/usb/usbip/doc/usbip.8 List local USB devices. · line 87

Quoted 3 lines
tools/usb/usbip/doc/usbip.8 +0 -0
@@ -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

tools/usb/usbip/doc/usbip.8 List local USB devices.

Quoted 7 lines
tools/usb/usbip/doc/usbip.8 +2 -0
+    client:# modprobe vhci-hcd
+
 
      client:# usbip attach --remote=server --busid=1-2
          - Connect the remote USB device.

thanks,
-- Shuah

#2 lore raw

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

In reply to 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".

--

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(-)
tools/usb/usbip/doc/usbip.8 +3 -1
index a6097be25d28..a15d20063b98 100644
@@ -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

Signature · 1 line
2.27.0
maintainer Acked-by on v2 1/1
#3 lore raw
Quoted 37 lines · 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".

--

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(-)
tools/usb/usbip/doc/usbip.8 +3 -1
index a6097be25d28..a15d20063b98 100644
@@ -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.
Quoted 2 lines

base-commit: 48778464bb7d346b47157d21ffde2af6b2d39110

thanks,
-- Shuah