Re: [oe-commits] Scott Garman : Add missing SUMMARY fields to various recipes

Re: [oe-commits] Scott Garman : Add missing SUMMARY fields to various recipes

[Andreas Müller]

On Monday, December 19, 2011 10:34:47 AM git@git.openembedded.org wrote:
> Module: openembedded-core.git
> Branch: master
> Commit: e8c194a627e091ef9da3b7fa83ea3897bd283d9e
> URL:   
> http://git.openembedded.org/?p=openembedded-core.git&a=commit;h=e8c194a627
> e091ef9da3b7fa83ea3897bd283d9e
> 
> Author: Scott Garman <scott.a.garman@intel.com>
> Date:   Sun Dec 18 15:06:57 2011 -0800
> 
> Add missing SUMMARY fields to various recipes
> 
> This adds the SUMMARY field to the following recipes which were
> missing it:
> 
> * dosfstools
> * grep
> * icu
> * libevent
> * libnfsidmap
> * qemu-helper-nativesdk
> 
> Signed-off-by: Scott Garman <scott.a.garman@intel.com>
> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
> 
> ---
> 
>  .../nfs-utils/libnfsidmap_0.24.bb                  |    3 ++-
>  .../recipes-devtools/dosfstools/dosfstools_2.11.bb |    2 +-
>  .../qemu/qemu-helper-nativesdk_1.0.bb              |    3 ++-
>  meta/recipes-extended/grep/grep_2.9.bb             |    1 +
>  meta/recipes-support/icu/icu-3.6.inc               |    1 +
>  meta/recipes-support/libevent/libevent_1.4.14b.bb  |    3 ++-
>  6 files changed, 9 insertions(+), 4 deletions(-)
> 
> diff --git a/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb
> b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index
> 101ecab..eff75ec 100644
> --- a/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb
> +++ b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb
> @@ -1,4 +1,5 @@
> -DESCRIPTION = "nfs idmapping library"
> +SUMMARY = "NFS id mapping library"
> +DESCRIPTION = "NFS id mapping library"
>  HOMEPAGE = "http://www.citi.umich.edu/projects/nfsv4/linux/"
>  SECTION = "libs"
> 
> diff --git a/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb
> b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index
> ec75ac9..eca54f1 100644
> --- a/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb
> +++ b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb
> @@ -1,7 +1,7 @@
>  # dosfstools OE build file
>  # Copyright (C) 2004-2006, Advanced Micro Devices, Inc.  All Rights
> Reserved # Released under the MIT license (see packages/COPYING)
> -
> +SUMMARY = "DOS FAT Filesystem Utilities"
>  DESCRIPTION = "DOS FAT Filesystem Utilities"
> 
>  SECTION = "base"
> diff --git a/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb
> b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index
> a3dca3d..df0cae0 100644
> --- a/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb
> +++ b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb
> @@ -1,4 +1,5 @@
> -DESCRIPTION = "Qemu helper scripts from Poky"
> +SUMMARY = "Qemu helper scripts"
> +DESCRIPTION = "Qemu helper scripts"
>  LICENSE = "GPLv2"
>  RDEPENDS_${PN} = "qemu-nativesdk"
>  PR = "r9"
> diff --git a/meta/recipes-extended/grep/grep_2.9.bb
> b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644
> --- a/meta/recipes-extended/grep/grep_2.9.bb
> +++ b/meta/recipes-extended/grep/grep_2.9.bb
> @@ -1,3 +1,4 @@
> +SUMMARY = "GNU grep utility"
>  DESCRIPTION = "GNU grep utility"
>  HOMEPAGE = "http://savannah.gnu.org/projects/grep/"
>  BUGTRACKER = "http://savannah.gnu.org/bugs/?group=grep"
> diff --git a/meta/recipes-support/icu/icu-3.6.inc
> b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644
> --- a/meta/recipes-support/icu/icu-3.6.inc
> +++ b/meta/recipes-support/icu/icu-3.6.inc
> @@ -1,3 +1,4 @@
> +SUMMARY = "International Component for Unicode libraries"
>  DESCRIPTION = "The International Component for Unicode (ICU) is a mature,
> portable set of C/C++ and Java libraries for Unicode support, software
> internationalization (I18N) and globalization (G11N), giving applications
> the same results on all platforms." HOMEPAGE =
> "http://www-01.ibm.com/software/globalization/icu/index.jsp"
> 
> diff --git a/meta/recipes-support/libevent/libevent_1.4.14b.bb
> b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc
> 100644
> --- a/meta/recipes-support/libevent/libevent_1.4.14b.bb
> +++ b/meta/recipes-support/libevent/libevent_1.4.14b.bb
> @@ -1,4 +1,5 @@
> -DESCRIPTION = "an asynchronous event notification library"
> +SUMMARY = "An asynchronous event notification library"
> +DESCRIPTION = "An asynchronous event notification library"
>  HOMEPAGE = "http://www.monkey.org/~provos/libevent/"
>  SECTION = "libs"
> 
What is the value in creating redundancies by copying DESRCIPTION to SUMMARY?

Andreas

Re: [oe-commits] Scott Garman : Add missing SUMMARY fields to various recipes

[Mark Hatle]

On 12/19/11 3:54 AM, Andreas Müller wrote:
>> diff --git a/meta/recipes-support/libevent/libevent_1.4.14b.bb
>> b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc
>> 100644
>> --- a/meta/recipes-support/libevent/libevent_1.4.14b.bb
>> +++ b/meta/recipes-support/libevent/libevent_1.4.14b.bb
>> @@ -1,4 +1,5 @@
>> -DESCRIPTION = "an asynchronous event notification library"
>> +SUMMARY = "An asynchronous event notification library"
>> +DESCRIPTION = "An asynchronous event notification library"
>>   HOMEPAGE = "http://www.monkey.org/~provos/libevent/"
>>   SECTION = "libs"
>>
> What is the value in creating redundancies by copying DESRCIPTION to SUMMARY?

(related item, not the actual answer to your existion)

For those unfamiliar with the SUMMARY, it automatically inherits the 
DESCRIPTION.  In the original design of the SUMMARY field it was expected that a 
number of items already have "small" descriptions, so automatically inheriting 
made sense.

When I did the original pass for oe-core to add summaries, what I found is that 
many of the "DESCRIPTIONS" are really just summaries.  So (in the example 
above), I would have renamed the DESCRIPTION to summary, and put in a new, more 
detailed DESCRIPTION.

For instance (taking from Fedora):

DESCRIPTION = "The libevent API provides a mechanism to execute \
a callback function when a specific event occurs on a file \
descriptor or after a timeout has been reached. libevent is \
meant to replace the asynchronous event loop found in event \
driven network servers. An application just needs to call \
event_dispatch() and can then add or remove events dynamically \
without having to change the event loop."

So my suggestion is when the DESCRIPTION is small enough, there is no reason to 
add a duplicate SUMMARY.  However, it should be a trigger that the DESCRIPTION 
itself is likely just a summary, and a more explicit DESCRIPTION should be 
added.  (I always thing of a summary as "what is this in 74 charachters or 
less", and the DESCRIPTION is "why would I want this thing?")

--Mark

> Andreas
>
> _______________________________________________
> Openembedded-devel mailing list
> Openembedded-devel@lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel

Re: [oe-commits] Scott Garman : Add missing SUMMARY fields to various recipes

[Scott Garman]

On 12/19/2011 01:54 AM, Andreas Müller wrote:
> On Monday, December 19, 2011 10:34:47 AM git@git.openembedded.org wrote:
>> Module: openembedded-core.git
>> Branch: master
>> Commit: e8c194a627e091ef9da3b7fa83ea3897bd283d9e
>> URL:
>> http://git.openembedded.org/?p=openembedded-core.git&a=commit;h=e8c194a627
>> e091ef9da3b7fa83ea3897bd283d9e
>>
>> Author: Scott Garman<scott.a.garman@intel.com>
>> Date:   Sun Dec 18 15:06:57 2011 -0800
>>
>> Add missing SUMMARY fields to various recipes
>>
>> This adds the SUMMARY field to the following recipes which were
>> missing it:
>>
>> * dosfstools
>> * grep
>> * icu
>> * libevent
>> * libnfsidmap
>> * qemu-helper-nativesdk
>>
>> Signed-off-by: Scott Garman<scott.a.garman@intel.com>
>> Signed-off-by: Richard Purdie<richard.purdie@linuxfoundation.org>
>>
>> ---
>>
>>   .../nfs-utils/libnfsidmap_0.24.bb                  |    3 ++-
>>   .../recipes-devtools/dosfstools/dosfstools_2.11.bb |    2 +-
>>   .../qemu/qemu-helper-nativesdk_1.0.bb              |    3 ++-
>>   meta/recipes-extended/grep/grep_2.9.bb             |    1 +
>>   meta/recipes-support/icu/icu-3.6.inc               |    1 +
>>   meta/recipes-support/libevent/libevent_1.4.14b.bb  |    3 ++-
>>   6 files changed, 9 insertions(+), 4 deletions(-)
>>
>> diff --git a/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb
>> b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index
>> 101ecab..eff75ec 100644
>> --- a/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb
>> +++ b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb
>> @@ -1,4 +1,5 @@
>> -DESCRIPTION = "nfs idmapping library"
>> +SUMMARY = "NFS id mapping library"
>> +DESCRIPTION = "NFS id mapping library"
>>   HOMEPAGE = "http://www.citi.umich.edu/projects/nfsv4/linux/"
>>   SECTION = "libs"
>>
>> diff --git a/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb
>> b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index
>> ec75ac9..eca54f1 100644
>> --- a/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb
>> +++ b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb
>> @@ -1,7 +1,7 @@
>>   # dosfstools OE build file
>>   # Copyright (C) 2004-2006, Advanced Micro Devices, Inc.  All Rights
>> Reserved # Released under the MIT license (see packages/COPYING)
>> -
>> +SUMMARY = "DOS FAT Filesystem Utilities"
>>   DESCRIPTION = "DOS FAT Filesystem Utilities"
>>
>>   SECTION = "base"
>> diff --git a/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb
>> b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index
>> a3dca3d..df0cae0 100644
>> --- a/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb
>> +++ b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb
>> @@ -1,4 +1,5 @@
>> -DESCRIPTION = "Qemu helper scripts from Poky"
>> +SUMMARY = "Qemu helper scripts"
>> +DESCRIPTION = "Qemu helper scripts"
>>   LICENSE = "GPLv2"
>>   RDEPENDS_${PN} = "qemu-nativesdk"
>>   PR = "r9"
>> diff --git a/meta/recipes-extended/grep/grep_2.9.bb
>> b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644
>> --- a/meta/recipes-extended/grep/grep_2.9.bb
>> +++ b/meta/recipes-extended/grep/grep_2.9.bb
>> @@ -1,3 +1,4 @@
>> +SUMMARY = "GNU grep utility"
>>   DESCRIPTION = "GNU grep utility"
>>   HOMEPAGE = "http://savannah.gnu.org/projects/grep/"
>>   BUGTRACKER = "http://savannah.gnu.org/bugs/?group=grep"
>> diff --git a/meta/recipes-support/icu/icu-3.6.inc
>> b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644
>> --- a/meta/recipes-support/icu/icu-3.6.inc
>> +++ b/meta/recipes-support/icu/icu-3.6.inc
>> @@ -1,3 +1,4 @@
>> +SUMMARY = "International Component for Unicode libraries"
>>   DESCRIPTION = "The International Component for Unicode (ICU) is a mature,
>> portable set of C/C++ and Java libraries for Unicode support, software
>> internationalization (I18N) and globalization (G11N), giving applications
>> the same results on all platforms." HOMEPAGE =
>> "http://www-01.ibm.com/software/globalization/icu/index.jsp"
>>
>> diff --git a/meta/recipes-support/libevent/libevent_1.4.14b.bb
>> b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc
>> 100644
>> --- a/meta/recipes-support/libevent/libevent_1.4.14b.bb
>> +++ b/meta/recipes-support/libevent/libevent_1.4.14b.bb
>> @@ -1,4 +1,5 @@
>> -DESCRIPTION = "an asynchronous event notification library"
>> +SUMMARY = "An asynchronous event notification library"
>> +DESCRIPTION = "An asynchronous event notification library"
>>   HOMEPAGE = "http://www.monkey.org/~provos/libevent/"
>>   SECTION = "libs"
>>
> What is the value in creating redundancies by copying DESRCIPTION to SUMMARY?

Hi Andreas,

I did this because SUMMARY is a required field by the HOB UI. This was 
requested by Shane Wang on the oe-core ML:

http://lists.linuxtogo.org/pipermail/openembedded-core/2011-December/014600.html

For recipes which have short descriptions, there was little sense in 
summarizing them further, so I duplicated the DESCRIPTION field. Above 
you can also see an example (in the icu recipe) were I did summarize a 
long DESCRIPTION field.

Mark Hatle replied to this thread explaining why we previously allowed 
SUMMARY to be an optional field and how it automatically inherited from 
DESCRIPTION.

Let me know if you have further questions.

Regards,

Scott