Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Yann E. MORIN <yann.morin.1998@free.fr>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 3/3] weston: add help text for compositor backends
Date: Fri, 11 Oct 2013 23:17:43 +0200	[thread overview]
Message-ID: <20131011211743.GB29458@free.fr> (raw)
In-Reply-To: <1381525213-14034-3-git-send-email-arnout@mind.be>

Arnout, All,

On 2013-10-11 23:00 +0200, Arnout Vandecappelle (Essensium/Mind) spake thusly:
> Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
> ---
>  package/weston/Config.in | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/package/weston/Config.in b/package/weston/Config.in
> index ea0e87e..4322aaa 100644
> --- a/package/weston/Config.in
> +++ b/package/weston/Config.in
> @@ -42,8 +42,12 @@ config BR2_PACKAGE_WESTON_RPI
>  	depends on BR2_TOOLCHAIN_HAS_THREADS    # rpi-userland
>  	select BR2_PACKAGE_RPI_USERLAND
>  	select BR2_PACKAGE_WESTON_HAS_COMPOSITOR
> +	help
> +	  Compositor backend for the Raspberry Pi.
>  
>  config BR2_PACKAGE_WESTON_FBDEV
>  	bool "fbdev compositor"
> +	help
> +	  Compositor backend for the Linux framebuffer.

I am not sure adding such terse help entries is helpfull.

Surely "RPi compositor" is no less explicit than "Compositor backend for
the Raspberry Pi". Arguably, the prompt oculd be changed to "Raspberry Pi
compositor", which would be as much descriptive as the help entry.

Ditto for fbdev: the prompt is explicit enough, the help entry does not
add any value.

If I have to read a help entry, I expect to find more information than
the prompt provides. Just repeating the prompt (even in other trerms) is
just deceiving IMHO.

So, either we provide hepl entries that actually provide information
that can not fit in the prompt, or we do not provide help entries at
all.

Regards,
Yann E. MORIN.

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

  reply	other threads:[~2013-10-11 21:17 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-10-11 21:00 [Buildroot] [PATCH 1/3] weston: improve selection of compositor Arnout Vandecappelle
2013-10-11 21:00 ` [Buildroot] [PATCH 2/3] weston: add missing toolchain comments Arnout Vandecappelle
2013-10-11 21:10   ` Yann E. MORIN
2013-10-11 21:00 ` [Buildroot] [PATCH 3/3] weston: add help text for compositor backends Arnout Vandecappelle
2013-10-11 21:17   ` Yann E. MORIN [this message]
2013-10-11 21:23 ` [Buildroot] [PATCH 1/3] weston: improve selection of compositor Yann E. MORIN
2013-10-11 22:39 ` Yann E. MORIN
2013-10-12 10:58   ` Arnout Vandecappelle

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20131011211743.GB29458@free.fr \
    --to=yann.morin.1998@free.fr \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox