Skip to contentSkip to conversation

Scott Garman : Add missing SUMMARY fields to various recipes

oe-commits Andreas Müller 7 participants 12 messages Dec 19, 2011 – Dec 20, 2011 1 message not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): 20111219093447.C6DBE10331@opal

Andreas Müller

author
#1 lore raw
Quoted 100 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] 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 <[email protected]>
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 <[email protected]>
Signed-off-by Richard Purdie <[email protected]>

---

 .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb line 5

Quoted 6 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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

#2 lore raw
Quoted 5 lines · Andreas Müller
Quoted 5 lines
(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb +0 -0
Quoted 8 lines

meta/recipes-support/libevent/libevent_1.4.14b.bb line 5

Quoted 7 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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

Quoted 6 lines

Andreas

_______________________________________________
Openembedded-devel mailing list
[email protected]
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel

#3 lore raw
In reply to Andreas Müller
Quoted 95 lines · Andreas Müller
Quoted 94 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] 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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

  .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

Quoted 13 lines

meta/recipes-support/libevent/libevent_1.4.14b.bb line 5

Quoted 12 lines
(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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

author
#4 lore raw
In reply to a message not in the archive
Quoted 100 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] 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 <[email protected]>
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 <[email protected]>
Signed-off-by Richard Purdie <[email protected]>

---

 .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb line 4

Quoted 5 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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?

Andreas

#5 lore raw
Quoted 108 lines · Andreas Müller
Quoted 100 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] 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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

  .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb line 4

Quoted 5 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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:

Quoted 2 lines

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.

Let me know if you have further questions.

Regards,

Scott

Signature · 3 lines
Scott Garman
Embedded Linux Engineer - Yocto Project
Intel Open Source Technology Center
#6 lore raw

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 116 lines · Andreas Müller
Quoted 108 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] wrote:
Quoted 100 lines

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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

 .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb line 4

Quoted 5 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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:

Quoted 2 lines

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,

Quoted 7 lines

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?

regards,

Koen

#7 lore raw
Quoted 121 lines · Koen Kooi

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 118 lines · Andreas Müller
Quoted 108 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] wrote:
Quoted 100 lines

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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

  .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb line 4

Quoted 5 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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:

Quoted 2 lines

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:

Quoted 7 lines
Quoted 5 lines

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?

Scott

Signature · 3 lines
Scott Garman
Embedded Linux Engineer - Yocto Project
Intel Open Source Technology Center
#8 lore raw
Quoted 136 lines · Scott Garman
Quoted 121 lines · Koen Kooi

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 118 lines · Andreas Müller
Quoted 108 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] wrote:
Quoted 100 lines

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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

   .../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc 100644

meta/recipes-support/libevent/libevent_1.4.14b.bb line 4

Quoted 5 lines
meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -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:

Quoted 2 lines

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:

Quoted 7 lines
Quoted 5 lines

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:

Quoted 7 lines

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

--Mark

Quoted 2 lines

Scott

#9 lore raw
Quoted 158 lines · Mark Hatle
Quoted 157 lines · Scott Garman
Quoted 138 lines · Koen Kooi

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 135 lines · Andreas Müller
Quoted 115 lines
Quoted 109 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] 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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

.../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc
100644

meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -1,4 +1,5 @@
-DESCRIPTION = "an asynchronous event notification library"
+SUMMARY = "An asynchronous event notification library"
+DESCRIPTION = "An asynchronous event notification library"
Quoted 2 lines

HOMEPAGE = "http://www.monkey.org/~provos/libevent/" SECTION = "libs"

Sorry I sent it to the wrong list so now again:

Quoted 3 lines

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.

Quoted 5 lines
Quoted 3 lines

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.

Quoted 9 lines
Quoted 2 lines

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

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?

my 2 cents

Sau!

Quoted 11 lines

--Mark

Quoted 2 lines

Scott

_______________________________________________
Openembedded-core mailing list
[email protected]
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-core

#10 lore raw
Quoted 159 lines · Saul Wold
Quoted 158 lines · Mark Hatle
Quoted 157 lines · Scott Garman
Quoted 138 lines · Koen Kooi

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 135 lines · Andreas Müller
Quoted 115 lines
Quoted 109 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] 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<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

.../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb index a3dca3d..df0cae0 100644

meta/recipes-devtools/qemu/qemu-helper-nativesdk_1.0.bb +2 -1
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-extended/grep/grep_2.9.bb index 08ac527..9099bed 100644

meta/recipes-extended/grep/grep_2.9.bb +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc
100644

meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -1,4 +1,5 @@
-DESCRIPTION = "an asynchronous event notification library"
+SUMMARY = "An asynchronous event notification library"
+DESCRIPTION = "An asynchronous event notification library"
Quoted 2 lines

HOMEPAGE = "http://www.monkey.org/~provos/libevent/" SECTION = "libs"

Sorry I sent it to the wrong list so now again:

Quoted 3 lines

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.

Quoted 5 lines
Quoted 3 lines

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.

Quoted 8 lines
Quoted 8 lines
Quoted 2 lines

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.

Quoted 6 lines

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

Quoted 16 lines

my 2 cents

Sau!

Quoted 11 lines

--Mark

Quoted 2 lines

Scott

_______________________________________________
Openembedded-core mailing list
[email protected]
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-core

#11 lore raw

Mark Hatle wrote on 2011-12-20:

Quoted 175 lines · Saul Wold
Quoted 6 lines · Mark Hatle
Quoted 5 lines · Scott Garman
Quoted 4 lines · Koen Kooi
Quoted 3 lines

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines · Andreas Müller
Quoted 7 lines
Quoted 5 lines · On Monday, December 19, 2011 10:34:47 AM [email protected] wrote:

Module: openembedded-core.git
Branch: master
Commit: e8c194a627e091ef9da3b7fa83ea3897bd283d9e
URL:

http://git.openembedded.org/?p=openembedded-core.git&a=commit;h=e8
c194a627

Quoted 98 lines
Quoted 98 lines
Quoted 98 lines
Quoted 98 lines
Quoted 98 lines
Quoted 97 lines
Quoted 90 lines

e091ef9da3b7fa83ea3897bd283d9e

Author: Scott Garman<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

.../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(-)
(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"

(quoted diff) +0 -0

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"

(quoted diff) +0 -0

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"

(quoted diff) +0 -0

b/meta/recipes-support/libevent/libevent_1.4.14b.bb index 1a369b5..36468dc
100644

meta/recipes-support/libevent/libevent_1.4.14b.bb +2 -1
@@ -1,4 +1,5 @@
-DESCRIPTION = "an asynchronous event notification library"
+SUMMARY = "An asynchronous event notification library"
+DESCRIPTION = "An asynchronous event notification library"
Quoted 2 lines

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?

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

(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/0
14600.html

Quoted 25 lines
Quoted 25 lines
Quoted 25 lines
Quoted 7 lines
Quoted 7 lines

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.

Quoted 5 lines
Quoted 3 lines

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.

Quoted 8 lines
Quoted 8 lines
Quoted 2 lines

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.

Quoted 6 lines

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.

Quoted 16 lines

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

Quoted 9 lines

my 2 cents

Sau!

Quoted 4 lines

--Mark

Quoted 2 lines

Scott

I agree with Mark at this point. Another case is what if a recipe has a summary but the summary starts with ${PN}? Extremely the summary *is* ${PN} version ${PV}-${PR}, then we get the description as the replacement, that is wrong.

HOB could get either summary or description or whatever, are both optional?

--
Shane

#12 lore raw
In reply to Scott Garman

Scott Garman wrote on 2011-12-20:

Quoted 145 lines · Koen Kooi
Quoted 5 lines

Op 19 dec. 2011, om 18:17 heeft Scott Garman het volgende geschreven:

Quoted 2 lines · Andreas Müller
Quoted 1 line

On Monday, December 19, 2011 10:34:47 AM

Quoted 5 lines · [email protected] wrote:
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines

Module: openembedded-core.git
Branch: master
Commit: e8c194a627e091ef9da3b7fa83ea3897bd283d9e
URL:

http://git.openembedded.org/?p=openembedded-core.git&a=commit;h=e8
c194a627

Quoted 71 lines
Quoted 71 lines
Quoted 71 lines
Quoted 71 lines

e091ef9da3b7fa83ea3897bd283d9e

Author: Scott Garman<[email protected]>
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<[email protected]>
Signed-off-by Richard Purdie<[email protected]>

---

  .../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(-)

(quoted diff) +0 -0

b/meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb index 101ecab..eff75ec 100644

meta/recipes-connectivity/nfs-utils/libnfsidmap_0.24.bb +2 -1
@@ -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"
(quoted diff) +0 -0

b/meta/recipes-devtools/dosfstools/dosfstools_2.11.bb index ec75ac9..eca54f1 100644

meta/recipes-devtools/dosfstools/dosfstools_2.11.bb +1 -1
@@ -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"
(quoted diff) +0 -0

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"

(quoted diff) +0 -0

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

Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

meta/recipes-support/icu/icu-3.6.inc line 2

Quoted 8 lines

BUGTRACKER = "http://savannah.gnu.org/bugs/?group=grep"

(quoted diff) +0 -0

b/meta/recipes-support/icu/icu-3.6.inc index 8fadc92..e3f9dd2 100644

meta/recipes-support/icu/icu-3.6.inc +1 -0
@@ -1,3 +1,4 @@
+SUMMARY = "International Component for Unicode libraries"
  DESCRIPTION = "The International Component for Unicode (ICU) is

a mature,

Quoted 20 lines
Quoted 20 lines
Quoted 19 lines
Quoted 6 lines

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"

(quoted diff) +0 -0
Quoted 9 lines

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?

Quoted 8 lines
Quoted 8 lines

(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/0
14600.html

Quoted 2 lines
Quoted 2 lines

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.

Quoted 2 lines
Quoted 2 lines

Mark Hatle replied to this thread explaining why we previously allowed

SUMMARY to be an optional field and how it automatically inherited from DESCRIPTION.

Quoted 2 lines

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

Quoted 7 lines

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?

Scott

I don't why. From the HOB 1.1 code, it started to use SUMMARY instead of DESCRIPTION. Is DESCRIPTION required for a recipe?

--
Shane