[OE-core] [PATCH 1/2] classes/package: clarify installed-vs-shipped message

[Paul Eggleton]

On Monday 13 April 2015 19:02:13 Martin Jansa wrote:
> On Mon, Apr 13, 2015 at 05:46:03PM +0100, Paul Eggleton wrote:
> > On Monday 13 April 2015 18:28:28 Martin Jansa wrote:
> > > On Mon, Apr 13, 2015 at 04:44:52PM +0100, Paul Eggleton wrote:
> > > > Based on the number of times I've had to explain it over the years it
> > > > seems that a lot of new users don't immediately realise what is meant
> > > > by "shipped" here (nor should we expect them to) so let's at least
> > > > mention packaging and briefly tell the user what they need to do. (I
> > > > was
> > > > going to go into more detail in the message, but there is really more
> > > > detail than can be covered succinctly here.)
> > > > 
> > > > Signed-off-by: Paul Eggleton <paul.eggleton at linux.intel.com>
> > > > ---
> > > > 
> > > >  meta/classes/package.bbclass | 3 ++-
> > > >  1 file changed, 2 insertions(+), 1 deletion(-)
> > > > 
> > > > diff --git a/meta/classes/package.bbclass
> > > > b/meta/classes/package.bbclass
> > > > index 5558d0d..9790e9d 100644
> > > > --- a/meta/classes/package.bbclass
> > > > +++ b/meta/classes/package.bbclass
> > > > @@ -1132,12 +1132,13 @@ python populate_packages () {
> > > > 
> > > >                  unshipped.append(path)
> > > >      
> > > >      if unshipped != []:
> > > > -        msg = pn + ": Files/directories were installed but not
> > > > shipped"
> > > > +        msg = pn + ": Files/directories were installed but not
> > > > shipped in
> > > > any package:">
> > > > 
> > > >          if "installed-vs-shipped" in (d.getVar('INSANE_SKIP_' + pn,
> > > >          True)
> > 
> > or "").split():
> > > >              bb.note("Package %s skipping QA tests:
> > > >              installed-vs-shipped"
> > > >              % pn)
> > > >          
> > > >          else:
> > > >              for f in unshipped:
> > > >                  msg = msg + "\n  " + f
> > > > 
> > > > +            msg = msg + "\nPlease either set FILES such that these
> > > > items
> > > > are packaged, or alternatively delete them within do_install"
> > > 
> > > We should also mention the possibility to fix Makefile.am,
> > > CMakeLists.txt, ... not to install them in first place.
> > 
> > This is the sort of thing I was alluding to in the commit message, I'd
> > rather not get into too many specifics, or the message is going to end up
> > very long indeed covering all of the things you need to pay attention to.
> > That kind of thing is much better covered in the documentation.
> 
> OK, maybe I'm too sensitive for this, because recently I was fixing few
> recipes where do_install task was doing
> cp -ra ${S} ${D}
> and then INSANE_SKIP was used to ignore "patches" and ".pc" files
> "installed" in ${D} but luckily not included in any package.
> 
> So I fear that obvious fix after reading this message will be to delete
> "patches" and ".pc" directories in do_install instead of fixing the root
> cause.

OK fair enough, I guess we could say "Please set FILES such that these
items are packaged. Alternatively if they are unneeded, avoid installing them 
or delete them within do_install."

Cheers,
Paul

-- 

Paul Eggleton
Intel Open Source Technology Centre