]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
ref-manual: Added two links for FILESOVERRIDES and OVERRIDES
authorScott Rifenbark <scott.m.rifenbark@intel.com>
Wed, 7 Aug 2013 09:12:55 +0000 (12:12 +0300)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Tue, 13 Aug 2013 12:18:51 +0000 (13:18 +0100)
These variables were missing links into the reference section
glossary from the Migration chapter.

(From yocto-docs rev: 65ad5fc60f5a1067fbe2a54987d195ee388d264b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/ref-manual/migration.xml

index a7bab5aa364c96ebc8ba9aefc534142263c38304..4f46d6348dedf031a31be9b7f6a3ab4de36ec657 100644 (file)
             Differences include the following:
             <itemizedlist>
                 <listitem><para><emphasis>Comment Continuation:</emphasis>
-                    If a comment ends with a line continuation (\) character, 
+                    If a comment ends with a line continuation (\) character,
                     then the next line must also be a comment.
-                    Any instance where this is not the case, now triggers 
-                    a warning. 
-                    You must either remove the continuation character, or be 
+                    Any instance where this is not the case, now triggers
+                    a warning.
+                    You must either remove the continuation character, or be
                     sure the next line is a comment.
                     </para></listitem>
                 <listitem><para><emphasis>Package Name Overrides:</emphasis>
-                    The runtime package specific variables 
+                    The runtime package specific variables
                     <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>,
                     <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
-                    <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, 
+                    <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>,
                     <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>,
                     <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>,
                     <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>,
                     <link linkend='var-FILES'><filename>FILES</filename></link>,
                     <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>,
-                    and the pre, post, install, and uninstall script functions 
-                    <filename>pkg_preinst</filename>, 
-                    <filename>pkg_postinst</filename>, 
-                    <filename>pkg_prerm</filename>, and 
+                    and the pre, post, install, and uninstall script functions
+                    <filename>pkg_preinst</filename>,
+                    <filename>pkg_postinst</filename>,
+                    <filename>pkg_prerm</filename>, and
                     <filename>pkg_postrm</filename> should always have a
                     package name override.
-                    For example, use <filename>RDEPENDS_${PN}</filename> for 
+                    For example, use <filename>RDEPENDS_${PN}</filename> for
                     the main package instead of <filename>RDEPENDS</filename>.
                     BitBake uses more strict checks when it parses recipes.
                     </para></listitem>
             Differences include the following:
             <itemizedlist>
                 <listitem><para><emphasis>Shared State Code:</emphasis>
-                    The shared state code has been optimized to avoid running 
+                    The shared state code has been optimized to avoid running
                     unnecessary tasks.
-                    For example, 
-                    <filename>bitbake -c rootfs some-image</filename> from 
-                    shared state no longer populates the target sysroot 
+                    For example,
+                    <filename>bitbake -c rootfs some-image</filename> from
+                    shared state no longer populates the target sysroot
                     since that is not necessary.
-                    Instead, the system just needs to extract the output 
-                    package contents, re-create the packages, and construct 
-                    the root filesystem. 
-                    This change is unlikely to cause any problems unless 
+                    Instead, the system just needs to extract the output
+                    package contents, re-create the packages, and construct
+                    the root filesystem.
+                    This change is unlikely to cause any problems unless
                     you have missing declared dependencies.
                     </para></listitem>
                 <listitem><para><emphasis>Scanning Directory Names:</emphasis>
-                    When scanning for files in 
-                    <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, 
-                    the build system now uses <filename>FILESOVERRIDES</filename>
-                    instead of <filename>OVERRIDES</filename> for the directory 
-                    names. 
+                    When scanning for files in
+                    <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>,
+                    the build system now uses
+                    <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link>
+                    instead of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
+                    for the directory names.
                     In general, the values previously in
-                    <filename>OVERRIDES</filename> are now in 
+                    <filename>OVERRIDES</filename> are now in
                     <filename>FILESOVERRIDES</filename> as well.
-                    However, if you relied upon an additional value 
+                    However, if you relied upon an additional value
                     you previously added to <filename>OVERRIDES</filename>,
-                    you might now need to add it to 
-                    <filename>FILESOVERRIDES</filename> unless you are already 
-                    adding it through the 
-                    <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link> 
+                    you might now need to add it to
+                    <filename>FILESOVERRIDES</filename> unless you are already
+                    adding it through the
+                    <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>
                     or <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link>
                     variables, as appropriate.
                     For more related changes, see the
         <title>Proxies and Fetching Source</title>
 
         <para>
-            A new <filename>oe-git-proxy</filename> script has been added to 
-            replace previous methods of handling proxies and fetching source 
-            from Git. 
+            A new <filename>oe-git-proxy</filename> script has been added to
+            replace previous methods of handling proxies and fetching source
+            from Git.
             See the <filename>meta-yocto/conf/site.conf.sample</filename> file
             for information on how to use this script.
         </para>
         <title>Custom Interfaces File (netbase change)</title>
 
         <para>
-            If you have created your own custom 
-            <filename>etc/network/interfaces</filename> file by creating 
-            an append file for the <filename>netbase</filename> recipe, 
-            you now need to create an append file for the 
-            <filename>init-ifupdown</filename> recipe instead, which you can 
-            find in the 
+            If you have created your own custom
+            <filename>etc/network/interfaces</filename> file by creating
+            an append file for the <filename>netbase</filename> recipe,
+            you now need to create an append file for the
+            <filename>init-ifupdown</filename> recipe instead, which you can
+            find in the
             <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
             at <filename>meta/recipes-core/init-ifupdown</filename>.
-            For information on how to use append files, see the 
+            For information on how to use append files, see the
             "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>"
             in the Yocto Project Development Manual.
         </para>
         <title>Remote Debugging</title>
 
         <para>
-            Support for remote debugging with the Eclipse IDE is now 
-            separated into an image feature 
-            (<filename>eclipse-debug</filename>) that corresponds to the 
-            <filename>packagegroup-core-eclipse-debug</filename> package group. 
-            Previously, the debugging feature was included through the 
-            <filename>tools-debug</filename> image feature, which corresponds 
+            Support for remote debugging with the Eclipse IDE is now
+            separated into an image feature
+            (<filename>eclipse-debug</filename>) that corresponds to the
+            <filename>packagegroup-core-eclipse-debug</filename> package group.
+            Previously, the debugging feature was included through the
+            <filename>tools-debug</filename> image feature, which corresponds
             to the <filename>packagegroup-core-tools-debug</filename>
             package group.
         </para>
             The following variables have changed:
             <itemizedlist>
                 <listitem><para><emphasis><filename>SANITY_TESTED_DISTROS</filename>:</emphasis>
-                    This variable now uses a distribution ID, which is composed 
+                    This variable now uses a distribution ID, which is composed
                     of the host distributor ID followed by the release.
-                    Previously, 
+                    Previously,
                     <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
                     was composed of the description field.
-                    For example, "Ubuntu 12.10" becomes "Ubuntu-12.10". 
-                    You do not need to worry about this change if you are not 
+                    For example, "Ubuntu 12.10" becomes "Ubuntu-12.10".
+                    You do not need to worry about this change if you are not
                     specifically setting this variable, or if you are
                     specifically setting it to "".
                     </para></listitem>
                 <listitem><para><emphasis><filename>SRC_URI</filename>:</emphasis>
-                    The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>, 
-                    <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>, 
-                    <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>, 
-                    and <filename>FILE_DIRNAME</filename> directories have been 
-                    dropped from the default value of the 
+                    The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>,
+                    <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>,
+                    <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>,
+                    and <filename>FILE_DIRNAME</filename> directories have been
+                    dropped from the default value of the
                     <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
-                    variable, which is used as the search path for finding files 
-                    referred to in 
-                    <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>. 
-                    If you have a recipe that relied upon these directories, 
-                    which would be unusual, then you will need to add the 
+                    variable, which is used as the search path for finding files
+                    referred to in
+                    <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>.
+                    If you have a recipe that relied upon these directories,
+                    which would be unusual, then you will need to add the
                     appropriate paths within the recipe or, alternatively,
-                    rearrange the files. 
-                    The most common locations are still covered by 
+                    rearrange the files.
+                    The most common locations are still covered by
                     <filename>${BP}</filename>, <filename>${BPN}</filename>,
                     and "files", which all remain in the default value of
-                    <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. 
+                    <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
                     </para></listitem>
-            </itemizedlist>           
+            </itemizedlist>
         </para>
     </section>
 
         <title>Target Package Management with RPM</title>
 
         <para>
-            If runtime package management is enabled and the RPM backend 
-            is selected, Smart is now installed for package download, dependency 
+            If runtime package management is enabled and the RPM backend
+            is selected, Smart is now installed for package download, dependency
             resolution, and upgrades instead of Zypper.
-            For more information on how to use Smart, run the following command 
+            For more information on how to use Smart, run the following command
             on the target:
             <literallayout class='monospaced'>
      smart --help
         <title>Recipes Moved</title>
 
         <para>
-            The following recipes were moved from their previous locations 
-            because they are no longer used by anything in  
+            The following recipes were moved from their previous locations
+            because they are no longer used by anything in
             the OpenEmbedded-Core:
             <itemizedlist>
                 <listitem><para><emphasis><filename>clutter-box2d</filename>:</emphasis>
             The following list shows what has been removed or renamed:
             <itemizedlist>
                 <listitem><para><emphasis><filename>evieext</filename>:</emphasis>
-                    Removed because it has been removed from 
+                    Removed because it has been removed from
                     <filename>xserver</filename> since 2008.
                     </para></listitem>
                 <listitem><para><emphasis>Gtk+ DirectFB:</emphasis>
                     Removed because they were removed from the Xorg server in 2008.
                     </para></listitem>
                 <listitem><para><emphasis><filename>libxp / libxprintapputil / libxprintutil / printproto</filename>:</emphasis>
-                    Removed because the XPrint server was removed from 
+                    Removed because the XPrint server was removed from
                     Xorg in 2008.
                     </para></listitem>
                 <listitem><para><emphasis><filename>libxtrap / xtrapproto</filename>:</emphasis>
                     as part of the release.
                     </para></listitem>
                 <listitem><para><emphasis><filename>lsbsetup</filename>:</emphasis>
-                    Removed with functionality now provided by 
+                    Removed with functionality now provided by
                     <filename>lsbtest</filename>.
                     </para></listitem>
                 <listitem><para><emphasis><filename>matchbox-stroke</filename>:</emphasis>
                     </para></listitem>
                 <listitem><para><emphasis><filename>matchbox-wm-2 / matchbox-theme-sato-2</filename>:</emphasis>
                     Removed because they are not maintained.
-                    However, <filename>matchbox-wm</filename> and  
-                    <filename>matchbox-theme-sato</filename> are still 
+                    However, <filename>matchbox-wm</filename> and
+                    <filename>matchbox-theme-sato</filename> are still
                     provided.
                     </para></listitem>
                 <listitem><para><emphasis><filename>mesa-dri</filename>:</emphasis>
                     Removed because it was no longer useful.
                     </para></listitem>
                 <listitem><para><emphasis><filename>mutter</filename>:</emphasis>
-                    Removed because nothing ever uses it and the recipe is 
+                    Removed because nothing ever uses it and the recipe is
                     very old.
                     </para></listitem>
                 <listitem><para><emphasis><filename>orinoco-conf</filename>:</emphasis>
                     </para></listitem>
                 <listitem><para><emphasis><filename>update-modules</filename>:</emphasis>
                     Removed because it is no longer used.
-                    The kernel module <filename>postinstall</filename> and 
-                    <filename>postrm</filename> scripts can now do the same 
+                    The kernel module <filename>postinstall</filename> and
+                    <filename>postrm</filename> scripts can now do the same
                     task without the use of this script.
                     </para></listitem>
                 <listitem><para><emphasis><filename>web</filename>:</emphasis>
-                    Removed because it is not maintained.  Superseded by 
+                    Removed because it is not maintained.  Superseded by
                     <filename>web-webkit</filename>.
                     </para></listitem>
                 <listitem><para><emphasis><filename>xf86bigfontproto</filename>:</emphasis>
-                    Removed because upstream it has been disabled by default 
+                    Removed because upstream it has been disabled by default
                     since 2007.
                     Nothing uses <filename>xf86bigfontproto</filename>.
                     </para></listitem>
                 <listitem><para><emphasis><filename>xf86rushproto</filename>:</emphasis>
-                    Removed because its dependency in 
+                    Removed because its dependency in
                     <filename>xserver</filename> was spurious and it was
                     removed in 2005.
                     </para></listitem>
                 <listitem><para><emphasis><filename>zypper / libzypp / sat-solver</filename>:</emphasis>
-                    Removed and been functionally replaced with Smart 
-                    (<filename>python-smartpm</filename>) when RPM packaging 
+                    Removed and been functionally replaced with Smart
+                    (<filename>python-smartpm</filename>) when RPM packaging
                     is used and package management is enabled on the target.
                     </para></listitem>
             </itemizedlist>