Bug 10377 - Suggested change to make the SYSROOT_DIRS* variables more discoverable
Summary: Suggested change to make the SYSROOT_DIRS* variables more discoverable
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: 05 Oct 2016: RESOLVED
Depends on:
Blocks:
 
Reported: 2016-10-04 22:10 UTC by ulfalizer
Modified: 2016-10-05 18:13 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-10-04 22:10:01 UTC
Hello Scott,

These nifty variables (introduced in May) are only mentioned in the glossary.
They would be easier to find if they were also linked to from the description
of do_populate_sysroot.

I also noticed that the description of do_populate_sysroot has the same problem
that the STAGING_DIR_HOST glossary entry had: STAGING_DIR_HOST is not the
directory do_populate_sysroot uses for e.g. native recipes.

Here's some suggested changes to fix both issues:

 1. Replace the first paragraph of '8.1.23. do_populate_sysroot' with the
    following two paragraphs:

      Stages (copies) a subset of the files installed by the [do_install] task
      into the appropriate sysroot (see [STAGING_DIR_HOST]) to make them
      available to other recipes. Directories that would typically not be
      needed by other recipes at build time (e.g. /etc) are not copied by
      default.
      
      For information on what directories are copied by default, see the
      [SYSROOT_DIRS*](http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-SYSROOT_DIRS)
      variables. These variables can be changed inside your recipe if you need
      to make additional (or fewer) directories available to other recipes at
      build time.

 2. Replace the beginning of the SYSROOT_DIRS glossary entry with the
    following:

      Directories that are staged into the sysroot by the [do_populate_sysroot]
      task. By default, the following directories are staged:

 3. Replace the beginning of the SYSROOT_DIRS_BLACKLIST glossary entry with
    the following:

      Directories that are not staged into the sysroot by the
      [do_populate_sysroot] task. This variable is used to exclude certain
      subdirectories of directories listed in [SYSROOT_DIRS] from staging. By
      default, the following directories are not staged:

 4. Replace the beginning of the SYSROOT_DIRS_NATIVE glossary entry with the
    following:

      Extra directories staged into the sysroot by the [do_populate_sysroot]
      task for -native recipes, in addition to those specified in
      [SYSROOT_DIRS]. By default, the following extra directories are staged:


Cheers,
Ulf
Comment 1 ulfalizer 2016-10-04 22:13:02 UTC
Self-nit: Could say "listed" instead of "specified" to be a bit more casual.
Comment 3 ulfalizer 2016-10-05 17:46:39 UTC
This sounds a bit weird to me:

  For information on how to make these files available to other recipes, see
  the STAGING_DIR_HOST variable.

Maybe it could say "access" instead, like below:

  For information on how to access these files from other recipes, see the
  [STAGING_DIR*](http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-STAGING_DIR_HOST)
  variables.


Could this note be added to the end of the SYSROOT_DIRS_NATIVE entry too?

  Note {
  Programs built by -native recipes run directly from the sysroot
  ([STAGING_DIR_NATIVE]), which is why additional directories containing
  program executables and supporting files need to be staged.
  }


Cheers,
Ulf
Comment 5 ulfalizer 2016-10-05 18:09:25 UTC
STAGING_DIR_NATIVE could be linkified in the SYSROOT_DIRS_NATIVE glossary entry too. Other than that, it looks good to me!

Thanks,
Ulf
Comment 6 Scott Rifenbark 2016-10-05 18:13:42 UTC
Ulf, 

Sorry about that... completely blew that one.  It is fixed now.  I am also setting to RESOLVED and putting the doc flag to "done."

See http://www.yoctoproject.org/docs/2.2/ref-manual/ref-manual.html#var-SYSROOT_DIRS_NATIVE

Scott