summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-05 11:19:15 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:08:06 -0800
commit4db23d60007d06197b9387555efc503398655b19 (patch)
tree38b6c4f5d13df36460ca17fccd28742710af11aa /documentation
parentc38b2de6305ea192096c0c9cad04bd12237f2fc1 (diff)
downloadpoky-4db23d60007d06197b9387555efc503398655b19.tar.gz
documentation/poky-ref-manual/ref-variables.xml: New glossary entries
Added glossary entries for FILESPATH and FILESEXTRAPATHS. Although the user is not supposed to manually edit FILESPATH, the entry is necessary I feel in order to better understand the FILESEXTRAPATHS variable. (From yocto-docs rev: 67357174148859ace6bf605c3ebc0bf49b761753) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml65
1 files changed, 65 insertions, 0 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index fe1c63528c..8356cb4a5c 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -613,6 +613,71 @@
613 </glossdef> 613 </glossdef>
614 </glossentry> 614 </glossentry>
615 615
616 <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm>
617 <glossdef>
618 <para>
619 Extends the search path the Yocto Project build system uses when
620 looking for files and patches as it processes recipes.
621 The directories BitBake uses when it processes recipes is defined by the
622 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> variable.
623 You can add directories to the search path by defining the
624 <filename>FILESEXTRAPATHS</filename> variable.
625 </para>
626
627 <para>
628 To add paths to the search order, provide a list of directories and separate
629 each path using a colon character as follows:
630 <literallayout class='monospaced'>
631 FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
632 </literallayout>
633 Typically, you want your directories search first.
634 To make sure that happens, use <filename>_prepend</filename> and
635 the immediate expansion (<filename>:=</filename>) operator as shown in the
636 previous example.
637 Finally, to maintain the integrity of the <filename>FILESPATH</filename> variable,
638 you must inclued the appropriate beginning or ending (as needed) colon character.
639 </para>
640
641 <para>
642 The <filename>FILESEXTRAPATHS</filename> variable is intended for use in
643 <filename>.bbappend</filename> files to include any additional files provided in that layer.
644 You typically accomplish this with the following:
645 <literallayout class='monospaced'>
646 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
647 </literallayout>
648 </para>
649 </glossdef>
650 </glossentry>
651
652 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
653 <glossdef>
654 <para>
655 The default set of directories the Yocto Project build system uses
656 when searching for patches and files.
657 During the build process, BitBake searches each directory in
658 <filename>FILESPATH</filename> in the specified order when looking for
659 files and patches specified by each <filename>file://</filename> URI in a recipe.
660 </para>
661
662 <para>
663 The default value for the <filename>FILESPATH</filename> variable is defined
664 in the <filename>base.bbclass</filename> class found in
665 <filename>meta/classes</filename> in the
666 <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#yocto-project-files'>Yocto Project Files</ulink>:
667 <literallayout class='monospaced'>
668FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
669 "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \
670 "${FILE_DIRNAME}/${BP}", "${FILE_DIRNAME}/${BPN}", \
671 "${FILE_DIRNAME}/files", "${FILE_DIRNAME}" ], d)}"
672 </literallayout>
673 Do not hand-edit the <filename>FILESPATH</filename> variable.
674 If you want to extend the set of pathnames that BitBake uses when searching for
675 files and patches, use the
676 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> variable.
677 </para>
678 </glossdef>
679 </glossentry>
680
616 <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm> 681 <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm>
617 <glossdef> 682 <glossdef>
618 <para>Allows you to define your own file permissions settings table as part of 683 <para>Allows you to define your own file permissions settings table as part of