Bug 1804

Created attachment 299 [details]
summary missing list

attach the TODO list for SUMMARY in recipes

According to the comments from the community, the community will not add summary for each recipe since it is optional but description is required. Hob2 is going to use description instead of summmary.

However, in the latest video made by Belen, both summary and description disappeared. So Hob2 will not use summary and description. Mark this bug as "Resolved".

(In reply to comment #2)
> However, in the latest video made by Belen, both summary and description
> disappeared. So Hob2 will not use summary and description. Mark this bug as
> "Resolved".

From Belen's email to the Yocto project list it seems like the second video missed this as the design was already settled, not because the functionality is to be removed.

Just to clarify: videos show relevant functionality to a specific design piece. The fact that a video does not show something it doesn't mean the functionality has gone away. If I showed everything on each video they would be very very long (and very very boring) videos.  I hope this explains. 

Given the time constraints we have, the little design documentation I am producing is incomplete. Therefore, it is very important that if you have any questions, doubts, thoughts, feedback, general comments etc about the Hob UI, you get in touch with me. Even if the question sounds very small or trivial: that's what I am here for.

Cheers

Belen

OK, mark it as "REOPEN" to include descriptions.

Give it to Alex for him to reassign to the team.

I think we can mark this as a duplicate of 

https://bugzilla.yoctoproject.org/show_bug.cgi?id=2248

That bug coves how all information about variables, packages and recipes will be displayed using property windows and information alerts. See this document:

https://bugzilla.yoctoproject.org/attachment.cgi?id=737

I think we shouldn't dismiss the idea of getting SUMMARY set appropriately for all recipes; not sure if we need to create a separate bug for that.

I've opened a new bug for the recipe's SUMMARY

https://bugzilla.yoctoproject.org/show_bug.cgi?id=3291

(In reply to comment #8)
> I think we shouldn't dismiss the idea of getting SUMMARY set appropriately
> for all recipes; not sure if we need to create a separate bug for that.

So whre are we at this issue? Do we have DESCRIPTION set for all recipes? If not, can we generate a list of ones we need to do this with? No movement on this since Oct is bad.

A cursory check of the upcoming layer index web app database extracted from the metadata tells me that we still have work to do here; most recipes do have DESCRIPTION set but some of the descriptions aren't particularly useful and there are still those that don't have them (e.g. packagegroup-core-x11-xserver, gnome-doc-utils) or only set SUMMARY where there could be an appropriate longer description in DESCRIPTION.

I'd like to think that when the layer index web app becomes available and people start using it these missing/poor description values will become more apparent; having the data available should allow us to find these more easily although as yet there is no exposed interface to query for blank values. I've thought about adding tools within the app to facilitate editing these fields and automatically producing patches as output but of course that will take some additional engineering.

Kind of related, bug 2248 addresses the presentation of this information in Hob. I believe a patch has been submitted, but the bug status has not been updated, so I don't know if it's been merged.

Reassigned to Belen. She'll take up with Scott R to determine the best format for the SUMMARY/DESCRIPTION fields,and then help us out with updating recipes to standard.

*** Bug 3291 has been marked as a duplicate of this bug. ***

I've started from recipes that have neither summary nor description (see the list below). I have 2 sets of recipes: complete and incomplete ones. For the incomplete recipes we need help from Paul / Alex: they might be able to fill the gaps (if needed). The complete recipes should be reviewed by Scott. 

Thanks!

INCOMPLETE RECIPES
Alex / Paul: can you fill the gaps? Otherwise, I'll try something else.

= Recipe =
core-image-directfb
= Summary = 
An image that uses directfb instead of X11. 
= Description =
= Homepage =
= Some comments =
This image seems to have replaced core-image-gtk-directfb. The latest reference manual still lists the old name and description (http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html#ref-images), so a description for this image could be reused for the manual as well. 

= Recipe =
eglibc-locale
= Summary = 
Compile locale definition files
= Description =
= Homepage =
http://www.eglibc.org

= Recipe =
gettext-minimal-native
= Summary = 
A set of pre built gettext .m4 macros
= Description =
When analysing our build performance, its apparent that binutils-cross takes an age to get built. This is due to its dependencies on flex-native and bison-native which in turn depend on gettext-native. gettext-native is problematic as it has a significant dependency chain of its own and takes an age to build. What is worse is that we never care about the native language support in -native and -cross packages since we always force the C locale. This patch therefore disables nls for all -native packages (its already disabled for -cross) and adds a new gettext-minimal-native package which contains the m4 macros to keep autoconf/automake happy. This means we gain a significant build time speedup by the removal of gettext-native from most dependency chains (only being part of gettext for the target now).
= Homepage =
= Some comments =
This recipe seems to have been created by RP for performance reasons. The above description is just a copy / paste from the patch (http://cgit.openembedded.org/openembedded-core/commit/meta/recipes-core/gettext?id=01b2a16beb4a924077b74943ad4d6e7976563ff1). It's a bit hard for me to rewrite this as a proper description. Maybe Scott can help.

= Recipe =
packagegroup-core-x11-xserver
= Summary = 
= Description =
= Homepage =
= Some comments =
I could find absolutely nothing about this package group :(

= Recipe =
ptest-runner
= Summary = 
A simple shell script which searches for all installed ptests on the rootfs and runs each test in sequence.
= Description =
= Homepage =


COMPLETE RECIPES

= Recipe = 
connman-conf
= Summary =
ConnMan configuration to set up a Wired network interface in any qemu machine
= Description = 
This is the ConnMan configuration to set up a Wired network interface in a qemu machine. The ConnMan project provides a daemon for managing internet connections within embedded devices running the Linux operating system.
= Homepage = 
http://connman.net/

= Recipe = 
external-sourcery-toolchain
= Summary =
Yocto/OE metadata for the external Sourcery G++ toolchain
= Description =
Lite version of the Sourcery G++ toolchain for ARM GNU/Linux EABI processors.
= Homepage = 
http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/

= Recipe =
gnome-doc-utils
= Summary =
A collection of documentation utilities for the Gnome project.
= Description = 
The GNOME Documentation Build Utilities (gnome-doc-utils) were created to make it easier for application developers to include and create documentation in their releases. They include the xml2po tool which makes it easier to translate and keep up to date translations of documentation. There are several advantages to using gnome-doc-utils in your application:
1. Translation is made much easier through the use of xml2po, which generates standard .po files from docbook/xml.
2. OMF file creation is automated from a template file for all translated languages.
3. Installation of documentation is automated.
= Homepage = 
https://developer.gnome.org/gnome-doc-make/0.20/index.html.en

= Recipe =
gst-openmax
= Summary = 
A GStreamer plug-in for communication with OpenMAX IL components.
= Description =
GstOpenMAX is a GStreamer plug-in that allows communication with OpenMAX Integration Layer (IL) components. OpenMAX IL is an industry standard that provides an abstraction layer for computer graphics, video, and sound routines. The OpenMAX IL API defines a standardized media component interface to enable developers and platform providers to integrate and communicate with multimedia codecs implemented in hardware or software.
= Homepage =
http://freedesktop.org/wiki/GstOpenMAX

= Recipe =
icon-naming-utils
= Summary = 
A Perl script used for maintaining backwards compatibility with current desktop icon themes, while migrating to the names specified in the Icon Naming Specification.
= Description =
The Icon Naming Utilities map the icon names used by the GNOME and KDE desktops to the icon names proposed in the Icon Naming Specification, and generate the icon files appropriate to the desktop environment you use. The Icon Naming Specification provides a standard list of common icon contexts and names that can be used by icon theme authors to make their themes work in a desktop environment or application that implements the naming specification. More information at http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
= Homepage =
http://tango.freedesktop.org/Installation#Icon_Naming_Utilities

= Recipe =
libxml-simple-perl
= Summary = 
Perl module for reading and writing XML.
= Description =
The XML::Simple Perl module provides a simple API layer on top of an underlying XML parsing module to maintain XML files (especially configuration files). It is a blunt rewrite of XML::Simple (by Grant McLean) to use the XML::LibXML parser for XML structures, where the original uses plain Perl or SAX parsers.
= Homepage =
http://search.cpan.org/~markov/XML-LibXML-Simple-0.93/lib/XML/LibXML/Simple.pod

Paul and Belen,

Move this one to 1.5 unless you think it's resolved.

Belen, where are we with this list, I think we might need some additional 
documenation from ScottR, and I need to look at ensuring any additional changes 
are needed for existing recipes.

I think most of Belen's DESCRIPTION/SUMMARY changes referred to above have gone in already. I'm fairly sure we still have some improvements left to make though.

It's worth pointing out that we now have the ability to use the "Bulk Change" function in the layer index for doing easy edits to these fields, producing patches as the result (account required):

http://layers.openembedded.org/layerindex/bulkchange/

Looking at this again, I wrote a simple tinfoil based script (stole the 
packageconfig script) that checks for DESCRIPTION and SUMMARY in all the 
recipes and that SUMMARY is less than 72 character's long.  Based on that 
script everything seems correct, I will clean that script up and submit it to 
the scripts/contrib directory.

FYI I have a fairly comprehensive patch series prepared to change short DESCRIPTION values to SUMMARY values, add some missing SUMMARY values and a load of other cleanups. I'll send the series once I've had a chance to make sure I haven't broken anything.

The aforementioned patch series has just been sent.

Numerous recipes have been updated, this will be closed and a new bug entry will be opened for a tinfoil based script

Hi, 

The descriptions for the SUMMARY and DESCRIPTION variables are adequate.  I am marking the documentation flag as "No."

Scott

Verified in Hob
poky 52b788c6df9201764130ab744bf67b770b24b896