path: root/documentation/bsp-guide
diff options
authorScott Rifenbark <>2013-04-22 16:16:29 (GMT)
committerRichard Purdie <>2013-05-22 16:23:37 (GMT)
commitcaa6e079c316c70f3600114069654c459607e983 (patch)
tree60f556ea34889a479d43aa96c2bb4f9f8ae34430 /documentation/bsp-guide
parent06af7c1b3240f23f036afab3baf664f37a0b6f36 (diff)
dev-manual, bsp-guide: Updates for init-ifupdown change.
Release 1.4 requires the user to create an append file to the new recipe init-ifupdown if they want to create their own custom /etc/network/interfaces file. Previously, they needed to append the netbase recipe. Changes needed in the migration section of the ref-manual as well as the exmaple used in the bsp-guide. (From yocto-docs rev: 1903df0c21dbc018f0dbb4ce90eac192b428606b) Signed-off-by: Scott Rifenbark <> Signed-off-by: Richard Purdie <>
Diffstat (limited to 'documentation/bsp-guide')
1 files changed, 39 insertions, 11 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index d5d87fa..363ab77 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -883,31 +883,59 @@
883 If you plan on customizing a recipe for a particular BSP, you need to do the 883 If you plan on customizing a recipe for a particular BSP, you need to do the
884 following: 884 following:
885 <itemizedlist> 885 <itemizedlist>
886 <listitem><para>Include within the BSP layer a <filename>.bbappend</filename> 886 <listitem><para>Create a <filename>.bbappend</filename>
887 file for the modified recipe.</para></listitem> 887 file for the modified recipe.
888 <listitem><para>Place the BSP-specific file in the BSP's recipe 888 For information on using append files, see the
889 <filename>.bbappend</filename> file path under a directory named 889 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>"
890 after the machine.</para></listitem> 890 section in the Yocto Project Development Manual.
891 </para></listitem>
892 <listitem><para>
893 Ensure your directory structure in the BSP layer
894 that supports your machine is such that it can be found
895 by the build system.
896 See the example later in this section for more information.
897 </para></listitem>
898 <listitem><para>
899 Put the append file in a directory whose name matches
900 the machine's name and is located in an appropriate
901 sub-directory inside the BSP layer (i.e.
902 <filename>recipes-bsp</filename>, <filename>recipes-graphics</filename>,
903 <filename>recipes-core</filename>, and so forth).
904 </para></listitem>
905 <listitem><para>Place the BSP-specific files in the directory named for
906 your machine inside the BSP layer.
907 </para></listitem>
891 </itemizedlist> 908 </itemizedlist>
892 </para> 909 </para>
893 910
894 <para> 911 <para>
895 To better understand this, consider an example that customizes a recipe by adding 912 Following is a specific example to help you better understand the process.
913 Consider an example that customizes a recipe by adding
896 a BSP-specific configuration file named <filename>interfaces</filename> to the 914 a BSP-specific configuration file named <filename>interfaces</filename> to the
897 <filename></filename> recipe for machine "xyz". 915 <filename></filename> recipe for machine "xyz".
898 Do the following: 916 Do the following:
899 <orderedlist> 917 <orderedlist>
900 <listitem><para>Edit the <filename>netbase_5.0.bbappend</filename> file so that it 918 <listitem><para>Edit the <filename>init-ifupdown_1.0.bbappend</filename> file so that it
901 contains the following: 919 contains the following:
902 <literallayout class='monospaced'> 920 <literallayout class='monospaced'>
903 FILESEXTRAPATHS_prepend := "${THISDIR}/files:" 921 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
904 PRINC := "${@int(PRINC) + 2}" 922 PRINC := "${@int(PRINC) + 2}"
905 </literallayout></para></listitem> 923 </literallayout>
924 The append file needs to be in the
925 <filename>meta-xyz/recipes-core/init-ifupdown</filename> directory.
926 </para></listitem>
906 <listitem><para>Create and place the new <filename>interfaces</filename> 927 <listitem><para>Create and place the new <filename>interfaces</filename>
907 configuration file in the BSP's layer here: 928 configuration file in the BSP's layer here:
908 <literallayout class='monospaced'> 929 <literallayout class='monospaced'>
909 meta-xyz/recipes-core/netbase/files/xyz/interfaces 930 meta-xyz/recipes-core/init-ifupdown/files/xyz/interfaces
910 </literallayout></para></listitem> 931 </literallayout>
932 The
933 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
934 variable in the append files extends the search path
935 the build system uses to find files during the build.
936 Consequently, for this example you need to have the
937 <filename>files</filename> directory in the same location
938 as your append file.</para></listitem>
911 </orderedlist> 939 </orderedlist>
912 </para> 940 </para>
913 </section> 941 </section>