Bug 10094 - Small suggested clarifications to the PACKAGES and FILES glossary entries
Summary: Small suggested clarifications to the PACKAGES and FILES glossary entries
Status: RESOLVED FIXED
Alias: None
Product: Reference
Classification: Documentation
Component: handbook (show other bugs)
Version: 2.2
Hardware: x86 Multiple
: Undecided normal
Target Milestone: 2.2 M4
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 08 August 2016: RESOLVED
Depends on:
Blocks:
 
Reported: 2016-08-05 02:47 UTC by ulfalizer
Modified: 2016-08-08 20:41 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description ulfalizer 2016-08-05 02:47:32 UTC
It's currently easy to miss how PACKAGES works w.r.t. files matching FILES for
many different packages. I suggest the following changes:

* Add this to the end of the PACKAGES glossary entry:

  During packaging, the [do_package] task goes through PACKAGES and uses the
  [FILES] variable corresponding to each package to assign files to the
  package. If a file matches the FILES variable for more than one package in
  PACKAGES, it will be assigned to the earliest (leftmost) one.

* Linkify PACKAGE_BEFORE_PN in the PACKAGES glossary entry.

* Add this to the end of the Note in the FILES glossary entry:

  You will also find the default value of the various FILES_* variables in this
  file.


Cheers,
Ulf
Comment 1 ulfalizer 2016-08-08 06:54:01 UTC
One small change:

  If a file matches the FILES variable for more than one package in
  PACKAGES, it will be assigned to the earliest (leftmost) package.

("package" instead of "one" at the end.)

Cheers,
Ulf
Comment 2 Scott Rifenbark 2016-08-08 16:25:09 UTC
Ulf, 

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-PACKAGES for PACKAGES.  Note that I did not "linkify" that variable in the example.  I try not to link variables in code examples.  If you feel the reference is really important, I can add a separate cross-reference to it outside of the code example.

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-FILES for the addition at the end of the note for the FILES variable.

Thanks, 
Scott
Comment 3 ulfalizer 2016-08-08 19:22:16 UTC
Looks good to me. I'm OK with not linkifying PACKAGE_BEFORE_PN.

Thanks,
Ulf
Comment 4 Scott Rifenbark 2016-08-08 20:41:36 UTC
Thanks... setting to RESOLVED and putting doc flag to "done".

Scott