Skip to contentSkip to conversation

More descriptive help text for usb_modeswitch

PATCH New Jonathan Ben-Avraham 3 participants 5 messages Aug 20, 2014 – Aug 21, 2014

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 More descriptive help text for usb_modeswitch

Improve the help text for usb_modeswitch package for the benefit of the clueless.

---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
package/usb_modeswitch/Config.in +11 -2
index 5d8a6d2..2f4c2e8 100644
@@ -3,8 +3,17 @@ config BR2_PACKAGE_USB_MODESWITCH
 	depends on BR2_TOOLCHAIN_HAS_THREADS # libusb
 	select BR2_PACKAGE_LIBUSB
 	help
-	  USB mode switcher.
-	  Used to switch mode on multiple-function devices
+	  Some USB devices such as modems and Wifi adapters power-up in mass
+	  storage mode to provide access to drivers for the device's
+	  application mode. USB_ModeSwitch changes the mode of such devices
+	  from the initial mode to the application mode. Specific configuration
+	  data for each device model is required.
+
+	  usb_modeswitch can be used with package usb_modeswitch_data and udev
+	  for automatic mode switching when devices are connected.
+
+	  For more information Internet search for "Virtual CD-ROM switching
+	  utility".
 
 	  http://www.draisberghof.de/usb_modeswitch/
 
Signature · 1 line
1.7.10.4
#1 lore raw

PATCH 1/1 More descriptive help text for usb_modeswitch

Jonathan, All,

On 2014-08-20 21:04 +0300, Jonathan Ben-Avraham spake thusly:

Quoted 12 lines

Improve the help text for usb_modeswitch package for the benefit of the clueless.

---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
package/usb_modeswitch/Config.in +0 -0
index 5d8a6d2..2f4c2e8 100644

package/usb_modeswitch/Config.in config BR2_PACKAGE_USB_MODESWITCH · line 7

Quoted 7 lines
package/usb_modeswitch/Config.in +2 -2
@@ -3,8 +3,17 @@ config BR2_PACKAGE_USB_MODESWITCH
 	depends on BR2_TOOLCHAIN_HAS_THREADS # libusb
 	select BR2_PACKAGE_LIBUSB
 	help
-	  USB mode switcher.
-	  Used to switch mode on multiple-function devices
+	  Some USB devices such as modems and Wifi adapters power-up in mass
+	  storage mode to provide access to drivers for the device's

I would be even more explixit why those drivers are not needed on a Linux system:

[...] to provide access to (Windows-only) drivers for the device's application mode. [...]

Otherwise, looks good to me:

Regards,
Yann E. MORIN.

Quoted 19 lines
package/usb_modeswitch/Config.in +9 -0
+	  application mode. USB_ModeSwitch changes the mode of such devices
+	  from the initial mode to the application mode. Specific configuration
+	  data for each device model is required.
+
+	  usb_modeswitch can be used with package usb_modeswitch_data and udev
+	  for automatic mode switching when devices are connected.
+
+	  For more information Internet search for "Virtual CD-ROM switching
+	  utility".
 
 	  http://www.draisberghof.de/usb_modeswitch/
 
Signature · 6 lines
1.7.10.4

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
#2 lore raw

PATCH 1/1 More descriptive help text for usb_modeswitch

Hi Yann,

I agree with your comment.

I will add the explanation about why the drivers are not required on Linux and re-submit.

Thanks,

- yba

Quoted 62 lines · Yann E. MORIN

Date: Thu, 21 Aug 2014 12:14:36 +0200
From: Yann E. MORIN <[email protected]>
To: Jonathan Ben-Avraham <[email protected]>
Cc: buildroot at busybox.net
Subject: Re: [Buildroot] [PATCH] More descriptive help text for usb_modeswitch

Jonathan, All,

On 2014-08-20 21:04 +0300, Jonathan Ben-Avraham spake thusly:

Quoted 12 lines

Improve the help text for usb_modeswitch package for the benefit of the clueless.

---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
package/usb_modeswitch/Config.in +0 -0
index 5d8a6d2..2f4c2e8 100644

package/usb_modeswitch/Config.in config BR2_PACKAGE_USB_MODESWITCH · line 7

Quoted 7 lines
package/usb_modeswitch/Config.in +2 -2
@@ -3,8 +3,17 @@ config BR2_PACKAGE_USB_MODESWITCH
 	depends on BR2_TOOLCHAIN_HAS_THREADS # libusb
 	select BR2_PACKAGE_LIBUSB
 	help
-	  USB mode switcher.
-	  Used to switch mode on multiple-function devices
+	  Some USB devices such as modems and Wifi adapters power-up in mass
+	  storage mode to provide access to drivers for the device's

I would be even more explixit why those drivers are not needed on a Linux system:

[...] to provide access to (Windows-only) drivers for the device's application mode. [...]

Otherwise, looks good to me:

Regards,
Yann E. MORIN.

Quoted 19 lines
package/usb_modeswitch/Config.in +9 -1
+	  application mode. USB_ModeSwitch changes the mode of such devices
+	  from the initial mode to the application mode. Specific configuration
+	  data for each device model is required.
+
+	  usb_modeswitch can be used with package usb_modeswitch_data and udev
+	  for automatic mode switching when devices are connected.
+
+	  For more information Internet search for "Virtual CD-ROM switching
+	  utility".
 
 	  http://www.draisberghof.de/usb_modeswitch/
 
--

1.7.10.4

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot

Signature · 3 lines
  9590 8E58 D30D 1660 C349  673D B205 4FC4 B8F5 B7F9  ~. .~  Tk Open Systems
=}-------- Jonathan Ben-Avraham ("yba") ----------ooO--U--Ooo------------{=
mailto:yba at tkos.co.il tel:+972.52.486.3386 http://tkos.co.il skype:benavrhm
#3 lore raw

PATCH 1/1 More descriptive help text for usb_modeswitch

In reply to Jonathan Ben-Avraham

Dear Jonathan Ben-Avraham,

Quoted 6 lines · Jonathan Ben-Avraham

Improve the help text for usb_modeswitch package for the benefit of the clueless.

---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

I've applied your patch, after tweaking the commit title (it should always be "<package>: <something>"), rewrapping the help text to a shorter line length, and slightly adjusting the wording.

Thanks!

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com
#4 lore raw

PATCH 1/1 More descriptive help text for usb_modeswitch

Hi Thomas,
Thanks.
I'm working on a better text as per Yann's comments.
Please remind me what the line-length requirement for the help text is (not 80 chars?).

- yba

Quoted 24 lines · Thomas Petazzoni

Date: Thu, 21 Aug 2014 15:30:11 +0200
From: Thomas Petazzoni <[email protected]>
To: Jonathan Ben-Avraham <[email protected]>
Cc: buildroot at busybox.net
Subject: Re: [Buildroot] [PATCH] More descriptive help text for usb_modeswitch

Dear Jonathan Ben-Avraham,

Quoted 6 lines · Jonathan Ben-Avraham

Improve the help text for usb_modeswitch package for the benefit of the clueless.

---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

I've applied your patch, after tweaking the commit title (it should always be "<package>: <something>"), rewrapping the help text to a shorter line length, and slightly adjusting the wording.

Thanks!

Thomas

Signature · 3 lines
  9590 8E58 D30D 1660 C349  673D B205 4FC4 B8F5 B7F9  ~. .~  Tk Open Systems
=}-------- Jonathan Ben-Avraham ("yba") ----------ooO--U--Ooo------------{=
mailto:yba at tkos.co.il tel:+972.52.486.3386 http://tkos.co.il skype:benavrhm