All of lore.kernel.org
 help / color / mirror / Atom feed
* [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
@ 2014-08-20 18:04 Jonathan Ben-Avraham
  2014-08-21 10:14 ` Yann E. MORIN
  2014-08-21 13:30 ` Thomas Petazzoni
  0 siblings, 2 replies; 6+ messages in thread
From: Jonathan Ben-Avraham @ 2014-08-20 18:04 UTC (permalink / raw)
  To: buildroot

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

Signed-off-by: Jonathan Ben-Avraham <yba@tkos.co.il>
---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/package/usb_modeswitch/Config.in b/package/usb_modeswitch/Config.in
index 5d8a6d2..2f4c2e8 100644
--- a/package/usb_modeswitch/Config.in
+++ b/package/usb_modeswitch/Config.in
@@ -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/
 
-- 
1.7.10.4

^ permalink raw reply related	[flat|nested] 6+ messages in thread
* [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
  2014-08-20 18:04 [Buildroot] [PATCH] More descriptive help text for usb_modeswitch Jonathan Ben-Avraham
@ 2014-08-21 10:14 ` Yann E. MORIN
  2014-08-21 12:38   ` Jonathan Ben Avraham
  2014-08-21 13:30 ` Thomas Petazzoni
  1 sibling, 1 reply; 6+ messages in thread
From: Yann E. MORIN @ 2014-08-21 10:14 UTC (permalink / raw)
  To: buildroot

Jonathan, All,

On 2014-08-20 21:04 +0300, Jonathan Ben-Avraham spake thusly:
> Improve the help text for usb_modeswitch package for the benefit of the clueless.
> 
> Signed-off-by: Jonathan Ben-Avraham <yba@tkos.co.il>
> ---
>  package/usb_modeswitch/Config.in |   13 +++++++++++--
>  1 file changed, 11 insertions(+), 2 deletions(-)
> 
> diff --git a/package/usb_modeswitch/Config.in b/package/usb_modeswitch/Config.in
> index 5d8a6d2..2f4c2e8 100644
> --- a/package/usb_modeswitch/Config.in
> +++ b/package/usb_modeswitch/Config.in
> @@ -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:
Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> +	  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

-- 
.-----------------.--------------------.------------------.--------------------.
|  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.  |
'------------------------------^-------^------------------^--------------------'

^ permalink raw reply	[flat|nested] 6+ messages in thread
* [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
  2014-08-21 10:14 ` Yann E. MORIN
@ 2014-08-21 12:38   ` Jonathan Ben Avraham
  0 siblings, 0 replies; 6+ messages in thread
From: Jonathan Ben Avraham @ 2014-08-21 12:38 UTC (permalink / raw)
  To: buildroot

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


On Thu, 21 Aug 2014, Yann E. MORIN wrote:

> Date: Thu, 21 Aug 2014 12:14:36 +0200
> From: Yann E. MORIN <yann.morin.1998@free.fr>
> To: Jonathan Ben-Avraham <yba@tkos.co.il>
> 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:
>> Improve the help text for usb_modeswitch package for the benefit of the clueless.
>>
>> Signed-off-by: Jonathan Ben-Avraham <yba@tkos.co.il>
>> ---
>>  package/usb_modeswitch/Config.in |   13 +++++++++++--
>>  1 file changed, 11 insertions(+), 2 deletions(-)
>>
>> diff --git a/package/usb_modeswitch/Config.in b/package/usb_modeswitch/Config.in
>> index 5d8a6d2..2f4c2e8 100644
>> --- a/package/usb_modeswitch/Config.in
>> +++ b/package/usb_modeswitch/Config.in
>> @@ -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:
> Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
>
> Regards,
> Yann E. MORIN.
>
>> +	  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
>
>

-- 
  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

^ permalink raw reply	[flat|nested] 6+ messages in thread
* [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
  2014-08-20 18:04 [Buildroot] [PATCH] More descriptive help text for usb_modeswitch Jonathan Ben-Avraham
  2014-08-21 10:14 ` Yann E. MORIN
@ 2014-08-21 13:30 ` Thomas Petazzoni
  2014-08-21 13:39   ` Jonathan Ben Avraham
  1 sibling, 1 reply; 6+ messages in thread
From: Thomas Petazzoni @ 2014-08-21 13:30 UTC (permalink / raw)
  To: buildroot

Dear Jonathan Ben-Avraham,

On Wed, 20 Aug 2014 21:04:53 +0300, Jonathan Ben-Avraham wrote:
> Improve the help text for usb_modeswitch package for the benefit of the clueless.
> 
> Signed-off-by: Jonathan Ben-Avraham <yba@tkos.co.il>
> ---
>  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
-- 
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com

^ permalink raw reply	[flat|nested] 6+ messages in thread
* [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
  2014-08-21 13:30 ` Thomas Petazzoni
@ 2014-08-21 13:39   ` Jonathan Ben Avraham
  0 siblings, 0 replies; 6+ messages in thread
From: Jonathan Ben Avraham @ 2014-08-21 13:39 UTC (permalink / raw)
  To: buildroot

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


On Thu, 21 Aug 2014, Thomas Petazzoni wrote:

> Date: Thu, 21 Aug 2014 15:30:11 +0200
> From: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
> To: Jonathan Ben-Avraham <yba@tkos.co.il>
> Cc: buildroot at busybox.net
> Subject: Re: [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
> 
> Dear Jonathan Ben-Avraham,
>
> On Wed, 20 Aug 2014 21:04:53 +0300, Jonathan Ben-Avraham wrote:
>> Improve the help text for usb_modeswitch package for the benefit of the clueless.
>>
>> Signed-off-by: Jonathan Ben-Avraham <yba@tkos.co.il>
>> ---
>>  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
>

-- 
  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

^ permalink raw reply	[flat|nested] 6+ messages in thread
* [Buildroot] [PATCH] More descriptive help text for usb_modeswitch
@ 2014-08-21 11:42 Jonathan Ben-Avraham
  0 siblings, 0 replies; 6+ messages in thread
From: Jonathan Ben-Avraham @ 2014-08-21 11:42 UTC (permalink / raw)
  To: buildroot

Provides a fuller description of the USB_ModeSwitch functionality for the
benefit of the otherwise clueless.

Signed-off-by: Jonathan Ben-Avraham <yba@tkos.co.il>
---
 package/usb_modeswitch/Config.in |   13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/package/usb_modeswitch/Config.in b/package/usb_modeswitch/Config.in
index 5d8a6d2..8f7e7c9 100644
--- a/package/usb_modeswitch/Config.in
+++ b/package/usb_modeswitch/Config.in
@@ -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 models of 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 power-up 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

^ permalink raw reply related	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2014-08-21 13:39 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-08-20 18:04 [Buildroot] [PATCH] More descriptive help text for usb_modeswitch Jonathan Ben-Avraham
2014-08-21 10:14 ` Yann E. MORIN
2014-08-21 12:38   ` Jonathan Ben Avraham
2014-08-21 13:30 ` Thomas Petazzoni
2014-08-21 13:39   ` Jonathan Ben Avraham
2014-08-21 11:42 Jonathan Ben-Avraham

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.