summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/extendpoky.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-03-17 18:28:20 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-03-18 17:22:24 +0000
commitf228642ece22d5a284aaed718c5ba3b30a01feb7 (patch)
tree736183d211add64a56d0ed4369811d77123bd5ca /documentation/poky-ref-manual/extendpoky.xml
parent8e05ccaa0bde44b870908d4bb1f6dfbfdd2459e2 (diff)
downloadpoky-f228642ece22d5a284aaed718c5ba3b30a01feb7.tar.gz
documentation/poky-ref-manual/extendpoky.xml: small edits
Various small edits and format changes. (From OE-Core rev: 259128eb1b7676a71d5c0df4ef5db065ba5c3c88) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/extendpoky.xml')
-rw-r--r--documentation/poky-ref-manual/extendpoky.xml29
1 files changed, 15 insertions, 14 deletions
diff --git a/documentation/poky-ref-manual/extendpoky.xml b/documentation/poky-ref-manual/extendpoky.xml
index 951468d46c..8e41031702 100644
--- a/documentation/poky-ref-manual/extendpoky.xml
+++ b/documentation/poky-ref-manual/extendpoky.xml
@@ -81,7 +81,7 @@ do_install() {
81 Applications that use autotools such as <filename>autoconf</filename> and 81 Applications that use autotools such as <filename>autoconf</filename> and
82 <filename>automake</filename> require a recipe that has a source archive listed in 82 <filename>automake</filename> require a recipe that has a source archive listed in
83 <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> and 83 <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm> and
84 <filename>also inherits autotools</filename>, which instructs BitBake to use the 84 also inherits autotools, which instructs BitBake to use the
85 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps 85 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps
86 needed to build an autotooled application. 86 needed to build an autotooled application.
87 The result of the build is automatically packaged. 87 The result of the build is automatically packaged.
@@ -114,7 +114,7 @@ inherit autotools gettext
114 <para> 114 <para>
115 Applications that use GNU <filename>make</filename> also require a recipe that has 115 Applications that use GNU <filename>make</filename> also require a recipe that has
116 the source archive listed in <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm>. 116 the source archive listed in <glossterm><link linkend='var-SRC_URI'>SRC_URI</link></glossterm>.
117 You do not need to add a <function>do_compile</function> step since by default BitBake 117 You do not need to add a "do_compile" step since by default BitBake
118 starts the <filename>make</filename> command to compile the application. 118 starts the <filename>make</filename> command to compile the application.
119 If you need additional <filename>make</filename> options you should store them in the 119 If you need additional <filename>make</filename> options you should store them in the
120 <glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm> variable. 120 <glossterm><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></glossterm> variable.
@@ -209,8 +209,8 @@ FILES_sxpm = "${bindir}/sxpm"
209 <title>Post Install Scripts</title> 209 <title>Post Install Scripts</title>
210 210
211 <para> 211 <para>
212 To add a post-installation script to a package, add a <function>pkg_postinst_PACKAGENAME() 212 To add a post-installation script to a package, add a <filename>pkg_postinst_PACKAGENAME()
213 </function> function to the <filename>.bb</filename> file and use 213 </filename> function to the <filename>.bb</filename> file and use
214 <filename>PACKAGENAME</filename> as the name of the package you want to attach to the 214 <filename>PACKAGENAME</filename> as the name of the package you want to attach to the
215 <filename>postinst</filename> script. 215 <filename>postinst</filename> script.
216 Normally <glossterm><link linkend='var-PN'>PN</link></glossterm> can be used, which 216 Normally <glossterm><link linkend='var-PN'>PN</link></glossterm> can be used, which
@@ -298,8 +298,8 @@ IMAGE_INSTALL += "strace"
298 <para> 298 <para>
299 For complex custom images, the best approach is to create a custom task package 299 For complex custom images, the best approach is to create a custom task package
300 that is used to build the image or images. 300 that is used to build the image or images.
301 A good example of a tasks package is <filename>meta/recipes-sato/tasks/task-poky.bb 301 A good example of a tasks package is
302 </filename>. 302 <filename>meta/recipes-sato/tasks/task-poky.bb</filename>.
303 The <glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm> 303 The <glossterm><link linkend='var-PACKAGES'>PACKAGES</link></glossterm>
304 variable lists the task packages to build along with the complementary 304 variable lists the task packages to build along with the complementary
305 -dbg and -dev packages. 305 -dbg and -dev packages.
@@ -494,7 +494,7 @@ COMPATIBLE_MACHINE = '(qemux86|qemumips)'
494 <title>Adding a Formfactor Configuration File</title> 494 <title>Adding a Formfactor Configuration File</title>
495 <para> 495 <para>
496 A formfactor configuration file provides information about the 496 A formfactor configuration file provides information about the
497 target hardware on which Poky is running, and information that Poky cannot 497 target hardware on which Poky is running and information that Poky cannot
498 obtain from other sources such as the kernel. 498 obtain from other sources such as the kernel.
499 Some examples of information contained in a formfactor configuration file include 499 Some examples of information contained in a formfactor configuration file include
500 framebuffer orientation, whether or not the system has a keyboard, 500 framebuffer orientation, whether or not the system has a keyboard,
@@ -505,7 +505,7 @@ COMPATIBLE_MACHINE = '(qemux86|qemumips)'
505 Reasonable defaults are used in most cases, but if customization is 505 Reasonable defaults are used in most cases, but if customization is
506 necessary you need to create a <filename>machconfig</filename> file 506 necessary you need to create a <filename>machconfig</filename> file
507 under <filename>meta/packages/formfactor/files/MACHINENAME/</filename>, 507 under <filename>meta/packages/formfactor/files/MACHINENAME/</filename>,
508 where <literal>MACHINENAME</literal> is the name for which this information 508 where <filename>MACHINENAME</filename> is the name for which this information
509 applies. 509 applies.
510 For information about the settings available and the defaults, see 510 For information about the settings available and the defaults, see
511 <filename>meta/packages/formfactor/files/config</filename>. 511 <filename>meta/packages/formfactor/files/config</filename>.
@@ -674,7 +674,7 @@ BBFILE_PRIORITY_emenlow = "6"
674 variables allowing moves to be made towards generating checksums and allowing 674 variables allowing moves to be made towards generating checksums and allowing
675 use of the dependency information in other parts of bitbake. 675 use of the dependency information in other parts of bitbake.
676 676
677 Signed-off-by: Richard Purdie rpurdie@linux.intel.com 677 Signed-off-by: Richard Purdie richard.purdie@linuxfoundation.org
678 </literallayout> 678 </literallayout>
679 679
680 <para> 680 <para>
@@ -714,7 +714,7 @@ BBFILE_PRIORITY_emenlow = "6"
714 Usually, version increases occur only to packages. 714 Usually, version increases occur only to packages.
715 However, if for some reason PV changes but does not increase, you can increase the 715 However, if for some reason PV changes but does not increase, you can increase the
716 <glossterm><link linkend='var-PE'>PE</link></glossterm> variable (Package Epoch). 716 <glossterm><link linkend='var-PE'>PE</link></glossterm> variable (Package Epoch).
717 The PE variable defaults to '0'. 717 The PE variable defaults to "0".
718 </para> 718 </para>
719 <para> 719 <para>
720 Version numbering strives to follow the 720 Version numbering strives to follow the
@@ -823,7 +823,8 @@ BBFILE_PRIORITY_emenlow = "6"
823 For a standard recipe not related to 823 For a standard recipe not related to
824 <glossterm><link linkend='var-MACHINE'>MACHINE</link></glossterm> the location is 824 <glossterm><link linkend='var-MACHINE'>MACHINE</link></glossterm> the location is
825 <filename>tmp/work/PACKAGE_ARCH-poky-TARGET_OS/PN-PV-PR/</filename>. 825 <filename>tmp/work/PACKAGE_ARCH-poky-TARGET_OS/PN-PV-PR/</filename>.
826 For target device-dependent packages you should use the MACHINE variable instead of 826 For target device-dependent packages you should use the <filename>MACHINE</filename>
827 variable instead of
827 <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm> 828 <glossterm><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></glossterm>
828 in the directory name. 829 in the directory name.
829 </para> 830 </para>
@@ -864,19 +865,19 @@ BBFILE_PRIORITY_emenlow = "6"
864 into the new patch file: 865 into the new patch file:
865 866
866 <literallayout class='monospaced'> 867 <literallayout class='monospaced'>
867quilt new NAME-OF-PATCH.patch 868 quilt new NAME-OF-PATCH.patch
868 </literallayout> 869 </literallayout>
869 870
870 After notifying quilt, add all modified files into that patch: 871 After notifying quilt, add all modified files into that patch:
871 <literallayout class='monospaced'> 872 <literallayout class='monospaced'>
872quilt add file1 file2 file3 873 quilt add file1 file2 file3
873 </literallayout> 874 </literallayout>
874 875
875 You can now start editing. 876 You can now start editing.
876 Once you are done editing, you need to use quilt to generate the final patch that 877 Once you are done editing, you need to use quilt to generate the final patch that
877 will contain all your modifications. 878 will contain all your modifications.
878 <literallayout class='monospaced'> 879 <literallayout class='monospaced'>
879quilt refresh 880 quilt refresh
880 </literallayout> 881 </literallayout>
881 882
882 You can find the resulting patch file in the 883 You can find the resulting patch file in the