[meta-freescale] [meta-fsl-arm][PATCH] linux: Add DESCRIPTION for some kernel recipes

[Daiane.Angolini at freescale.com]

> -----Original Message-----
> From: otavio.salvador at gmail.com [mailto:otavio.salvador at gmail.com] On
> Behalf Of Otavio Salvador
> Sent: Wednesday, March 26, 2014 3:55 PM
> To: Angolini Daiane-B19406
> Cc: meta-freescale at yoctoproject.org
> Subject: Re: [meta-freescale] [meta-fsl-arm][PATCH] linux: Add DESCRIPTION
> for some kernel recipes
> 
> Hello Daiane,
> 
> On Wed, Mar 26, 2014 at 3:27 PM, Daiane Angolini
> <daiane.angolini at freescale.com> wrote:
> > The DESCRIPTION content may be used in Release Notes to describe the
> > each kernel provider.
> >
> > Signed-off-by: Daiane Angolini <daiane.angolini at freescale.com>
> 
> Great! I fully agree.
> 
> Use SUMMARY as the descriptions here are small. DESCRIPTION is used for
> long and detailed description of a package and this has different visuals
> in Hob and Toaster. So use SUMMARY.

Do you think "a small description" is good enough to be in release notes?


Daiane
> 
> > ---
> >  recipes-kernel/linux/linux-fslc.inc    | 2 +-
> >  recipes-kernel/linux/linux-imx.inc     | 4 ++--
> >  recipes-kernel/linux/linux-mfgtool.inc | 2 ++
> >  3 files changed, 5 insertions(+), 3 deletions(-)
> >
> > diff --git a/recipes-kernel/linux/linux-fslc.inc
> > b/recipes-kernel/linux/linux-fslc.inc
> > index 19acec1..9d58b7e 100644
> > --- a/recipes-kernel/linux/linux-fslc.inc
> > +++ b/recipes-kernel/linux/linux-fslc.inc
> > @@ -1,7 +1,7 @@
> >  # Copyright (C) 2012-2014 O.S. Systems Software LTDA.
> >  # Released under the MIT license (see COPYING.MIT for the terms)
> >
> > -DESCRIPTION = "Freescale Community mainline based Linux kernel"
> > +DESCRIPTION = "Freescale Community mainline based Linux kernel, with
> backported fixes"
> 
> I'd use
> 
> SUMMARY = "Linux mainline based kernel with backported features and fixes"
> 
> ...
> > diff --git a/recipes-kernel/linux/linux-mfgtool.inc
> > b/recipes-kernel/linux/linux-mfgtool.inc
> > index 2b1ebf0..54fd8a3 100644
> > --- a/recipes-kernel/linux/linux-mfgtool.inc
> > +++ b/recipes-kernel/linux/linux-mfgtool.inc
> > @@ -8,6 +8,8 @@
> >  #
> >  # Copyright (C) 2014 O.S. Systems Software LTDA.
> >
> > +DESCRIPTION_append = " that produces a Manufacturing Tool compatible
> Linux Kernel"
> > +
> 
> I'd add it in the kernel recipe bb file, not in the .inc. We shouldn't
> guess the description for the user.
> 
> Apart from that the patch is nice. This does simplifies our release notes
> maintenance in long term. :-)
> 
> --
> Otavio Salvador                             O.S. Systems
> http://www.ossystems.com.br        http://code.ossystems.com.br
> Mobile: +55 (53) 9981-7854            Mobile: +1 (347) 903-9750
>