summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-11-18 14:34:46 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-11-23 11:10:35 +0000
commit479fbee8408d1b4d3829377b040f4f1e6457b418 (patch)
tree63866758598b2e3347db59687347fccf14731d20 /documentation
parent8028d253a078f3abeb9b6654a366accc06274e09 (diff)
downloadpoky-479fbee8408d1b4d3829377b040f4f1e6457b418.tar.gz
ref-manual, dev-manual: Added references to SYSROOT_DIRS
Fixes [YOCTO #10692] I updated the STAGING_DIR variable description to have a reference to the SYSROOT_DIRS variable as well as the "Sharing Files Between Recipes" section of the dev-manual. I also updated the "Sharing Files Between Recipes" section so that the role of SYSROOT_DIRS is explained and actually used in an example to add another directory. (From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml24
-rw-r--r--documentation/ref-manual/ref-variables.xml15
2 files changed, 34 insertions, 5 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 55a2995519..39ce2a2497 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2891,9 +2891,9 @@
2891 machine, and a sysroot exists for the build host. 2891 machine, and a sysroot exists for the build host.
2892 <note> 2892 <note>
2893 You could find the term "staging" used within the Yocto 2893 You could find the term "staging" used within the Yocto
2894 project regarding files populating sysroot. 2894 project regarding files populating sysroot (e.g. the
2895 The term "staging" was used for previous releases of 2895 <ulink url='&YOCTO_DOCS_REF_URL;#var-STAGING_DIR'><filename>STAGING_DIR</filename></ulink>
2896 the Yocto Project. 2896 variable).
2897 </note> 2897 </note>
2898 </para> 2898 </para>
2899 2899
@@ -2906,7 +2906,12 @@
2906 task within the 2906 task within the
2907 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink><filename>}</filename> 2907 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink><filename>}</filename>
2908 directory. 2908 directory.
2909 A subset of these files automatically populates the sysroot. 2909 </para>
2910
2911 <para>
2912 A subset of these files, as defined by the
2913 the <ulink url='&YOCTO_DOCS_REF_URL;#var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></ulink>
2914 variable, automatically populates the sysroot.
2910 The reason for this limitation is that almost all files that 2915 The reason for this limitation is that almost all files that
2911 populate the sysroot are cataloged in manifests in order to 2916 populate the sysroot are cataloged in manifests in order to
2912 ensure the files can be removed later when a recipe is either 2917 ensure the files can be removed later when a recipe is either
@@ -2915,6 +2920,17 @@
2915 </para> 2920 </para>
2916 2921
2917 <para> 2922 <para>
2923 It is possible to modify the list of directories that populate
2924 the sysroot.
2925 The following example shows how you could add the
2926 <filename>/opt</filename> directory to the list of
2927 directories:
2928 <literallayout class='monospaced'>
2929 SYSROOT_DIRS += "/opt"
2930 </literallayout>
2931 </para>
2932
2933 <para>
2918 For information on variables you can use to help control how 2934 For information on variables you can use to help control how
2919 files sysroot is populated, see the 2935 files sysroot is populated, see the
2920 <ulink url='&YOCTO_DOCS_REF_URL;#var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></ulink>, 2936 <ulink url='&YOCTO_DOCS_REF_URL;#var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></ulink>,
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9d6fab0c94..af1ed8408b 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -12692,9 +12692,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
12692 Specifies the path to the top-level sysroots directory 12692 Specifies the path to the top-level sysroots directory
12693 (i.e. 12693 (i.e.
12694 <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots</filename>). 12694 <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots</filename>).
12695 </para>
12696
12697 <para>
12698 <filename>STAGING_DIR</filename> contains the directories
12699 that are staged into the sysroot by the
12700 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
12701 task.
12702 See the
12703 <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link>
12704 variable and the
12705 "<ulink url='&YOCTO_DOCS_DEV_URL;#new-sharing-files-between-recipes'>Sharing Files Between Recipes</ulink>"
12706 section for more information.
12695 <note> 12707 <note>
12696 Recipes should never write files directly under 12708 Recipes should never write files directly under
12697 this directory because the OpenEmbedded build system 12709 the <filename>STAGING_DIR</filename> directory because
12710 the OpenEmbedded build system
12698 manages the directory automatically. 12711 manages the directory automatically.
12699 Instead, files should be installed to 12712 Instead, files should be installed to
12700 <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> 12713 <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>