Bug 10135 - Some small mostly package-related nits
Summary: Some small mostly package-related nits
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: 12 July 2016: RESOLVED
Depends on:
Blocks:
 
Reported: 2016-08-12 14:14 UTC by ulfalizer
Modified: 2016-08-12 21:49 UTC (History)
3 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-12 14:14:01 UTC
Some small mostly package-related nits

Hello! Some small (too small for separate bugs) documentation nits below:


* The FILES variable is closely linked to the PACKAGES variable, but
the FILES glossary entry does not mention it at all. The first sentence of the
FILES glossary entry could be replaced by this:

  The list of files and directories that are placed in a package. The
  [PACKAGES] variable lists the packages generated by a recipe.


* The FILES glossary entry has a path with a redundant '/' at the end. This is
a personal pet peeve because it means you often end up with ugly stuff like
"//", plus people start thinking all directory paths have to end with '/'.
Here's the fixed version:

  FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile"


* In '2.3.3. Running Specific Tasks', instead of saying "any given package
consists of a set of tasks", it would be better to say "any given recipe
consists of a set of tasks". People often confuse packages and recipes.


* There's another redundant '/' in '5.3.18.3. Makefile-Based Package' in the
development manual. Instead of

  S = "${WORKDIR}/git/"

it could just say

  S = "${WORKDIR}/git"


Cheers,
Ulf
Comment 1 Scott Rifenbark 2016-08-12 21:15:13 UTC
Hi, 

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-FILES for the changes to the FILES glossary entry

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#usingpoky-debugging-taskrunning for the change to "Running Specific Tasks" section.

See http://www.yoctoproject.org/docs/2.2/dev-manual/dev-manual.html#new-recipe-makefile-based-package for the change in the dev-manual.

Thanks, 
Scott
Comment 2 ulfalizer 2016-08-12 21:19:19 UTC
Looks good to me.

Thanks,
Ulf
Comment 3 Scott Rifenbark 2016-08-12 21:49:34 UTC
Awesome!

Setting to RESOLVED and turning the flag off for docs.

scott