Patchwork [3/4] directfb: expanding the help strings

login
register
mail settings
Submitter Carsten Schoenert
Date March 10, 2013, 9:47 a.m.
Message ID <1362908858-6340-4-git-send-email-c.schoenert@gmail.com>
Download mbox | patch
Permalink /patch/226421/
State Superseded
Headers show

Comments

Carsten Schoenert - March 10, 2013, 9:47 a.m.
From: Carsten Schoenert <c.schoenert@gmail.com>

Adding a helper string for the PXA3xx and graphics driver from Marvell
and the EP9x graphics driver from Cirrus Logic.

Signed-off-by: Carsten Schoenert <c.schoenert@gmail.com>
---
 package/directfb/Config.in |   17 +++++++++++++++++
 1 file changed, 17 insertions(+)
Thomas Petazzoni - March 10, 2013, 10:27 a.m.
Dear Carsten Schoenert,

On Sun, 10 Mar 2013 10:47:37 +0100, Carsten Schoenert wrote:
> From: Carsten Schoenert <c.schoenert@gmail.com>
> 
> Adding a helper string for the PXA3xx and graphics driver from Marvell
> and the EP9x graphics driver from Cirrus Logic.
> 
> Signed-off-by: Carsten Schoenert <c.schoenert@gmail.com>
> ---
>  package/directfb/Config.in |   17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/package/directfb/Config.in b/package/directfb/Config.in
> index a184568..3d22e15 100644
> --- a/package/directfb/Config.in
> +++ b/package/directfb/Config.in
> @@ -49,10 +49,27 @@ config BR2_PACKAGE_DIRECTFB_MATROX
>  config BR2_PACKAGE_DIRECTFB_PXA3XX
>  	bool "compile pxa3xx graphics driver"
>  	depends on BR2_arm
> +    help
> +      The Marvell PXA3xx Processor Family is a system-on-chip based
> +      on XScale® microarchitecture. The PXA3xx processor provide
> +      high-performance multimedia, low-power capabilities, and rich
> +      peripheral integration. The PXA3xx Processor Family provide
> +      enhanced features compared to the PXA27x Processor Family, and
> +      are the first Marvell applications processors to integrate a
> +      hardware video accelerator unit.
> +
> +      http://www.marvell.com/application-processors/pxa-family/

Indentation is wrong. It should be one tab for "help" and one tab + two
spaces for the help text.

In addition to that, I'm not sure the wording of the help text is so
useful. Something like "This option enables a graphics driver specific
to the graphics hardware of the Marvell PXA3xx processor family", would
be a bit more useful.

>  config BR2_PACKAGE_DIRECTFB_EP9X
>  	bool "compile ep9x graphics driver"
>  	depends on BR2_arm
> +    help
> +      The EP93xx ARMv9 based processors from Cirrus Logic are highly
> +      integrated systems-on-a-chip that pave the way for a multitude
> +      of next-generation consumer and industrial electronic products.
> +
> +      http://cirrus.com/en/products/arm9.html

Same comments.

Best regards,

Thomas
Carsten Schoenert - March 10, 2013, 12:21 p.m.
Hello Thomas,

Am 10.03.2013 11:27, schrieb Thomas Petazzoni:
>> +    help
>> +      The Marvell PXA3xx Processor Family is a system-on-chip based
>> +      on XScale® microarchitecture. The PXA3xx processor provide
>> +      high-performance multimedia, low-power capabilities, and rich
>> +      peripheral integration. The PXA3xx Processor Family provide
>> +      enhanced features compared to the PXA27x Processor Family, and
>> +      are the first Marvell applications processors to integrate a
>> +      hardware video accelerator unit.
>> +
>> +      http://www.marvell.com/application-processors/pxa-family/
> 
> Indentation is wrong. It should be one tab for "help" and one tab + two
> spaces for the help text.

Hmm, I have to check my vim settings, sorry.
What about modlines in thees files? This would be helpful and it's just
a one-liner on top of this files.

> In addition to that, I'm not sure the wording of the help text is so
> useful. Something like "This option enables a graphics driver specific
> to the graphics hardware of the Marvell PXA3xx processor family", would
> be a bit more useful.

It have take some times for me to find out what this option is for and
what kind of devices are supported by this option, so at least directfb
is something for the frame buffer the most people know the options are
of course depending on this frame buffer and graphic output related things.
So I think it's worth to explain a little bit more than just 'it's for
the Marvel PXA family foo ...'. But yes, we can discuss about the word
and formulation. ;)
I will rethink about that.

Regards
Carsten
Thomas Petazzoni - March 10, 2013, 1:13 p.m.
Dear Carsten Schoenert,

On Sun, 10 Mar 2013 13:21:06 +0100, Carsten Schoenert wrote:

> > Indentation is wrong. It should be one tab for "help" and one tab + two
> > spaces for the help text.
> 
> Hmm, I have to check my vim settings, sorry.
> What about modlines in thees files? This would be helpful and it's just
> a one-liner on top of this files.

I don't have a very strong opinion about this, but vim would require
one modeline, Emacs would require another one, some other $editor would
require yet a different one.

I guess it's rather up to your editor to understand that Config.in
should be treated with such or such mode.

> > In addition to that, I'm not sure the wording of the help text is so
> > useful. Something like "This option enables a graphics driver specific
> > to the graphics hardware of the Marvell PXA3xx processor family", would
> > be a bit more useful.
> 
> It have take some times for me to find out what this option is for and
> what kind of devices are supported by this option, so at least directfb
> is something for the frame buffer the most people know the options are
> of course depending on this frame buffer and graphic output related things.
> So I think it's worth to explain a little bit more than just 'it's for
> the Marvel PXA family foo ...'. But yes, we can discuss about the word
> and formulation. ;)
> I will rethink about that.

My only problem with your wording is that it was just the copy/paste
describing what the processor is. The reader may not necessarily see
the relation with the configuration option. So just keep your text, but
at the beginning at a sentence like "This option enables a graphics
driver blablabla".

Thomas

Patch

diff --git a/package/directfb/Config.in b/package/directfb/Config.in
index a184568..3d22e15 100644
--- a/package/directfb/Config.in
+++ b/package/directfb/Config.in
@@ -49,10 +49,27 @@  config BR2_PACKAGE_DIRECTFB_MATROX
 config BR2_PACKAGE_DIRECTFB_PXA3XX
 	bool "compile pxa3xx graphics driver"
 	depends on BR2_arm
+    help
+      The Marvell PXA3xx Processor Family is a system-on-chip based
+      on XScale® microarchitecture. The PXA3xx processor provide
+      high-performance multimedia, low-power capabilities, and rich
+      peripheral integration. The PXA3xx Processor Family provide
+      enhanced features compared to the PXA27x Processor Family, and
+      are the first Marvell applications processors to integrate a
+      hardware video accelerator unit.
+
+      http://www.marvell.com/application-processors/pxa-family/
 
 config BR2_PACKAGE_DIRECTFB_EP9X
 	bool "compile ep9x graphics driver"
 	depends on BR2_arm
+    help
+      The EP93xx ARMv9 based processors from Cirrus Logic are highly
+      integrated systems-on-a-chip that pave the way for a multitude
+      of next-generation consumer and industrial electronic products.
+
+      http://cirrus.com/en/products/arm9.html
+
 
 config BR2_PACKAGE_DIRECTFB_UNICHROME
 	bool "compile unichrome graphics driver"