Patchwork [v1] recipes: convert remaining SUMMARY/DESCRIPTION cosmetic issues

login
register
mail settings
Submitter Matthieu CRAPET
Date Feb. 14, 2014, 4:34 p.m.
Message ID <1392395660-28806-1-git-send-email-Matthieu.Crapet@ingenico.com>
Download mbox | patch
Permalink /patch/66765/
State New
Headers show

Comments

Matthieu CRAPET - Feb. 14, 2014, 4:34 p.m.
Rename SUMMARY with length > 80 to DESCRIPTION.
Note: don't bump PR

Signed-off-by: Matthieu Crapet <Matthieu.Crapet@ingenico.com>
---
 meta/recipes-bsp/hostap/hostap-conf_1.0.bb           |  3 ++-
 meta/recipes-devtools/json-c/json-c_0.11.bb          |  3 ++-
 meta/recipes-graphics/xorg-proto/presentproto_git.bb | 14 ++++++--------
 meta/recipes-multimedia/x264/x264_git.bb             |  3 ++-
 4 files changed, 12 insertions(+), 11 deletions(-)
Matthieu CRAPET - Feb. 14, 2014, 4:42 p.m.
Hi, 

Few explanations ;) Seen in:
https://wiki.yoctoproject.org/wiki/Janitors

Didn't find any opened bugtracker.

These recipes are "pending", i.e. 80 < len(SUMMARY) < 95:

meta/recipes-support/libunistring/libunistring_0.9.3.bb
meta/recipes-devtools/devel-config/nfs-export-root.bb
meta/recipes-devtools/autogen/autogen-native_5.18.2.bb

Should I translate them to DESCRIPTION ?

Regards,
Matthieu
Paul Eggleton - Feb. 14, 2014, 4:56 p.m.
Hi Matthieu,

Thanks for looking at this.

On Friday 14 February 2014 16:42:33 Matthieu CRAPET wrote:
> Few explanations ;) Seen in:
> https://wiki.yoctoproject.org/wiki/Janitors
> 
> Didn't find any opened bugtracker.
> 
> These recipes are "pending", i.e. 80 < len(SUMMARY) < 95:
> 
> meta/recipes-support/libunistring/libunistring_0.9.3.bb
> meta/recipes-devtools/devel-config/nfs-export-root.bb
> meta/recipes-devtools/autogen/autogen-native_5.18.2.bb
> 
> Should I translate them to DESCRIPTION ?

If you add a shorter SUMMARY at the same time, sure. Having a reasonable 
SUMMARY is more important than DESCRIPTION, IMO.

Cheers,
Paul

Patch

diff --git a/meta/recipes-bsp/hostap/hostap-conf_1.0.bb b/meta/recipes-bsp/hostap/hostap-conf_1.0.bb
index 0208509..e2c7cc0 100644
--- a/meta/recipes-bsp/hostap/hostap-conf_1.0.bb
+++ b/meta/recipes-bsp/hostap/hostap-conf_1.0.bb
@@ -1,4 +1,5 @@ 
-SUMMARY = "PCMCIA-cs configuration files for wireless LAN cards based on Intersil's Prism2/2.5/3 chipset"
+SUMMARY = "Configuration files for HostAP (wifi) driver"
+DESCRIPTION = "PCMCIA-cs configuration files for wireless LAN cards based on Intersil's Prism2/2.5/3 chipset."
 SECTION = "kernel/modules"
 LICENSE = "GPLv2"
 LIC_FILES_CHKSUM = "file://COPYING;md5=393a5ca445f6965873eca0259a17f833"
diff --git a/meta/recipes-devtools/json-c/json-c_0.11.bb b/meta/recipes-devtools/json-c/json-c_0.11.bb
index d1bf0e9..389e0f9 100644
--- a/meta/recipes-devtools/json-c/json-c_0.11.bb
+++ b/meta/recipes-devtools/json-c/json-c_0.11.bb
@@ -1,4 +1,5 @@ 
-SUMMARY = "JSON-C implements a reference counting object model that allows you to easily construct JSON objects in C"
+SUMMARY = "C bindings for apps which will manipulate JSON data"
+DESCRIPTION = "JSON-C implements a reference counting object model that allows you to easily construct JSON objects in C."
 HOMEPAGE = "https://github.com/json-c/json-c/wiki"
 LICENSE = "MIT"
 LIC_FILES_CHKSUM = "file://COPYING;md5=de54b60fbbc35123ba193fea8ee216f2"
diff --git a/meta/recipes-graphics/xorg-proto/presentproto_git.bb b/meta/recipes-graphics/xorg-proto/presentproto_git.bb
index 007824f..bd6c60a 100644
--- a/meta/recipes-graphics/xorg-proto/presentproto_git.bb
+++ b/meta/recipes-graphics/xorg-proto/presentproto_git.bb
@@ -1,13 +1,11 @@ 
 require xorg-proto-common.inc
 
-SUMMARY = "The Present extension provides a way for applications to update their \
-           window contents from a pixmap in a well defined fashion, synchronizing \
-           with the display refresh and potentially using a more efficient \
-           mechanism than copying the contents of the source pixmap.\
-          "
-
-DESCRIPTION = "This package provides the basic headers for the X Window \
-System."
+SUMMARY = "This package provides the basic headers for the X Window System"
+DESCRIPTION = "The Present extension provides a way for applications to update their \
+               window contents from a pixmap in a well defined fashion, synchronizing \
+               with the display refresh and potentially using a more efficient \
+               mechanism than copying the contents of the source pixmap.\
+              "
 
 LICENSE = "GPLv2"
 
diff --git a/meta/recipes-multimedia/x264/x264_git.bb b/meta/recipes-multimedia/x264/x264_git.bb
index 406df30..5ebf885 100644
--- a/meta/recipes-multimedia/x264/x264_git.bb
+++ b/meta/recipes-multimedia/x264/x264_git.bb
@@ -1,4 +1,5 @@ 
-SUMMARY = "A free software library and application for encoding video streams into the H.264/MPEG-4 AVC format"
+SUMMARY = "H.264/MPEG-4 AVC video encoder"
+DESCRIPTION = "A free software library and application for encoding video streams into the H.264/MPEG-4 AVC format."
 HOMEPAGE = "http://www.videolan.org/developers/x264.html"
 
 LICENSE = "GPLv2"