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

Mon Dec 19 18:10:20 UTC 2011

On 12/19/11 12:00 PM, Saul Wold wrote:
> On 12/19/2011 09:44 AM, Mark Hatle wrote:
>> On 12/19/11 11:28 AM, Scott Garman wrote:
>>> On 12/19/2011 09:21 AM, Koen Kooi wrote:
>>>>
>>>> Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:
>>>>
>>>>> On 12/19/2011 04:37 AM, Andreas Müller wrote:
>>>>>> On Monday, December 19, 2011 10:34:47 AM git at 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 at 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 at intel.com>
>>>>>>> Signed-off-by: Richard Purdie<richard.purdie at 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"
>>>>>> Sorry I sent it to the wrong list so now again:
>>>>>>
>>>>>> What is the value - apart HOB's sake - in creating redundancies by
>>>>>> copying
>>>>>> DESRCIPTION to SUMMARY? Why not use DESCRIPTION?
>>>>>
>>>>> (this is a copy of the email I sent to the oe-devel ML):
>>>>>
>>>>> 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.
>>>>
>>>> So if it's automatically inherited why are these patches duplicating it?
>>>
>>> Hi Koen,
>>>
>>> Ah, I see why this is still confusing.
>>>
>>> Shane wrote:
>>>
>>> "If the summary is missing, bitbake will create a default value for
>>> summary. That is PN plus string " version " plus its version."
>>>
>>> So apparently the HOB UI isn't actually "inheriting" the DESCRIPTION
>>> field.
>>>
>>> Shane and Mark: can you clarify what the intended behavior is? Why would
>>> the HOB UI not inherit DESCRIPTION?
>>
>> I don't know. Within the bitbake.conf there is:
>>
>> DESCRIPTION ?= "${SUMMARY}"
>>
>> So it should just work...

I just realized, I had it backwards.. DESCRIPTION automatically inherits SUMMARY 
if SUMMARY is empty..  SUMMARY thought is simply the version string.

> It does work just not what HOB is looking for, HOB seems to be looking
> for a SUMMARY not DESCRIPTION first.  So if there is no SUMMARY HOB gets
> the bitbake.conf default of: SUMMARY ?= "${PN} version ${PV}-${PR}"
>
> Maybe HOB can be fixed to check if the ${SUMMARY} first word is ${PN}
> then use ${DESCRIPTION} instead of requiring all recipes have a SUMMARY?

Hmm..  I don't think that is the right solution.  If HOB wants a SUMMARY then 
SUMMARY is correct.. if it want's more descriptive info then it should go to 
DESCRIPTION.

It sounds like these packages either need the DESCRIPTION changed to SUMMARY -- 
or we need to change the way we're inheriting the variables.  It's been too long 
now since the original implementation to remember all of the permutations...

--Mark

> my 2 cents
>
> Sau!
>
>
>> --Mark
>>
>>> Scott
>>>
>>
>>
>> _______________________________________________
>> Openembedded-core mailing list
>> Openembedded-core at lists.openembedded.org
>> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-core
>>