summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2014-08-04 08:10:35 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-08-12 13:50:29 +0100
commit93f0d03a8dc0b7071a324495277a4fe6d908b7da (patch)
treeff1fd40977c419037cda93cc35e1a1d72e4b1b2a /documentation/dev-manual/dev-manual-common-tasks.xml
parent99a3c1911c72547327c1167caab5f4bfd2b1eb14 (diff)
downloadpoky-93f0d03a8dc0b7071a324495277a4fe6d908b7da.tar.gz
dev-manual: Technical and text edits applied as patch.
(From yocto-docs rev: 703cbe5c037334b3fbf08123b7cc501d36e1e8f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml58
1 files changed, 33 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index a8ef2d1576..a373f92090 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2994,7 +2994,7 @@
2994 <title>Adding a New Machine</title> 2994 <title>Adding a New Machine</title>
2995 2995
2996 <para> 2996 <para>
2997 Adding a new machine to the Yocto Project is a straight forward 2997 Adding a new machine to the Yocto Project is a straightforward
2998 process. 2998 process.
2999 This section describes how to add machines that are similar 2999 This section describes how to add machines that are similar
3000 to those that the Yocto Project already supports. 3000 to those that the Yocto Project already supports.
@@ -3034,7 +3034,8 @@
3034 3034
3035 <para> 3035 <para>
3036 The most important variables you must set in your machine 3036 The most important variables you must set in your machine
3037 configuration file are as follows: 3037 configuration file or include from a lower-level configuration
3038 file are as follows:
3038 <itemizedlist> 3039 <itemizedlist>
3039 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_ARCH'>TARGET_ARCH</ulink></filename> 3040 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_ARCH'>TARGET_ARCH</ulink></filename>
3040 (e.g. "arm")</para></listitem> 3041 (e.g. "arm")</para></listitem>
@@ -3192,41 +3193,47 @@
3192 variables in the 3193 variables in the
3193 <filename>meta/conf/bitbake.conf</filename> configuration file define how files installed 3194 <filename>meta/conf/bitbake.conf</filename> configuration file define how files installed
3194 by the <filename>do_install</filename> task are packaged. 3195 by the <filename>do_install</filename> task are packaged.
3195 By default, the <filename>PACKAGES</filename> variable contains 3196 By default, the <filename>PACKAGES</filename> variable includes
3196 <filename>${PN}-staticdev</filename>, which includes all static library files. 3197 <filename>${PN}-staticdev</filename>, which represents all static library files.
3197 <note> 3198 <note>
3198 Some previously released versions of the Yocto Project 3199 Some previously released versions of the Yocto Project
3199 defined the static library files through 3200 defined the static library files through
3200 <filename>${PN}-dev</filename>. 3201 <filename>${PN}-dev</filename>.
3201 </note> 3202 </note>
3202 Following, is part of the BitBake configuration file. 3203 Following is part of the BitBake configuration file, where
3203 You can see where the static library files are defined: 3204 you can see how the static library files are defined:
3204 <literallayout class='monospaced'> 3205 <literallayout class='monospaced'>
3205 PACKAGES = "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev ${PN}-staticdev ${PN}-locale" 3206 PACKAGE_BEFORE_PN ?= ""
3206 PACKAGES_DYNAMIC = "${PN}-locale-*" 3207 PACKAGES = "${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}"
3208 PACKAGES_DYNAMIC = "^${PN}-locale-.*"
3207 FILES = "" 3209 FILES = ""
3208 3210
3209 FILES_${PN} = "${bindir}/* ${sbindir}/* ${libexecdir}/* ${libdir}/lib*${SOLIBS} \ 3211 FILES_${PN} = "${bindir}/* ${sbindir}/* ${libexecdir}/* ${libdir}/lib*${SOLIBS} \
3210 ${sysconfdir} ${sharedstatedir} ${localstatedir} \ 3212 ${sysconfdir} ${sharedstatedir} ${localstatedir} \
3211 ${base_bindir}/* ${base_sbindir}/* \ 3213 ${base_bindir}/* ${base_sbindir}/* \
3212 ${base_libdir}/*${SOLIBS} \ 3214 ${base_libdir}/*${SOLIBS} \
3215 ${base_prefix}/lib/udev/rules.d ${prefix}/lib/udev/rules.d \
3213 ${datadir}/${BPN} ${libdir}/${BPN}/* \ 3216 ${datadir}/${BPN} ${libdir}/${BPN}/* \
3214 ${datadir}/pixmaps ${datadir}/applications \ 3217 ${datadir}/pixmaps ${datadir}/applications \
3215 ${datadir}/idl ${datadir}/omf ${datadir}/sounds \ 3218 ${datadir}/idl ${datadir}/omf ${datadir}/sounds \
3216 ${libdir}/bonobo/servers" 3219 ${libdir}/bonobo/servers"
3217 3220
3221 FILES_${PN}-bin = "${bindir}/* ${sbindir}/*"
3222
3218 FILES_${PN}-doc = "${docdir} ${mandir} ${infodir} ${datadir}/gtk-doc \ 3223 FILES_${PN}-doc = "${docdir} ${mandir} ${infodir} ${datadir}/gtk-doc \
3219 ${datadir}/gnome/help" 3224 ${datadir}/gnome/help"
3220 SECTION_${PN}-doc = "doc" 3225 SECTION_${PN}-doc = "doc"
3221 3226
3222 FILES_${PN}-dev = "${includedir} ${libdir}/lib*${SOLIBSDEV} ${libdir}/*.la \ 3227 FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}"
3228 FILES_${PN}-dev = "${includedir} ${FILES_SOLIBSDEV} ${libdir}/*.la \
3223 ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \ 3229 ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \
3224 ${datadir}/aclocal ${base_libdir}/*.o" 3230 ${datadir}/aclocal ${base_libdir}/*.o \
3231 ${libdir}/${BPN}/*.la ${base_libdir}/*.la"
3225 SECTION_${PN}-dev = "devel" 3232 SECTION_${PN}-dev = "devel"
3226 ALLOW_EMPTY_${PN}-dev = "1" 3233 ALLOW_EMPTY_${PN}-dev = "1"
3227 RDEPENDS_${PN}-dev = "${PN} (= ${EXTENDPKGV})" 3234 RDEPENDS_${PN}-dev = "${PN} (= ${EXTENDPKGV})"
3228 3235
3229 FILES_${PN}-staticdev = "${libdir}/*.a ${base_libdir}/*.a" 3236 FILES_${PN}-staticdev = "${libdir}/*.a ${base_libdir}/*.a ${libdir}/${BPN}/*.a"
3230 SECTION_${PN}-staticdev = "devel" 3237 SECTION_${PN}-staticdev = "devel"
3231 RDEPENDS_${PN}-staticdev = "${PN}-dev (= ${EXTENDPKGV})" 3238 RDEPENDS_${PN}-staticdev = "${PN}-dev (= ${EXTENDPKGV})"
3232 </literallayout> 3239 </literallayout>
@@ -3256,7 +3263,7 @@
3256 While the Multilib feature is most commonly used for 32 and 64-bit differences, 3263 While the Multilib feature is most commonly used for 32 and 64-bit differences,
3257 the approach the build system uses facilitates different target optimizations. 3264 the approach the build system uses facilitates different target optimizations.
3258 You could compile some binaries to use one set of libraries and other binaries 3265 You could compile some binaries to use one set of libraries and other binaries
3259 to use other different sets of libraries. 3266 to use a different set of libraries.
3260 The libraries could differ in architecture, compiler options, or other 3267 The libraries could differ in architecture, compiler options, or other
3261 optimizations. 3268 optimizations.
3262 </para> 3269 </para>
@@ -3315,8 +3322,9 @@
3315 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>, 3322 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>,
3316 <ulink url='&YOCTO_DOCS_REF_URL;#var-RPROVIDES'><filename>RPROVIDES</filename></ulink>, 3323 <ulink url='&YOCTO_DOCS_REF_URL;#var-RPROVIDES'><filename>RPROVIDES</filename></ulink>,
3317 <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>, 3324 <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>,
3318 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>, 3325 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>, and
3319 and <filename>PACKAGES_DYNAMIC</filename> are automatically extended by the system. 3326 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></ulink>
3327 are automatically extended by the system.
3320 If you are extending any manual code in the recipe, you can use the 3328 If you are extending any manual code in the recipe, you can use the
3321 <filename>${MLPREFIX}</filename> variable to ensure those names are extended 3329 <filename>${MLPREFIX}</filename> variable to ensure those names are extended
3322 correctly. 3330 correctly.
@@ -3360,7 +3368,7 @@
3360 </literallayout> 3368 </literallayout>
3361 You can also build Multilib packages specifically with a command like this: 3369 You can also build Multilib packages specifically with a command like this:
3362 <literallayout class='monospaced'> 3370 <literallayout class='monospaced'>
3363 $ bitbake lib32-connman 3371 $ bitbake lib32-connman
3364 </literallayout> 3372 </literallayout>
3365 </para> 3373 </para>
3366 </section> 3374 </section>
@@ -3434,7 +3442,7 @@
3434 </para> 3442 </para>
3435 3443
3436 <para> 3444 <para>
3437 The process is straight forward as long as the libraries use 3445 The process is straightforward as long as the libraries use
3438 proper versioning. 3446 proper versioning.
3439 With properly versioned libraries, all you need to do to 3447 With properly versioned libraries, all you need to do to
3440 individually specify the libraries is create separate, 3448 individually specify the libraries is create separate,
@@ -3488,7 +3496,7 @@
3488 from existing OpenEmbedded build artifacts. 3496 from existing OpenEmbedded build artifacts.
3489 Image generation is driven by partitioning commands contained 3497 Image generation is driven by partitioning commands contained
3490 in an Openembedded kickstart file (<filename>.wks</filename>) 3498 in an Openembedded kickstart file (<filename>.wks</filename>)
3491 specified either directly on the command-line or as one of a 3499 specified either directly on the command line or as one of a
3492 selection of canned <filename>.wks</filename> files as shown 3500 selection of canned <filename>.wks</filename> files as shown
3493 with the <filename>wic list images</filename> command in the 3501 with the <filename>wic list images</filename> command in the
3494 "<link linkend='using-a-provided-kickstart_file'>Using an Existing Kickstart File</link>" 3502 "<link linkend='using-a-provided-kickstart_file'>Using an Existing Kickstart File</link>"
@@ -3545,7 +3553,7 @@
3545 standalone utility that initially provides 3553 standalone utility that initially provides
3546 easier-to-use and more flexible replacements for a 3554 easier-to-use and more flexible replacements for a
3547 couple bits of existing functionality in OE Core's 3555 couple bits of existing functionality in OE Core's
3548 <filename>directdisk.bbclass</filename> and 3556 <filename>boot-directdisk.bbclass</filename> and
3549 <filename>mkefidisk.sh</filename> scripts. 3557 <filename>mkefidisk.sh</filename> scripts.
3550 The difference between 3558 The difference between
3551 <filename>wic</filename> and those examples is 3559 <filename>wic</filename> and those examples is
@@ -3650,7 +3658,7 @@
3650 <literallayout class='monospaced'> 3658 <literallayout class='monospaced'>
3651 $ wic list &lt;image&gt; help 3659 $ wic list &lt;image&gt; help
3652 </literallayout> 3660 </literallayout>
3653 Where <filename>&lt;image&gt;</filename> is either 3661 where <filename>&lt;image&gt;</filename> is either
3654 <filename>directdisk</filename> or 3662 <filename>directdisk</filename> or
3655 <filename>mkefidisk</filename>. 3663 <filename>mkefidisk</filename>.
3656 </para> 3664 </para>
@@ -3698,7 +3706,7 @@
3698 Where: 3706 Where:
3699 3707
3700 <replaceable>image_name</replaceable>.wks 3708 <replaceable>image_name</replaceable>.wks
3701 An an OpenEmbedded kickstart file. You can provide 3709 An OpenEmbedded kickstart file. You can provide
3702 your own custom file or use a file from a set of 3710 your own custom file or use a file from a set of
3703 existing files as described by further options. 3711 existing files as described by further options.
3704 3712
@@ -3730,7 +3738,7 @@
3730 The path to the native sysroot containing the tools to use 3738 The path to the native sysroot containing the tools to use
3731 to build the image. 3739 to build the image.
3732 3740
3733 -p, &dash;&dash;skip-build-check 3741 -s, &dash;&dash;skip-build-check
3734 Skips the build check. 3742 Skips the build check.
3735 3743
3736 -D, &dash;&dash;debug 3744 -D, &dash;&dash;debug
@@ -3805,13 +3813,13 @@
3805 # long-description: Creates a partitioned EFI disk image that the user 3813 # long-description: Creates a partitioned EFI disk image that the user
3806 # can directly dd to boot media. 3814 # can directly dd to boot media.
3807 3815
3808 part /boot &dash;&dash;source bootimg-efi &dash;&dash;ondisk sda &dash;&dash;active 3816 part /boot --source bootimg-efi --ondisk sda --label msdos --active --align 1024
3809 3817
3810 part / &dash;&dash;source rootfs &dash;&dash;ondisk sda &dash;&dash;fstype=ext3 &dash;&dash;label platform 3818 part / --source rootfs --ondisk sda --fstype=ext3 --label platform --align 1024
3811 3819
3812 part swap &dash;&dash;ondisk sda &dash;&dash;size 44 &dash;&dash;label swap1 &dash;&dash;fstype=swap 3820 part swap --ondisk sda --size 44 --label swap1 --fstype=swap
3813 3821
3814 bootloader &dash;&dash;timeout=10 &dash;&dash;append="rootwait console=ttyPCH0,115200" 3822 bootloader --timeout=10 --append="rootwait rootfstype=ext3 console=ttyPCH0,115200 console=tty0 vmalloc=256MB snd-hda-intel.enable_msi=0"
3815 </literallayout> 3823 </literallayout>
3816 </para> 3824 </para>
3817 </section> 3825 </section>