summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAdrian Dudau <adrian.dudau@enea.com>2013-12-12 13:38:32 +0100
committerAdrian Dudau <adrian.dudau@enea.com>2013-12-12 13:50:20 +0100
commite2e6f6fe07049f33cb6348780fa975162752e421 (patch)
treeb1813295411235d1297a0ed642b1346b24fdfb12 /documentation
downloadpoky-e2e6f6fe07049f33cb6348780fa975162752e421.tar.gz
initial commit of Enea Linux 3.1
Migrated from the internal git server on the dora-enea branch Signed-off-by: Adrian Dudau <adrian.dudau@enea.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Makefile395
-rw-r--r--documentation/README91
-rw-r--r--documentation/adt-manual/adt-command.xml224
-rw-r--r--documentation/adt-manual/adt-intro.xml195
-rw-r--r--documentation/adt-manual/adt-manual-customization.xsl11
-rw-r--r--documentation/adt-manual/adt-manual-eclipse-customization.xsl27
-rw-r--r--documentation/adt-manual/adt-manual.xml113
-rw-r--r--documentation/adt-manual/adt-package.xml101
-rw-r--r--documentation/adt-manual/adt-prepare.xml646
-rw-r--r--documentation/adt-manual/adt-style.css979
-rw-r--r--documentation/adt-manual/figures/adt-title.pngbin0 -> 13498 bytes
-rw-r--r--documentation/bsp-guide/bsp-guide-customization.xsl10
-rw-r--r--documentation/bsp-guide/bsp-guide-eclipse-customization.xsl27
-rw-r--r--documentation/bsp-guide/bsp-guide.xml118
-rw-r--r--documentation/bsp-guide/bsp-style.css980
-rw-r--r--documentation/bsp-guide/bsp.xml1480
-rw-r--r--documentation/bsp-guide/figures/bsp-title.pngbin0 -> 17388 bytes
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml5913
-rw-r--r--documentation/dev-manual/dev-manual-customization.xsl10
-rw-r--r--documentation/dev-manual/dev-manual-eclipse-customization.xsl27
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml210
-rw-r--r--documentation/dev-manual/dev-manual-model.xml2058
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml1575
-rw-r--r--documentation/dev-manual/dev-manual-start.xml407
-rw-r--r--documentation/dev-manual/dev-manual.xml102
-rw-r--r--documentation/dev-manual/dev-style.css979
-rw-r--r--documentation/dev-manual/figures/app-dev-flow.pngbin0 -> 53301 bytes
-rw-r--r--documentation/dev-manual/figures/bsp-dev-flow.pngbin0 -> 56047 bytes
-rw-r--r--documentation/dev-manual/figures/dev-title.pngbin0 -> 11813 bytes
-rw-r--r--documentation/dev-manual/figures/git-workflow.pngbin0 -> 26610 bytes
-rw-r--r--documentation/dev-manual/figures/index-downloads.pngbin0 -> 100374 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-dev-flow.pngbin0 -> 45225 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-overview-1.pngbin0 -> 35839 bytes
-rw-r--r--documentation/dev-manual/figures/kernel-overview-2-generic.pngbin0 -> 39931 bytes
-rw-r--r--documentation/dev-manual/figures/source-repos.pngbin0 -> 188986 bytes
-rw-r--r--documentation/dev-manual/figures/yp-download.pngbin0 -> 193275 bytes
-rwxr-xr-xdocumentation/kernel-dev/figures/kernel-architecture-overview.pngbin0 -> 40748 bytes
-rw-r--r--documentation/kernel-dev/figures/kernel-dev-title.pngbin0 -> 13453 bytes
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml1071
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml863
-rw-r--r--documentation/kernel-dev/kernel-dev-concepts-appx.xml253
-rw-r--r--documentation/kernel-dev/kernel-dev-customization.xsl11
-rw-r--r--documentation/kernel-dev/kernel-dev-eclipse-customization.xsl27
-rw-r--r--documentation/kernel-dev/kernel-dev-examples.xml918
-rw-r--r--documentation/kernel-dev/kernel-dev-faq.xml131
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.xml147
-rw-r--r--documentation/kernel-dev/kernel-dev-maint-appx.xml220
-rw-r--r--documentation/kernel-dev/kernel-dev-style.css978
-rw-r--r--documentation/kernel-dev/kernel-dev.xml95
-rw-r--r--documentation/mega-manual/figures/adt-title.pngbin0 -> 13498 bytes
-rw-r--r--documentation/mega-manual/figures/analysis-for-package-splitting.pngbin0 -> 63291 bytes
-rw-r--r--documentation/mega-manual/figures/app-dev-flow.pngbin0 -> 52670 bytes
-rw-r--r--documentation/mega-manual/figures/bsp-dev-flow.pngbin0 -> 57479 bytes
-rw-r--r--documentation/mega-manual/figures/bsp-title.pngbin0 -> 17388 bytes
-rw-r--r--documentation/mega-manual/figures/buildhistory-web.pngbin0 -> 49966 bytes
-rw-r--r--documentation/mega-manual/figures/buildhistory.pngbin0 -> 42532 bytes
-rwxr-xr-xdocumentation/mega-manual/figures/building-an-image.pngbin0 -> 14891 bytes
-rw-r--r--documentation/mega-manual/figures/configuration-compile-autoreconf.pngbin0 -> 46080 bytes
-rw-r--r--documentation/mega-manual/figures/cross-development-toolchains.pngbin0 -> 59275 bytes
-rw-r--r--documentation/mega-manual/figures/dev-title.pngbin0 -> 11813 bytes
-rw-r--r--documentation/mega-manual/figures/git-workflow.pngbin0 -> 26610 bytes
-rw-r--r--documentation/mega-manual/figures/image-generation.pngbin0 -> 47713 bytes
-rw-r--r--documentation/mega-manual/figures/images.pngbin0 -> 22926 bytes
-rw-r--r--documentation/mega-manual/figures/index-downloads.pngbin0 -> 58263 bytes
-rwxr-xr-xdocumentation/mega-manual/figures/kernel-architecture-overview.pngbin0 -> 40748 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-dev-flow.pngbin0 -> 45225 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-dev-title.pngbin0 -> 13453 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-overview-1.pngbin0 -> 35839 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-overview-2-generic.pngbin0 -> 39931 bytes
-rw-r--r--documentation/mega-manual/figures/kernel-title.pngbin0 -> 13970 bytes
-rw-r--r--documentation/mega-manual/figures/kernelshark-all.pngbin0 -> 89316 bytes
-rw-r--r--documentation/mega-manual/figures/kernelshark-choose-events.pngbin0 -> 57372 bytes
-rw-r--r--documentation/mega-manual/figures/kernelshark-i915-display.pngbin0 -> 98765 bytes
-rw-r--r--documentation/mega-manual/figures/kernelshark-output-display.pngbin0 -> 204454 bytes
-rw-r--r--documentation/mega-manual/figures/layer-input.pngbin0 -> 45856 bytes
-rw-r--r--documentation/mega-manual/figures/lttngmain0.pngbin0 -> 120581 bytes
-rw-r--r--documentation/mega-manual/figures/oprofileui-busybox.pngbin0 -> 98334 bytes
-rw-r--r--documentation/mega-manual/figures/oprofileui-copy-to-user.pngbin0 -> 105661 bytes
-rw-r--r--documentation/mega-manual/figures/oprofileui-downloading.pngbin0 -> 37301 bytes
-rw-r--r--documentation/mega-manual/figures/oprofileui-processes.pngbin0 -> 95741 bytes
-rw-r--r--documentation/mega-manual/figures/package-feeds.pngbin0 -> 27711 bytes
-rw-r--r--documentation/mega-manual/figures/patching.pngbin0 -> 42523 bytes
-rw-r--r--documentation/mega-manual/figures/perf-probe-do_fork-profile.pngbin0 -> 59078 bytes
-rw-r--r--documentation/mega-manual/figures/perf-report-cycles-u.pngbin0 -> 171368 bytes
-rw-r--r--documentation/mega-manual/figures/perf-systemwide-libc.pngbin0 -> 136826 bytes
-rw-r--r--documentation/mega-manual/figures/perf-systemwide.pngbin0 -> 140616 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-busybox-annotate-menu.pngbin0 -> 22364 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-busybox-annotate-udhcpc.pngbin0 -> 171529 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-busybox-debuginfo.pngbin0 -> 174971 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-busybox-dso-zoom-menu.pngbin0 -> 23735 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-busybox-dso-zoom.pngbin0 -> 101685 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-busybox-expanded-stripped.pngbin0 -> 95140 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-flat-stripped.pngbin0 -> 178919 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.pngbin0 -> 138550 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.pngbin0 -> 102790 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.pngbin0 -> 110101 bytes
-rw-r--r--documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.pngbin0 -> 102812 bytes
-rw-r--r--documentation/mega-manual/figures/poky-title.pngbin0 -> 11592 bytes
-rw-r--r--documentation/mega-manual/figures/profile-title.pngbin0 -> 12799 bytes
-rw-r--r--documentation/mega-manual/figures/pybootchartgui-linux-yocto.pngbin0 -> 36366 bytes
-rw-r--r--documentation/mega-manual/figures/pychart-linux-yocto-rpm-nostrip.pngbin0 -> 98053 bytes
-rw-r--r--documentation/mega-manual/figures/pychart-linux-yocto-rpm.pngbin0 -> 81053 bytes
-rw-r--r--documentation/mega-manual/figures/sched-wakeup-profile.pngbin0 -> 123810 bytes
-rw-r--r--documentation/mega-manual/figures/sdk-generation.pngbin0 -> 45456 bytes
-rw-r--r--documentation/mega-manual/figures/sdk.pngbin0 -> 20074 bytes
-rw-r--r--documentation/mega-manual/figures/source-fetching.pngbin0 -> 38860 bytes
-rw-r--r--documentation/mega-manual/figures/source-input.pngbin0 -> 39872 bytes
-rw-r--r--documentation/mega-manual/figures/source-repos.pngbin0 -> 188986 bytes
-rw-r--r--documentation/mega-manual/figures/sysprof-callers.pngbin0 -> 145043 bytes
-rw-r--r--documentation/mega-manual/figures/sysprof-copy-from-user.pngbin0 -> 132976 bytes
-rw-r--r--documentation/mega-manual/figures/sysprof-copy-to-user.pngbin0 -> 132074 bytes
-rw-r--r--documentation/mega-manual/figures/user-configuration.pngbin0 -> 23687 bytes
-rw-r--r--documentation/mega-manual/figures/using-a-pre-built-image.pngbin0 -> 12733 bytes
-rw-r--r--documentation/mega-manual/figures/yocto-environment-ref.pngbin0 -> 83206 bytes
-rw-r--r--documentation/mega-manual/figures/yocto-environment.pngbin0 -> 73095 bytes
-rwxr-xr-xdocumentation/mega-manual/figures/yocto-project-transp.pngbin0 -> 8626 bytes
-rw-r--r--documentation/mega-manual/figures/yp-download.pngbin0 -> 193275 bytes
-rw-r--r--documentation/mega-manual/mega-manual-customization.xsl8
-rw-r--r--documentation/mega-manual/mega-manual.xml53
-rw-r--r--documentation/mega-manual/mega-style.css979
-rw-r--r--documentation/poky.ent65
-rw-r--r--documentation/profile-manual/figures/kernelshark-all.pngbin0 -> 89316 bytes
-rw-r--r--documentation/profile-manual/figures/kernelshark-choose-events.pngbin0 -> 57372 bytes
-rw-r--r--documentation/profile-manual/figures/kernelshark-i915-display.pngbin0 -> 98765 bytes
-rw-r--r--documentation/profile-manual/figures/kernelshark-output-display.pngbin0 -> 204454 bytes
-rw-r--r--documentation/profile-manual/figures/lttngmain0.pngbin0 -> 120581 bytes
-rw-r--r--documentation/profile-manual/figures/oprofileui-busybox.pngbin0 -> 98334 bytes
-rw-r--r--documentation/profile-manual/figures/oprofileui-copy-to-user.pngbin0 -> 105661 bytes
-rw-r--r--documentation/profile-manual/figures/oprofileui-downloading.pngbin0 -> 37301 bytes
-rw-r--r--documentation/profile-manual/figures/oprofileui-processes.pngbin0 -> 95741 bytes
-rw-r--r--documentation/profile-manual/figures/perf-probe-do_fork-profile.pngbin0 -> 59078 bytes
-rw-r--r--documentation/profile-manual/figures/perf-report-cycles-u.pngbin0 -> 171368 bytes
-rw-r--r--documentation/profile-manual/figures/perf-systemwide-libc.pngbin0 -> 136826 bytes
-rw-r--r--documentation/profile-manual/figures/perf-systemwide.pngbin0 -> 140616 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-busybox-annotate-menu.pngbin0 -> 22364 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-busybox-annotate-udhcpc.pngbin0 -> 171529 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-busybox-debuginfo.pngbin0 -> 174971 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-busybox-dso-zoom-menu.pngbin0 -> 23735 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-busybox-dso-zoom.pngbin0 -> 101685 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-busybox-expanded-stripped.pngbin0 -> 95140 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-flat-stripped.pngbin0 -> 178919 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.pngbin0 -> 138550 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.pngbin0 -> 102790 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.pngbin0 -> 110101 bytes
-rw-r--r--documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.pngbin0 -> 102812 bytes
-rw-r--r--documentation/profile-manual/figures/profile-title.pngbin0 -> 12799 bytes
-rw-r--r--documentation/profile-manual/figures/pybootchartgui-linux-yocto.pngbin0 -> 36366 bytes
-rw-r--r--documentation/profile-manual/figures/pychart-linux-yocto-rpm-nostrip.pngbin0 -> 98053 bytes
-rw-r--r--documentation/profile-manual/figures/pychart-linux-yocto-rpm.pngbin0 -> 81053 bytes
-rw-r--r--documentation/profile-manual/figures/sched-wakeup-profile.pngbin0 -> 123810 bytes
-rw-r--r--documentation/profile-manual/figures/sysprof-callers.pngbin0 -> 145043 bytes
-rw-r--r--documentation/profile-manual/figures/sysprof-copy-from-user.pngbin0 -> 132976 bytes
-rw-r--r--documentation/profile-manual/figures/sysprof-copy-to-user.pngbin0 -> 132074 bytes
-rw-r--r--documentation/profile-manual/profile-manual-arch.xml45
-rw-r--r--documentation/profile-manual/profile-manual-customization.xsl11
-rw-r--r--documentation/profile-manual/profile-manual-eclipse-customization.xsl27
-rw-r--r--documentation/profile-manual/profile-manual-examples.xml39
-rw-r--r--documentation/profile-manual/profile-manual-intro.xml102
-rw-r--r--documentation/profile-manual/profile-manual-style.css978
-rw-r--r--documentation/profile-manual/profile-manual-usage.xml3684
-rw-r--r--documentation/profile-manual/profile-manual.xml85
-rw-r--r--documentation/ref-manual/TODO11
-rw-r--r--documentation/ref-manual/closer-look.xml1224
-rw-r--r--documentation/ref-manual/examples/hello-autotools/hello_2.3.bb8
-rw-r--r--documentation/ref-manual/examples/hello-single/files/helloworld.c8
-rw-r--r--documentation/ref-manual/examples/hello-single/hello.bb17
-rw-r--r--documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb14
-rw-r--r--documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb15
-rw-r--r--documentation/ref-manual/faq.xml710
-rw-r--r--documentation/ref-manual/figures/analysis-for-package-splitting.pngbin0 -> 63291 bytes
-rw-r--r--documentation/ref-manual/figures/buildhistory-web.pngbin0 -> 49966 bytes
-rw-r--r--documentation/ref-manual/figures/buildhistory.pngbin0 -> 42532 bytes
-rw-r--r--documentation/ref-manual/figures/configuration-compile-autoreconf.pngbin0 -> 46080 bytes
-rw-r--r--documentation/ref-manual/figures/cross-development-toolchains.pngbin0 -> 59275 bytes
-rw-r--r--documentation/ref-manual/figures/image-generation.pngbin0 -> 47713 bytes
-rw-r--r--documentation/ref-manual/figures/images.pngbin0 -> 22926 bytes
-rw-r--r--documentation/ref-manual/figures/layer-input.pngbin0 -> 45856 bytes
-rw-r--r--documentation/ref-manual/figures/package-feeds.pngbin0 -> 27711 bytes
-rw-r--r--documentation/ref-manual/figures/patching.pngbin0 -> 42523 bytes
-rw-r--r--documentation/ref-manual/figures/poky-title.pngbin0 -> 11592 bytes
-rw-r--r--documentation/ref-manual/figures/sdk-generation.pngbin0 -> 45456 bytes
-rw-r--r--documentation/ref-manual/figures/sdk.pngbin0 -> 20074 bytes
-rw-r--r--documentation/ref-manual/figures/source-fetching.pngbin0 -> 38860 bytes
-rw-r--r--documentation/ref-manual/figures/source-input.pngbin0 -> 39872 bytes
-rw-r--r--documentation/ref-manual/figures/user-configuration.pngbin0 -> 23687 bytes
-rw-r--r--documentation/ref-manual/figures/yocto-environment-ref.pngbin0 -> 83206 bytes
-rw-r--r--documentation/ref-manual/introduction.xml444
-rw-r--r--documentation/ref-manual/migration.xml1089
-rw-r--r--documentation/ref-manual/ref-bitbake.xml432
-rw-r--r--documentation/ref-manual/ref-classes.xml1104
-rw-r--r--documentation/ref-manual/ref-features.xml334
-rw-r--r--documentation/ref-manual/ref-images.xml150
-rw-r--r--documentation/ref-manual/ref-manual-customization.xsl11
-rw-r--r--documentation/ref-manual/ref-manual-eclipse-customization.xsl27
-rw-r--r--documentation/ref-manual/ref-manual.xml138
-rw-r--r--documentation/ref-manual/ref-structure.xml953
-rw-r--r--documentation/ref-manual/ref-style.css979
-rw-r--r--documentation/ref-manual/ref-variables.xml5888
-rw-r--r--documentation/ref-manual/ref-varlocality.xml196
-rw-r--r--documentation/ref-manual/resources.xml128
-rw-r--r--documentation/ref-manual/technical-details.xml1335
-rw-r--r--documentation/ref-manual/usingpoky.xml848
-rw-r--r--documentation/template/Vera.ttfbin0 -> 65932 bytes
-rw-r--r--documentation/template/Vera.xml1
-rw-r--r--documentation/template/VeraMoBd.ttfbin0 -> 49052 bytes
-rw-r--r--documentation/template/VeraMoBd.xml1
-rw-r--r--documentation/template/VeraMono.ttfbin0 -> 49224 bytes
-rw-r--r--documentation/template/VeraMono.xml1
-rw-r--r--documentation/template/draft.pngbin0 -> 24847 bytes
-rw-r--r--documentation/template/fop-config.xml58
-rw-r--r--documentation/template/ohand-color.svg150
-rw-r--r--documentation/template/poky-db-pdf.xsl64
-rw-r--r--documentation/template/poky-ref-manual.pngbin0 -> 32145 bytes
-rw-r--r--documentation/template/poky.svg163
-rw-r--r--documentation/template/titlepage.templates.xml1227
-rw-r--r--documentation/template/yocto-project-qs.pngbin0 -> 17829 bytes
-rw-r--r--documentation/tools/eclipse-help.sed18
-rw-r--r--documentation/tools/mega-manual.sed13
-rwxr-xr-xdocumentation/tools/poky-docbook-to-pdf51
-rwxr-xr-xdocumentation/yocto-project-qs/figures/building-an-image.pngbin0 -> 14891 bytes
-rw-r--r--documentation/yocto-project-qs/figures/using-a-pre-built-image.pngbin0 -> 12733 bytes
-rw-r--r--documentation/yocto-project-qs/figures/yocto-environment.pngbin0 -> 73095 bytes
-rwxr-xr-xdocumentation/yocto-project-qs/figures/yocto-project-transp.pngbin0 -> 8626 bytes
-rw-r--r--documentation/yocto-project-qs/qs-style.css979
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs-customization.xsl9
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl25
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl3820
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml963
228 files changed, 51074 insertions, 0 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
new file mode 100644
index 0000000000..5f2f865f39
--- /dev/null
+++ b/documentation/Makefile
@@ -0,0 +1,395 @@
1# This is a single Makefile to handle all generated Yocto Project documents.
2# The Makefile needs to live in the documents directory and all figures used
3# in any manuals must be .PNG files and live in the individual book's figures
4# directory as well as in the figures directory for the mega-manual.
5# Note that the figures for the Yocto Project Development Manual
6# differ depending on the BRANCH being built.
7#
8# The Makefile has these targets:
9#
10# pdf: generates a PDF version of a manual. Not valid for the Quick Start
11# or the mega-manual (single, large HTML file comprised of all
12# Yocto Project manuals).
13# html: generates an HTML version of a manual.
14# eclipse: generates an HTML version of a manual that can be used as
15# eclipse help (including necessary metadata files).
16# tarball: creates a tarball for the doc files.
17# validate: validates
18# publish: pushes generated files to the Yocto Project website
19# clean: removes files
20#
21# The Makefile generates an HTML and PDF version of every document except the
22# Yocto Project Quick Start and the single, HTML mega-manual, which is comprised
23# of all the individual Yocto Project manuals. These two manuals are in HTML
24# form only. The variable DOC indicates the folder name for a given manual. The
25# variable VER represents the distro version of the Yocto Release for which the
26# manuals are being generated. The variable BRANCH is used to indicate the
27# branch (edison or denzil) and is used only when DOC=dev-manual or
28# DOC=mega-manual. If you do not specify a BRANCH, the default branch used
29# will be for the latest Yocto Project release. If you build for either
30# edison or denzil, you must use BRANCH. You do not need to use BRANCH for
31# any release beyond denzil.
32#
33# To build a manual, you must invoke Makefile with the DOC argument. If you
34# are going to publish the manual, then you must invoke Makefile with both the
35# DOC and the VER argument. Furthermore, if you are building or publishing
36# the edison or denzil versions of the Yocto Poject Development Manual or
37# the mega-manual, you must also use the BRANCH argument.
38#
39# Examples:
40#
41# make DOC=bsp-guide
42# make DOC=yocto-project-qs
43# make pdf DOC=ref-manual
44# make DOC=dev-manual BRANCH=edison
45# make DOC=mega-manual BRANCH=denzil
46#
47# The first example generates the HTML and PDF versions of the BSP Guide.
48# The second example generates the HTML version only of the Quick Start. Note that
49# the Quick Start only has an HTML version available. The third example generates
50# both the PDF and HTML versions of the Yocto Project Reference Manual. The
51# fourth example generates both the PDF and HTML 'edison' versions of the YP
52# Development Manual. The last exmample generates the HTML version of the
53# mega-manual and uses the 'denzil' branch when choosing figures for the
54# tarball of figures. Any example that does not use the BRANCH argument
55# builds the current version of the manual set.
56#
57# Use the publish target to push the generated manuals to the Yocto Project
58# website. All files needed for the manual's HTML form are pushed as well as the
59# PDF version (if applicable).
60# Examples:
61#
62# make publish DOC=bsp-guide VER=1.3
63# make publish DOC=adt-manual VER=1.3
64# make publish DOC=dev-manual VER=1.1.1 BRANCH=edison
65# make publish DOC=dev-manual VER=1.2 BRANCH=denzil
66#
67# The first example publishes the 1.3 version of both the PDF and HTML versions of
68# the BSP Guide. The second example publishes the 1.3 version of both the PDF and
69# HTML versions of the ADT Manual. The third example publishes the PDF and HTML
70# 'edison' versions of the YP Development Manual. The fourth example publishes
71# the PDF and HTML 'denzil' versions of the YP Development Manual.
72#
73
74ifeq ($(DOC),bsp-guide)
75XSLTOPTS = --xinclude
76ALLPREQ = html pdf eclipse tarball
77TARFILES = bsp-style.css bsp-guide.html bsp-guide.pdf figures/bsp-title.png \
78 eclipse
79MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
80FIGURES = figures
81STYLESHEET = $(DOC)/*.css
82
83endif
84
85ifeq ($(DOC),dev-manual)
86XSLTOPTS = --xinclude
87ALLPREQ = html pdf eclipse tarball
88#
89# Note that the tarfile might produce the "Cannot stat: No such file or directory" error
90# message for .PNG files that are not present when building a particular branch. The
91# list of files is all-inclusive for all branches. Note, if you don't provide a BRANCH
92# option, it defaults to the latest stuff. This would be appropriate for "master" branch.
93#
94
95 ifeq ($(BRANCH),edison)
96TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
97 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
98 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
99 figures/kernel-example-repos-edison.png \
100 figures/kernel-overview-1.png figures/kernel-overview-2.png \
101 figures/kernel-overview-3-edison.png \
102 figures/source-repos.png figures/yp-download.png \
103 figures/wip.png
104 else ifeq ($(BRANCH),denzil)
105TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
106 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
107 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
108 figures/kernel-example-repos-denzil.png \
109 figures/kernel-overview-1.png figures/kernel-overview-2.png \
110 figures/kernel-overview-3-denzil.png \
111 figures/source-repos.png figures/yp-download.png \
112 figures/wip.png
113 else
114TARFILES = dev-style.css dev-manual.html dev-manual.pdf \
115 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
116 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
117 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
118 figures/source-repos.png figures/yp-download.png \
119 eclipse
120 endif
121
122MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
123FIGURES = figures
124STYLESHEET = $(DOC)/*.css
125
126endif
127
128ifeq ($(DOC),yocto-project-qs)
129XSLTOPTS = --xinclude
130ALLPREQ = html eclipse tarball
131TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \
132 figures/building-an-image.png figures/using-a-pre-built-image.png \
133 figures/yocto-project-transp.png \
134 eclipse
135MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
136FIGURES = figures
137STYLESHEET = $(DOC)/*.css
138endif
139
140ifeq ($(DOC),mega-manual)
141XSLTOPTS = --stringparam html.stylesheet mega-style.css \
142 --stringparam chapter.autolabel 1 \
143 --stringparam section.autolabel 1 \
144 --stringparam section.label.includes.component.label 1 \
145 --xinclude
146ALLPREQ = html tarball
147
148 ifeq ($(BRANCH),edison)
149TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
150 figures/using-a-pre-built-image.png \
151 figures/poky-title.png \
152 figures/adt-title.png figures/bsp-title.png \
153 figures/kernel-title.png figures/kernel-architecture-overview.png \
154 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
155 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
156 figures/kernel-example-repos-edison.png \
157 figures/kernel-overview-1.png figures/kernel-overview-2.png \
158 figures/kernel-overview-3-edison.png \
159 figures/source-repos.png figures/yp-download.png \
160 figures/wip.png
161 else ifeq ($(BRANCH),denzil)
162TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
163 figures/using-a-pre-built-image.png \
164 figures/poky-title.png \
165 figures/adt-title.png figures/bsp-title.png \
166 figures/kernel-title.png figures/kernel-architecture-overview.png \
167 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
168 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
169 figures/kernel-example-repos-denzil.png \
170 figures/kernel-overview-1.png figures/kernel-overview-2.png \
171 figures/kernel-overview-3-denzil.png \
172 figures/source-repos.png figures/yp-download.png \
173 figures/wip.png
174 else
175TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures/building-an-image.png \
176 figures/using-a-pre-built-image.png \
177 figures/poky-title.png figures/buildhistory.png figures/buildhistory-web.png \
178 figures/adt-title.png figures/bsp-title.png \
179 figures/kernel-dev-title.png figures/kernel-architecture-overview.png \
180 figures/app-dev-flow.png figures/bsp-dev-flow.png figures/dev-title.png \
181 figures/git-workflow.png figures/index-downloads.png figures/kernel-dev-flow.png \
182 figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
183 figures/source-repos.png figures/yp-download.png \
184 figures/profile-title.png figures/kernelshark-all.png \
185 figures/kernelshark-choose-events.png figures/kernelshark-i915-display.png \
186 figures/kernelshark-output-display.png figures/lttngmain0.png \
187 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
188 figures/oprofileui-downloading.png figures/oprofileui-processes.png \
189 figures/perf-probe-do_fork-profile.png figures/perf-report-cycles-u.png \
190 figures/perf-systemwide.png figures/perf-systemwide-libc.png \
191 figures/perf-wget-busybox-annotate-menu.png figures/perf-wget-busybox-annotate-udhcpc.png \
192 figures/perf-wget-busybox-debuginfo.png figures/perf-wget-busybox-dso-zoom.png \
193 figures/perf-wget-busybox-dso-zoom-menu.png figures/perf-wget-busybox-expanded-stripped.png \
194 figures/perf-wget-flat-stripped.png figures/perf-wget-g-copy-from-user-expanded-stripped.png \
195 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png figures/perf-wget-g-copy-to-user-expanded-stripped.png \
196 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png figures/pybootchartgui-linux-yocto.png \
197 figures/pychart-linux-yocto-rpm.png figures/pychart-linux-yocto-rpm-nostrip.png \
198 figures/sched-wakeup-profile.png figures/sysprof-callers.png \
199 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \
200 figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \
201 figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \
202 figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \
203 figures/analysis-for-package-splitting.png figures/image-generation.png \
204 figures/sdk-generation.png
205 endif
206
207MANUALS = $(DOC)/$(DOC).html
208FIGURES = figures
209STYLESHEET = $(DOC)/*.css
210
211endif
212
213ifeq ($(DOC),ref-manual)
214XSLTOPTS = --xinclude
215ALLPREQ = html pdf eclipse tarball
216TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
217 figures/buildhistory.png figures/buildhistory-web.png eclipse \
218 figures/cross-development-toolchains.png figures/layer-input.png \
219 figures/package-feeds.png figures/source-input.png \
220 figures/user-configuration.png figures/yocto-environment-ref.png \
221 figures/images.png figures/sdk.png figures/source-fetching.png \
222 figures/patching.png figures/configuration-compile-autoreconf.png \
223 figures/analysis-for-package-splitting.png figures/image-generation.png \
224 figures/sdk-generation.png
225MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
226FIGURES = figures
227STYLESHEET = $(DOC)/*.css
228endif
229
230
231ifeq ($(DOC),adt-manual)
232XSLTOPTS = --xinclude
233ALLPREQ = html pdf eclipse tarball
234TARFILES = adt-manual.html adt-manual.pdf adt-style.css figures/adt-title.png \
235 eclipse
236MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
237FIGURES = figures
238STYLESHEET = $(DOC)/*.css
239endif
240
241ifeq ($(DOC),profile-manual)
242XSLTOPTS = --xinclude
243ALLPREQ = html pdf eclipse tarball
244TARFILES = profile-manual.html profile-manual.pdf profile-manual-style.css \
245 figures/profile-title.png figures/kernelshark-all.png \
246 figures/kernelshark-choose-events.png figures/kernelshark-i915-display.png \
247 figures/kernelshark-output-display.png figures/lttngmain0.png \
248 figures/oprofileui-busybox.png figures/oprofileui-copy-to-user.png \
249 figures/oprofileui-downloading.png figures/oprofileui-processes.png \
250 figures/perf-probe-do_fork-profile.png figures/perf-report-cycles-u.png \
251 figures/perf-systemwide.png figures/perf-systemwide-libc.png \
252 figures/perf-wget-busybox-annotate-menu.png figures/perf-wget-busybox-annotate-udhcpc.png \
253 figures/perf-wget-busybox-debuginfo.png figures/perf-wget-busybox-dso-zoom.png \
254 figures/perf-wget-busybox-dso-zoom-menu.png figures/perf-wget-busybox-expanded-stripped.png \
255 figures/perf-wget-flat-stripped.png figures/perf-wget-g-copy-from-user-expanded-stripped.png \
256 figures/perf-wget-g-copy-to-user-expanded-debuginfo.png figures/perf-wget-g-copy-to-user-expanded-stripped.png \
257 figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png figures/pybootchartgui-linux-yocto.png \
258 figures/pychart-linux-yocto-rpm.png figures/pychart-linux-yocto-rpm-nostrip.png \
259 figures/sched-wakeup-profile.png figures/sysprof-callers.png \
260 figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png \
261 eclipse
262MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
263FIGURES = figures
264STYLESHEET = $(DOC)/*.css
265endif
266
267ifeq ($(DOC),kernel-dev)
268XSLTOPTS = --xinclude
269ALLPREQ = html pdf eclipse tarball
270TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css figures/kernel-dev-title.png \
271 figures/kernel-architecture-overview.png \
272 eclipse
273MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse
274FIGURES = figures
275STYLESHEET = $(DOC)/*.css
276endif
277
278
279##
280# These URI should be rewritten by your distribution's xml catalog to
281# match your localy installed XSL stylesheets.
282XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
283XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
284
285all: $(ALLPREQ)
286
287pdf:
288ifeq ($(DOC),yocto-project-qs)
289 @echo " "
290 @echo "ERROR: You cannot generate a yocto-project-qs PDF file."
291 @echo " "
292
293else ifeq ($(DOC),mega-manual)
294 @echo " "
295 @echo "ERROR: You cannot generate a mega-manual PDF file."
296 @echo " "
297
298else
299
300 cd $(DOC); ../tools/poky-docbook-to-pdf $(DOC).xml ../template; cd ..
301endif
302
303html:
304ifeq ($(DOC),mega-manual)
305# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
306 @echo " "
307 @echo "******** Building "$(DOC)
308 @echo " "
309 cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
310 @echo " "
311 @echo "******** Using mega-manual.sed to process external links"
312 @echo " "
313 cd $(DOC); sed -f ../tools/mega-manual.sed < mega-manual.html > mega-output.html; cd ..
314 @echo " "
315 @echo "******** Cleaning up transient file mega-output.html"
316 @echo " "
317 cd $(DOC); rm mega-manual.html; mv mega-output.html mega-manual.html; cd ..
318else
319# See http://www.sagehill.net/docbookxsl/HtmlOutput.html
320 @echo " "
321 @echo "******** Building "$(DOC)
322 @echo " "
323 cd $(DOC); xsltproc $(XSLTOPTS) -o $(DOC).html $(DOC)-customization.xsl $(DOC).xml; cd ..
324endif
325
326
327eclipse: BASE_DIR = html/$(DOC)/
328
329eclipse: eclipse-generate eclipse-resolve-links
330
331.PHONY : eclipse-generate eclipse-resolve-links
332
333eclipse-generate:
334ifeq ($(filter $(DOC), adt-manual bsp-guide dev-manual kernel-dev profile-manual ref-manual yocto-project-qs),)
335 @echo " "
336 @echo "ERROR: You can only create eclipse documentation"
337 @echo " of the following documentation parts:"
338 @echo " - adt-manual"
339 @echo " - bsp-guide"
340 @echo " - dev-manual"
341 @echo " - kernel-dev"
342 @echo " - profile-manual"
343 @echo " - ref-manual"
344 @echo " - yocto-project-qs"
345 @echo " "
346else
347 @echo " "
348 @echo "******** Building eclipse help of "$(DOC)
349 @echo " "
350 cd $(DOC) && \
351 xsltproc $(XSLTOPTS) \
352 --stringparam base.dir '$(BASE_DIR)' \
353 -o eclipse/$(DOC).html \
354 $(DOC)-eclipse-customization.xsl $(DOC).xml && \
355 mv eclipse/toc.xml eclipse/$(DOC)-toc.xml && \
356 cp -rf $(FIGURES) eclipse/$(BASE_DIR) && \
357 cd ..;
358
359 $(call modify-eclipse)
360endif
361
362eclipse-resolve-links:
363 @echo " "
364 @echo "******** Using eclipse-help.sed to process external links"
365 @echo " "
366 $(foreach FILE, \
367 $(wildcard $(DOC)/eclipse/html/$(DOC)/*.html), \
368 $(shell sed -i -f tools/eclipse-help.sed $(FILE)))
369
370tarball: html
371 @echo " "
372 @echo "******** Creating Tarball of document files"
373 @echo " "
374 cd $(DOC); tar -cvzf $(DOC).tgz $(TARFILES); cd ..
375
376validate:
377 cd $(DOC); xmllint --postvalid --xinclude --noout $(DOC).xml; cd ..
378
379
380publish:
381 @if test -f $(DOC)/$(DOC).html; \
382 then \
383 echo " "; \
384 echo "******** Publishing "$(DOC)".html"; \
385 echo " "; \
386 scp -r $(MANUALS) $(STYLESHEET) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \
387 cd $(DOC); scp -r $(FIGURES) docs.yp:/var/www/www.yoctoproject.org-docs/$(VER)/$(DOC); \
388 else \
389 echo " "; \
390 echo $(DOC)".html missing. Generate the file first then try again."; \
391 echo " "; \
392 fi
393
394clean:
395 rm -rf $(MANUALS); rm $(DOC)/$(DOC).tgz;
diff --git a/documentation/README b/documentation/README
new file mode 100644
index 0000000000..d01678d4f4
--- /dev/null
+++ b/documentation/README
@@ -0,0 +1,91 @@
1documentation
2=============
3
4This is the directory that contains the Yocto Project documentation. The Yocto
5Project source repositories at http://git.yoctoproject.org/cgit.cgi have two
6instances of the "documentation" directory. You should understand each of
7these instances.
8
9 poky/documentation - The directory within the poky Git repository containing
10 the set of Yocto Project manuals. When you clone the
11 poky Git repository, the documentation directory
12 contains the manuals. The state of the manuals in this
13 directory is guaranteed to reflect the latest Yocto
14 Project release. The manuals at the tip of this
15 directory will also likely contain most manual
16 development changes.
17
18 yocto-docs/documentation - The Git repository for the Yocto Project manuals.
19 This repository is where manual development
20 occurs. If you plan on contributing back to the
21 Yocto Project documentation, you should set up
22 a local Git repository based on this upstream
23 repository as follows:
24
25 git clone git://git.yoctoproject.org/yocto-docs
26
27 Changes and patches are first pushed to the
28 yocto-docs Git repository. Later, they make it
29 into the poky Git repository found at
30 git://git.yoctoproject.org/poky.
31
32Manual Organization
33===================
34
35Folders exist for individual manuals as follows:
36
37* adt-manual - The Yocto Project Application Developer's Guide.
38* bsp-guide - The Yocto Project Board Support Package (BSP) Developer's Guide
39* dev-manual - The Yocto Project Development Manual
40* kernel-dev - The Yocto Project Linux Kernel Development Manual
41* ref-manual - The Yocto Project Reference Manual
42* yocto-project-qs - The Yocto Project Quick Start
43* mega-manual - An aggregated manual comprised of all YP manuals and guides
44* profile-manual - The Yocto Project Profile and Tracing Manual
45
46Each folder is self-contained regarding content and figures. Note that there
47is a sed file needed to process the links of the mega-manual. The sed file
48is located in the tools directory. Also note that the figures folder in the
49mega-manual directory contains duplicates of all the figures in the YP folders
50directories for all YP manuals and guides.
51
52If you want to find HTML versions of the Yocto Project manuals on the web,
53go to http://www.yoctoproject.org and click on the "Documentation" tab. From
54there you have access to archived documentation from previous releases, current
55documentation for the latest release, and "Docs in Progress" for the release
56currently being developed.
57
58In general, the Yocto Project site (http://www.yoctoproject.org) is a great
59reference for both information and downloads.
60
61Makefile
62========
63
64The Makefile processes manual directories to create HTML, PDF,
65tarballs, etc. Details on how the Makefile work are documented
66inside the Makefile. See that file for more information.
67
68To build a manual, you run the make command and pass it the name
69of the folder containing the manual's contents.
70For example, the following command run from the documentation directory
71creates an HTML and a PDF version of the ADT manual.
72The DOC variable specifies the manual you are making:
73
74 $ make DOC=adt-manual
75
76poky.ent
77========
78
79This file defines variables used for documentation production. The variables
80are used to define release pathnames, URLs for the published manuals, etc.
81
82template
83========
84Contains various templates, fonts, and some old PNG files.
85
86tools
87=====
88Contains a tool to convert the DocBook files to PDF format. This folder also
89contains the mega-manual.sed file, which is used by Makefile to process
90cross-references from within the manual that normally go to an external
91manual.
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
new file mode 100644
index 0000000000..0ed3396ef5
--- /dev/null
+++ b/documentation/adt-manual/adt-command.xml
@@ -0,0 +1,224 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='using-the-command-line'>
6<title>Using the Command Line</title>
7
8 <para>
9 Recall that earlier the manual discussed how to use an existing toolchain
10 tarball that had been installed into the default installation
11 directory, <filename>/opt/poky/&DISTRO;</filename>, which is outside of the
12 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
13 (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball)</link>".
14 And, that sourcing your architecture-specific environment setup script
15 initializes a suitable cross-toolchain development environment.
16 </para>
17
18 <para>
19 During this setup, locations for the compiler, QEMU scripts, QEMU binary,
20 a special version of <filename>pkgconfig</filename> and other useful
21 utilities are added to the <filename>PATH</filename> variable.
22 Also, variables to assist
23 <filename>pkgconfig</filename> and <filename>autotools</filename>
24 are also defined so that, for example, <filename>configure.sh</filename>
25 can find pre-generated test results for tests that need target hardware
26 on which to run.
27 </para>
28
29 <para>
30 Collectively, these conditions allow you to easily use the toolchain
31 outside of the OpenEmbedded build environment on both autotools-based
32 projects and Makefile-based projects.
33 This chapter provides information for both these types of projects.
34 </para>
35
36
37<section id='autotools-based-projects'>
38<title>Autotools-Based Projects</title>
39
40 <para>
41 Once you have a suitable cross-toolchain installed, it is very easy to
42 develop a project outside of the OpenEmbedded build system.
43 This section presents a simple "Helloworld" example that shows how
44 to set up, compile, and run the project.
45 </para>
46
47 <section id='creating-and-running-a-project-based-on-gnu-autotools'>
48 <title>Creating and Running a Project Based on GNU Autotools</title>
49
50 <para>
51 Follow these steps to create a simple autotools-based project:
52 <orderedlist>
53 <listitem><para><emphasis>Create your directory:</emphasis>
54 Create a clean directory for your project and then make
55 that directory your working location:
56 <literallayout class='monospaced'>
57 $ mkdir $HOME/helloworld
58 $ cd $HOME/helloworld
59 </literallayout></para></listitem>
60 <listitem><para><emphasis>Populate the directory:</emphasis>
61 Create <filename>hello.c</filename>, <filename>Makefile.am</filename>,
62 and <filename>configure.in</filename> files as follows:
63 <itemizedlist>
64 <listitem><para>For <filename>hello.c</filename>, include
65 these lines:
66 <literallayout class='monospaced'>
67 #include &lt;stdio.h&gt;
68
69 main()
70 {
71 printf("Hello World!\n");
72 }
73 </literallayout></para></listitem>
74 <listitem><para>For <filename>Makefile.am</filename>,
75 include these lines:
76 <literallayout class='monospaced'>
77 bin_PROGRAMS = hello
78 hello_SOURCES = hello.c
79 </literallayout></para></listitem>
80 <listitem><para>For <filename>configure.in</filename>,
81 include these lines:
82 <literallayout class='monospaced'>
83 AC_INIT(hello.c)
84 AM_INIT_AUTOMAKE(hello,0.1)
85 AC_PROG_CC
86 AC_PROG_INSTALL
87 AC_OUTPUT(Makefile)
88 </literallayout></para></listitem>
89 </itemizedlist></para></listitem>
90 <listitem><para><emphasis>Source the cross-toolchain
91 environment setup file:</emphasis>
92 Installation of the cross-toolchain creates a cross-toolchain
93 environment setup script in the directory that the ADT
94 was installed.
95 Before you can use the tools to develop your project, you must
96 source this setup script.
97 The script begins with the string "environment-setup" and contains
98 the machine architecture, which is followed by the string
99 "poky-linux".
100 Here is an example that sources a script from the
101 default ADT installation directory that uses the
102 32-bit Intel x86 Architecture and using the
103 &DISTRO_NAME; Yocto Project release:
104 <literallayout class='monospaced'>
105 $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
106 </literallayout></para></listitem>
107 <listitem><para><emphasis>Generate the local aclocal.m4
108 files and create the configure script:</emphasis>
109 The following GNU Autotools generate the local
110 <filename>aclocal.m4</filename> files and create the
111 configure script:
112 <literallayout class='monospaced'>
113 $ aclocal
114 $ autoconf
115 </literallayout></para></listitem>
116 <listitem><para><emphasis>Generate files needed by GNU
117 coding standards:</emphasis>
118 GNU coding standards require certain files in order for the
119 project to be compliant.
120 This command creates those files:
121 <literallayout class='monospaced'>
122 $ touch NEWS README AUTHORS ChangeLog
123 </literallayout></para></listitem>
124 <listitem><para><emphasis>Generate the configure
125 file:</emphasis>
126 This command generates the <filename>configure</filename>:
127 <literallayout class='monospaced'>
128 $ automake -a
129 </literallayout></para></listitem>
130 <listitem><para><emphasis>Cross-compile the project:</emphasis>
131 This command compiles the project using the cross-compiler:
132 <literallayout class='monospaced'>
133 $ ./configure ${CONFIGURE_FLAGS}
134 </literallayout></para></listitem>
135 <listitem><para><emphasis>Make and install the project:</emphasis>
136 These two commands generate and install the project into the
137 destination directory:
138 <literallayout class='monospaced'>
139 $ make
140 $ make install DESTDIR=./tmp
141 </literallayout></para></listitem>
142 <listitem><para><emphasis>Verify the installation:</emphasis>
143 This command is a simple way to verify the installation
144 of your project.
145 Running the command prints the architecture on which
146 the binary file can run.
147 This architecture should be the same architecture that
148 the installed cross-toolchain supports.
149 <literallayout class='monospaced'>
150 $ file ./tmp/usr/local/bin/hello
151 </literallayout></para></listitem>
152 <listitem><para><emphasis>Execute your project:</emphasis>
153 To execute the project in the shell, simply enter the name.
154 You could also copy the binary to the actual target hardware
155 and run the project there as well:
156 <literallayout class='monospaced'>
157 $ ./hello
158 </literallayout>
159 As expected, the project displays the "Hello World!" message.
160 </para></listitem>
161 </orderedlist>
162 </para>
163 </section>
164
165 <section id='passing-host-options'>
166 <title>Passing Host Options</title>
167
168 <para>
169 For an Autotools-based project, you can use the cross-toolchain by just
170 passing the appropriate host option to <filename>configure.sh</filename>.
171 The host option you use is derived from the name of the environment setup
172 script found in the directory in which you installed the cross-toolchain.
173 For example, the host option for an ARM-based target that uses the GNU EABI
174 is <filename>armv5te-poky-linux-gnueabi</filename>.
175 You will notice that the name of the script is
176 <filename>environment-setup-armv5te-poky-linux-gnueabi</filename>.
177 Thus, the following command works:
178 <literallayout class='monospaced'>
179 $ ./configure --host=armv5te-poky-linux-gnueabi \
180 --with-libtool-sysroot=&lt;sysroot-dir&gt;
181 </literallayout>
182 </para>
183
184 <para>
185 This single command updates your project and rebuilds it using the appropriate
186 cross-toolchain tools.
187 <note>
188 If <filename>configure</filename> script results in problems recognizing the
189 <filename>--with-libtool-sysroot=&lt;sysroot-dir&gt;</filename> option,
190 regenerate the script to enable the support by doing the following and then
191 run the script again:
192 <literallayout class='monospaced'>
193 $ libtoolize --automake
194 $ aclocal -I ${OECORE_NATIVE_SYSROOT}/usr/share/aclocal \
195 [-I &lt;dir_containing_your_project-specific_m4_macros&gt;]
196 $ autoconf
197 $ autoheader
198 $ automake -a
199 </literallayout>
200 </note>
201 </para>
202 </section>
203</section>
204
205<section id='makefile-based-projects'>
206<title>Makefile-Based Projects</title>
207
208 <para>
209 For a Makefile-based project, you use the cross-toolchain by making sure
210 the tools are used.
211 You can do this as follows:
212 <literallayout class='monospaced'>
213 CC=arm-poky-linux-gnueabi-gcc
214 LD=arm-poky-linux-gnueabi-ld
215 CFLAGS=”${CFLAGS} --sysroot=&lt;sysroot-dir&gt;”
216 CXXFLAGS=”${CXXFLAGS} --sysroot=&lt;sysroot-dir&gt;”
217 </literallayout>
218 </para>
219</section>
220
221</chapter>
222<!--
223vim: expandtab tw=80 ts=4
224-->
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml
new file mode 100644
index 0000000000..a92828515d
--- /dev/null
+++ b/documentation/adt-manual/adt-intro.xml
@@ -0,0 +1,195 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='adt-intro'>
6<title>Introduction</title>
7
8<para>
9 Welcome to the Yocto Project Application Developer's Guide.
10 This manual provides information that lets you begin developing applications
11 using the Yocto Project.
12</para>
13
14<para>
15 The Yocto Project provides an application development environment based on
16 an Application Development Toolkit (ADT) and the availability of stand-alone
17 cross-development toolchains and other tools.
18 This manual describes the ADT and how you can configure and install it,
19 how to access and use the cross-development toolchains, how to
20 customize the development packages installation,
21 how to use command line development for both Autotools-based and Makefile-based projects,
22 and an introduction to the <trademark class='trade'>Eclipse</trademark> IDE
23 Yocto Plug-in.
24 <note>
25 The ADT is distribution-neutral and does not require the Yocto
26 Project reference distribution, which is called Poky.
27 This manual, however, uses examples that use the Poky distribution.
28 </note>
29</para>
30
31<section id='adt-intro-section'>
32 <title>The Application Development Toolkit (ADT)</title>
33
34 <para>
35 Part of the Yocto Project development solution is an Application Development
36 Toolkit (ADT).
37 The ADT provides you with a custom-built, cross-development
38 platform suited for developing a user-targeted product application.
39 </para>
40
41 <para>
42 Fundamentally, the ADT consists of the following:
43 <itemizedlist>
44 <listitem><para>An architecture-specific cross-toolchain and matching
45 sysroot both built by the OpenEmbedded build system.
46 The toolchain and sysroot are based on a
47 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
48 configuration and extensions,
49 which allows you to cross-develop on the host machine for the target hardware.
50 </para></listitem>
51 <listitem><para>The Eclipse IDE Yocto Plug-in.</para></listitem>
52 <listitem><para>The Quick EMUlator (QEMU), which lets you simulate target hardware.
53 </para></listitem>
54 <listitem><para>Various user-space tools that greatly enhance your application
55 development experience.</para></listitem>
56 </itemizedlist>
57 </para>
58
59 <section id='the-cross-development-toolchain'>
60 <title>The Cross-Development Toolchain</title>
61
62 <para>
63 The
64 <ulink url='&YOCTO_DOCS_DEV_URL;#cross-development-toolchain'>Cross-Development Toolchain</ulink>
65 consists of a cross-compiler, cross-linker, and cross-debugger
66 that are used to develop user-space applications for targeted
67 hardware.
68 This toolchain is created either by running the ADT Installer
69 script, a toolchain installer script, or through a
70 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
71 that is based on your Metadata configuration or extension for
72 your targeted device.
73 The cross-toolchain works with a matching target sysroot.
74 </para>
75 </section>
76
77 <section id='sysroot'>
78 <title>Sysroot</title>
79
80 <para>
81 The matching target sysroot contains needed headers and libraries for generating
82 binaries that run on the target architecture.
83 The sysroot is based on the target root filesystem image that is built by
84 the OpenEmbedded build system and uses the same Metadata configuration
85 used to build the cross-toolchain.
86 </para>
87 </section>
88
89 <section id='eclipse-overview'>
90 <title>Eclipse Yocto Plug-in</title>
91
92 <para>
93 The Eclipse IDE is a popular development environment and it fully supports
94 development using the Yocto Project.
95 When you install and configure the Eclipse Yocto Project Plug-in into
96 the Eclipse IDE, you maximize your Yocto Project experience.
97 Installing and configuring the Plug-in results in an environment that
98 has extensions specifically designed to let you more easily develop software.
99 These extensions allow for cross-compilation, deployment, and execution of
100 your output into a QEMU emulation session.
101 You can also perform cross-debugging and profiling.
102 The environment also supports a suite of tools that allows you to perform
103 remote profiling, tracing, collection of power data, collection of
104 latency data, and collection of performance data.
105 </para>
106
107 <para>
108 For information about the application development workflow that uses the Eclipse
109 IDE and for a detailed example of how to install and configure the Eclipse
110 Yocto Project Plug-in, see the
111 "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working Within Eclipse</ulink>" section
112 of the Yocto Project Development Manual.
113 </para>
114 </section>
115
116 <section id='the-qemu-emulator'>
117 <title>The QEMU Emulator</title>
118
119 <para>
120 The QEMU emulator allows you to simulate your hardware while running your
121 application or image.
122 QEMU is made available a number of ways:
123 <itemizedlist>
124 <listitem><para>If you use the ADT Installer script to install ADT, you can
125 specify whether or not to install QEMU.</para></listitem>
126 <listitem><para>If you have downloaded a Yocto Project release and unpacked
127 it to create a
128 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> and
129 you have sourced
130 the environment setup script, QEMU is installed and automatically
131 available.</para></listitem>
132 <listitem><para>If you have installed the cross-toolchain
133 tarball and you have sourced the toolchain's setup environment script, QEMU
134 is also installed and automatically available.</para></listitem>
135 </itemizedlist>
136 </para>
137 </section>
138
139 <section id='user-space-tools'>
140 <title>User-Space Tools</title>
141
142 <para>
143 User-space tools are included as part of the distribution.
144 You will find these tools helpful during development.
145 The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust.
146 These tools are common development tools for the Linux platform.
147 <itemizedlist>
148 <listitem><para><emphasis>LatencyTOP:</emphasis> LatencyTOP focuses on latency
149 that causes skips in audio,
150 stutters in your desktop experience, or situations that overload your server
151 even when you have plenty of CPU power left.
152 </para></listitem>
153 <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what
154 software is using the most power.
155 You can find out more about PowerTOP at
156 <ulink url='https://01.org/powertop/'></ulink>.</para></listitem>
157 <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux
158 systems that is capable of profiling all running code at low overhead.
159 You can find out more about OProfile at
160 <ulink url='http://oprofile.sourceforge.net/about/'></ulink>.
161 For examples on how to setup and use this tool, see the
162 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>"
163 section in the Yocto Project Profiling and Tracing Manual.
164 </para></listitem>
165 <listitem><para><emphasis>Perf:</emphasis> Performance counters for Linux used
166 to keep track of certain types of hardware and software events.
167 For more information on these types of counters see
168 <ulink url='https://perf.wiki.kernel.org/'></ulink> and click
169 on “Perf tools.”
170 For examples on how to setup and use this tool, see the
171 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
172 section in the Yocto Project Profiling and Tracing Manual.
173 </para></listitem>
174 <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure
175 that simplifies information gathering about a running Linux system.
176 This information helps you diagnose performance or functional problems.
177 SystemTap is not available as a user-space tool through the Eclipse IDE Yocto Plug-in.
178 See <ulink url='http://sourceware.org/systemtap'></ulink> for more information
179 on SystemTap.
180 For examples on how to setup and use this tool, see the
181 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-systemtap'>SystemTap</ulink>"
182 section in the Yocto Project Profiling and Tracing Manual.</para></listitem>
183 <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to
184 provide detailed information on user-space activity.
185 See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust.
186 </para></listitem>
187 </itemizedlist>
188 </para>
189 </section>
190</section>
191
192</chapter>
193<!--
194vim: expandtab tw=80 ts=4
195-->
diff --git a/documentation/adt-manual/adt-manual-customization.xsl b/documentation/adt-manual/adt-manual-customization.xsl
new file mode 100644
index 0000000000..373bdb7140
--- /dev/null
+++ b/documentation/adt-manual/adt-manual-customization.xsl
@@ -0,0 +1,11 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="html.stylesheet" select="'adt-style.css'" />
7 <xsl:param name="chapter.autolabel" select="1" />
8 <xsl:param name="appendix.autolabel" select="1" />
9 <xsl:param name="section.autolabel" select="1" />
10 <xsl:param name="section.label.includes.component.label" select="1" />
11</xsl:stylesheet>
diff --git a/documentation/adt-manual/adt-manual-eclipse-customization.xsl b/documentation/adt-manual/adt-manual-eclipse-customization.xsl
new file mode 100644
index 0000000000..d16ffbb68e
--- /dev/null
+++ b/documentation/adt-manual/adt-manual-eclipse-customization.xsl
@@ -0,0 +1,27 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10
11 <xsl:param name="chunker.output.indent" select="'yes'"/>
12 <xsl:param name="chunk.quietly" select="1"/>
13 <xsl:param name="chunk.first.sections" select="1"/>
14 <xsl:param name="chunk.section.depth" select="10"/>
15 <xsl:param name="use.id.as.filename" select="1"/>
16 <xsl:param name="ulink.target" select="'_self'" />
17 <xsl:param name="base.dir" select="'html/adt-manual/'"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="chapter.autolabel" select="1" />
24 <xsl:param name="appendix.autolabel" select="1" />
25 <xsl:param name="section.autolabel" select="1" />
26 <xsl:param name="section.label.includes.component.label" select="1" />
27</xsl:stylesheet>
diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml
new file mode 100644
index 0000000000..9ac54d35d0
--- /dev/null
+++ b/documentation/adt-manual/adt-manual.xml
@@ -0,0 +1,113 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='adt-manual' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/adt-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Application Developer's Guide
21 </title>
22
23 <authorgroup>
24 <author>
25 <firstname>Jessica</firstname> <surname>Zhang</surname>
26 <affiliation>
27 <orgname>Intel Corporation</orgname>
28 </affiliation>
29 <email>jessica.zhang@intel.com</email>
30 </author>
31 </authorgroup>
32
33 <revhistory>
34 <revision>
35 <revnumber>1.0</revnumber>
36 <date>6 April 2011</date>
37 <revremark>Released with the Yocto Project 1.0 Release.</revremark>
38 </revision>
39 <revision>
40 <revnumber>1.0.1</revnumber>
41 <date>23 May 2011</date>
42 <revremark>Released with the Yocto Project 1.0.1 Release.</revremark>
43 </revision>
44 <revision>
45 <revnumber>1.1</revnumber>
46 <date>6 October 2011</date>
47 <revremark>Released with the Yocto Project 1.1 Release.</revremark>
48 </revision>
49 <revision>
50 <revnumber>1.2</revnumber>
51 <date>April 2012</date>
52 <revremark>Released with the Yocto Project 1.2 Release.</revremark>
53 </revision>
54 <revision>
55 <revnumber>1.3</revnumber>
56 <date>October 2012</date>
57 <revremark>Released with the Yocto Project 1.3 Release.</revremark>
58 </revision>
59 <revision>
60 <revnumber>1.4</revnumber>
61 <date>April 2013</date>
62 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
63 </revision>
64 <revision>
65 <revnumber>1.5</revnumber>
66 <date>October 2013</date>
67 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
68 </revision>
69 <revision>
70 <revnumber>1.5.1</revnumber>
71 <date>Sometime in 2013</date>
72 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
73 </revision>
74 </revhistory>
75
76 <copyright>
77 <year>&COPYRIGHT_YEAR;</year>
78 <holder>Linux Foundation</holder>
79 </copyright>
80
81 <legalnotice>
82 <para>
83 Permission is granted to copy, distribute and/or modify this document under
84 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
85 </para>
86 <note>
87 For the latest version of this manual associated with this
88 Yocto Project release, see the
89 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>
90 from the Yocto Project website.
91 </note>
92
93 </legalnotice>
94
95 </bookinfo>
96
97 <xi:include href="adt-intro.xml"/>
98
99 <xi:include href="adt-prepare.xml"/>
100
101 <xi:include href="adt-package.xml"/>
102
103 <xi:include href="adt-command.xml"/>
104
105<!-- <index id='index'>
106 <title>Index</title>
107 </index>
108-->
109
110</book>
111<!--
112vim: expandtab tw=80 ts=4
113-->
diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml
new file mode 100644
index 0000000000..48edf0aef5
--- /dev/null
+++ b/documentation/adt-manual/adt-package.xml
@@ -0,0 +1,101 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='adt-package'>
6<title>Optionally Customizing the Development Packages Installation</title>
7
8 <para>
9 Because the Yocto Project is suited for embedded Linux development, it is
10 likely that you will need to customize your development packages installation.
11 For example, if you are developing a minimal image, then you might not need
12 certain packages (e.g. graphics support packages).
13 Thus, you would like to be able to remove those packages from your target sysroot.
14 </para>
15
16<section id='package-management-systems'>
17 <title>Package Management Systems</title>
18
19 <para>
20 The OpenEmbedded build system supports the generation of sysroot files using
21 three different Package Management Systems (PMS):
22 <itemizedlist>
23 <listitem><para><emphasis>OPKG:</emphasis> A less well known PMS whose use
24 originated in the OpenEmbedded and OpenWrt embedded Linux projects.
25 This PMS works with files packaged in an <filename>.ipk</filename> format.
26 See <ulink url='http://en.wikipedia.org/wiki/Opkg'></ulink> for more
27 information about OPKG.</para></listitem>
28 <listitem><para><emphasis>RPM:</emphasis> A more widely known PMS intended for GNU/Linux
29 distributions.
30 This PMS works with files packaged in an <filename>.rms</filename> format.
31 The build system currently installs through this PMS by default.
32 See <ulink url='http://en.wikipedia.org/wiki/RPM_Package_Manager'></ulink>
33 for more information about RPM.</para></listitem>
34 <listitem><para><emphasis>Debian:</emphasis> The PMS for Debian-based systems
35 is built on many PMS tools.
36 The lower-level PMS tool <filename>dpkg</filename> forms the base of the Debian PMS.
37 For information on dpkg see
38 <ulink url='http://en.wikipedia.org/wiki/Dpkg'></ulink>.</para></listitem>
39 </itemizedlist>
40 </para>
41</section>
42
43<section id='configuring-the-pms'>
44 <title>Configuring the PMS</title>
45
46 <para>
47 Whichever PMS you are using, you need to be sure that the
48 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>
49 variable in the <filename>conf/local.conf</filename>
50 file is set to reflect that system.
51 The first value you choose for the variable specifies the package file format for the root
52 filesystem at sysroot.
53 Additional values specify additional formats for convenience or testing.
54 See the configuration file for details.
55 </para>
56
57 <note>
58 For build performance information related to the PMS, see the
59 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
60 section in the Yocto Project Reference Manual.
61 </note>
62
63 <para>
64 As an example, consider a scenario where you are using OPKG and you want to add
65 the <filename>libglade</filename> package to the target sysroot.
66 </para>
67
68 <para>
69 First, you should generate the <filename>ipk</filename> file for the
70 <filename>libglade</filename> package and add it
71 into a working <filename>opkg</filename> repository.
72 Use these commands:
73 <literallayout class='monospaced'>
74 $ bitbake libglade
75 $ bitbake package-index
76 </literallayout>
77 </para>
78
79 <para>
80 Next, source the environment setup script found in the
81 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
82 Follow that by setting up the installation destination to point to your
83 sysroot as <filename>&lt;sysroot_dir&gt;</filename>.
84 Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename>
85 that corresponds to the <filename>opkg</filename> repository you have just created.
86 The following command forms should now work:
87 <literallayout class='monospaced'>
88 $ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; update
89 $ opkg-cl –f &lt;cconf_file&gt; -o &lt;sysroot_dir&gt; \
90 --force-overwrite install libglade
91 $ opkg-cl –f &lt;cconf_file&gt; -o &lt;sysroot_dir&gt; \
92 --force-overwrite install libglade-dbg
93 $ opkg-cl –f &lt;conf_file&gt; -o &lt;sysroot_dir&gt; \
94 --force-overwrite install libglade-dev
95 </literallayout>
96 </para>
97</section>
98</chapter>
99<!--
100vim: expandtab tw=80 ts=4
101-->
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
new file mode 100644
index 0000000000..02416b3cda
--- /dev/null
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -0,0 +1,646 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='adt-prepare'>
6
7<title>Preparing for Application Development</title>
8
9<para>
10 In order to develop applications, you need set up your host development system.
11 Several ways exist that allow you to install cross-development tools, QEMU, the
12 Eclipse Yocto Plug-in, and other tools.
13 This chapter describes how to prepare for application development.
14</para>
15
16<section id='installing-the-adt'>
17 <title>Installing the ADT and Toolchains</title>
18
19 <para>
20 The following list describes installation methods that set up varying degrees of tool
21 availability on your system.
22 Regardless of the installation method you choose,
23 you must <filename>source</filename> the cross-toolchain
24 environment setup script before you use a toolchain.
25 See the "<link linkend='setting-up-the-cross-development-environment'>Setting Up the
26 Cross-Development Environment</link>" section for more information.
27 </para>
28
29 <note>
30 <para>Avoid mixing installation methods when installing toolchains for different architectures.
31 For example, avoid using the ADT Installer to install some toolchains and then hand-installing
32 cross-development toolchains by running the toolchain installer for different architectures.
33 Mixing installation methods can result in situations where the ADT Installer becomes
34 unreliable and might not install the toolchain.</para>
35 <para>If you must mix installation methods, you might avoid problems by deleting
36 <filename>/var/lib/opkg</filename>, thus purging the <filename>opkg</filename> package
37 metadata</para>
38 </note>
39
40 <para>
41 <itemizedlist>
42 <listitem><para><emphasis>Use the ADT installer script:</emphasis>
43 This method is the recommended way to install the ADT because it
44 automates much of the process for you.
45 For example, you can configure the installation to install the QEMU emulator
46 and the user-space NFS, specify which root filesystem profiles to download,
47 and define the target sysroot location.</para></listitem>
48 <listitem><para><emphasis>Use an existing toolchain:</emphasis>
49 Using this method, you select and download an architecture-specific
50 toolchain installer and then run the script to hand-install the toolchain.
51 If you use this method, you just get the cross-toolchain and QEMU - you do not
52 get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem>
53 <listitem><para><emphasis>Use the toolchain from within the Build Directory:</emphasis>
54 If you already have a
55 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
56 you can build the cross-toolchain within the directory.
57 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you
58 do not get any of the other benefits without taking separate steps.</para></listitem>
59 </itemizedlist>
60 </para>
61
62 <section id='using-the-adt-installer'>
63 <title>Using the ADT Installer</title>
64
65 <para>
66 To run the ADT Installer, you need to get the ADT Installer tarball, be sure
67 you have the necessary host development packages that support the ADT Installer,
68 and then run the ADT Installer Script.
69 </para>
70
71 <para>
72 For a list of the host packages needed to support ADT installation and use, see the
73 "ADT Installer Extras" lists in the
74 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" section
75 of the Yocto Project Reference Manual.
76 </para>
77
78 <section id='getting-the-adt-installer-tarball'>
79 <title>Getting the ADT Installer Tarball</title>
80
81 <para>
82 The ADT Installer is contained in the ADT Installer tarball.
83 You can get the tarball using either of these methods:
84 <itemizedlist>
85 <listitem><para><emphasis>Download the Tarball:</emphasis>
86 You can download the tarball from
87 <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink> into
88 any directory.</para></listitem>
89 <listitem><para><emphasis>Build the Tarball:</emphasis>
90 You can use BitBake to generate the tarball inside an
91 existing
92 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
93 </para>
94 <para>If you use BitBake to generate the ADT Installer
95 tarball, you must <filename>source</filename> the
96 environment setup script
97 (<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
98 or
99 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
100 located in the Source Directory before running the
101 BitBake command that creates the tarball.</para>
102 <para>The following example commands establish
103 the
104 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
105 check out the current release branch, set up the
106 build environment while also creating the default
107 Build Directory, and run the BitBake command that
108 results in the tarball
109 <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>:
110 <note>
111 Before using BitBake to build the ADT tarball, be
112 sure to make sure your
113 <filename>local.conf</filename> file is properly
114 configured.
115 </note>
116 <literallayout class='monospaced'>
117 $ cd ~
118 $ git clone git://git.yoctoproject.org/poky
119 $ cd poky
120 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
121 $ source &OE_INIT_FILE;
122 $ bitbake adt-installer
123 </literallayout></para></listitem>
124 </itemizedlist>
125 </para>
126 </section>
127
128 <section id='configuring-and-running-the-adt-installer-script'>
129 <title>Configuring and Running the ADT Installer Script</title>
130
131 <para>
132 Before running the ADT Installer script, you need to unpack the tarball.
133 You can unpack the tarball in any directory you wish.
134 For example, this command copies the ADT Installer tarball from where
135 it was built into the home directory and then unpacks the tarball into
136 a top-level directory named <filename>adt-installer</filename>:
137 <literallayout class='monospaced'>
138 $ cd ~
139 $ cp ~/poky/build/tmp/deploy/sdk/adt_installer.tar.bz2 $HOME
140 $ tar -xjf adt_installer.tar.bz2
141 </literallayout>
142 Unpacking it creates the directory <filename>adt-installer</filename>,
143 which contains the ADT Installer script (<filename>adt_installer</filename>)
144 and its configuration file (<filename>adt_installer.conf</filename>).
145 </para>
146
147 <para>
148 Before you run the script, however, you should examine the ADT Installer configuration
149 file and be sure you are going to get what you want.
150 Your configurations determine which kernel and filesystem image are downloaded.
151 </para>
152
153 <para>
154 The following list describes the configurations you can define for the ADT Installer.
155 For configuration values and restrictions, see the comments in
156 the <filename>adt-installer.conf</filename> file:
157
158 <itemizedlist>
159 <listitem><para><filename>YOCTOADT_REPO</filename>: This area
160 includes the IPKG-based packages and the root filesystem upon which
161 the installation is based.
162 If you want to set up your own IPKG repository pointed to by
163 <filename>YOCTOADT_REPO</filename>, you need to be sure that the
164 directory structure follows the same layout as the reference directory
165 set up at <ulink url='http://adtrepo.yoctoproject.org'></ulink>.
166 Also, your repository needs to be accessible through HTTP.</para></listitem>
167 <listitem><para><filename>YOCTOADT_TARGETS</filename>: The machine
168 target architectures for which you want to set up cross-development
169 environments.</para></listitem>
170 <listitem><para><filename>YOCTOADT_QEMU</filename>: Indicates whether
171 or not to install the emulator QEMU.</para></listitem>
172 <listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether
173 or not to install user-mode NFS.
174 If you plan to use the Eclipse IDE Yocto plug-in against QEMU,
175 you should install NFS.
176 <note>To boot QEMU images using our userspace NFS server, you need
177 to be running <filename>portmap</filename> or <filename>rpcbind</filename>.
178 If you are running <filename>rpcbind</filename>, you will also need to add the
179 <filename>-i</filename> option when <filename>rpcbind</filename> starts up.
180 Please make sure you understand the security implications of doing this.
181 You might also have to modify your firewall settings to allow
182 NFS booting to work.</note></para></listitem>
183 <listitem><para><filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>: The root
184 filesystem images you want to download from the
185 <filename>YOCTOADT_IPKG_REPO</filename> repository.</para></listitem>
186 <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_&lt;arch&gt;</filename>: The
187 particular root filesystem used to extract and create the target sysroot.
188 The value of this variable must have been specified with
189 <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>.
190 For example, if you downloaded both <filename>minimal</filename> and
191 <filename>sato-sdk</filename> images by setting
192 <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>
193 to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_&lt;arch&gt;</filename>
194 must be set to either <filename>minimal</filename> or
195 <filename>sato-sdk</filename>.</para></listitem>
196 <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename>: The
197 location on the development host where the target sysroot is created.
198 </para></listitem>
199 </itemizedlist>
200 </para>
201
202 <para>
203 After you have configured the <filename>adt_installer.conf</filename> file,
204 run the installer using the following command.
205 Be sure that you are not trying to use cross-compilation tools.
206 When you run the installer, the environment must use a
207 host <filename>gcc</filename>:
208 <literallayout class='monospaced'>
209 $ cd ~/adt-installer
210 $ ./adt_installer
211 </literallayout>
212 Once the installer begins to run, you are asked to enter the
213 location for cross-toolchain installation.
214 The default location is
215 <filename>/opt/poky/&lt;release&gt;</filename>.
216 After either accepting the default location or selecting your
217 own location, you are prompted to run the installation script
218 interactively or in silent mode.
219 If you want to closely monitor the installation,
220 choose “I” for interactive mode rather than “S” for silent mode.
221 Follow the prompts from the script to complete the installation.
222 </para>
223
224 <para>
225 Once the installation completes, the ADT, which includes the
226 cross-toolchain, is installed in the selected installation
227 directory.
228 You will notice environment setup files for the cross-toolchain
229 in the installation directory, and image tarballs in the
230 <filename>adt-installer</filename> directory according to your
231 installer configurations, and the target sysroot located
232 according to the
233 <filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename>
234 variable also in your configuration file.
235 </para>
236 </section>
237 </section>
238
239 <section id='using-an-existing-toolchain-tarball'>
240 <title>Using a Cross-Toolchain Tarball</title>
241
242 <para>
243 If you want to simply install a cross-toolchain by hand, you can
244 do so by running the toolchain installer.
245 The installer includes the pre-built cross-toolchain, the
246 <filename>runqemu</filename> script, and support files.
247 If you use this method to install the cross-toolchain, you
248 might still need to install the target sysroot by installing and
249 extracting it separately.
250 For information on how to install the sysroot, see the
251 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section.
252 </para>
253
254 <para>
255 Follow these steps:
256 <orderedlist>
257 <listitem><para>Get your toolchain installer using one of the
258 following methods:
259 <itemizedlist>
260 <listitem><para>Go to
261 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>
262 and find the folder that matches your host
263 development system (i.e. <filename>i686</filename>
264 for 32-bit machines or <filename>x86_64</filename>
265 for 64-bit machines).</para>
266 <para>Go into that folder and download the toolchain
267 installer whose name includes the appropriate target
268 architecture.
269 The toolchains provided by the Yocto Project
270 are based off of the
271 <filename>core-image-sato</filename> image and
272 contain libraries appropriate for developing
273 against that image.
274 For example, if your host development system is a
275 64-bit x86 system and you are going to use
276 your cross-toolchain for a 32-bit x86
277 target, go into the <filename>x86_64</filename>
278 folder and download the following installer:
279 <literallayout class='monospaced'>
280 poky-eglibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
281 </literallayout></para></listitem>
282 <listitem><para>Build your own toolchain installer.
283 For cases where you cannot use an installer
284 from the download area, you can build your own as
285 described in the
286 "<link linkend='optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</link>"
287 section.</para></listitem>
288 </itemizedlist></para></listitem>
289 <listitem><para>Once you have the installer, run it to install
290 the toolchain.
291 <note>
292 You must change the permissions on the toolchain
293 installer script so that it is executable.
294 </note></para>
295 <para>The following command shows how to run the installer
296 given a toolchain tarball for a 64-bit x86 development host
297 system and a 32-bit x86 target architecture.
298 The example assumes the toolchain installer is located
299 in <filename>~/Downloads/</filename>.
300 <literallayout class='monospaced'>
301 $ ~/Downloads/poky-eglibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
302 </literallayout>
303 The first thing the installer prompts you for is the
304 directory into which you want to install the toolchain.
305 The default directory used is
306 <filename>opt/poky/&DISTRO;</filename>.
307 If you do not have write permissions for the directory
308 into which you are installing the toolchain, the
309 toolchain installer notifies you and exits.
310 Be sure you have write permissions in the directory and
311 run the installer again.</para>
312 <para>When the script finishes, the cross-toolchain is
313 installed.
314 You will notice environment setup files for the
315 cross-toolchain in the installation directory.
316 </para></listitem>
317 </orderedlist>
318 </para>
319 </section>
320
321 <section id='using-the-toolchain-from-within-the-build-tree'>
322 <title>Using BitBake and the Build Directory</title>
323
324 <para>
325 A final way of making the cross-toolchain available is to use BitBake
326 to generate the toolchain within an existing
327 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
328 This method does not install the toolchain into the default
329 <filename>/opt</filename> directory.
330 As with the previous method, if you need to install the target sysroot, you must
331 do that separately as well.
332 </para>
333
334 <para>
335 Follow these steps to generate the toolchain into the Build Directory:
336 <orderedlist>
337 <listitem><para><emphasis>Set up the Build Environment:</emphasis>
338 Source the OpenEmbedded build environment setup
339 script (i.e.
340 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
341 or
342 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
343 located in the
344 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
345 </para></listitem>
346 <listitem><para><emphasis>Check your Local Configuration File:</emphasis>
347 At this point, you should be sure that the
348 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable
349 in the <filename>local.conf</filename> file found in the
350 <filename>conf</filename> directory of the Build Directory
351 is set for the target architecture.
352 Comments within the <filename>local.conf</filename> file
353 list the values you can use for the
354 <filename>MACHINE</filename> variable.
355 <note>
356 You can populate the Build Directory with the
357 cross-toolchains for more than a single architecture.
358 You just need to edit the <filename>MACHINE</filename>
359 variable in the <filename>local.conf</filename> file and
360 re-run the BitBake command.
361 </note></para></listitem>
362 <listitem><para><emphasis>Generate the Cross-Toolchain:</emphasis>
363 Run <filename>bitbake meta-ide-support</filename> to
364 complete the cross-toolchain generation.
365 Once the BitBake command finishes, the cross-toolchain is
366 generated and populated within the Build Directory.
367 You will notice environment setup files for the
368 cross-toolchain that contain the string
369 "<filename>environment-setup</filename>" in the
370 Build Directory's <filename>tmp</filename> folder.</para>
371 <para>Be aware that when you use this method to install the
372 toolchain, you still need to separately extract and install
373 the sysroot filesystem.
374 For information on how to do this, see the
375 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section.
376 </para></listitem>
377 </orderedlist>
378 </para>
379 </section>
380</section>
381
382<section id='setting-up-the-cross-development-environment'>
383 <title>Setting Up the Cross-Development Environment</title>
384
385 <para>
386 Before you can develop using the cross-toolchain, you need to set up the
387 cross-development environment by sourcing the toolchain's environment setup script.
388 If you used the ADT Installer or hand-installed cross-toolchain,
389 then you can find this script in the directory you chose for installation.
390 The default installation directory is the <filename>&YOCTO_ADTPATH_DIR;</filename>
391 directory.
392 If you installed the toolchain in the
393 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
394 you can find the environment setup
395 script for the toolchain in the Build Directory's <filename>tmp</filename> directory.
396 </para>
397
398 <para>
399 Be sure to run the environment setup script that matches the
400 architecture for which you are developing.
401 Environment setup scripts begin with the string
402 "<filename>environment-setup</filename>" and include as part of their
403 name the architecture.
404 For example, the toolchain environment setup script for a 64-bit
405 IA-based architecture installed in the default installation directory
406 would be the following:
407 <literallayout class='monospaced'>
408 &YOCTO_ADTPATH_DIR;/environment-setup-x86_64-poky-linux
409 </literallayout>
410 </para>
411</section>
412
413<section id='securing-kernel-and-filesystem-images'>
414 <title>Securing Kernel and Filesystem Images</title>
415
416 <para>
417 You will need to have a kernel and filesystem image to boot using your
418 hardware or the QEMU emulator.
419 Furthermore, if you plan on booting your image using NFS or you want to use the root filesystem
420 as the target sysroot, you need to extract the root filesystem.
421 </para>
422
423 <section id='getting-the-images'>
424 <title>Getting the Images</title>
425
426 <para>
427 To get the kernel and filesystem images, you either have to build them or download
428 pre-built versions.
429 You can find examples for both these situations in the
430 "<ulink url='&YOCTO_DOCS_QS_URL;#test-run'>A Quick Test Run</ulink>" section of
431 the Yocto Project Quick Start.
432 </para>
433
434 <para>
435 The Yocto Project ships basic kernel and filesystem images for several
436 architectures (<filename>x86</filename>, <filename>x86-64</filename>,
437 <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>)
438 that you can use unaltered in the QEMU emulator.
439 These kernel images reside in the release
440 area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink>
441 and are ideal for experimentation using Yocto Project.
442 For information on the image types you can build using the OpenEmbedded build system,
443 see the
444 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
445 the Yocto Project Reference Manual.
446 </para>
447
448 <para>
449 If you are planning on developing against your image and you are not
450 building or using one of the Yocto Project development images
451 (e.g. <filename>core-image-*-dev</filename>), you must be sure to
452 include the development packages as part of your image recipe.
453 </para>
454
455 <para>
456 Furthermore, if you plan on remotely deploying and debugging your
457 application from within the
458 Eclipse IDE, you must have an image that contains the Yocto Target Communication
459 Framework (TCF) agent (<filename>tcf-agent</filename>).
460 By default, the Yocto Project provides only one type of pre-built
461 image that contains the <filename>tcf-agent</filename>.
462 And, those images are SDK (e.g.<filename>core-image-sato-sdk</filename>).
463 </para>
464
465 <para>
466 If you want to use a different image type that contains the <filename>tcf-agent</filename>,
467 you can do so one of two ways:
468 <itemizedlist>
469 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
470 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
471 and then rebuild the image.
472 With this method, you need to modify the
473 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
474 variable to have the value of "tools-debug" before rebuilding the image.
475 Once the image is rebuilt, the <filename>tcf-agent</filename> will be included
476 in the image and is launched automatically after the boot.</para></listitem>
477 <listitem><para>Manually build the <filename>tcf-agent</filename>.
478 To build the agent, follow these steps:
479 <orderedlist>
480 <listitem><para>Be sure the ADT is installed as described in the
481 "<link linkend='installing-the-adt'>Installing the ADT and Toolchains</link>" section.
482 </para></listitem>
483 <listitem><para>Set up the cross-development environment as described in the
484 "<link linkend='setting-up-the-cross-development-environment'>Setting
485 Up the Cross-Development Environment</link>" section.</para></listitem>
486 <listitem><para>Get the <filename>tcf-agent</filename> source code using
487 the following commands:
488 <literallayout class='monospaced'>
489 $ git clone http://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.agent.git
490 $ cd org.eclipse.tcf.agent/agent
491 </literallayout></para></listitem>
492 <listitem><para>Locate the
493 <filename>Makefile.inc</filename> file inside the
494 <filename>agent</filename> folder and modify it
495 for the cross-compilation environment by setting the
496 <filename>OPSYS</filename> and
497 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
498 variables according to your target.
499 </para></listitem>
500 <listitem><para>Use the cross-development tools to build the
501 <filename>tcf-agent</filename>.
502 Before you "Make" the file, be sure your cross-tools are set up first.
503 See the "<link linkend='makefile-based-projects'>Makefile-Based Projects</link>"
504 section for information on how to make sure the cross-tools are set up
505 correctly.</para>
506 <para>If the build is successful, the <filename>tcf-agent</filename> output will
507 be <filename>obj/$(OPSYS)/$(MACHINE)/Debug/agent</filename>.</para></listitem>
508 <listitem><para>Deploy the agent into the image's root filesystem.</para></listitem>
509 </orderedlist>
510 </para></listitem>
511 </itemizedlist>
512 </para>
513 </section>
514
515 <section id='extracting-the-root-filesystem'>
516 <title>Extracting the Root Filesystem</title>
517
518 <para>
519 If you install your toolchain by hand or build it using BitBake and
520 you need a root filesystem, you need to extract it separately.
521 If you use the ADT Installer to install the ADT, the root
522 filesystem is automatically extracted and installed.
523 </para>
524
525 <para>
526 Here are some cases where you need to extract the root filesystem:
527 <itemizedlist>
528 <listitem><para>You want to boot the image using NFS.
529 </para></listitem>
530 <listitem><para>You want to use the root filesystem as the
531 target sysroot.
532 For example, the Eclipse IDE environment with the Eclipse
533 Yocto Plug-in installed allows you to use QEMU to boot
534 under NFS.</para></listitem>
535 <listitem><para>You want to develop your target application
536 using the root filesystem as the target sysroot.
537 </para></listitem>
538 </itemizedlist>
539 </para>
540
541 <para>
542 To extract the root filesystem, first <filename>source</filename>
543 the cross-development environment setup script.
544 If you built the toolchain in the Build Directory, you will find
545 the toolchain environment script in the
546 <filename>tmp</filename> directory.
547 If you installed the toolchain by hand, the environment setup
548 script is located in <filename>opt/poky/&DISTRO;</filename>.
549 </para>
550
551 <para>
552 After sourcing the environment script, use the
553 <filename>runqemu-extract-sdk</filename> command and provide the
554 filesystem image.
555 </para>
556
557 <para>
558 Following is an example.
559 The second command sets up the environment.
560 In this case, the setup script is located in the
561 <filename>/opt/poky/&DISTRO;</filename> directory.
562 The third command extracts the root filesystem from a previously
563 built filesystem that is located in the
564 <filename>~/Downloads</filename> directory.
565 Furthermore, this command extracts the root filesystem into the
566 <filename>$HOME/qemux86-sato</filename> directory:
567 <literallayout class='monospaced'>
568 $ cd ~
569 $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
570 $ runqemu-extract-sdk \
571 ~Downloads/core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2 \
572 $HOME/qemux86-sato
573 </literallayout>
574 You could now point to the target sysroot at
575 <filename>$HOME/qemux86-sato</filename>.
576 </para>
577 </section>
578</section>
579
580<section id='optionally-building-a-toolchain-installer'>
581 <title>Optionally Building a Toolchain Installer</title>
582
583 <para>
584 As an alternative to locating and downloading a toolchain installer,
585 you can build the toolchain installer one of two ways if you have a
586 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
587 <itemizedlist>
588 <listitem><para>Use <filename>bitbake meta-toolchain</filename>.
589 This method requires you to still install the target
590 sysroot by installing and extracting it separately.
591 For information on how to install the sysroot, see the
592 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>"
593 section.</para></listitem>
594 <listitem><para>Use
595 <filename>bitbake image -c populate_sdk</filename>.
596 This method has significant advantages over the previous method
597 because it results in a toolchain installer that contains the
598 sysroot that matches your target root filesystem.
599 </para></listitem>
600 </itemizedlist>
601 </para>
602
603 <para>
604 Remember, before using any BitBake command, you
605 must source the build environment setup script
606 (i.e.
607 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
608 or
609 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
610 located in the Source Directory and you must make sure your
611 <filename>conf/local.conf</filename> variables are correct.
612 In particular, you need to be sure the
613 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
614 variable matches the architecture for which you are building and that
615 the
616 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>
617 variable is correctly set if you are building a toolchain designed to
618 run on an architecture that differs from your current development host
619 machine (i.e. the build machine).
620 </para>
621
622 <para>
623 When the BitBake command completes, the toolchain installer will be in
624 <filename>tmp/deploy/sdk</filename> in the Build Directory.
625 <note>
626 By default, this toolchain does not build static binaries.
627 If you want to use the toolchain to build these types of libraries,
628 you need to be sure your image has the appropriate static
629 development libraries.
630 Use the
631 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
632 variable inside your <filename>local.conf</filename> file to
633 install the appropriate library packages.
634 Following is an example using <filename>eglibc</filename> static
635 development libraries:
636 <literallayout class='monospaced'>
637 IMAGE_INSTALL_append = " eglibc-staticdev"
638 </literallayout>
639 </note>
640 </para>
641</section>
642
643</chapter>
644<!--
645vim: expandtab tw=80 ts=4
646-->
diff --git a/documentation/adt-manual/adt-style.css b/documentation/adt-manual/adt-style.css
new file mode 100644
index 0000000000..3b098aa493
--- /dev/null
+++ b/documentation/adt-manual/adt-style.css
@@ -0,0 +1,979 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("figures/adt-title.png");
122 background-position: left top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 0px;
126 text-align: right;
127 width: 740px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/yocto-project-bw.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
979
diff --git a/documentation/adt-manual/figures/adt-title.png b/documentation/adt-manual/figures/adt-title.png
new file mode 100644
index 0000000000..6e71e41f1a
--- /dev/null
+++ b/documentation/adt-manual/figures/adt-title.png
Binary files differ
diff --git a/documentation/bsp-guide/bsp-guide-customization.xsl b/documentation/bsp-guide/bsp-guide-customization.xsl
new file mode 100644
index 0000000000..5560289ee8
--- /dev/null
+++ b/documentation/bsp-guide/bsp-guide-customization.xsl
@@ -0,0 +1,10 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="html.stylesheet" select="'bsp-style.css'" />
7 <xsl:param name="chapter.autolabel" select="1" />
8 <xsl:param name="section.autolabel" select="1" />
9 <xsl:param name="section.label.includes.component.label" select="1" />
10</xsl:stylesheet>
diff --git a/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl
new file mode 100644
index 0000000000..1c80bee1cf
--- /dev/null
+++ b/documentation/bsp-guide/bsp-guide-eclipse-customization.xsl
@@ -0,0 +1,27 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10
11 <xsl:param name="chunker.output.indent" select="'yes'"/>
12 <xsl:param name="chunk.quietly" select="1"/>
13 <xsl:param name="chunk.first.sections" select="1"/>
14 <xsl:param name="chunk.section.depth" select="10"/>
15 <xsl:param name="use.id.as.filename" select="1"/>
16 <xsl:param name="ulink.target" select="'_self'" />
17 <xsl:param name="base.dir" select="'html/bsp-guide/'"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="chapter.autolabel" select="1" />
24 <xsl:param name="appendix.autolabel" select="1" />
25 <xsl:param name="section.autolabel" select="1" />
26 <xsl:param name="section.label.includes.component.label" select="1" />
27</xsl:stylesheet>
diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml
new file mode 100644
index 0000000000..86b16d1226
--- /dev/null
+++ b/documentation/bsp-guide/bsp-guide.xml
@@ -0,0 +1,118 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='bsp-guide' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/bsp-title.png'
14 format='SVG'
15 align='center' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Board Support Package Developer's Guide
21 </title>
22
23 <authorgroup>
24 <author>
25 <firstname>Tom</firstname> <surname>Zanussi</surname>
26 <affiliation>
27 <orgname>Intel Corporation</orgname>
28 </affiliation>
29 <email>tom.zanussi@intel.com</email>
30 </author>
31 <author>
32 <firstname>Richard</firstname> <surname>Purdie</surname>
33 <affiliation>
34 <orgname>Linux Foundation</orgname>
35 </affiliation>
36 <email>richard.purdie@linuxfoundation.org</email>
37 </author>
38 </authorgroup>
39
40 <revhistory>
41 <revision>
42 <revnumber>0.9</revnumber>
43 <date>24 November 2010</date>
44 <revremark>The initial document draft released with the Yocto Project 0.9 Release.</revremark>
45 </revision>
46 <revision>
47 <revnumber>1.0</revnumber>
48 <date>6 April 2011</date>
49 <revremark>Released with the Yocto Project 1.0 Release.</revremark>
50 </revision>
51 <revision>
52 <revnumber>1.0.1</revnumber>
53 <date>23 May 2011</date>
54 <revremark>Released with the Yocto Project 1.0.1 Release.</revremark>
55 </revision>
56 <revision>
57 <revnumber>1.1</revnumber>
58 <date>6 October 2011</date>
59 <revremark>Released with the Yocto Project 1.1 Release.</revremark>
60 </revision>
61 <revision>
62 <revnumber>1.2</revnumber>
63 <date>April 2012</date>
64 <revremark>Released with the Yocto Project 1.2 Release.</revremark>
65 </revision>
66 <revision>
67 <revnumber>1.3</revnumber>
68 <date>October 2012</date>
69 <revremark>Released with the Yocto Project 1.3 Release.</revremark>
70 </revision>
71 <revision>
72 <revnumber>1.4</revnumber>
73 <date>April 2013</date>
74 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
75 </revision>
76 <revision>
77 <revnumber>1.5</revnumber>
78 <date>October 2013</date>
79 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
80 </revision>
81 <revision>
82 <revnumber>1.5.1</revnumber>
83 <date>Sometime in 2013</date>
84 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
85 </revision>
86 </revhistory>
87
88 <copyright>
89 <year>&COPYRIGHT_YEAR;</year>
90 <holder>Linux Foundation</holder>
91 </copyright>
92
93 <legalnotice>
94 <para>
95 Permission is granted to copy, distribute and/or modify this document under
96 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Non-Commercial-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
97 </para>
98 <note>
99 For the latest version of this manual associated with this
100 Yocto Project release, see the
101 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>
102 from the Yocto Project website.
103 </note>
104 </legalnotice>
105
106 </bookinfo>
107
108 <xi:include href="bsp.xml"/>
109
110<!-- <index id='index'>
111 <title>Index</title>
112 </index>
113-->
114
115</book>
116<!--
117vim: expandtab tw=80 ts=4
118-->
diff --git a/documentation/bsp-guide/bsp-style.css b/documentation/bsp-guide/bsp-style.css
new file mode 100644
index 0000000000..4a1a45e727
--- /dev/null
+++ b/documentation/bsp-guide/bsp-style.css
@@ -0,0 +1,980 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("figures/bsp-title.png");
122 background-position: left top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 0px;
126 text-align: right;
127 width: 740px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title {
784 background-image: url("images/title-bg.png");
785 background-position: bottom;
786 background-repeat: repeat-x;
787}
788
789div.section div.section .titlepage .title,
790div.sect2 .titlepage .title {
791 background: none;
792}
793
794
795h1.title {
796 background-color: transparent;
797 background-image: url("poky-ref-manual.png");
798 background-repeat: no-repeat;
799 height: 256px;
800 text-indent: -9000px;
801 overflow:hidden;
802}
803
804h2.subtitle {
805 background-color: transparent;
806 text-indent: -9000px;
807 overflow:hidden;
808 width: 0px;
809 display: none;
810}
811
812 /*************************************** /
813 / pippin.gimp.org specific alterations /
814/ ***************************************/
815
816/*
817div.heading, div.navheader {
818 color: #777;
819 font-size: 80%;
820 padding: 0;
821 margin: 0;
822 text-align: left;
823 position: absolute;
824 top: 0px;
825 left: 0px;
826 width: 100%;
827 height: 50px;
828 background: url('/gfx/heading_bg.png') transparent;
829 background-repeat: repeat-x;
830 background-attachment: fixed;
831 border: none;
832}
833
834div.heading a {
835 color: #444;
836}
837
838div.footing, div.navfooter {
839 border: none;
840 color: #ddd;
841 font-size: 80%;
842 text-align:right;
843
844 width: 100%;
845 padding-top: 10px;
846 position: absolute;
847 bottom: 0px;
848 left: 0px;
849
850 background: url('/gfx/footing_bg.png') transparent;
851}
852*/
853
854
855
856 /****************** /
857 / nasty ie tweaks /
858/ ******************/
859
860/*
861div.heading, div.navheader {
862 width:expression(document.body.clientWidth + "px");
863}
864
865div.footing, div.navfooter {
866 width:expression(document.body.clientWidth + "px");
867 margin-left:expression("-5em");
868}
869body {
870 padding:expression("4em 5em 0em 5em");
871}
872*/
873
874 /**************************************** /
875 / mozilla vendor specific css extensions /
876/ ****************************************/
877/*
878div.navfooter, div.footing{
879 -moz-opacity: 0.8em;
880}
881
882div.figure,
883div.table,
884div.informalfigure,
885div.informaltable,
886div.informalexample,
887div.example,
888.tip,
889.warning,
890.caution,
891.note {
892 -moz-border-radius: 0.5em;
893}
894
895b.keycap,
896.keycap {
897 -moz-border-radius: 0.3em;
898}
899*/
900
901table tr td table tr td {
902 display: none;
903}
904
905
906hr {
907 display: none;
908}
909
910table {
911 border: 0em;
912}
913
914 .photo {
915 float: right;
916 margin-left: 1.5em;
917 margin-bottom: 1.5em;
918 margin-top: 0em;
919 max-width: 17em;
920 border: 1px solid gray;
921 padding: 3px;
922 background: white;
923}
924 .seperator {
925 padding-top: 2em;
926 clear: both;
927 }
928
929 #validators {
930 margin-top: 5em;
931 text-align: right;
932 color: #777;
933 }
934 @media print {
935 body {
936 font-size: 8pt;
937 }
938 .noprint {
939 display: none;
940 }
941 }
942
943
944.tip,
945.note {
946 background: #f0f0f2;
947 color: #333;
948 padding: 20px;
949 margin: 20px;
950}
951
952.tip h3,
953.note h3 {
954 padding: 0em;
955 margin: 0em;
956 font-size: 2em;
957 font-weight: bold;
958 color: #333;
959}
960
961.tip a,
962.note a {
963 color: #333;
964 text-decoration: underline;
965}
966
967.footnote {
968 font-size: small;
969 color: #333;
970}
971
972/* Changes the announcement text */
973.tip h3,
974.warning h3,
975.caution h3,
976.note h3 {
977 font-size:large;
978 color: #00557D;
979}
980
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
new file mode 100644
index 0000000000..c85e7e0883
--- /dev/null
+++ b/documentation/bsp-guide/bsp.xml
@@ -0,0 +1,1480 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='bsp'>
6
7 <title>Board Support Packages (BSP) - Developer's Guide</title>
8
9 <para>
10 A Board Support Package (BSP) is a collection of information that
11 defines how to support a particular hardware device, set of devices, or
12 hardware platform.
13 The BSP includes information about the hardware features
14 present on the device and kernel configuration information along with any
15 additional hardware drivers required.
16 The BSP also lists any additional software
17 components required in addition to a generic Linux software stack for both
18 essential and optional platform features.
19 </para>
20
21 <para>
22 This guide presents information about BSP Layers, defines a structure for components
23 so that BSPs follow a commonly understood layout, discusses how to customize
24 a recipe for a BSP, addresses BSP licensing, and provides information that
25 shows you how to create and manage a
26 <link linkend='bsp-layers'>BSP Layer</link> using two Yocto Project
27 <link linkend='using-the-yocto-projects-bsp-tools'>BSP Tools</link>.
28 </para>
29
30 <section id='bsp-layers'>
31 <title>BSP Layers</title>
32
33 <para>
34 The BSP consists of a file structure inside a base directory.
35 Collectively, you can think of the base directory and the file structure
36 as a BSP Layer.
37 Although not a strict requirement, layers in the Yocto Project use the
38 following well established naming convention:
39 <literallayout class='monospaced'>
40 meta-&lt;bsp_name&gt;
41 </literallayout>
42 The string "meta-" is prepended to the machine or platform name, which is
43 "bsp_name" in the above form.
44 </para>
45
46 <para>
47 The layer's base directory (<filename>meta-&lt;bsp_name&gt;</filename>) is the root
48 of the BSP Layer.
49 This root is what you add to the
50 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
51 variable in the <filename>conf/bblayers.conf</filename> file found in the
52 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
53 Adding the root allows the OpenEmbedded build system to recognize the BSP
54 definition and from it build an image.
55 Here is an example:
56 <literallayout class='monospaced'>
57 BBLAYERS ?= " \
58 /usr/local/src/yocto/meta \
59 /usr/local/src/yocto/meta-yocto \
60 /usr/local/src/yocto/meta-yocto-bsp \
61 /usr/local/src/yocto/meta-mylayer \
62 "
63
64 BBLAYERS_NON_REMOVABLE ?= " \
65 /usr/local/src/yocto/meta \
66 /usr/local/src/yocto/meta-yocto \
67 "
68 </literallayout>
69 </para>
70
71 <para>
72 Some BSPs require additional layers on
73 top of the BSP's root layer in order to be functional.
74 For these cases, you also need to add those layers to the
75 <filename>BBLAYERS</filename> variable in order to build the BSP.
76 You must also specify in the "Dependencies" section of the BSP's
77 <filename>README</filename> file any requirements for additional
78 layers and, preferably, any
79 build instructions that might be contained elsewhere
80 in the <filename>README</filename> file.
81 </para>
82
83 <para>
84 Some layers function as a layer to hold other BSP layers.
85 An example of this type of layer is the <filename>meta-intel</filename> layer.
86 The <filename>meta-intel</filename> layer contains over 10 individual BSP layers.
87 </para>
88
89 <para>
90 For more detailed information on layers, see the
91 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
92 section of the Yocto Project Development Manual.
93 </para>
94 </section>
95
96
97 <section id="bsp-filelayout">
98 <title>Example Filesystem Layout</title>
99
100 <para>
101 Providing a common form allows end-users to understand and become familiar
102 with the layout.
103 A common format also encourages standardization of software support of hardware.
104 </para>
105
106 <para>
107 The proposed form does have elements that are specific to the
108 OpenEmbedded build system.
109 It is intended that this information can be
110 used by other build systems besides the OpenEmbedded build system
111 and that it will be simple
112 to extract information and convert it to other formats if required.
113 The OpenEmbedded build system, through its standard layers mechanism, can directly
114 accept the format described as a layer.
115 The BSP captures all
116 the hardware-specific details in one place in a standard format, which is
117 useful for any person wishing to use the hardware platform regardless of
118 the build system they are using.
119 </para>
120
121 <para>
122 The BSP specification does not include a build system or other tools -
123 it is concerned with the hardware-specific components only.
124 At the end-distribution point, you can ship the BSP combined with a build system
125 and other tools.
126 However, it is important to maintain the distinction that these
127 are separate components that happen to be combined in certain end products.
128 </para>
129
130 <para>
131 Before looking at the common form for the file structure inside a BSP Layer,
132 you should be aware that some requirements do exist in order for a BSP to
133 be considered compliant with the Yocto Project.
134 For that list of requirements, see the
135 "<link linkend='released-bsp-requirements'>Released BSP Requirements</link>"
136 section.
137 </para>
138
139 <para>
140 Below is the common form for the file structure inside a BSP Layer.
141 While you can use this basic form for the standard, realize that the actual structures
142 for specific BSPs could differ.
143
144 <literallayout class='monospaced'>
145 meta-&lt;bsp_name&gt;/
146 meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
147 meta-&lt;bsp_name&gt;/README
148 meta-&lt;bsp_name&gt;/README.sources
149 meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
150 meta-&lt;bsp_name&gt;/conf/layer.conf
151 meta-&lt;bsp_name&gt;/conf/machine/*.conf
152 meta-&lt;bsp_name&gt;/recipes-bsp/*
153 meta-&lt;bsp_name&gt;/recipes-core/*
154 meta-&lt;bsp_name&gt;/recipes-graphics/*
155 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-yocto_&lt;kernel_rev&gt;.bbappend
156 </literallayout>
157 </para>
158
159 <para>
160 Below is an example of the Crown Bay BSP:
161
162 <literallayout class='monospaced'>
163 meta-crownbay/COPYING.MIT
164 meta-crownbay/README
165 meta-crownbay/README.sources
166 meta-crownbay/binary/
167 meta-crownbay/conf/
168 meta-crownbay/conf/layer.conf
169 meta-crownbay/conf/machine/
170 meta-crownbay/conf/machine/crownbay.conf
171 meta-crownbay/conf/machine/crownbay-noemgd.conf
172 meta-crownbay/recipes-bsp/
173 meta-crownbay/recipes-bsp/formfactor/
174 meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
175 meta-crownbay/recipes-bsp/formfactor/formfactor/
176 meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/
177 meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
178 meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay-noemgd/
179 meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay-noemgd/machconfig
180 meta-crownbay/recipes-graphics/
181 meta-crownbay/recipes-graphics/xorg-xserver/
182 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
183 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/
184 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/
185 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xorg.conf
186 meta-crownbay/recipes-kernel/
187 meta-crownbay/recipes-kernel/linux/
188 meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend
189 meta-crownbay/recipes-kernel/linux/linux-yocto_3.8.bbappend
190 meta-crownbay/recipes-kernel/linux/linux-yocto_3.10.bbappend
191 meta-crownbay/recipes-kernel/linux/linux-yocto-dev.bbappend
192 meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.4.bbappend
193 meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.8.bbappend
194 meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.10.bbappend
195 </literallayout>
196 </para>
197
198 <para>
199 The following sections describe each part of the proposed BSP format.
200 </para>
201
202 <section id="bsp-filelayout-license">
203 <title>License Files</title>
204
205 <para>
206 You can find these files in the BSP Layer at:
207 <literallayout class='monospaced'>
208 meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
209 </literallayout>
210 </para>
211
212 <para>
213 These optional files satisfy licensing requirements for the BSP.
214 The type or types of files here can vary depending on the licensing requirements.
215 For example, in the Crown Bay BSP all licensing requirements are handled with the
216 <filename>COPYING.MIT</filename> file.
217 </para>
218
219 <para>
220 Licensing files can be MIT, BSD, GPLv*, and so forth.
221 These files are recommended for the BSP but are optional and totally up to the BSP developer.
222 </para>
223 </section>
224
225 <section id="bsp-filelayout-readme">
226 <title>README File</title>
227 <para>
228 You can find this file in the BSP Layer at:
229 <literallayout class='monospaced'>
230 meta-&lt;bsp_name&gt;/README
231 </literallayout>
232 </para>
233
234 <para>
235 This file provides information on how to boot the live images that are optionally
236 included in the <filename>binary/</filename> directory.
237 The <filename>README</filename> file also provides special information needed for
238 building the image.
239 </para>
240
241 <para>
242 At a minimum, the <filename>README</filename> file must
243 contain a list of dependencies, such as the names of
244 any other layers on which the BSP depends and the name of
245 the BSP maintainer with his or her contact information.
246 </para>
247 </section>
248
249 <section id="bsp-filelayout-readme-sources">
250 <title>README.sources File</title>
251 <para>
252 You can find this file in the BSP Layer at:
253 <literallayout class='monospaced'>
254 meta-&lt;bsp_name&gt;/README.sources
255 </literallayout>
256 </para>
257
258 <para>
259 This file provides information on where to locate the BSP source files.
260 For example, information provides where to find the sources that comprise
261 the images shipped with the BSP.
262 Information is also included to help you find the
263 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
264 used to generate the images that ship with the BSP.
265 </para>
266 </section>
267
268 <section id="bsp-filelayout-binary">
269 <title>Pre-built User Binaries</title>
270 <para>
271 You can find these files in the BSP Layer at:
272 <literallayout class='monospaced'>
273 meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
274 </literallayout>
275 </para>
276
277 <para>
278 This optional area contains useful pre-built kernels and user-space filesystem
279 images appropriate to the target system.
280 This directory typically contains graphical (e.g. Sato) and minimal live images
281 when the BSP tarball has been created and made available in the
282 <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website.
283 You can use these kernels and images to get a system running and quickly get started
284 on development tasks.
285 </para>
286
287 <para>
288 The exact types of binaries present are highly hardware-dependent.
289 However, a README file should be present in the BSP Layer that explains how to use
290 the kernels and images with the target hardware.
291 If pre-built binaries are present, source code to meet licensing requirements must also
292 exist in some form.
293 </para>
294 </section>
295
296 <section id='bsp-filelayout-layer'>
297 <title>Layer Configuration File</title>
298 <para>
299 You can find this file in the BSP Layer at:
300 <literallayout class='monospaced'>
301 meta-&lt;bsp_name&gt;/conf/layer.conf
302 </literallayout>
303 </para>
304
305 <para>
306 The <filename>conf/layer.conf</filename> file identifies the file structure as a
307 layer, identifies the
308 contents of the layer, and contains information about how the build
309 system should use it.
310 Generally, a standard boilerplate file such as the following works.
311 In the following example, you would replace "<filename>bsp</filename>" and
312 "<filename>_bsp</filename>" with the actual name
313 of the BSP (i.e. <filename>&lt;bsp_name&gt;</filename> from the example template).
314 </para>
315
316 <para>
317 <literallayout class='monospaced'>
318 # We have a conf and classes directory, add to BBPATH
319 BBPATH .= ":${LAYERDIR}"
320
321 # We have a recipes directory, add to BBFILES
322 BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \
323 ${LAYERDIR}/recipes-*/*/*.bbappend"
324
325 BBFILE_COLLECTIONS += "bsp"
326 BBFILE_PATTERN_bsp = "^${LAYERDIR}/"
327 BBFILE_PRIORITY_bsp = "6"
328 </literallayout>
329 </para>
330
331 <para>
332 To illustrate the string substitutions, here are the corresponding statements
333 from the Crown Bay <filename>conf/layer.conf</filename> file:
334 <literallayout class='monospaced'>
335 BBFILE_COLLECTIONS += "crownbay"
336 BBFILE_PATTERN_crownbay = "^${LAYERDIR}/"
337 BBFILE_PRIORITY_crownbay = "6"
338 </literallayout>
339 </para>
340
341 <para>
342 This file simply makes BitBake aware of the recipes and configuration directories.
343 The file must exist so that the OpenEmbedded build system can recognize the BSP.
344 </para>
345 </section>
346
347 <section id="bsp-filelayout-machine">
348 <title>Hardware Configuration Options</title>
349 <para>
350 You can find these files in the BSP Layer at:
351 <literallayout class='monospaced'>
352 meta-&lt;bsp_name&gt;/conf/machine/*.conf
353 </literallayout>
354 </para>
355
356 <para>
357 The machine files bind together all the information contained elsewhere
358 in the BSP into a format that the build system can understand.
359 If the BSP supports multiple machines, multiple machine configuration files
360 can be present.
361 These filenames correspond to the values to which users have set the
362 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable.
363 </para>
364
365 <para>
366 These files define things such as the kernel package to use
367 (<ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></ulink>
368 of virtual/kernel), the hardware drivers to
369 include in different types of images, any special software components
370 that are needed, any bootloader information, and also any special image
371 format requirements.
372 </para>
373
374 <para>
375 Each BSP Layer requires at least one machine file.
376 However, you can supply more than one file.
377 </para>
378
379 <para>
380 This <filename>crownbay.conf</filename> file could also include
381 a hardware "tuning" file that is commonly used to
382 define the package architecture and specify
383 optimization flags, which are carefully chosen to give best
384 performance on a given processor.
385 </para>
386
387 <para>
388 Tuning files are found in the <filename>meta/conf/machine/include</filename>
389 directory within the
390 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
391 For example, the <filename>ia32-base.inc</filename> file resides in the
392 <filename>meta/conf/machine/include</filename> directory.
393 </para>
394
395 <para>
396 To use an include file, you simply include them in the machine configuration file.
397 For example, the Crown Bay BSP <filename>crownbay.conf</filename> contains the
398 following statements:
399 <literallayout class='monospaced'>
400 require conf/machine/include/tune-atom.inc
401 require conf/machine/include/ia32-base.inc
402 require conf/machine/include/meta-intel.inc
403 require conf/machine/include/meta-intel-emgd.inc
404 </literallayout>
405 </para>
406 </section>
407
408 <section id='bsp-filelayout-misc-recipes'>
409 <title>Miscellaneous BSP-Specific Recipe Files</title>
410 <para>
411 You can find these files in the BSP Layer at:
412 <literallayout class='monospaced'>
413 meta-&lt;bsp_name&gt;/recipes-bsp/*
414 </literallayout>
415 </para>
416
417 <para>
418 This optional directory contains miscellaneous recipe files for the BSP.
419 Most notably would be the formfactor files.
420 For example, in the Crown Bay BSP there is the
421 <filename>formfactor_0.0.bbappend</filename> file, which is an
422 append file used to augment the recipe that starts the build.
423 Furthermore, there are machine-specific settings used during the
424 build that are defined by the <filename>machconfig</filename> file.
425 In the Crown Bay example, two <filename>machconfig</filename> files
426 exist: one that supports the Intel® Embedded Media and Graphics
427 Driver (Intel® EMGD) and one that does not:
428 <literallayout class='monospaced'>
429 meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
430 meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay-noemgd/machconfig
431 meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
432 </literallayout>
433 </para>
434
435 <note><para>
436 If a BSP does not have a formfactor entry, defaults are established according to
437 the formfactor configuration file that is installed by the main
438 formfactor recipe
439 <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>,
440 which is found in the
441 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
442 </para></note>
443 </section>
444
445 <section id='bsp-filelayout-recipes-graphics'>
446 <title>Display Support Files</title>
447 <para>
448 You can find these files in the BSP Layer at:
449 <literallayout class='monospaced'>
450 meta-&lt;bsp_name&gt;/recipes-graphics/*
451 </literallayout>
452 </para>
453
454 <para>
455 This optional directory contains recipes for the BSP if it has
456 special requirements for graphics support.
457 All files that are needed for the BSP to support a display are kept here.
458 For example, the Crown Bay BSP's <filename>xorg.conf</filename> file
459 detects the graphics support needed (i.e. the Intel® Embedded Media
460 Graphics Driver (EMGD) or the Video Electronics Standards Association
461 (VESA) graphics):
462 <literallayout class='monospaced'>
463 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
464 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xorg.conf
465 </literallayout>
466 </para>
467 </section>
468
469 <section id='bsp-filelayout-kernel'>
470 <title>Linux Kernel Configuration</title>
471 <para>
472 You can find these files in the BSP Layer at:
473 <literallayout class='monospaced'>
474 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-yocto_*.bbappend
475 </literallayout>
476 </para>
477
478 <para>
479 These files append your specific changes to the main kernel recipe you are using.
480 </para>
481 <para>
482 For your BSP, you typically want to use an existing Yocto Project kernel recipe found in the
483 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
484 at <filename>meta/recipes-kernel/linux</filename>.
485 You can append your specific changes to the kernel recipe by using a
486 similarly named append file, which is located in the BSP Layer (e.g.
487 the <filename>meta-&lt;bsp_name&gt;/recipes-kernel/linux</filename> directory).
488 </para>
489 <para>
490 Suppose you are using the <filename>linux-yocto_3.10.bb</filename> recipe to build
491 the kernel.
492 In other words, you have selected the kernel in your
493 <filename>&lt;bsp_name&gt;.conf</filename> file by adding these types
494 of statements:
495 <literallayout class='monospaced'>
496 PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
497 PREFERRED_VERSION_linux-yocto ?= "3.10%"
498 </literallayout>
499 <note>
500 When the preferred provider is assumed by default, the
501 <filename>PREFERRED_PROVIDER</filename> statement does not appear in the
502 <filename>&lt;bsp_name&gt;.conf</filename> file.
503 </note>
504 You would use the <filename>linux-yocto_3.10.bbappend</filename> file to append
505 specific BSP settings to the kernel, thus configuring the kernel for your particular BSP.
506 </para>
507 <para>
508 As an example, look at the existing Crown Bay BSP.
509 The append file used is:
510 <literallayout class='monospaced'>
511 meta-crownbay/recipes-kernel/linux/linux-yocto_3.10.bbappend
512 </literallayout>
513 The following listing shows the file.
514 Be aware that the actual commit ID strings in this example listing might be different
515 than the actual strings in the file from the <filename>meta-intel</filename>
516 Git source repository.
517 <literallayout class='monospaced'>
518 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
519
520 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
521 KMACHINE_crownbay-noemgd = "crownbay"
522 KBRANCH_crownbay-noemgd = "standard/crownbay"
523 KERNEL_FEATURES_append_crownbay-noemgd = " cfg/vesafb"
524
525 LINUX_VERSION = "3.10.11"
526
527 SRCREV_meta_crownbay-noemgd = "285f93bf942e8f6fa678ffc6cc53696ed5400718"
528 SRCREV_machine_crownbay-noemgd = "702040ac7c7ec66a29b4d147665ccdd0ff015577"
529 </literallayout>
530 This append file contains statements used to support the Crown Bay BSP.
531 The file defines <filename>crownbay</filename> as the
532 <ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></ulink>
533 and uses the
534 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink> variable to
535 ensure the machine name used by the OpenEmbedded build system maps to the
536 machine name used by the Linux Yocto kernel.
537 The file also uses the optional
538 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable
539 to ensure the build process uses the <filename>standard/crownbay</filename>
540 kernel branch.
541 The
542 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'><filename>KERNEL_FEATURES</filename></ulink>
543 variable enables features specific to the kernel.
544 Finally, the append file points to specific commits in the
545 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> Git
546 repository and the <filename>meta</filename> Git repository branches to identify the
547 exact kernel needed to build the Crown Bay BSP.
548 </para>
549
550 <para>
551 One thing missing in this particular BSP, which you will typically need when
552 developing a BSP, is the kernel configuration file (<filename>.config</filename>) for your BSP.
553 When developing a BSP, you probably have a kernel configuration file or a set of kernel
554 configuration files that, when taken together, define the kernel configuration for your BSP.
555 You can accomplish this definition by putting the configurations in a file or a set of files
556 inside a directory located at the same level as your kernel's append file and having the same
557 name as the kernel's main recipe file.
558 With all these conditions met, simply reference those files in a
559 <filename>SRC_URI</filename> statement in the append file.
560 </para>
561
562 <para>
563 For example, suppose you had some configuration options in a file called
564 <filename>network_configs.cfg</filename>.
565 You can place that file inside a directory named <filename>/linux-yocto</filename> and then add
566 a <filename>SRC_URI</filename> statement such as the following to the append file.
567 When the OpenEmbedded build system builds the kernel, the configuration options are
568 picked up and applied.
569 <literallayout class='monospaced'>
570 SRC_URI += "file://network_configs.cfg"
571 </literallayout>
572 </para>
573
574 <para>
575 To group related configurations into multiple files, you perform a similar procedure.
576 Here is an example that groups separate configurations specifically for Ethernet and graphics
577 into their own files and adds the configurations
578 by using a <filename>SRC_URI</filename> statement like the following in your append file:
579 <literallayout class='monospaced'>
580 SRC_URI += "file://myconfig.cfg \
581 file://eth.cfg \
582 file://gfx.cfg"
583 </literallayout>
584 </para>
585
586 <para>
587 The <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
588 variable is in boilerplate form in the
589 previous example in order to make it easy to do that.
590 This variable must be in your layer or BitBake will not find the patches or
591 configurations even if you have them in your <filename>SRC_URI</filename>.
592 The <filename>FILESEXTRAPATHS</filename> variable enables the build process to
593 find those configuration files.
594 </para>
595
596 <note>
597 <para>
598 Other methods exist to accomplish grouping and defining configuration options.
599 For example, if you are working with a local clone of the kernel repository,
600 you could checkout the kernel's <filename>meta</filename> branch, make your changes,
601 and then push the changes to the local bare clone of the kernel.
602 The result is that you directly add configuration options to the
603 <filename>meta</filename> branch for your BSP.
604 The configuration options will likely end up in that location anyway if the BSP gets
605 added to the Yocto Project.
606 </para>
607
608 <para>
609 In general, however, the Yocto Project maintainers take care of moving the
610 <filename>SRC_URI</filename>-specified
611 configuration options to the kernel's <filename>meta</filename> branch.
612 Not only is it easier for BSP developers to not have to worry about putting those
613 configurations in the branch, but having the maintainers do it allows them to apply
614 'global' knowledge about the kinds of common configuration options multiple BSPs in
615 the tree are typically using.
616 This allows for promotion of common configurations into common features.
617 </para>
618 </note>
619 </section>
620 </section>
621
622 <section id='requirements-and-recommendations-for-released-bsps'>
623 <title>Requirements and Recommendations for Released BSPs</title>
624
625 <para>
626 Certain requirements exist for a released BSP to be considered
627 compliant with the Yocto Project.
628 Additionally, recommendations also exist.
629 This section describes the requirements and recommendations for
630 released BSPs.
631 </para>
632
633 <section id='released-bsp-requirements'>
634 <title>Released BSP Requirements</title>
635
636 <para>
637 Before looking at BSP requirements, you should consider the following:
638 <itemizedlist>
639 <listitem><para>The requirements here assume the BSP layer is a well-formed, "legal"
640 layer that can be added to the Yocto Project.
641 For guidelines on creating a layer that meets these base requirements, see the
642 "<link linkend='bsp-layers'>BSP Layers</link>" and the
643 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding
644 and Creating Layers"</ulink> in the Yocto Project Development Manual.</para></listitem>
645 <listitem><para>The requirements in this section apply regardless of how you
646 ultimately package a BSP.
647 You should consult the packaging and distribution guidelines for your
648 specific release process.
649 For an example of packaging and distribution requirements, see the
650 "<ulink url='https://wiki.yoctoproject.org/wiki/Third_Party_BSP_Release_Process'>Third Party BSP Release Process</ulink>"
651 wiki page.</para></listitem>
652 <listitem><para>The requirements for the BSP as it is made available to a developer
653 are completely independent of the released form of the BSP.
654 For example, the BSP Metadata can be contained within a Git repository
655 and could have a directory structure completely different from what appears
656 in the officially released BSP layer.</para></listitem>
657 <listitem><para>It is not required that specific packages or package
658 modifications exist in the BSP layer, beyond the requirements for general
659 compliance with the Yocto Project.
660 For example, no requirement exists dictating that a specific kernel or
661 kernel version be used in a given BSP.</para></listitem>
662 </itemizedlist>
663 </para>
664
665 <para>
666 Following are the requirements for a released BSP that conforms to the
667 Yocto Project:
668 <itemizedlist>
669 <listitem><para><emphasis>Layer Name:</emphasis>
670 The BSP must have a layer name that follows the Yocto
671 Project standards.
672 For information on BSP layer names, see the
673 "<link linkend='bsp-layers'>BSP Layers</link>" section.
674 </para></listitem>
675 <listitem><para><emphasis>File System Layout:</emphasis>
676 When possible, use the same directory names in your
677 BSP layer as listed in the <filename>recipes.txt</filename> file.
678 In particular, you should place recipes
679 (<filename>.bb</filename> files) and recipe
680 modifications (<filename>.bbappend</filename> files) into
681 <filename>recipes-*</filename> subdirectories by functional area
682 as outlined in <filename>recipes.txt</filename>.
683 If you cannot find a category in <filename>recipes.txt</filename>
684 to fit a particular recipe, you can make up your own
685 <filename>recipes-*</filename> subdirectory.
686 You can find <filename>recipes.txt</filename> in the
687 <filename>meta</filename> directory of the
688 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
689 or in the OpenEmbedded Core Layer
690 (<filename>openembedded-core</filename>) found at
691 <ulink url='http://git.openembedded.org/openembedded-core/tree/meta'></ulink>.
692 </para>
693 <para>Within any particular <filename>recipes-*</filename> category, the layout
694 should match what is found in the OpenEmbedded Core
695 Git repository (<filename>openembedded-core</filename>)
696 or the Source Directory (<filename>poky</filename>).
697 In other words, make sure you place related files in appropriately
698 related <filename>recipes-*</filename> subdirectories specific to the
699 recipe's function, or within a subdirectory containing a set of closely-related
700 recipes.
701 The recipes themselves should follow the general guidelines
702 for recipes used in the Yocto Project found in the
703 "<ulink url='https://wiki.yoctoproject.org/wiki/Recipe_%26_Patch_Style_Guide'>Yocto Recipe and Patch Style Guide</ulink>".
704 </para></listitem>
705 <listitem><para><emphasis>License File:</emphasis>
706 You must include a license file in the
707 <filename>meta-&lt;bsp_name&gt;</filename> directory.
708 This license covers the BSP Metadata as a whole.
709 You must specify which license to use since there is no
710 default license if one is not specified.
711 See the
712 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/COPYING.MIT'><filename>COPYING.MIT</filename></ulink>
713 file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer
714 as an example.</para></listitem>
715 <listitem><para><emphasis>README File:</emphasis>
716 You must include a <filename>README</filename> file in the
717 <filename>meta-&lt;bsp_name&gt;</filename> directory.
718 See the
719 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README'><filename>README</filename></ulink>
720 file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer
721 as an example.</para>
722 <para>At a minimum, the <filename>README</filename> file should
723 contain the following:
724 <itemizedlist>
725 <listitem><para>A brief description about the hardware the BSP
726 targets.</para></listitem>
727 <listitem><para>A list of all the dependencies
728 on which a BSP layer depends.
729 These dependencies are typically a list of required layers needed
730 to build the BSP.
731 However, the dependencies should also contain information regarding
732 any other dependencies the BSP might have.</para></listitem>
733 <listitem><para>Any required special licensing information.
734 For example, this information includes information on
735 special variables needed to satisfy a EULA,
736 or instructions on information needed to build or distribute
737 binaries built from the BSP Metadata.</para></listitem>
738 <listitem><para>The name and contact information for the
739 BSP layer maintainer.
740 This is the person to whom patches and questions should
741 be sent.
742 For information on how to find the right person, see the
743 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>"
744 section in the Yocto Project Development Manual.
745 </para></listitem>
746 <listitem><para>Instructions on how to build the BSP using the BSP
747 layer.</para></listitem>
748 <listitem><para>Instructions on how to boot the BSP build from
749 the BSP layer.</para></listitem>
750 <listitem><para>Instructions on how to boot the binary images
751 contained in the <filename>/binary</filename> directory,
752 if present.</para></listitem>
753 <listitem><para>Information on any known bugs or issues that users
754 should know about when either building or booting the BSP
755 binaries.</para></listitem>
756 </itemizedlist></para></listitem>
757 <listitem><para><emphasis>README.sources File:</emphasis>
758 You must include a <filename>README.sources</filename> in the
759 <filename>meta-&lt;bsp_name&gt;</filename> directory.
760 This file specifies exactly where you can find the sources used to
761 generate the binary images contained in the
762 <filename>/binary</filename> directory, if present.
763 See the
764 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README.sources'><filename>README.sources</filename></ulink>
765 file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer
766 as an example.</para></listitem>
767 <listitem><para><emphasis>Layer Configuration File:</emphasis>
768 You must include a <filename>conf/layer.conf</filename> in the
769 <filename>meta-&lt;bsp_name&gt;</filename> directory.
770 This file identifies the <filename>meta-&lt;bsp_name&gt;</filename>
771 BSP layer as a layer to the build system.</para></listitem>
772 <listitem><para><emphasis>Machine Configuration File:</emphasis>
773 You must include one or more <filename>conf/machine/&lt;bsp_name&gt;.conf</filename>
774 files in the <filename>meta-&lt;bsp_name&gt;</filename> directory.
775 These configuration files define machine targets that can be built
776 using the BSP layer.
777 Multiple machine configuration files define variations of machine
778 configurations that are supported by the BSP.
779 If a BSP supports multiple machine variations, you need to
780 adequately describe each variation in the BSP
781 <filename>README</filename> file.
782 Do not use multiple machine configuration files to describe disparate
783 hardware.
784 If you do have very different targets, you should create separate
785 BSP layers for each target.
786 <note>It is completely possible for a developer to structure the
787 working repository as a conglomeration of unrelated BSP
788 files, and to possibly generate BSPs targeted for release
789 from that directory using scripts or some other mechanism
790 (e.g. <filename>meta-yocto-bsp</filename> layer).
791 Such considerations are outside the scope of this document.</note>
792 </para></listitem>
793 </itemizedlist>
794 </para>
795 </section>
796
797 <section id='released-bsp-recommendations'>
798 <title>Released BSP Recommendations</title>
799
800 <para>
801 Following are recommendations for a released BSP that conforms to the
802 Yocto Project:
803 <itemizedlist>
804 <listitem><para><emphasis>Bootable Images:</emphasis>
805 BSP releases
806 can contain one or more bootable images.
807 Including bootable images allows users to easily try out the BSP
808 on their own hardware.</para>
809 <para>In some cases, it might not be convenient to include a
810 bootable image.
811 In this case, you might want to make two versions of the
812 BSP available: one that contains binary images, and one
813 that does not.
814 The version that does not contain bootable images avoids
815 unnecessary download times for users not interested in the images.
816 </para>
817 <para>If you need to distribute a BSP and include bootable images or build kernel and
818 filesystems meant to allow users to boot the BSP for evaluation
819 purposes, you should put the images and artifacts within a
820 <filename>binary/</filename> subdirectory located in the
821 <filename>meta-&lt;bsp_name&gt;</filename> directory.
822 <note>If you do include a bootable image as part of the BSP and the image
823 was built by software covered by the GPL or other open source licenses,
824 it is your responsibility to understand
825 and meet all licensing requirements, which could include distribution
826 of source files.</note></para></listitem>
827 <listitem><para><emphasis>Use a Yocto Linux Kernel:</emphasis>
828 Kernel recipes in the BSP should be based on a Yocto Linux kernel.
829 Basing your recipes on these kernels reduces the costs for maintaining
830 the BSP and increases its scalability.
831 See the <filename>Yocto Linux Kernel</filename> category in the
832 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Source Repositories</ulink>
833 for these kernels.</para></listitem>
834 </itemizedlist>
835 </para>
836 </section>
837 </section>
838
839 <section id='customizing-a-recipe-for-a-bsp'>
840 <title>Customizing a Recipe for a BSP</title>
841
842 <para>
843 If you plan on customizing a recipe for a particular BSP, you need to do the
844 following:
845 <itemizedlist>
846 <listitem><para>Create a <filename>.bbappend</filename>
847 file for the modified recipe.
848 For information on using append files, see the
849 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>"
850 section in the Yocto Project Development Manual.
851 </para></listitem>
852 <listitem><para>
853 Ensure your directory structure in the BSP layer
854 that supports your machine is such that it can be found
855 by the build system.
856 See the example later in this section for more information.
857 </para></listitem>
858 <listitem><para>
859 Put the append file in a directory whose name matches
860 the machine's name and is located in an appropriate
861 sub-directory inside the BSP layer (i.e.
862 <filename>recipes-bsp</filename>, <filename>recipes-graphics</filename>,
863 <filename>recipes-core</filename>, and so forth).
864 </para></listitem>
865 <listitem><para>Place the BSP-specific files in the directory named for
866 your machine inside the BSP layer.
867 </para></listitem>
868 </itemizedlist>
869 </para>
870
871 <para>
872 Following is a specific example to help you better understand the process.
873 Consider an example that customizes a recipe by adding
874 a BSP-specific configuration file named <filename>interfaces</filename> to the
875 <filename>init-ifupdown_1.0.bb</filename> recipe for machine "xyz".
876 Do the following:
877 <orderedlist>
878 <listitem><para>Edit the <filename>init-ifupdown_1.0.bbappend</filename> file so that it
879 contains the following:
880 <literallayout class='monospaced'>
881 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
882 PRINC := "${@int(PRINC) + 2}"
883 </literallayout>
884 The append file needs to be in the
885 <filename>meta-xyz/recipes-core/init-ifupdown</filename> directory.
886 </para></listitem>
887 <listitem><para>Create and place the new <filename>interfaces</filename>
888 configuration file in the BSP's layer here:
889 <literallayout class='monospaced'>
890 meta-xyz/recipes-core/init-ifupdown/files/xyz/interfaces
891 </literallayout>
892 The
893 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
894 variable in the append files extends the search path
895 the build system uses to find files during the build.
896 Consequently, for this example you need to have the
897 <filename>files</filename> directory in the same location
898 as your append file.</para></listitem>
899 </orderedlist>
900 </para>
901 </section>
902
903 <section id='bsp-licensing-considerations'>
904 <title>BSP Licensing Considerations</title>
905
906 <para>
907 In some cases, a BSP contains separately licensed Intellectual Property (IP)
908 for a component or components.
909 For these cases, you are required to accept the terms of a commercial or other
910 type of license that requires some kind of explicit End User License Agreement (EULA).
911 Once the license is accepted, the OpenEmbedded build system can then build and
912 include the corresponding component in the final BSP image.
913 If the BSP is available as a pre-built image, you can download the image after
914 agreeing to the license or EULA.
915 </para>
916
917 <para>
918 You could find that some separately licensed components that are essential
919 for normal operation of the system might not have an unencumbered (or free)
920 substitute.
921 Without these essential components, the system would be non-functional.
922 Then again, you might find that other licensed components that are simply
923 'good-to-have' or purely elective do have an unencumbered, free replacement
924 component that you can use rather than agreeing to the separately licensed component.
925 Even for components essential to the system, you might find an unencumbered component
926 that is not identical but will work as a less-capable version of the
927 licensed version in the BSP recipe.
928 </para>
929
930 <para>
931 For cases where you can substitute a free component and still
932 maintain the system's functionality, the "Downloads" page from the
933 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website's</ulink>
934 makes available de-featured BSPs
935 that are completely free of any IP encumbrances.
936 For these cases, you can use the substitution directly and
937 without any further licensing requirements.
938 If present, these fully de-featured BSPs are named appropriately
939 different as compared to the names of the respective
940 encumbered BSPs.
941 If available, these substitutions are your
942 simplest and most preferred options.
943 Use of these substitutions of course assumes the resulting functionality meets
944 system requirements.
945 </para>
946
947 <para>
948 If however, a non-encumbered version is unavailable or
949 it provides unsuitable functionality or quality, you can use an encumbered
950 version.
951 </para>
952
953 <para>
954 A couple different methods exist within the OpenEmbedded build system to
955 satisfy the licensing requirements for an encumbered BSP.
956 The following list describes them in order of preference:
957 <orderedlist>
958 <listitem><para><emphasis>Use the <filename>LICENSE_FLAGS</filename> variable
959 to define the recipes that have commercial or other types of
960 specially-licensed packages:</emphasis>
961 For each of those recipes, you can
962 specify a matching license string in a
963 <filename>local.conf</filename> variable named
964 <filename>LICENSE_FLAGS_WHITELIST</filename>.
965 Specifying the matching license string signifies that you agree to the license.
966 Thus, the build system can build the corresponding recipe and include
967 the component in the image.
968 See the
969 "<ulink url='&YOCTO_DOCS_REF_URL;#enabling-commercially-licensed-recipes'>Enabling
970 Commercially Licensed Recipes</ulink>" section in the Yocto Project Reference
971 Manual for details on how to use these variables.</para>
972 <para>If you build as you normally would, without
973 specifying any recipes in the
974 <filename>LICENSE_FLAGS_WHITELIST</filename>, the build stops and
975 provides you with the list of recipes that you have
976 tried to include in the image that need entries in
977 the <filename>LICENSE_FLAGS_WHITELIST</filename>.
978 Once you enter the appropriate license flags into the whitelist,
979 restart the build to continue where it left off.
980 During the build, the prompt will not appear again
981 since you have satisfied the requirement.</para>
982 <para>Once the appropriate license flags are on the white list
983 in the <filename>LICENSE_FLAGS_WHITELIST</filename> variable, you
984 can build the encumbered image with no change at all
985 to the normal build process.</para></listitem>
986 <listitem><para><emphasis>Get a pre-built version of the BSP:</emphasis>
987 You can get this type of BSP by visiting the
988 "Downloads" page of the
989 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>.
990 You can download BSP tarballs that contain proprietary components
991 after agreeing to the licensing
992 requirements of each of the individually encumbered
993 packages as part of the download process.
994 Obtaining the BSP this way allows you to access an encumbered
995 image immediately after agreeing to the
996 click-through license agreements presented by the
997 website.
998 Note that if you want to build the image
999 yourself using the recipes contained within the BSP
1000 tarball, you will still need to create an
1001 appropriate <filename>LICENSE_FLAGS_WHITELIST</filename> to match the
1002 encumbered recipes in the BSP.</para></listitem>
1003 </orderedlist>
1004 </para>
1005
1006 <note>
1007 Pre-compiled images are bundled with
1008 a time-limited kernel that runs for a
1009 predetermined amount of time (10 days) before it forces
1010 the system to reboot.
1011 This limitation is meant to discourage direct redistribution
1012 of the image.
1013 You must eventually rebuild the image if you want to remove this restriction.
1014 </note>
1015 </section>
1016
1017 <section id='using-the-yocto-projects-bsp-tools'>
1018 <title>Using the Yocto Project's BSP Tools</title>
1019
1020 <para>
1021 The Yocto Project includes a couple of tools that enable
1022 you to create a <link linkend='bsp-layers'>BSP layer</link>
1023 from scratch and do basic configuration and maintenance
1024 of the kernel without ever looking at a Metadata file.
1025 These tools are <filename>yocto-bsp</filename> and <filename>yocto-kernel</filename>,
1026 respectively.
1027 </para>
1028
1029 <para>
1030 The following sections describe the common location and help features as well
1031 as provide details for the
1032 <filename>yocto-bsp</filename> and <filename>yocto-kernel</filename> tools.
1033 </para>
1034
1035 <section id='common-features'>
1036 <title>Common Features</title>
1037
1038 <para>
1039 Designed to have a command interface somewhat like
1040 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>, each
1041 tool is structured as a set of sub-commands under a
1042 top-level command.
1043 The top-level command (<filename>yocto-bsp</filename>
1044 or <filename>yocto-kernel</filename>) itself does
1045 nothing but invoke or provide help on the sub-commands
1046 it supports.
1047 </para>
1048
1049 <para>
1050 Both tools reside in the <filename>scripts/</filename> subdirectory
1051 of the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1052 Consequently, to use the scripts, you must <filename>source</filename> the
1053 environment just as you would when invoking a build:
1054 <literallayout class='monospaced'>
1055 $ source oe-init-build-env [build_dir]
1056 </literallayout>
1057 </para>
1058
1059 <para>
1060 The most immediately useful function is to get help on both tools.
1061 The built-in help system makes it easy to drill down at
1062 any time and view the syntax required for any specific command.
1063 Simply enter the name of the command with the <filename>help</filename>
1064 switch:
1065 <literallayout class='monospaced'>
1066 $ yocto-bsp help
1067 Usage:
1068
1069 Create a customized Yocto BSP layer.
1070
1071 usage: yocto-bsp [--version] [--help] COMMAND [ARGS]
1072
1073 Current 'yocto-bsp' commands are:
1074 create Create a new Yocto BSP
1075 list List available values for options and BSP properties
1076
1077 See 'yocto-bsp help COMMAND' for more information on a specific command.
1078
1079
1080 Options:
1081 --version show program's version number and exit
1082 -h, --help show this help message and exit
1083 -D, --debug output debug information
1084 </literallayout>
1085 </para>
1086
1087 <para>
1088 Similarly, entering just the name of a sub-command shows the detailed usage
1089 for that sub-command:
1090 <literallayout class='monospaced'>
1091 $ yocto-bsp create
1092
1093 Usage:
1094
1095 Create a new Yocto BSP
1096
1097 usage: yocto-bsp create &lt;bsp-name&gt; &lt;karch&gt; [-o &lt;DIRNAME&gt; | --outdir &lt;DIRNAME&gt;]
1098 [-i &lt;JSON PROPERTY FILE&gt; | --infile &lt;JSON PROPERTY_FILE&gt;]
1099
1100 This command creates a Yocto BSP based on the specified parameters.
1101 The new BSP will be a new Yocto BSP layer contained by default within
1102 the top-level directory specified as 'meta-bsp-name'. The -o option
1103 can be used to place the BSP layer in a directory with a different
1104 name and location.
1105
1106 ...
1107 </literallayout>
1108 </para>
1109
1110 <para>
1111 For any sub-command, you can use the word "help" option just before the
1112 sub-command to get more extensive documentation:
1113 <literallayout class='monospaced'>
1114 $ yocto-bsp help create
1115
1116 NAME
1117 yocto-bsp create - Create a new Yocto BSP
1118
1119 SYNOPSIS
1120 yocto-bsp create &lt;bsp-name&gt; &lt;karch&gt; [-o &lt;DIRNAME&gt; | --outdir &lt;DIRNAME&gt;]
1121 [-i &lt;JSON PROPERTY FILE&gt; | --infile &lt;JSON PROPERTY_FILE&gt;]
1122
1123 DESCRIPTION
1124 This command creates a Yocto BSP based on the specified
1125 parameters. The new BSP will be a new Yocto BSP layer contained
1126 by default within the top-level directory specified as
1127 'meta-bsp-name'. The -o option can be used to place the BSP layer
1128 in a directory with a different name and location.
1129
1130 The value of the 'karch' parameter determines the set of files
1131 that will be generated for the BSP, along with the specific set of
1132 'properties' that will be used to fill out the BSP-specific
1133 portions of the BSP. The possible values for the 'karch' parameter
1134 can be listed via 'yocto-bsp list karch'.
1135
1136 ...
1137 </literallayout>
1138 </para>
1139
1140 <para>
1141 Now that you know where these two commands reside and how to access information
1142 on them, you should find it relatively straightforward to discover the commands
1143 necessary to create a BSP and perform basic kernel maintenance on that BSP using
1144 the tools.
1145 <note>
1146 You can also use the <filename>yocto-layer</filename> tool to create
1147 a "generic" layer.
1148 For information on this tool, see the
1149 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>"
1150 section in the Yocto Project Development Guide.
1151 </note>
1152 </para>
1153
1154 <para>
1155 The next sections provide a concrete starting point to expand on a few points that
1156 might not be immediately obvious or that could use further explanation.
1157 </para>
1158 </section>
1159
1160
1161 <section id='creating-a-new-bsp-layer-using-the-yocto-bsp-script'>
1162 <title>Creating a new BSP Layer Using the yocto-bsp Script</title>
1163
1164 <para>
1165 The <filename>yocto-bsp</filename> script creates a new
1166 <link linkend='bsp-layers'>BSP layer</link> for any architecture supported
1167 by the Yocto Project, as well as QEMU versions of the same.
1168 The default mode of the script's operation is to prompt you for information needed
1169 to generate the BSP layer.
1170 </para>
1171
1172 <para>
1173 For the current set of BSPs, the script prompts you for various important
1174 parameters such as:
1175 <itemizedlist>
1176 <listitem><para>The kernel to use</para></listitem>
1177 <listitem><para>The branch of that kernel to use (or re-use)</para></listitem>
1178 <listitem><para>Whether or not to use X, and if so, which drivers to use</para></listitem>
1179 <listitem><para>Whether to turn on SMP</para></listitem>
1180 <listitem><para>Whether the BSP has a keyboard</para></listitem>
1181 <listitem><para>Whether the BSP has a touchscreen</para></listitem>
1182 <listitem><para>Remaining configurable items associated with the BSP</para></listitem>
1183 </itemizedlist>
1184 </para>
1185
1186 <para>
1187 You use the <filename>yocto-bsp create</filename> sub-command to create
1188 a new BSP layer.
1189 This command requires you to specify a particular kernel architecture
1190 (<filename>karch</filename>) on which to base the BSP.
1191 Assuming you have sourced the environment, you can use the
1192 <filename>yocto-bsp list karch</filename> sub-command to list the
1193 architectures available for BSP creation as follows:
1194 <literallayout class='monospaced'>
1195 $ yocto-bsp list karch
1196 Architectures available:
1197 powerpc
1198 i386
1199 x86_64
1200 arm
1201 qemu
1202 mips
1203 </literallayout>
1204 </para>
1205
1206 <para>
1207 The remainder of this section presents an example that uses
1208 <filename>myarm</filename> as the machine name and <filename>qemu</filename>
1209 as the machine architecture.
1210 Of the available architectures, <filename>qemu</filename> is the only architecture
1211 that causes the script to prompt you further for an actual architecture.
1212 In every other way, this architecture is representative of how creating a BSP for
1213 an actual machine would work.
1214 The reason the example uses this architecture is because it is an emulated architecture
1215 and can easily be followed without requiring actual hardware.
1216 </para>
1217
1218 <para>
1219 As the <filename>yocto-bsp create</filename> command runs, default values for
1220 the prompts appear in brackets.
1221 Pressing enter without supplying anything on the command line or pressing enter
1222 with an invalid response causes the script to accept the default value.
1223 Once the script completes, the new <filename>meta-myarm</filename> BSP layer
1224 is created in the current working directory.
1225 This example assumes you have sourced the
1226 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
1227 and are currently in the top-level folder of the
1228 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1229 </para>
1230
1231 <para>
1232 Following is the complete example:
1233 <literallayout class='monospaced'>
1234 $ yocto-bsp create myarm qemu
1235 Checking basic git connectivity...
1236 Done.
1237
1238 Which qemu architecture would you like to use? [default: i386]
1239 1) i386 (32-bit)
1240 2) x86_64 (64-bit)
1241 3) ARM (32-bit)
1242 4) PowerPC (32-bit)
1243 5) MIPS (32-bit)
1244 3
1245 Would you like to use the default (3.10) kernel? (y/n) [default: y] y
1246 Do you need a new machine branch for this BSP (the alternative is to re-use an existing branch)? [y/n] [default: y]
1247 Getting branches from remote repo git://git.yoctoproject.org/linux-yocto-3.10.git...
1248 Please choose a machine branch to base your new BSP branch on: [default: standard/base]
1249 1) standard/arm-versatile-926ejs
1250 2) standard/base
1251 3) standard/beagleboard
1252 4) standard/ck
1253 5) standard/crownbay
1254 6) standard/edf
1255 7) standard/emenlow
1256 8) standard/fri2
1257 9) standard/fsl-mpc8315e-rdb
1258 10) standard/minnow
1259 11) standard/mti-malta32
1260 12) standard/mti-malta64
1261 13) standard/qemuppc
1262 14) standard/routerstationpro
1263 15) standard/sys940x
1264 1
1265 Would you like SMP support? (y/n) [default: y]
1266 Does your BSP have a touchscreen? (y/n) [default: n]
1267 Does your BSP have a keyboard? (y/n) [default: y]
1268
1269 New qemu BSP created in meta-myarm
1270 </literallayout>
1271 Let's take a closer look at the example now:
1272 <orderedlist>
1273 <listitem><para>For the QEMU architecture,
1274 the script first prompts you for which emulated architecture to use.
1275 In the example, we use the ARM architecture.
1276 </para></listitem>
1277 <listitem><para>The script then prompts you for the kernel.
1278 The default 3.10 kernel is acceptable.
1279 So, the example accepts the default.
1280 If you enter 'n', the script prompts you to further enter the kernel
1281 you do want to use (e.g. 3.2, 3.2_preempt-rt, and so forth.).</para></listitem>
1282 <listitem><para>Next, the script asks whether you would like to have a new
1283 branch created especially for your BSP in the local
1284 <ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>
1285 Git repository .
1286 If not, then the script re-uses an existing branch.</para>
1287 <para>In this example, the default (or "yes") is accepted.
1288 Thus, a new branch is created for the BSP rather than using a common, shared
1289 branch.
1290 The new branch is the branch committed to for any patches you might later add.
1291 The reason a new branch is the default is that typically
1292 new BSPs do require BSP-specific patches.
1293 The tool thus assumes that most of time a new branch is required.
1294 </para></listitem>
1295 <listitem><para>Regardless of which choice you make in the previous step,
1296 you are now given the opportunity to select a particular machine branch on
1297 which to base your new BSP-specific machine branch
1298 (or to re-use if you had elected to not create a new branch).
1299 Because this example is generating an ARM-based BSP, the example
1300 uses <filename>#1</filename> at the prompt, which selects the ARM-versatile branch.
1301 </para></listitem>
1302 <listitem><para>The remainder of the prompts are routine.
1303 Defaults are accepted for each.</para></listitem>
1304 <listitem><para>By default, the script creates the new BSP Layer in the
1305 current working directory of the
1306 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
1307 which is <filename>poky</filename> in this case.
1308 </para></listitem>
1309 </orderedlist>
1310 </para>
1311
1312 <para>
1313 Once the BSP Layer is created, you must add it to your
1314 <filename>bblayers.conf</filename> file.
1315 Here is an example:
1316 <literallayout class='monospaced'>
1317 BBLAYERS = ? " \
1318 /usr/local/src/yocto/meta \
1319 /usr/local/src/yocto/meta-yocto \
1320 /usr/local/src/yocto/meta-yocto-bsp \
1321 /usr/local/src/yocto/meta-myarm \
1322 "
1323
1324 BBLAYERS_NON_REMOVABLE ?= " \
1325 /usr/local/src/yocto/meta \
1326 /usr/local/src/yocto/meta-yocto \
1327 "
1328 </literallayout>
1329 Adding the layer to this file allows the build system to build the BSP and
1330 the <filename>yocto-kernel</filename> tool to be able to find the layer and
1331 other Metadata it needs on which to operate.
1332 </para>
1333 </section>
1334
1335 <section id='managing-kernel-patches-and-config-items-with-yocto-kernel'>
1336 <title>Managing Kernel Patches and Config Items with yocto-kernel</title>
1337
1338 <para>
1339 Assuming you have created a <link linkend='bsp-layers'>BSP Layer</link> using
1340 <link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'>
1341 <filename>yocto-bsp</filename></link> and you added it to your
1342 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
1343 variable in the <filename>bblayers.conf</filename> file, you can now use
1344 the <filename>yocto-kernel</filename> script to add patches and configuration
1345 items to the BSP's kernel.
1346 </para>
1347
1348 <para>
1349 The <filename>yocto-kernel</filename> script allows you to add, remove, and list patches
1350 and kernel config settings to a BSP's kernel
1351 <filename>.bbappend</filename> file.
1352 All you need to do is use the appropriate sub-command.
1353 Recall that the easiest way to see exactly what sub-commands are available
1354 is to use the <filename>yocto-kernel</filename> built-in help as follows:
1355 <literallayout class='monospaced'>
1356 $ yocto-kernel
1357 Usage:
1358
1359 Modify and list Yocto BSP kernel config items and patches.
1360
1361 usage: yocto-kernel [--version] [--help] COMMAND [ARGS]
1362
1363 Current 'yocto-kernel' commands are:
1364 config list List the modifiable set of bare kernel config options for a BSP
1365 config add Add or modify bare kernel config options for a BSP
1366 config rm Remove bare kernel config options from a BSP
1367 patch list List the patches associated with a BSP
1368 patch add Patch the Yocto kernel for a BSP
1369 patch rm Remove patches from a BSP
1370 feature list List the features used by a BSP
1371 feature add Have a BSP use a feature
1372 feature rm Have a BSP stop using a feature
1373 features list List the features available to BSPs
1374 feature describe Describe a particular feature
1375 feature create Create a new BSP-local feature
1376 feature destroy Remove a BSP-local feature
1377
1378 See 'yocto-kernel help COMMAND' for more information on a specific command.
1379
1380
1381
1382 Options:
1383 --version show program's version number and exit
1384 -h, --help show this help message and exit
1385 -D, --debug output debug information
1386 </literallayout>
1387 </para>
1388
1389 <para>
1390 The <filename>yocto-kernel patch add</filename> sub-command allows you to add a
1391 patch to a BSP.
1392 The following example adds two patches to the <filename>myarm</filename> BSP:
1393 <literallayout class='monospaced'>
1394 $ yocto-kernel patch add myarm ~/test.patch
1395 Added patches:
1396 test.patch
1397
1398 $ yocto-kernel patch add myarm ~/yocto-testmod.patch
1399 Added patches:
1400 yocto-testmod.patch
1401 </literallayout>
1402 <note>Although the previous example adds patches one at a time, it is possible
1403 to add multiple patches at the same time.</note>
1404 </para>
1405
1406 <para>
1407 You can verify patches have been added by using the
1408 <filename>yocto-kernel patch list</filename> sub-command.
1409 Here is an example:
1410 <literallayout class='monospaced'>
1411 $ yocto-kernel patch list myarm
1412 The current set of machine-specific patches for myarm is:
1413 1) test.patch
1414 2) yocto-testmod.patch
1415 </literallayout>
1416 </para>
1417
1418 <para>
1419 You can also use the <filename>yocto-kernel</filename> script to
1420 remove a patch using the <filename>yocto-kernel patch rm</filename> sub-command.
1421 Here is an example:
1422 <literallayout class='monospaced'>
1423 $ yocto-kernel patch rm myarm
1424 Specify the patches to remove:
1425 1) test.patch
1426 2) yocto-testmod.patch
1427 1
1428 Removed patches:
1429 test.patch
1430 </literallayout>
1431 </para>
1432
1433 <para>
1434 Again, using the <filename>yocto-kernel patch list</filename> sub-command,
1435 you can verify that the patch was in fact removed:
1436 <literallayout class='monospaced'>
1437 $ yocto-kernel patch list myarm
1438 The current set of machine-specific patches for myarm is:
1439 1) yocto-testmod.patch
1440 </literallayout>
1441 </para>
1442
1443 <para>
1444 In a completely similar way, you can use the <filename>yocto-kernel config add</filename>
1445 sub-command to add one or more kernel config item settings to a BSP.
1446 The following commands add a couple of config items to the
1447 <filename>myarm</filename> BSP:
1448 <literallayout class='monospaced'>
1449 $ yocto-kernel config add myarm CONFIG_MISC_DEVICES=y
1450 Added items:
1451 CONFIG_MISC_DEVICES=y
1452
1453 $ yocto-kernel config add myarm CONFIG_YOCTO_TESTMOD=y
1454 Added items:
1455 CONFIG_YOCTO_TESTMOD=y
1456 </literallayout>
1457 <note>Although the previous example adds config items one at a time, it is possible
1458 to add multiple config items at the same time.</note>
1459 </para>
1460
1461 <para>
1462 You can list the config items now associated with the BSP.
1463 Doing so shows you the config items you added as well as others associated
1464 with the BSP:
1465 <literallayout class='monospaced'>
1466 $ yocto-kernel config list myarm
1467 The current set of machine-specific kernel config items for myarm is:
1468 1) CONFIG_MISC_DEVICES=y
1469 2) CONFIG_YOCTO_TESTMOD=y
1470 </literallayout>
1471 </para>
1472
1473 <para>
1474 Finally, you can remove one or more config items using the
1475 <filename>yocto-kernel config rm</filename> sub-command in a manner
1476 completely analogous to <filename>yocto-kernel patch rm</filename>.
1477 </para>
1478 </section>
1479 </section>
1480</chapter>
diff --git a/documentation/bsp-guide/figures/bsp-title.png b/documentation/bsp-guide/figures/bsp-title.png
new file mode 100644
index 0000000000..f624dd4f94
--- /dev/null
+++ b/documentation/bsp-guide/figures/bsp-title.png
Binary files differ
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
new file mode 100644
index 0000000000..e2e89a032c
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -0,0 +1,5913 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='extendpoky'>
6
7<title>Common Tasks</title>
8 <para>
9 This chapter describes fundamental procedures such as creating layers,
10 adding new software packages, extending or customizing images,
11 porting work to new hardware (adding a new machine), and so forth.
12 You will find the procedures documented here occur often in the
13 develop cycle using the Yocto Project.
14 </para>
15
16 <section id="understanding-and-creating-layers">
17 <title>Understanding and Creating Layers</title>
18
19 <para>
20 The OpenEmbedded build system supports organizing
21 <link linkend='metadata'>Metadata</link> into multiple layers.
22 Layers allow you to isolate different types of customizations from
23 each other.
24 You might find it tempting to keep everything in one layer when
25 working on a single project.
26 However, the more modular you organize your Metadata, the easier
27 it is to cope with future changes.
28 </para>
29
30 <para>
31 To illustrate how layers are used to keep things modular, consider
32 machine customizations.
33 These types of customizations typically reside in a special layer,
34 rather than a general layer, called a Board Specific Package (BSP)
35 Layer.
36 Furthermore, the machine customizations should be isolated from
37 recipes and Metadata that support a new GUI environment,
38 for example.
39 This situation gives you a couple of layers: one for the machine
40 configurations, and one for the GUI environment.
41 It is important to understand, however, that the BSP layer can
42 still make machine-specific additions to recipes within the GUI
43 environment layer without polluting the GUI layer itself
44 with those machine-specific changes.
45 You can accomplish this through a recipe that is a BitBake append
46 (<filename>.bbappend</filename>) file, which is described later
47 in this section.
48 </para>
49
50 <para>
51 </para>
52
53 <section id='yocto-project-layers'>
54 <title>Layers</title>
55
56 <para>
57 The <link linkend='source-directory'>Source Directory</link>
58 contains both general layers and BSP
59 layers right out of the box.
60 You can easily identify layers that ship with a
61 Yocto Project release in the Source Directory by their
62 folder names.
63 Folders that are layers begin with the string
64 <filename>meta</filename>.
65 <note>
66 It is not a requirement that a layer begins with the
67 string <filename>meta</filename>.
68 </note>
69 For example, when you set up the Source Directory structure,
70 you will see several layers:
71 <filename>meta</filename>, <filename>meta-hob</filename>,
72 <filename>meta-skeleton</filename>,
73 <filename>meta-yocto</filename>, and
74 <filename>meta-yocto-bsp</filename>.
75 Each of these folders is a layer.
76 </para>
77
78 <para>
79 Furthermore, if you set up a local copy of the
80 <filename>meta-intel</filename> Git repository
81 and then explore the folder of that general layer,
82 you will discover many BSP layers inside.
83 For more information on BSP layers, see the
84 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
85 section in the Yocto Project Board Support Package (BSP)
86 Developer's Guide.
87 </para>
88 </section>
89
90 <section id='creating-your-own-layer'>
91 <title>Creating Your Own Layer</title>
92
93 <para>
94 It is very easy to create your own layers to use with the
95 OpenEmbedded build system.
96 The Yocto Project ships with scripts that speed up creating
97 general layers and BSP layers.
98 This section describes the steps you perform by hand to create
99 a layer so that you can better understand them.
100 For information about the layer-creation scripts, see the
101 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>"
102 section in the Yocto Project Board Support Package (BSP)
103 Developer's Guide and the
104 "<link linkend='creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</link>"
105 section further down in this manual.
106 </para>
107
108 <para>
109 Follow these general steps to create your layer:
110 <orderedlist>
111 <listitem><para><emphasis>Check Existing Layers:</emphasis>
112 Before creating a new layer, you should be sure someone
113 has not already created a layer containing the Metadata
114 you need.
115 You can see the
116 <ulink url='http://layers.openembedded.org/layerindex/layers/'><filename>OpenEmbedded Metadata Index</filename></ulink>
117 for a list of layers from the OpenEmbedded community
118 that can be used in the Yocto Project.
119 </para></listitem>
120 <listitem><para><emphasis>Create a Directory:</emphasis>
121 Create the directory for your layer.
122 While not strictly required, prepend the name of the
123 folder with the string <filename>meta-</filename>.
124 For example:
125 <literallayout class='monospaced'>
126 meta-mylayer
127 meta-GUI_xyz
128 meta-mymachine
129 </literallayout>
130 </para></listitem>
131 <listitem><para><emphasis>Create a Layer Configuration
132 File:</emphasis>
133 Inside your new layer folder, you need to create a
134 <filename>conf/layer.conf</filename> file.
135 It is easiest to take an existing layer configuration
136 file and copy that to your layer's
137 <filename>conf</filename> directory and then modify the
138 file as needed.</para>
139 <para>The
140 <filename>meta-yocto-bsp/conf/layer.conf</filename> file
141 demonstrates the required syntax:
142 <literallayout class='monospaced'>
143 # We have a conf and classes directory, add to BBPATH
144 BBPATH .= ":${LAYERDIR}"
145
146 # We have recipes-* directories, add to BBFILES
147 BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \
148 ${LAYERDIR}/recipes-*/*/*.bbappend"
149
150 BBFILE_COLLECTIONS += "yoctobsp"
151 BBFILE_PATTERN_yoctobsp = "^${LAYERDIR}/"
152 BBFILE_PRIORITY_yoctobsp = "5"
153 LAYERVERSION_yoctobsp = "2"
154 </literallayout></para>
155 <para>Here is an explanation of the example:
156 <itemizedlist>
157 <listitem><para>The configuration and
158 classes directory is appended to
159 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink>.
160 <note>
161 All non-distro layers, which include all BSP
162 layers, are expected to append the layer
163 directory to the
164 <filename>BBPATH</filename>.
165 On the other hand, distro layers, such as
166 <filename>meta-yocto</filename>, can choose
167 to enforce their own precedence over
168 <filename>BBPATH</filename>.
169 For an example of that syntax, see the
170 <filename>layer.conf</filename> file for
171 the <filename>meta-yocto</filename> layer.
172 </note></para></listitem>
173 <listitem><para>The recipes for the layers are
174 appended to
175 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'>BBFILES</ulink></filename>.
176 </para></listitem>
177 <listitem><para>The
178 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename>
179 variable is then appended with the layer name.
180 </para></listitem>
181 <listitem><para>The
182 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename>
183 variable is set to a regular expression and is
184 used to match files from
185 <filename>BBFILES</filename> into a particular
186 layer.
187 In this case,
188 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename>
189 is used to make <filename>BBFILE_PATTERN</filename> match within the
190 layer's path.</para></listitem>
191 <listitem><para>The
192 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename>
193 variable then assigns a priority to the layer.
194 Applying priorities is useful in situations
195 where the same package might appear in multiple
196 layers and allows you to choose what layer
197 should take precedence.</para></listitem>
198 <listitem><para>The
199 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERVERSION'>LAYERVERSION</ulink></filename>
200 variable optionally specifies the version of a
201 layer as a single number.</para></listitem>
202 </itemizedlist></para>
203 <para>Note the use of the
204 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename>
205 variable, which expands to the directory of the current
206 layer.</para>
207 <para>Through the use of the <filename>BBPATH</filename>
208 variable, BitBake locates <filename>.bbclass</filename>
209 files, configuration files, and files that are included
210 with <filename>include</filename> and
211 <filename>require</filename> statements.
212 For these cases, BitBake uses the first file that
213 matches the name found in <filename>BBPATH</filename>.
214 This is similar to the way the <filename>PATH</filename>
215 variable is used for binaries.
216 We recommend, therefore, that you use unique
217 <filename>.bbclass</filename> and configuration
218 filenames in your custom layer.</para></listitem>
219 <listitem><para><emphasis>Add Content:</emphasis> Depending
220 on the type of layer, add the content.
221 If the layer adds support for a machine, add the machine
222 configuration in a <filename>conf/machine/</filename>
223 file within the layer.
224 If the layer adds distro policy, add the distro
225 configuration in a <filename>conf/distro/</filename>
226 file with the layer.
227 If the layer introduces new recipes, put the recipes
228 you need in <filename>recipes-*</filename>
229 subdirectories within the layer.
230 <note>In order to be compliant with the Yocto Project,
231 a layer must contain a
232 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-readme'>README file.</ulink>
233 </note></para></listitem>
234 </orderedlist>
235 </para>
236 </section>
237
238 <section id='best-practices-to-follow-when-creating-layers'>
239 <title>Best Practices to Follow When Creating Layers</title>
240
241 <para>
242 To create layers that are easier to maintain and that will
243 not impact builds for other machines, you should consider the
244 information in the following sections.
245 </para>
246
247 <section id='avoid-overlaying-entire-recipes'>
248 <title>Avoid "Overlaying" Entire Recipes</title>
249
250 <para>
251 Avoid "overlaying" entire recipes from other layers in your
252 configuration.
253 In other words, do not copy an entire recipe into your
254 layer and then modify it.
255 Use <filename>.bbappend</filename> files to override the
256 parts of the recipe you need to modify.
257 </para>
258 </section>
259
260 <section id='avoid-duplicating-include-files'>
261 <title>Avoid Duplicating Include Files</title>
262
263 <para>
264 Avoid duplicating include files.
265 Use <filename>.bbappend</filename> files for each recipe
266 that uses an include file.
267 Or, if you are introducing a new recipe that requires
268 the included file, use the path relative to the original
269 layer directory to refer to the file.
270 For example, use
271 <filename>require recipes-core/somepackage/somefile.inc</filename>
272 instead of <filename>require somefile.inc</filename>.
273 If you're finding you have to overlay the include file,
274 it could indicate a deficiency in the include file in
275 the layer to which it originally belongs.
276 If this is the case, you need to address that deficiency
277 instead of overlaying the include file.
278 For example, consider how support plug-ins for the Qt 4
279 database are configured.
280 The Source Directory does not have MySQL or PostgreSQL.
281 However, OpenEmbedded's layer <filename>meta-oe</filename>
282 does.
283 Consequently, <filename>meta-oe</filename> uses
284 <filename>.bbappend</filename> files to modify the
285 <filename>QT_SQL_DRIVER_FLAGS</filename> variable to
286 enable the appropriate plug-ins.
287 This variable was added to the <filename>qt4.inc</filename>
288 include file in the Source Directory specifically to allow
289 the <filename>meta-oe</filename> layer to be able to control
290 which plug-ins are built.
291 </para>
292 </section>
293
294 <section id='structure-your-layers'>
295 <title>Structure Your Layers</title>
296
297 <para>
298 Proper use of overrides within append files and placement
299 of machine-specific files within your layer can ensure that
300 a build is not using the wrong Metadata and negatively
301 impacting a build for a different machine.
302 Following are some examples:
303 <itemizedlist>
304 <listitem><para><emphasis>Modifying Variables to Support
305 a Different Machine:</emphasis>
306 Suppose you have a layer named
307 <filename>meta-one</filename> that adds support
308 for building machine "one".
309 To do so, you use an append file named
310 <filename>base-files.bbappend</filename> and
311 create a dependency on "foo" by altering the
312 <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>
313 variable:
314 <literallayout class='monospaced'>
315 DEPENDS = "foo"
316 </literallayout>
317 The dependency is created during any build that
318 includes the layer
319 <filename>meta-one</filename>.
320 However, you might not want this dependency
321 for all machines.
322 For example, suppose you are building for
323 machine "two" but your
324 <filename>bblayers.conf</filename> file has the
325 <filename>meta-one</filename> layer included.
326 During the build, the
327 <filename>base-files</filename> for machine
328 "two" will also have the dependency on
329 <filename>foo</filename>.</para>
330 <para>To make sure your changes apply only when
331 building machine "one", use a machine override
332 with the <filename>DEPENDS</filename> statement:
333 <literallayout class='monospaced'>
334 DEPENDS_one = "foo"
335 </literallayout>
336 You should follow the same strategy when using
337 <filename>_append</filename> and
338 <filename>_prepend</filename> operations:
339 <literallayout class='monospaced'>
340 DEPENDS_append_one = " foo"
341 DEPENDS_prepend_one = "foo "
342 </literallayout>
343 <note>
344 Avoiding "+=" and "=+" and using
345 machine-specific
346 <filename>_append</filename>
347 and <filename>_prepend</filename> operations
348 is recommended as well.
349 </note></para></listitem>
350 <listitem><para><emphasis>Place Machine-Specific Files
351 in Machine-Specific Locations:</emphasis>
352 When you have a base recipe, such as
353 <filename>base-files.bb</filename>, that
354 contains a
355 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
356 statement to a file, you can use an append file
357 to cause the build to use your own version of
358 the file.
359 For example, an append file in your layer at
360 <filename>/meta-one/recipes-core/base-files/base-files.bbappend</filename>
361 could extend
362 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
363 using
364 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
365 as follows:
366 <literallayout class='monospaced'>
367 FILESEXTRAPATHS_prepend := "${THISDIR}/${BPN}:"
368 </literallayout>
369 The build for machine "one" will pick up your
370 machine-specific file as long as you have the
371 file in
372 <filename>/meta-one/recipes-core/base-files/base-files/</filename>.
373 However, if you are building for a different
374 machine and the
375 <filename>bblayers.conf</filename> file includes
376 the <filename>meta-one</filename> layer and
377 the location of your machine-specific file is
378 the first location where that file is found
379 according to <filename>FILESPATH</filename>,
380 builds for all machines will also use that
381 machine-specific file.</para>
382 <para>You can make sure that a machine-specific
383 file is used for a particular machine by putting
384 the file in a subdirectory specific to the
385 machine.
386 For example, rather than placing the file in
387 <filename>/meta-one/recipes-core/base-files/base-files/</filename>
388 as shown above, put it in
389 <filename>/meta-one/recipes-core/base-files/base-files/one/</filename>.
390 Not only does this make sure the file is used
391 only when building for machine "one" but the
392 build process locates the file more quickly.</para>
393 <para>In summary, you need to place all files
394 referenced from <filename>SRC_URI</filename>
395 in a machine-specific subdirectory within the
396 layer in order to restrict those files to
397 machine-specific builds.</para></listitem>
398 </itemizedlist>
399 </para>
400 </section>
401
402 <section id='other-recommendations'>
403 <title>Other Recommendations</title>
404
405 <para>
406 We also recommend the following:
407 <itemizedlist>
408 <listitem><para>Store custom layers in a Git repository
409 that uses the
410 <filename>meta-&lt;layer_name&gt;</filename> format.
411 </para></listitem>
412 <listitem><para>Clone the repository alongside other
413 <filename>meta</filename> directories in the
414 <link linkend='source-directory'>Source Directory</link>.
415 </para></listitem>
416 </itemizedlist>
417 Following these recommendations keeps your Source Directory and
418 its configuration entirely inside the Yocto Project's core
419 base.
420 </para>
421 </section>
422 </section>
423
424 <section id='enabling-your-layer'>
425 <title>Enabling Your Layer</title>
426
427 <para>
428 Before the OpenEmbedded build system can use your new layer,
429 you need to enable it.
430 To enable your layer, simply add your layer's path to the
431 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename>
432 variable in your <filename>conf/bblayers.conf</filename> file,
433 which is found in the
434 <link linkend='build-directory'>Build Directory</link>.
435 The following example shows how to enable a layer named
436 <filename>meta-mylayer</filename>:
437 <literallayout class='monospaced'>
438 LCONF_VERSION = "6"
439
440 BBPATH = "${TOPDIR}"
441 BBFILES ?= ""
442
443 BBLAYERS ?= " \
444 $HOME/poky/meta \
445 $HOME/poky/meta-yocto \
446 $HOME/poky/meta-yocto-bsp \
447 $HOME/poky/meta-mylayer \
448 "
449
450 BBLAYERS_NON_REMOVABLE ?= " \
451 $HOME/poky/meta \
452 $HOME/poky/meta-yocto \
453 "
454 </literallayout>
455 </para>
456
457 <para>
458 BitBake parses each <filename>conf/layer.conf</filename> file
459 as specified in the <filename>BBLAYERS</filename> variable
460 within the <filename>conf/bblayers.conf</filename> file.
461 During the processing of each
462 <filename>conf/layer.conf</filename> file, BitBake adds the
463 recipes, classes and configurations contained within the
464 particular layer to the source directory.
465 </para>
466 </section>
467
468 <section id='using-bbappend-files'>
469 <title>Using .bbappend Files</title>
470
471 <para>
472 Recipes used to append Metadata to other recipes are called
473 BitBake append files.
474 BitBake append files use the <filename>.bbappend</filename> file
475 type suffix, while the corresponding recipes to which Metadata
476 is being appended use the <filename>.bb</filename> file type
477 suffix.
478 </para>
479
480 <para>
481 A <filename>.bbappend</filename> file allows your layer to make
482 additions or changes to the content of another layer's recipe
483 without having to copy the other recipe into your layer.
484 Your <filename>.bbappend</filename> file resides in your layer,
485 while the main <filename>.bb</filename> recipe file to
486 which you are appending Metadata resides in a different layer.
487 </para>
488
489 <para>
490 Append files must have the same root names as their corresponding
491 recipes.
492 For example, the append file
493 <filename>someapp_&DISTRO;.bbappend</filename> must apply to
494 <filename>someapp_&DISTRO;.bb</filename>.
495 This means the original recipe and append file names are version
496 number-specific.
497 If the corresponding recipe is renamed to update to a newer
498 version, the corresponding <filename>.bbappend</filename> file must
499 be renamed as well.
500 During the build process, BitBake displays an error on starting
501 if it detects a <filename>.bbappend</filename> file that does
502 not have a corresponding recipe with a matching name.
503 See the
504 <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_DANGLINGAPPENDS_WARNONLY'><filename>BB_DANGLINGAPPENDS_WARNONLY</filename></ulink>
505 variable for information on how to handle this error.
506 </para>
507
508 <para>
509 Being able to append information to an existing recipe not only
510 avoids duplication, but also automatically applies recipe
511 changes in a different layer to your layer.
512 If you were copying recipes, you would have to manually merge
513 changes as they occur.
514 </para>
515
516 <para>
517 As an example, consider the main formfactor recipe and a
518 corresponding formfactor append file both from the
519 <link linkend='source-directory'>Source Directory</link>.
520 Here is the main formfactor recipe, which is named
521 <filename>formfactor_0.0.bb</filename> and located in the
522 "meta" layer at
523 <filename>meta/recipes-bsp/formfactor</filename>:
524 <literallayout class='monospaced'>
525 DESCRIPTION = "Device formfactor information"
526 SECTION = "base"
527 LICENSE = "MIT"
528 LIC_FILES_CHKSUM = "file://${COREBASE}/LICENSE;md5=3f40d7994397109285ec7b81fdeb3b58 \
529 file://${COREBASE}/meta/COPYING.MIT;md5=3da9cfbcb788c80a0384361b4de20420"
530 PR = "r41"
531
532 SRC_URI = "file://config file://machconfig"
533 S = "${WORKDIR}"
534
535 PACKAGE_ARCH = "${MACHINE_ARCH}"
536 INHIBIT_DEFAULT_DEPS = "1"
537
538 do_install() {
539 # Only install file if it has a contents
540 install -d ${D}${sysconfdir}/formfactor/
541 install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/
542 if [ -s "${S}/machconfig" ]; then
543 install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/
544 fi
545 }
546 </literallayout>
547 In the main recipe, note the
548 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
549 variable, which tells the OpenEmbedded build system where to
550 find files during the build.
551 </para>
552
553 <para>
554 Following is the append file, which is named
555 <filename>formfactor_0.0.bbappend</filename> and is from the
556 Crown Bay BSP Layer named
557 <filename>meta-intel/meta-crownbay</filename>.
558 The file is in <filename>recipes-bsp/formfactor</filename>:
559 <literallayout class='monospaced'>
560 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
561 </literallayout>
562 </para>
563
564 <para>
565 By default, the build system uses the
566 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
567 variable to locate files.
568 This append file extends the locations by setting the
569 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
570 variable.
571 Setting this variable in the <filename>.bbappend</filename>
572 file is the most reliable and recommended method for adding
573 directories to the search path used by the build system
574 to find files.
575 </para>
576
577 <para>
578 The statement in this example extends the directories to include
579 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-THISDIR'><filename>THISDIR</filename></ulink><filename>}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename>,
580 which resolves to a directory named
581 <filename>formfactor</filename> in the same directory
582 in which the append file resides (i.e.
583 <filename>meta-intel/meta-crownbay/recipes-bsp/formfactor/formfactor</filename>.
584 This implies that you must have the supporting directory
585 structure set up that will contain any files or patches you
586 will be including from the layer.
587 </para>
588
589 <para>
590 Using the immediate expansion assignment operator
591 <filename>:=</filename> is important because of the reference to
592 <filename>THISDIR</filename>.
593 The trailing colon character is important as it ensures that
594 items in the list remain colon-separated.
595 <note><para>BitBake automatically defines the
596 <filename>THISDIR</filename> variable.
597 You should never set this variable yourself.
598 Using <filename>_prepend</filename> ensures your path will
599 be searched prior to other paths in the final list.</para>
600 <para>Also, not all append files add extra files.
601 Many append files simply exist to add build options
602 (e.g. <filename>systemd</filename>).
603 For these cases, it is not necessary to use the
604 "_prepend" part of the statement.</para>
605 </note>
606 </para>
607 </section>
608
609 <section id='prioritizing-your-layer'>
610 <title>Prioritizing Your Layer</title>
611
612 <para>
613 Each layer is assigned a priority value.
614 Priority values control which layer takes precedence if there
615 are recipe files with the same name in multiple layers.
616 For these cases, the recipe file from the layer with a higher
617 priority number takes precedence.
618 Priority values also affect the order in which multiple
619 <filename>.bbappend</filename> files for the same recipe are
620 applied.
621 You can either specify the priority manually, or allow the
622 build system to calculate it based on the layer's dependencies.
623 </para>
624
625 <para>
626 To specify the layer's priority manually, use the
627 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'><filename>BBFILE_PRIORITY</filename></ulink>
628 variable.
629 For example:
630 <literallayout class='monospaced'>
631 BBFILE_PRIORITY_mylayer = "1"
632 </literallayout>
633 </para>
634
635 <note>
636 <para>It is possible for a recipe with a lower version number
637 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>
638 in a layer that has a higher priority to take precedence.</para>
639 <para>Also, the layer priority does not currently affect the
640 precedence order of <filename>.conf</filename>
641 or <filename>.bbclass</filename> files.
642 Future versions of BitBake might address this.</para>
643 </note>
644 </section>
645
646 <section id='managing-layers'>
647 <title>Managing Layers</title>
648
649 <para>
650 You can use the BitBake layer management tool to provide a view
651 into the structure of recipes across a multi-layer project.
652 Being able to generate output that reports on configured layers
653 with their paths and priorities and on
654 <filename>.bbappend</filename> files and their applicable
655 recipes can help to reveal potential problems.
656 </para>
657
658 <para>
659 Use the following form when running the layer management tool.
660 <literallayout class='monospaced'>
661 $ bitbake-layers &lt;command&gt; [arguments]
662 </literallayout>
663 The following list describes the available commands:
664 <itemizedlist>
665 <listitem><para><filename><emphasis>help:</emphasis></filename>
666 Displays general help or help on a specified command.
667 </para></listitem>
668 <listitem><para><filename><emphasis>show-layers:</emphasis></filename>
669 Shows the current configured layers.
670 </para></listitem>
671 <listitem><para><filename><emphasis>show-recipes:</emphasis></filename>
672 Lists available recipes and the layers that provide them.
673 </para></listitem>
674 <listitem><para><filename><emphasis>show-overlayed:</emphasis></filename>
675 Lists overlayed recipes.
676 A recipe is overlayed when a recipe with the same name
677 exists in another layer that has a higher layer
678 priority.
679 </para></listitem>
680 <listitem><para><filename><emphasis>show-appends:</emphasis></filename>
681 Lists <filename>.bbappend</filename> files and the
682 recipe files to which they apply.
683 </para></listitem>
684 <listitem><para><filename><emphasis>show-cross-depends:</emphasis></filename>
685 Lists dependency relationships between recipes that
686 cross layer boundaries.
687 </para></listitem>
688 <listitem><para><filename><emphasis>flatten:</emphasis></filename>
689 Flattens the layer configuration into a separate output
690 directory.
691 Flattening your layer configuration builds a "flattened"
692 directory that contains the contents of all layers,
693 with any overlayed recipes removed and any
694 <filename>.bbappend</filename> files appended to the
695 corresponding recipes.
696 You might have to perform some manual cleanup of the
697 flattened layer as follows:
698 <itemizedlist>
699 <listitem><para>Non-recipe files (such as patches)
700 are overwritten.
701 The flatten command shows a warning for these
702 files.
703 </para></listitem>
704 <listitem><para>Anything beyond the normal layer
705 setup has been added to the
706 <filename>layer.conf</filename> file.
707 Only the lowest priority layer's
708 <filename>layer.conf</filename> is used.
709 </para></listitem>
710 <listitem><para>Overridden and appended items from
711 <filename>.bbappend</filename> files need to be
712 cleaned up.
713 The contents of each
714 <filename>.bbappend</filename> end up in the
715 flattened recipe.
716 However, if there are appended or changed
717 variable values, you need to tidy these up
718 yourself.
719 Consider the following example.
720 Here, the <filename>bitbake-layers</filename>
721 command adds the line
722 <filename>#### bbappended ...</filename> so that
723 you know where the following lines originate:
724 <literallayout class='monospaced'>
725 ...
726 DESCRIPTION = "A useful utility"
727 ...
728 EXTRA_OECONF = "--enable-something"
729 ...
730
731 #### bbappended from meta-anotherlayer ####
732
733 DESCRIPTION = "Customized utility"
734 EXTRA_OECONF += "--enable-somethingelse"
735 </literallayout>
736 Ideally, you would tidy up these utilities as
737 follows:
738 <literallayout class='monospaced'>
739 ...
740 DESCRIPTION = "Customized utility"
741 ...
742 EXTRA_OECONF = "--enable-something --enable-somethingelse"
743 ...
744 </literallayout></para></listitem>
745 </itemizedlist></para></listitem>
746 </itemizedlist>
747 </para>
748 </section>
749
750 <section id='creating-a-general-layer-using-the-yocto-layer-script'>
751 <title>Creating a General Layer Using the yocto-layer Script</title>
752
753 <para>
754 The <filename>yocto-layer</filename> script simplifies
755 creating a new general layer.
756 <note>
757 For information on BSP layers, see the
758 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
759 section in the Yocto Project Board Specific (BSP)
760 Developer's Guide.
761 </note>
762 The default mode of the script's operation is to prompt you for
763 information needed to generate the layer:
764 <itemizedlist>
765 <listitem><para>The layer priority
766 </para></listitem>
767 <listitem><para>Whether or not to create a sample recipe.
768 </para></listitem>
769 <listitem><para>Whether or not to create a sample
770 append file.
771 </para></listitem>
772 </itemizedlist>
773 </para>
774
775 <para>
776 Use the <filename>yocto-layer create</filename> sub-command
777 to create a new general layer.
778 In its simplest form, you can create a layer as follows:
779 <literallayout class='monospaced'>
780 $ yocto-layer create mylayer
781 </literallayout>
782 The previous example creates a layer named
783 <filename>meta-mylayer</filename> in the current directory.
784 </para>
785
786 <para>
787 As the <filename>yocto-layer create</filename> command runs,
788 default values for the prompts appear in brackets.
789 Pressing enter without supplying anything for the prompts
790 or pressing enter and providing an invalid response causes the
791 script to accept the default value.
792 Once the script completes, the new layer
793 is created in the current working directory.
794 The script names the layer by prepending
795 <filename>meta-</filename> to the name you provide.
796 </para>
797
798 <para>
799 Minimally, the script creates the following within the layer:
800 <itemizedlist>
801 <listitem><para><emphasis>The <filename>conf</filename>
802 directory:</emphasis>
803 This directory contains the layer's configuration file.
804 The root name for the file is the same as the root name
805 your provided for the layer (e.g.
806 <filename>&lt;layer&gt;.conf</filename>).
807 </para></listitem>
808 <listitem><para><emphasis>The
809 <filename>COPYING.MIT</filename>:</emphasis>
810 The copyright and use notice for the software.
811 </para></listitem>
812 <listitem><para><emphasis>The <filename>README</filename>
813 file:</emphasis>
814 A file describing the contents of your new layer.
815 </para></listitem>
816 </itemizedlist>
817 </para>
818
819 <para>
820 If you choose to generate a sample recipe file, the script
821 prompts you for the name for the recipe and then creates it
822 in <filename>&lt;layer&gt;/recipes-example/example/</filename>.
823 The script creates a <filename>.bb</filename> file and a
824 directory, which contains a sample
825 <filename>helloworld.c</filename> source file and along with
826 a sample patch file.
827 If you do not provide a recipe name, the script uses
828 "example".
829 </para>
830
831 <para>
832 If you choose to generate a sample append file, the script
833 prompts you for the name for the file and then creates it
834 in <filename>&lt;layer&gt;/recipes-example-bbappend/example-bbappend/</filename>.
835 The script creates a <filename>.bbappend</filename> file and a
836 directory, which contains a sample patch file.
837 If you do not provide a recipe name, the script uses
838 "example".
839 The script also prompts you for the version of the append file.
840 The version should match the recipe to which the append file
841 is associated.
842 </para>
843
844 <para>
845 The easiest way to see how the <filename>yocto-layer</filename>
846 script works is to experiment with the script.
847 You can also read the usage information by entering the
848 following:
849 <literallayout class='monospaced'>
850 $ yocto-layer help
851 </literallayout>
852 </para>
853
854 <para>
855 Once you create your general layer, you must add it to your
856 <filename>bblayers.conf</filename> file.
857 Here is an example where a layer named
858 <filename>meta-mylayer</filename> is added:
859 <literallayout class='monospaced'>
860 BBLAYERS = ?" \
861 /usr/local/src/yocto/meta \
862 /usr/local/src/yocto/meta-yocto \
863 /usr/local/src/yocto/meta-yocto-bsp \
864 /usr/local/src/yocto/meta-mylayer \
865 "
866
867 BBLAYERS_NON_REMOVABLE ?= " \
868 /usr/local/src/yocto/meta \
869 /usr/local/src/yocto/meta-yocto \
870 "
871 </literallayout>
872 Adding the layer to this file enables the build system to
873 locate the layer during the build.
874 </para>
875 </section>
876 </section>
877
878 <section id='usingpoky-extend-customimage'>
879 <title>Customizing Images</title>
880
881 <para>
882 You can customize images to satisfy particular requirements.
883 This section describes several methods and provides guidelines for each.
884 </para>
885
886 <section id='usingpoky-extend-customimage-custombb'>
887 <title>Customizing Images Using Custom .bb Files</title>
888
889 <para>
890 One way to get additional software into an image is to create a custom image.
891 The following example shows the form for the two lines you need:
892 <literallayout class='monospaced'>
893 IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2"
894
895 inherit core-image
896 </literallayout>
897 </para>
898
899 <para>
900 By creating a custom image, a developer has total control
901 over the contents of the image.
902 It is important to use the correct names of packages in the
903 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>
904 variable.
905 You must use the OpenEmbedded notation and not the Debian notation for the names
906 (e.g. <filename>eglibc-dev</filename> instead of <filename>libc6-dev</filename>).
907 </para>
908
909 <para>
910 The other method for creating a custom image is to base it on an existing image.
911 For example, if you want to create an image based on <filename>core-image-sato</filename>
912 but add the additional package <filename>strace</filename> to the image,
913 copy the <filename>meta/recipes-sato/images/core-image-sato.bb</filename> to a
914 new <filename>.bb</filename> and add the following line to the end of the copy:
915 <literallayout class='monospaced'>
916 IMAGE_INSTALL += "strace"
917 </literallayout>
918 </para>
919 </section>
920
921 <section id='usingpoky-extend-customimage-customtasks'>
922 <title>Customizing Images Using Custom Package Groups</title>
923
924 <para>
925 For complex custom images, the best approach is to create a
926 custom package group recipe that is used to build the image or
927 images.
928 A good example of a package group recipe is
929 <filename>meta/recipes-core/packagegroups/packagegroup-core-boot.bb</filename>.
930 The
931 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename>
932 variable lists the package group packages you wish to produce.
933 <filename>inherit packagegroup</filename> sets appropriate
934 default values and automatically adds <filename>-dev</filename>,
935 <filename>-dbg</filename>, and <filename>-ptest</filename>
936 complementary packages for every package specified in
937 <filename>PACKAGES</filename>.
938 Note that the inherit line should be towards
939 the top of the recipe, certainly before you set
940 <filename>PACKAGES</filename>.
941 For each package you specify in <filename>PACKAGES</filename>,
942 you can use
943 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename>
944 and
945 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename>
946 entries to provide a list of packages the parent task package
947 should contain.
948 Following is an example:
949 <literallayout class='monospaced'>
950 DESCRIPTION = "My Custom Package Groups"
951
952 inherit packagegroup
953
954 PACKAGES = "\
955 packagegroup-custom-apps \
956 packagegroup-custom-tools \
957 "
958
959 RDEPENDS_packagegroup-custom-apps = "\
960 dropbear \
961 portmap \
962 psplash"
963
964 RDEPENDS_packagegroup-custom-tools = "\
965 oprofile \
966 oprofileui-server \
967 lttng-control \
968 lttng-viewer"
969
970 RRECOMMENDS_packagegroup-custom-tools = "\
971 kernel-module-oprofile"
972 </literallayout>
973 </para>
974
975 <para>
976 In the previous example, two package group packages are created with their dependencies and their
977 recommended package dependencies listed: <filename>packagegroup-custom-apps</filename>, and
978 <filename>packagegroup-custom-tools</filename>.
979 To build an image using these package group packages, you need to add
980 <filename>packagegroup-custom-apps</filename> and/or
981 <filename>packagegroup-custom-tools</filename> to
982 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>.
983 For other forms of image dependencies see the other areas of this section.
984 </para>
985 </section>
986
987 <section id='usingpoky-extend-customimage-imagefeatures'>
988 <title>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and
989 <filename>EXTRA_IMAGE_FEATURES</filename></title>
990
991 <para>
992 You might want to customize your image by enabling or
993 disabling high-level image features by using the
994 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
995 and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
996 variables.
997 Although the functions for both variables are nearly equivalent,
998 best practices dictate using <filename>IMAGE_FEATURES</filename>
999 from within a recipe and using
1000 <filename>EXTRA_IMAGE_FEATURES</filename> from within
1001 your <filename>local.conf</filename> file, which is found in the
1002 <link linkend='build-directory'>Build Directory</link>.
1003 </para>
1004
1005 <para>
1006 To understand how these features work, the best reference is
1007 <filename>meta/classes/core-image.bbclass</filename>.
1008 In summary, the file looks at the contents of the
1009 <filename>IMAGE_FEATURES</filename> variable and then maps
1010 those contents into a set of package groups.
1011 Based on this information, the build system automatically
1012 adds the appropriate packages to the
1013 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
1014 variable.
1015 Effectively, you are enabling extra features by extending the
1016 class or creating a custom class for use with specialized image
1017 <filename>.bb</filename> files.
1018 </para>
1019
1020 <para>
1021 Use the <filename>EXTRA_IMAGE_FEATURES</filename> variable
1022 from within your local configuration file.
1023 Using a separate area from which to enable features with
1024 this variable helps you avoid overwriting the features in the
1025 image recipe that are enabled with
1026 <filename>IMAGE_FEATURES</filename>.
1027 The value of <filename>EXTRA_IMAGE_FEATURES</filename> is added
1028 to <filename>IMAGE_FEATURES</filename> within
1029 <filename>meta/conf/bitbake.conf</filename>.
1030 </para>
1031
1032 <para>
1033 To illustrate how you can use these variables to modify your
1034 image, consider an example that selects the SSH server.
1035 The Yocto Project ships with two SSH servers you can use
1036 with your images: Dropbear and OpenSSH.
1037 Dropbear is a minimal SSH server appropriate for
1038 resource-constrained environments, while OpenSSH is a
1039 well-known standard SSH server implementation.
1040 By default, the <filename>core-image-sato</filename> image
1041 is configured to use Dropbear.
1042 The <filename>core-image-basic</filename> and
1043 <filename>core-image-lsb</filename> images both
1044 include OpenSSH.
1045 The <filename>core-image-minimal</filename> image does not
1046 contain an SSH server.
1047 </para>
1048
1049 <para>
1050 You can customize your image and change these defaults.
1051 Edit the <filename>IMAGE_FEATURES</filename> variable
1052 in your recipe or use the
1053 <filename>EXTRA_IMAGE_FEATURES</filename> in your
1054 <filename>local.conf</filename> file so that it configures the
1055 image you are working with to include
1056 <filename>ssh-server-dropbear</filename> or
1057 <filename>ssh-server-openssh</filename>.
1058 </para>
1059
1060 <note>
1061 See the
1062 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
1063 section in the Yocto Project Reference Manual for a complete
1064 list of image features that ship with the Yocto Project.
1065 </note>
1066 </section>
1067
1068 <section id='usingpoky-extend-customimage-localconf'>
1069 <title>Customizing Images Using <filename>local.conf</filename></title>
1070
1071 <para>
1072 It is possible to customize image contents by using variables from your
1073 local configuration in your <filename>conf/local.conf</filename> file.
1074 Because it is limited to local use, this method generally only allows you to
1075 add packages and is not as flexible as creating your own customized image.
1076 When you add packages using local variables this way, you need to realize that
1077 these variable changes affect all images at the same time and might not be
1078 what you require.
1079 </para>
1080
1081 <para>
1082 The simplest way to add extra packages to all images is by using the
1083 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>
1084 variable with the <filename>_append</filename> operator:
1085 <literallayout class='monospaced'>
1086 IMAGE_INSTALL_append = " strace"
1087 </literallayout>
1088 Use of the syntax is important - specifically, the space between
1089 the quote and the package name, which is
1090 <filename>strace</filename> in this example.
1091 This space is required since the <filename>_append</filename>
1092 operator does not add the space.
1093 </para>
1094
1095 <para>
1096 Furthermore, you must use <filename>_append</filename> instead of the <filename>+=</filename>
1097 operator if you want to avoid ordering issues.
1098 The reason for this is because doing so unconditionally appends to the variable and
1099 avoids ordering problems due to the variable being set in image recipes and
1100 <filename>.bbclass</filename> files with operators like <filename>?=</filename>.
1101 Using <filename>_append</filename> ensures the operation takes affect.
1102 </para>
1103
1104 <para>
1105 As shown in its simplest use, <filename>IMAGE_INSTALL_append</filename> affects
1106 all images.
1107 It is possible to extend the syntax so that the variable applies to a specific image only.
1108 Here is an example:
1109 <literallayout class='monospaced'>
1110 IMAGE_INSTALL_append_pn-core-image-minimal = " strace"
1111 </literallayout>
1112 This example adds <filename>strace</filename> to <filename>core-image-minimal</filename>
1113 only.
1114 </para>
1115
1116 <para>
1117 You can add packages using a similar approach through the
1118 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'>CORE_IMAGE_EXTRA_INSTALL</ulink></filename>
1119 variable.
1120 If you use this variable, only <filename>core-image-*</filename> images are affected.
1121 </para>
1122 </section>
1123 </section>
1124
1125 <section id='usingpoky-extend-addpkg'>
1126 <title>Writing a Recipe to Add a Package to Your Image</title>
1127
1128 <para>
1129 Recipes add packages to your image.
1130 Writing a recipe means creating a <filename>.bb</filename> file that sets some
1131 variables.
1132 For information on variables that are useful for recipes and for information about recipe naming
1133 issues, see the
1134 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-varlocality-recipe-required'>Required</ulink>"
1135 section of the Yocto Project Reference Manual.
1136 </para>
1137
1138 <para>
1139 Before writing a recipe from scratch, it is often useful to check
1140 whether someone else has written one already.
1141 OpenEmbedded is a good place to look as it has a wider scope and range of packages.
1142 Because the Yocto Project aims to be compatible with OpenEmbedded, most recipes
1143 you find there should work for you.
1144 </para>
1145
1146 <para>
1147 For new packages, the simplest way to add a recipe is to base it on a similar
1148 pre-existing recipe.
1149 The sections that follow provide some examples that show how to add standard
1150 types of packages.
1151 </para>
1152
1153 <note>
1154 <para>When writing shell functions, you need to be aware of BitBake's
1155 curly brace parsing.
1156 If a recipe uses a closing curly brace within the function and
1157 the character has no leading spaces, BitBake produces a parsing
1158 error.
1159 If you use a pair of curly brace in a shell function, the
1160 closing curly brace must not be located at the start of the line
1161 without leading spaces.</para>
1162 <para>Here is an example that causes BitBake to produce a parsing
1163 error:
1164 <literallayout class='monospaced'>
1165 fakeroot create_shar() {
1166 cat &lt;&lt; "EOF" &gt; ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
1167 usage()
1168 {
1169 echo "test"
1170 ###### The following "}" at the start of the line causes a parsing error ######
1171 }
1172 EOF
1173 }
1174 </literallayout>
1175 Writing the recipe this way avoids the error:
1176 <literallayout class='monospaced'>
1177 fakeroot create_shar() {
1178 cat &lt;&lt; "EOF" &gt; ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh
1179 usage()
1180 {
1181 echo "test"
1182 ######The following "}" with a leading space at the start of the line avoids the error ######
1183 }
1184 EOF
1185 }
1186 </literallayout></para>
1187 </note>
1188
1189 <section id='usingpoky-extend-addpkg-singlec'>
1190 <title>Single .c File Package (Hello World!)</title>
1191
1192 <para>
1193 Building an application from a single file that is stored locally (e.g. under
1194 <filename>files/</filename>) requires a recipe that has the file listed in
1195 the
1196 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>
1197 variable.
1198 Additionally, you need to manually write the <filename>do_compile</filename> and
1199 <filename>do_install</filename> tasks.
1200 The <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename>
1201 variable defines the
1202 directory containing the source code, which is set to
1203 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'>
1204 WORKDIR</ulink></filename> in this case - the directory BitBake uses for the build.
1205 <literallayout class='monospaced'>
1206 DESCRIPTION = "Simple helloworld application"
1207 SECTION = "examples"
1208 LICENSE = "MIT"
1209 LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
1210 PR = "r0"
1211
1212 SRC_URI = "file://helloworld.c"
1213
1214 S = "${WORKDIR}"
1215
1216 do_compile() {
1217 ${CC} helloworld.c -o helloworld
1218 }
1219
1220 do_install() {
1221 install -d ${D}${bindir}
1222 install -m 0755 helloworld ${D}${bindir}
1223 }
1224 </literallayout>
1225 </para>
1226
1227 <para>
1228 By default, the <filename>helloworld</filename>, <filename>helloworld-dbg</filename>,
1229 and <filename>helloworld-dev</filename> packages are built.
1230 For information on how to customize the packaging process, see the
1231 "<link linkend='splitting-an-application-into-multiple-packages'>Splitting an Application
1232 into Multiple Packages</link>" section.
1233 </para>
1234 </section>
1235
1236 <section id='usingpoky-extend-addpkg-autotools'>
1237 <title>Autotooled Package</title>
1238 <para>
1239 Applications that use Autotools such as <filename>autoconf</filename> and
1240 <filename>automake</filename> require a recipe that has a source archive listed in
1241 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> and
1242 also inherits Autotools, which instructs BitBake to use the
1243 <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps
1244 needed to build an Autotool-based application.
1245 The result of the build is automatically packaged.
1246 And, if the application uses NLS for localization, packages with local information are
1247 generated (one package per language).
1248 Following is one example: (<filename>hello_2.3.bb</filename>)
1249 <literallayout class='monospaced'>
1250 DESCRIPTION = "GNU Helloworld application"
1251 SECTION = "examples"
1252 LICENSE = "GPLv2+"
1253 LIC_FILES_CHKSUM = "file://COPYING;md5=751419260aa954499f7abaabaa882bbe"
1254 PR = "r0"
1255
1256 SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz"
1257
1258 inherit autotools gettext
1259 </literallayout>
1260 </para>
1261
1262 <para>
1263 The variable
1264 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename>
1265 is used to track source license changes as described in the
1266 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" section.
1267 You can quickly create Autotool-based recipes in a manner similar to the previous example.
1268 </para>
1269 </section>
1270
1271 <section id='usingpoky-extend-addpkg-makefile'>
1272 <title>Makefile-Based Package</title>
1273
1274 <para>
1275 Applications that use GNU <filename>make</filename> also require a recipe that has
1276 the source archive listed in
1277 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>.
1278 You do not need to add a <filename>do_compile</filename> step since by default BitBake
1279 starts the <filename>make</filename> command to compile the application.
1280 If you need additional <filename>make</filename> options, you should store them in the
1281 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename>
1282 variable.
1283 BitBake passes these options into the <filename>make</filename> GNU invocation.
1284 Note that a <filename>do_install</filename> task is still required.
1285 Otherwise, BitBake runs an empty <filename>do_install</filename> task by default.
1286 </para>
1287
1288 <para>
1289 Some applications might require extra parameters to be passed to the compiler.
1290 For example, the application might need an additional header path.
1291 You can accomplish this by adding to the
1292 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink></filename> variable.
1293 The following example shows this:
1294 <literallayout class='monospaced'>
1295 CFLAGS_prepend = "-I ${S}/include "
1296 </literallayout>
1297 </para>
1298
1299 <para>
1300 In the following example, <filename>mtd-utils</filename> is a makefile-based package:
1301 <literallayout class='monospaced'>
1302 DESCRIPTION = "Tools for managing memory technology devices."
1303 SECTION = "base"
1304 DEPENDS = "zlib lzo e2fsprogs util-linux"
1305 HOMEPAGE = "http://www.linux-mtd.infradead.org/"
1306 LICENSE = "GPLv2+"
1307 LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
1308 file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
1309
1310 SRC_URI = "git://git.infradead.org/mtd-utils.git;protocol=git;tag=995cfe51b0a3cf32f381c140bf72b21bf91cef1b \
1311 file://add-exclusion-to-mkfs-jffs2-git-2.patch"
1312
1313 S = "${WORKDIR}/git/"
1314
1315 PR = "r1"
1316
1317 EXTRA_OEMAKE = "'CC=${CC}' 'RANLIB=${RANLIB}' 'AR=${AR}' \
1318 'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' 'BUILDDIR=${S}'"
1319
1320 do_install () {
1321 oe_runmake install DESTDIR=${D} SBINDIR=${sbindir} MANDIR=${mandir} \
1322 INCLUDEDIR=${includedir}
1323 install -d ${D}${includedir}/mtd/
1324 for f in ${S}/include/mtd/*.h; do
1325 install -m 0644 $f ${D}${includedir}/mtd/
1326 done
1327 }
1328
1329 PARALLEL_MAKE = ""
1330
1331 BBCLASSEXTEND = "native"
1332 </literallayout>
1333 </para>
1334
1335 <para>
1336 If your sources are available as a tarball instead of a Git repository, you
1337 will need to provide the URL to the tarball as well as an
1338 <filename>md5</filename> or <filename>sha256</filename> sum of
1339 the download.
1340 Here is an example:
1341 <literallayout class='monospaced'>
1342 SRC_URI="ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-1.4.9.tar.bz2"
1343 SRC_URI[md5sum]="82b8e714b90674896570968f70ca778b"
1344 </literallayout>
1345 You can generate the <filename>md5</filename> or <filename>sha256</filename> sums
1346 by using the <filename>md5sum</filename> or <filename>sha256sum</filename> commands
1347 with the target file as the only argument.
1348 Here is an example:
1349 <literallayout class='monospaced'>
1350 $ md5sum mtd-utils-1.4.9.tar.bz2
1351 82b8e714b90674896570968f70ca778b mtd-utils-1.4.9.tar.bz2
1352 </literallayout>
1353 </para>
1354 </section>
1355
1356 <section id='splitting-an-application-into-multiple-packages'>
1357 <title>Splitting an Application into Multiple Packages</title>
1358
1359 <para>
1360 You can use the variables
1361 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> and
1362 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink></filename>
1363 to split an application into multiple packages.
1364 </para>
1365
1366 <para>
1367 Following is an example that uses the <filename>libXpm</filename> recipe.
1368 By default, this recipe generates a single package that contains the library along
1369 with a few binaries.
1370 You can modify the recipe to split the binaries into separate packages:
1371 <literallayout class='monospaced'>
1372 require xorg-lib-common.inc
1373
1374 DESCRIPTION = "X11 Pixmap library"
1375 LICENSE = "X-BSD"
1376 LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
1377 DEPENDS += "libxext libsm libxt"
1378 PR = "r3"
1379 PE = "1"
1380
1381 XORG_PN = "libXpm"
1382
1383 PACKAGES =+ "sxpm cxpm"
1384 FILES_cxpm = "${bindir}/cxpm"
1385 FILES_sxpm = "${bindir}/sxpm"
1386 </literallayout>
1387 </para>
1388
1389 <para>
1390 In the previous example, we want to ship the <filename>sxpm</filename>
1391 and <filename>cxpm</filename> binaries in separate packages.
1392 Since <filename>bindir</filename> would be packaged into the main
1393 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename>
1394 package by default, we prepend the <filename>PACKAGES</filename>
1395 variable so additional package names are added to the start of list.
1396 This results in the extra <filename>FILES_*</filename>
1397 variables then containing information that define which files and
1398 directories go into which packages.
1399 Files included by earlier packages are skipped by latter packages.
1400 Thus, the main <filename>PN</filename> package
1401 does not include the above listed files.
1402 </para>
1403 </section>
1404
1405 <section id='usingpoky-extend-addpkg-postinstalls'>
1406 <title>Post-Installation Scripts</title>
1407
1408 <para>
1409 To add a post-installation script to a package, add a
1410 <filename>pkg_postinst_PACKAGENAME()</filename> function to the
1411 <filename>.bb</filename> file and use
1412 <filename>PACKAGENAME</filename> as the name of the package you want to attach to the
1413 <filename>postinst</filename> script.
1414 Normally,
1415 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename>
1416 can be used, which automatically expands to <filename>PACKAGENAME</filename>.
1417 A post-installation function has the following structure:
1418 <literallayout class='monospaced'>
1419 pkg_postinst_PACKAGENAME () {
1420 #!/bin/sh -e
1421 # Commands to carry out
1422 }
1423 </literallayout>
1424 </para>
1425
1426 <para>
1427 The script defined in the post-installation function is called when the
1428 root filesystem is created.
1429 If the script succeeds, the package is marked as installed.
1430 If the script fails, the package is marked as unpacked and the script is
1431 executed when the image boots again.
1432 </para>
1433
1434 <para>
1435 Sometimes it is necessary for the execution of a post-installation
1436 script to be delayed until the first boot.
1437 For example, the script might need to be executed on the device itself.
1438 To delay script execution until boot time, use the following structure in the
1439 post-installation script:
1440 <literallayout class='monospaced'>
1441 pkg_postinst_PACKAGENAME () {
1442 #!/bin/sh -e
1443 if [ x"$D" = "x" ]; then
1444 # Actions to carry out on the device go here
1445 else
1446 exit 1
1447 fi
1448 }
1449 </literallayout>
1450 </para>
1451
1452 <para>
1453 The previous example delays execution until the image boots again because the
1454 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'>D</ulink></filename>
1455 variable points
1456 to the directory containing the image when the root filesystem is created at build time but
1457 is unset when executed on the first boot.
1458 </para>
1459 </section>
1460 </section>
1461
1462 <section id="platdev-newmachine">
1463 <title>Adding a New Machine</title>
1464
1465 <para>
1466 Adding a new machine to the Yocto Project is a straightforward process.
1467 This section provides information that gives you an idea of the changes you must make.
1468 The information covers adding machines similar to those the Yocto Project already supports.
1469 Although well within the capabilities of the Yocto Project, adding a totally new architecture
1470 might require
1471 changes to <filename>gcc/eglibc</filename> and to the site information, which is
1472 beyond the scope of this manual.
1473 </para>
1474
1475 <para>
1476 For a complete example that shows how to add a new machine,
1477 see the
1478 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>"
1479 in the Yocto Project Board Support Package (BSP) Developer's Guide.
1480 </para>
1481
1482 <section id="platdev-newmachine-conffile">
1483 <title>Adding the Machine Configuration File</title>
1484
1485 <para>
1486 To add a machine configuration, you need to add a <filename>.conf</filename> file
1487 with details of the device being added to the <filename>conf/machine/</filename> file.
1488 The name of the file determines the name the OpenEmbedded build system
1489 uses to reference the new machine.
1490 </para>
1491
1492 <para>
1493 The most important variables to set in this file are as follows:
1494 <itemizedlist>
1495 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_ARCH'>TARGET_ARCH</ulink></filename>
1496 (e.g. "arm")</para></listitem>
1497 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER'>PREFERRED_PROVIDER</ulink>_virtual/kernel</filename>
1498 (see below)</para></listitem>
1499 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_FEATURES'>MACHINE_FEATURES</ulink></filename>
1500 (e.g. "apm screen wifi")</para></listitem>
1501 </itemizedlist>
1502 </para>
1503
1504 <para>
1505 You might also need these variables:
1506 <itemizedlist>
1507 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SERIAL_CONSOLES'>SERIAL_CONSOLES</ulink></filename>
1508 (e.g. "115200 ttyS0")</para></listitem>
1509 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_IMAGETYPE'>KERNEL_IMAGETYPE</ulink></filename>
1510 (e.g. "zImage")</para></listitem>
1511 <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'>IMAGE_FSTYPES</ulink></filename>
1512 (e.g. "tar.gz jffs2")</para></listitem>
1513 </itemizedlist>
1514 </para>
1515
1516 <para>
1517 You can find full details on these variables in the reference section.
1518 You can leverage many existing machine <filename>.conf</filename> files from
1519 <filename>meta/conf/machine/</filename>.
1520 </para>
1521 </section>
1522
1523 <section id="platdev-newmachine-kernel">
1524 <title>Adding a Kernel for the Machine</title>
1525
1526 <para>
1527 The OpenEmbedded build system needs to be able to build a kernel for the machine.
1528 You need to either create a new kernel recipe for this machine, or extend an
1529 existing recipe.
1530 You can find several kernel examples in the
1531 Source Directory at <filename>meta/recipes-kernel/linux</filename>
1532 that you can use as references.
1533 </para>
1534
1535 <para>
1536 If you are creating a new recipe, normal recipe-writing rules apply for setting
1537 up a
1538 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>.
1539 Thus, you need to specify any necessary patches and set
1540 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> to point at the source code.
1541 You need to create a <filename>configure</filename> task that configures the
1542 unpacked kernel with a defconfig.
1543 You can do this by using a <filename>make defconfig</filename> command or,
1544 more commonly, by copying in a suitable <filename>defconfig</filename> file and and then running
1545 <filename>make oldconfig</filename>.
1546 By making use of <filename>inherit kernel</filename> and potentially some of the
1547 <filename>linux-*.inc</filename> files, most other functionality is
1548 centralized and the the defaults of the class normally work well.
1549 </para>
1550
1551 <para>
1552 If you are extending an existing kernel, it is usually a matter of adding a
1553 suitable defconfig file.
1554 The file needs to be added into a location similar to defconfig files
1555 used for other machines in a given kernel.
1556 A possible way to do this is by listing the file in the
1557 <filename>SRC_URI</filename> and adding the machine to the expression in
1558 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</ulink></filename>:
1559 <literallayout class='monospaced'>
1560 COMPATIBLE_MACHINE = '(qemux86|qemumips)'
1561 </literallayout>
1562 </para>
1563 </section>
1564
1565 <section id="platdev-newmachine-formfactor">
1566 <title>Adding a Formfactor Configuration File</title>
1567
1568 <para>
1569 A formfactor configuration file provides information about the
1570 target hardware for which the image is being built and information that
1571 the build system cannot obtain from other sources such as the kernel.
1572 Some examples of information contained in a formfactor configuration file include
1573 framebuffer orientation, whether or not the system has a keyboard,
1574 the positioning of the keyboard in relation to the screen, and
1575 the screen resolution.
1576 </para>
1577
1578 <para>
1579 The build system uses reasonable defaults in most cases.
1580 However, if customization is
1581 necessary, you need to create a <filename>machconfig</filename> file
1582 in the <filename>meta/recipes-bsp/formfactor/files</filename>
1583 directory.
1584 This directory contains directories for specific machines such as
1585 <filename>qemuarm</filename> and <filename>qemux86</filename>.
1586 For information about the settings available and the defaults, see the
1587 <filename>meta/recipes-bsp/formfactor/files/config</filename> file found in the
1588 same area.
1589 </para>
1590
1591 <para>
1592 Following is an example for qemuarm:
1593 <literallayout class='monospaced'>
1594 HAVE_TOUCHSCREEN=1
1595 HAVE_KEYBOARD=1
1596
1597 DISPLAY_CAN_ROTATE=0
1598 DISPLAY_ORIENTATION=0
1599 #DISPLAY_WIDTH_PIXELS=640
1600 #DISPLAY_HEIGHT_PIXELS=480
1601 #DISPLAY_BPP=16
1602 DISPLAY_DPI=150
1603 DISPLAY_SUBPIXEL_ORDER=vrgb
1604 </literallayout>
1605 </para>
1606 </section>
1607 </section>
1608
1609 <section id="platdev-working-with-libraries">
1610 <title>Working With Libraries</title>
1611
1612 <para>
1613 Libraries are an integral part of your system.
1614 This section describes some common practices you might find
1615 helpful when working with libraries to build your system:
1616 <itemizedlist>
1617 <listitem><para><link linkend='including-static-library-files'>How to include static library files</link>
1618 </para></listitem>
1619 <listitem><para><link linkend='combining-multiple-versions-library-files-into-one-image'>How to use the Multilib feature to combine multiple versions of library files into a single image</link>
1620 </para></listitem>
1621 <listitem><para><link linkend='installing-multiple-versions-of-the-same-library'>How to install multiple versions of the same library in parallel on the same system</link>
1622 </para></listitem>
1623 </itemizedlist>
1624 </para>
1625
1626 <section id='including-static-library-files'>
1627 <title>Including Static Library Files</title>
1628
1629 <para>
1630 If you are building a library and the library offers static linking, you can control
1631 which static library files (<filename>*.a</filename> files) get included in the
1632 built library.
1633 </para>
1634
1635 <para>
1636 The <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>
1637 and <ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'><filename>FILES_*</filename></ulink>
1638 variables in the
1639 <filename>meta/conf/bitbake.conf</filename> configuration file define how files installed
1640 by the <filename>do_install</filename> task are packaged.
1641 By default, the <filename>PACKAGES</filename> variable contains
1642 <filename>${PN}-staticdev</filename>, which includes all static library files.
1643 <note>
1644 Some previously released versions of the Yocto Project
1645 defined the static library files through
1646 <filename>${PN}-dev</filename>.
1647 </note>
1648 Following, is part of the BitBake configuration file.
1649 You can see where the static library files are defined:
1650 <literallayout class='monospaced'>
1651 PACKAGES = "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev ${PN}-staticdev ${PN}-locale"
1652 PACKAGES_DYNAMIC = "${PN}-locale-*"
1653 FILES = ""
1654
1655 FILES_${PN} = "${bindir}/* ${sbindir}/* ${libexecdir}/* ${libdir}/lib*${SOLIBS} \
1656 ${sysconfdir} ${sharedstatedir} ${localstatedir} \
1657 ${base_bindir}/* ${base_sbindir}/* \
1658 ${base_libdir}/*${SOLIBS} \
1659 ${datadir}/${BPN} ${libdir}/${BPN}/* \
1660 ${datadir}/pixmaps ${datadir}/applications \
1661 ${datadir}/idl ${datadir}/omf ${datadir}/sounds \
1662 ${libdir}/bonobo/servers"
1663
1664 FILES_${PN}-doc = "${docdir} ${mandir} ${infodir} ${datadir}/gtk-doc \
1665 ${datadir}/gnome/help"
1666 SECTION_${PN}-doc = "doc"
1667
1668 FILES_${PN}-dev = "${includedir} ${libdir}/lib*${SOLIBSDEV} ${libdir}/*.la \
1669 ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \
1670 ${datadir}/aclocal ${base_libdir}/*.o"
1671 SECTION_${PN}-dev = "devel"
1672 ALLOW_EMPTY_${PN}-dev = "1"
1673 RDEPENDS_${PN}-dev = "${PN} (= ${EXTENDPKGV})"
1674
1675 FILES_${PN}-staticdev = "${libdir}/*.a ${base_libdir}/*.a"
1676 SECTION_${PN}-staticdev = "devel"
1677 RDEPENDS_${PN}-staticdev = "${PN}-dev (= ${EXTENDPKGV})"
1678 </literallayout>
1679 </para>
1680 </section>
1681
1682 <section id="combining-multiple-versions-library-files-into-one-image">
1683 <title>Combining Multiple Versions of Library Files into One Image</title>
1684
1685 <para>
1686 The build system offers the ability to build libraries with different
1687 target optimizations or architecture formats and combine these together
1688 into one system image.
1689 You can link different binaries in the image
1690 against the different libraries as needed for specific use cases.
1691 This feature is called "Multilib."
1692 </para>
1693
1694 <para>
1695 An example would be where you have most of a system compiled in 32-bit
1696 mode using 32-bit libraries, but you have something large, like a database
1697 engine, that needs to be a 64-bit application and uses 64-bit libraries.
1698 Multilib allows you to get the best of both 32-bit and 64-bit libraries.
1699 </para>
1700
1701 <para>
1702 While the Multilib feature is most commonly used for 32 and 64-bit differences,
1703 the approach the build system uses facilitates different target optimizations.
1704 You could compile some binaries to use one set of libraries and other binaries
1705 to use other different sets of libraries.
1706 The libraries could differ in architecture, compiler options, or other
1707 optimizations.
1708 </para>
1709
1710 <para>
1711 This section overviews the Multilib process only.
1712 For more details on how to implement Multilib, see the
1713 <ulink url='&YOCTO_WIKI_URL;/wiki/Multilib'>Multilib</ulink> wiki
1714 page.
1715 </para>
1716
1717 <para>
1718 Aside from this wiki page, several examples exist in the
1719 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/tree/meta-skeleton'><filename>meta-skeleton</filename></ulink>
1720 layer found in the
1721 <link linkend='source-directory'>Source Directory</link>:
1722 <itemizedlist>
1723 <listitem><para><filename>conf/multilib-example.conf</filename>
1724 configuration file</para></listitem>
1725 <listitem><para><filename>conf/multilib-example2.conf</filename>
1726 configuration file</para></listitem>
1727 <listitem><para><filename>recipes-multilib/images/core-image-multilib-example.bb</filename>
1728 recipe</para></listitem>
1729 </itemizedlist>
1730 </para>
1731
1732 <section id='preparing-to-use-multilib'>
1733 <title>Preparing to Use Multilib</title>
1734
1735 <para>
1736 User-specific requirements drive the Multilib feature.
1737 Consequently, there is no one "out-of-the-box" configuration that likely
1738 exists to meet your needs.
1739 </para>
1740
1741 <para>
1742 In order to enable Multilib, you first need to ensure your recipe is
1743 extended to support multiple libraries.
1744 Many standard recipes are already extended and support multiple libraries.
1745 You can check in the <filename>meta/conf/multilib.conf</filename>
1746 configuration file in the
1747 <link linkend='source-directory'>Source Directory</link> to see how this is
1748 done using the
1749 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink>
1750 variable.
1751 Eventually, all recipes will be covered and this list will be unneeded.
1752 </para>
1753
1754 <para>
1755 For the most part, the Multilib class extension works automatically to
1756 extend the package name from <filename>${PN}</filename> to
1757 <filename>${MLPREFIX}${PN}</filename>, where <filename>MLPREFIX</filename>
1758 is the particular multilib (e.g. "lib32-" or "lib64-").
1759 Standard variables such as
1760 <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>,
1761 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>,
1762 <ulink url='&YOCTO_DOCS_REF_URL;#var-RPROVIDES'><filename>RPROVIDES</filename></ulink>,
1763 <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>,
1764 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>,
1765 and <filename>PACKAGES_DYNAMIC</filename> are automatically extended by the system.
1766 If you are extending any manual code in the recipe, you can use the
1767 <filename>${MLPREFIX}</filename> variable to ensure those names are extended
1768 correctly.
1769 This automatic extension code resides in <filename>multilib.bbclass</filename>.
1770 </para>
1771 </section>
1772
1773 <section id='using-multilib'>
1774 <title>Using Multilib</title>
1775
1776 <para>
1777 After you have set up the recipes, you need to define the actual
1778 combination of multiple libraries you want to build.
1779 You accomplish this through your <filename>local.conf</filename>
1780 configuration file in the
1781 <link linkend='build-directory'>Build Directory</link>.
1782 An example configuration would be as follows:
1783 <literallayout class='monospaced'>
1784 MACHINE = "qemux86-64"
1785 require conf/multilib.conf
1786 MULTILIBS = "multilib:lib32"
1787 DEFAULTTUNE_virtclass-multilib-lib32 = "x86"
1788 IMAGE_INSTALL = "lib32-connman"
1789 </literallayout>
1790 This example enables an
1791 additional library named <filename>lib32</filename> alongside the
1792 normal target packages.
1793 When combining these "lib32" alternatives, the example uses "x86" for tuning.
1794 For information on this particular tuning, see
1795 <filename>meta/conf/machine/include/ia32/arch-ia32.inc</filename>.
1796 </para>
1797
1798 <para>
1799 The example then includes <filename>lib32-connman</filename>
1800 in all the images, which illustrates one method of including a
1801 multiple library dependency.
1802 You can use a normal image build to include this dependency,
1803 for example:
1804 <literallayout class='monospaced'>
1805 $ bitbake core-image-sato
1806 </literallayout>
1807 You can also build Multilib packages specifically with a command like this:
1808 <literallayout class='monospaced'>
1809 $ bitbake lib32-connman
1810 </literallayout>
1811 </para>
1812 </section>
1813
1814 <section id='additional-implementation-details'>
1815 <title>Additional Implementation Details</title>
1816
1817 <para>
1818 Different packaging systems have different levels of native Multilib
1819 support.
1820 For the RPM Package Management System, the following implementation details
1821 exist:
1822 <itemizedlist>
1823 <listitem><para>A unique architecture is defined for the Multilib packages,
1824 along with creating a unique deploy folder under
1825 <filename>tmp/deploy/rpm</filename> in the
1826 <link linkend='build-directory'>Build Directory</link>.
1827 For example, consider <filename>lib32</filename> in a
1828 <filename>qemux86-64</filename> image.
1829 The possible architectures in the system are "all", "qemux86_64",
1830 "lib32_qemux86_64", and "lib32_x86".</para></listitem>
1831 <listitem><para>The <filename>${MLPREFIX}</filename> variable is stripped from
1832 <filename>${PN}</filename> during RPM packaging.
1833 The naming for a normal RPM package and a Multilib RPM package in a
1834 <filename>qemux86-64</filename> system resolves to something similar to
1835 <filename>bash-4.1-r2.x86_64.rpm</filename> and
1836 <filename>bash-4.1.r2.lib32_x86.rpm</filename>, respectively.
1837 </para></listitem>
1838 <listitem><para>When installing a Multilib image, the RPM backend first
1839 installs the base image and then installs the Multilib libraries.
1840 </para></listitem>
1841 <listitem><para>The build system relies on RPM to resolve the identical files in the
1842 two (or more) Multilib packages.</para></listitem>
1843 </itemizedlist>
1844 </para>
1845
1846 <para>
1847 For the IPK Package Management System, the following implementation details exist:
1848 <itemizedlist>
1849 <listitem><para>The <filename>${MLPREFIX}</filename> is not stripped from
1850 <filename>${PN}</filename> during IPK packaging.
1851 The naming for a normal RPM package and a Multilib IPK package in a
1852 <filename>qemux86-64</filename> system resolves to something like
1853 <filename>bash_4.1-r2.x86_64.ipk</filename> and
1854 <filename>lib32-bash_4.1-rw_x86.ipk</filename>, respectively.
1855 </para></listitem>
1856 <listitem><para>The IPK deploy folder is not modified with
1857 <filename>${MLPREFIX}</filename> because packages with and without
1858 the Multilib feature can exist in the same folder due to the
1859 <filename>${PN}</filename> differences.</para></listitem>
1860 <listitem><para>IPK defines a sanity check for Multilib installation
1861 using certain rules for file comparison, overridden, etc.
1862 </para></listitem>
1863 </itemizedlist>
1864 </para>
1865 </section>
1866 </section>
1867
1868 <section id='installing-multiple-versions-of-the-same-library'>
1869 <title>Installing Multiple Versions of the Same Library</title>
1870
1871 <para>
1872 Situations can exist where you need to install and use
1873 multiple versions of the same library on the same system
1874 at the same time.
1875 These situations almost always exist when a library API
1876 changes and you have multiple pieces of software that
1877 depend on the separate versions of the library.
1878 To accommodate these situations, you can install multiple
1879 versions of the same library in parallel on the same system.
1880 </para>
1881
1882 <para>
1883 The process is straight forward as long as the libraries use
1884 proper versioning.
1885 With properly versioned libraries, all you need to do to
1886 individually specify the libraries is create separate,
1887 appropriately named recipes where the
1888 <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink> part of the
1889 name includes a portion that differentiates each library version
1890 (e.g.the major part of the version number).
1891 Thus, instead of having a single recipe that loads one version
1892 of a library (e.g. <filename>clutter</filename>), you provide
1893 multiple recipes that result in different versions
1894 of the libraries you want.
1895 As an example, the following two recipes would allow the
1896 two separate versions of the <filename>clutter</filename>
1897 library to co-exist on the same system:
1898 <literallayout class='monospaced'>
1899 clutter-1.6_1.6.20.bb
1900 clutter-1.8_1.8.4.bb
1901 </literallayout>
1902 Additionally, if you have other recipes that depend on a given
1903 library, you need to use the
1904 <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>
1905 variable to create the dependency.
1906 Continuing with the same example, if you want to have a recipe
1907 depend on the 1.8 version of the <filename>clutter</filename>
1908 library, use the following in your recipe:
1909 <literallayout class='monospaced'>
1910 DEPENDS = "clutter-1.8"
1911 </literallayout>
1912 </para>
1913 </section>
1914 </section>
1915
1916 <section id='configuring-the-kernel'>
1917 <title>Configuring the Kernel</title>
1918
1919 <para>
1920 Configuring the Yocto Project kernel consists of making sure the <filename>.config</filename>
1921 file has all the right information in it for the image you are building.
1922 You can use the <filename>menuconfig</filename> tool and configuration fragments to
1923 make sure your <filename>.config</filename> file is just how you need it.
1924 This section describes how to use <filename>menuconfig</filename>, create and use
1925 configuration fragments, and how to interactively tweak your <filename>.config</filename>
1926 file to create the leanest kernel configuration file possible.
1927 </para>
1928
1929 <para>
1930 For more information on kernel configuration, see the
1931 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#changing-the-configuration'>Changing the Configuration</ulink>"
1932 section in the Yocto Project Linux Kernel Development Manual.
1933 </para>
1934
1935 <section id='using-menuconfig'>
1936 <title>Using&nbsp;&nbsp;<filename>menuconfig</filename></title>
1937
1938 <para>
1939 The easiest way to define kernel configurations is to set them through the
1940 <filename>menuconfig</filename> tool.
1941 This tool provides an interactive method with which
1942 to set kernel configurations.
1943 For general information on <filename>menuconfig</filename>, see
1944 <ulink url='http://en.wikipedia.org/wiki/Menuconfig'></ulink>.
1945 </para>
1946
1947 <para>
1948 To use the <filename>menuconfig</filename> tool in the Yocto Project development
1949 environment, you must build the tool using BitBake.
1950 Thus, the environment must be set up using the
1951 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
1952 or
1953 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
1954 script found in the
1955 <link linkend='build-directory'>Build Directory</link>.
1956 The following commands build and invoke <filename>menuconfig</filename> assuming the
1957 <link linkend='source-directory'>Source Directory</link>
1958 top-level folder is <filename>~/poky</filename>:
1959 <literallayout class='monospaced'>
1960 $ cd ~/poky
1961 $ source oe-init-build-env
1962 $ bitbake linux-yocto -c menuconfig
1963 </literallayout>
1964 Once <filename>menuconfig</filename> comes up, its standard interface allows you to
1965 interactively examine and configure all the kernel configuration parameters.
1966 After making your changes, simply exit the tool and save your changes to
1967 create an updated version of the <filename>.config</filename> configuration file.
1968 </para>
1969
1970 <para>
1971 Consider an example that configures the <filename>linux-yocto-3.4</filename>
1972 kernel.
1973 The OpenEmbedded build system recognizes this kernel as
1974 <filename>linux-yocto</filename>.
1975 Thus, the following commands from the shell in which you previously sourced the
1976 environment initialization script cleans the shared state cache and the
1977 <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>
1978 directory and then builds and launches <filename>menuconfig</filename>:
1979 <literallayout class='monospaced'>
1980 $ bitbake linux-yocto -c menuconfig
1981 </literallayout>
1982 </para>
1983
1984 <para>
1985 Once <filename>menuconfig</filename> launches, use the interface
1986 to navigate through the selections to find the configuration settings in
1987 which you are interested.
1988 For example, consider the <filename>CONFIG_SMP</filename> configuration setting.
1989 You can find it at <filename>Processor Type and Features</filename> under
1990 the configuration selection <filename>Symmetric Multi-processing Support</filename>.
1991 After highlighting the selection, use the arrow keys to select or deselect
1992 the setting.
1993 When you are finished with all your selections, exit out and save them.
1994 </para>
1995
1996 <para>
1997 Saving the selections updates the <filename>.config</filename> configuration file.
1998 This is the file that the OpenEmbedded build system uses to configure the
1999 kernel during the build.
2000 You can find and examine this file in the Build Directory in
2001 <filename>tmp/work/</filename>.
2002 The actual <filename>.config</filename> is located in the area where the
2003 specific kernel is built.
2004 For example, if you were building a Linux Yocto kernel based on the
2005 Linux 3.4 kernel and you were building a QEMU image targeted for
2006 <filename>x86</filename> architecture, the
2007 <filename>.config</filename> file would be located here:
2008 <literallayout class='monospaced'>
2009 ~/poky/build/tmp/work/qemux86-poky-linux/linux-yocto-3.4.11+git1+84f...
2010 ...656ed30-r1/linux-qemux86-standard-build
2011 </literallayout>
2012 <note>
2013 The previous example directory is artificially split and many of the characters
2014 in the actual filename are omitted in order to make it more readable.
2015 Also, depending on the kernel you are using, the exact pathname
2016 for <filename>linux-yocto-3.4...</filename> might differ.
2017 </note>
2018 </para>
2019
2020 <para>
2021 Within the <filename>.config</filename> file, you can see the kernel settings.
2022 For example, the following entry shows that symmetric multi-processor support
2023 is not set:
2024 <literallayout class='monospaced'>
2025 # CONFIG_SMP is not set
2026 </literallayout>
2027 </para>
2028
2029 <para>
2030 A good method to isolate changed configurations is to use a combination of the
2031 <filename>menuconfig</filename> tool and simple shell commands.
2032 Before changing configurations with <filename>menuconfig</filename>, copy the
2033 existing <filename>.config</filename> and rename it to something else,
2034 use <filename>menuconfig</filename> to make
2035 as many changes an you want and save them, then compare the renamed configuration
2036 file against the newly created file.
2037 You can use the resulting differences as your base to create configuration fragments
2038 to permanently save in your kernel layer.
2039 <note>
2040 Be sure to make a copy of the <filename>.config</filename> and don't just
2041 rename it.
2042 The build system needs an existing <filename>.config</filename>
2043 from which to work.
2044 </note>
2045 </para>
2046 </section>
2047
2048 <section id='creating-config-fragments'>
2049 <title>Creating Configuration Fragments</title>
2050
2051 <para>
2052 Configuration fragments are simply kernel options that appear in a file
2053 placed where the OpenEmbedded build system can find and apply them.
2054 Syntactically, the configuration statement is identical to what would appear
2055 in the <filename>.config</filename> file, which is in the
2056 <link linkend='build-directory'>Build Directory</link> in
2057 <filename>tmp/work/&lt;arch&gt;-poky-linux/linux-yocto-&lt;release-specific-string&gt;/linux-&lt;arch&gt;-&lt;build-type&gt;</filename>.
2058 </para>
2059
2060 <para>
2061 It is simple to create a configuration fragment.
2062 For example, issuing the following from the shell creates a configuration fragment
2063 file named <filename>my_smp.cfg</filename> that enables multi-processor support
2064 within the kernel:
2065 <literallayout class='monospaced'>
2066 $ echo "CONFIG_SMP=y" >> my_smp.cfg
2067 </literallayout>
2068 <note>
2069 All configuration files must use the <filename>.cfg</filename> extension in order
2070 for the OpenEmbedded build system to recognize them as a configuration fragment.
2071 </note>
2072 </para>
2073
2074 <para>
2075 Where do you put your configuration files?
2076 You can place these configuration files in the same area pointed to by
2077 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
2078 The OpenEmbedded build system will pick up the configuration and add it to the
2079 kernel's configuration.
2080 For example, suppose you had a set of configuration options in a file called
2081 <filename>myconfig.cfg</filename>.
2082 If you put that file inside a directory named <filename>/linux-yocto</filename>
2083 that resides in the same directory as the kernel's append file and then add
2084 a <filename>SRC_URI</filename> statement such as the following to the kernel's append file,
2085 those configuration options will be picked up and applied when the kernel is built.
2086 <literallayout class='monospaced'>
2087 SRC_URI += "file://myconfig.cfg"
2088 </literallayout>
2089 </para>
2090
2091 <para>
2092 As mentioned earlier, you can group related configurations into multiple files and
2093 name them all in the <filename>SRC_URI</filename> statement as well.
2094 For example, you could group separate configurations specifically for Ethernet and graphics
2095 into their own files and add those by using a <filename>SRC_URI</filename> statement like the
2096 following in your append file:
2097 <literallayout class='monospaced'>
2098 SRC_URI += "file://myconfig.cfg \
2099 file://eth.cfg \
2100 file://gfx.cfg"
2101 </literallayout>
2102 </para>
2103 </section>
2104
2105 <section id='fine-tuning-the-kernel-configuration-file'>
2106 <title>Fine-Tuning the Kernel Configuration File</title>
2107
2108 <para>
2109 You can make sure the <filename>.config</filename> file is as lean or efficient as
2110 possible by reading the output of the kernel configuration fragment audit,
2111 noting any issues, making changes to correct the issues, and then repeating.
2112 </para>
2113
2114 <para>
2115 As part of the kernel build process, the
2116 <filename>kernel_configcheck</filename> task runs.
2117 This task validates the kernel configuration by checking the final
2118 <filename>.config</filename> file against the input files.
2119 During the check, the task produces warning messages for the following
2120 issues:
2121 <itemizedlist>
2122 <listitem><para>Requested options that did not make the final
2123 <filename>.config</filename> file.</para></listitem>
2124 <listitem><para>Configuration items that appear twice in the same
2125 configuration fragment.</para></listitem>
2126 <listitem><para>Configuration items tagged as "required" were overridden.
2127 </para></listitem>
2128 <listitem><para>A board overrides a non-board specific option.</para></listitem>
2129 <listitem><para>Listed options not valid for the kernel being processed.
2130 In other words, the option does not appear anywhere.</para></listitem>
2131 </itemizedlist>
2132 <note>
2133 The <filename>kernel_configcheck</filename> task can also optionally report
2134 if an option is overridden during processing.
2135 </note>
2136 </para>
2137
2138 <para>
2139 For each output warning, a message points to the file
2140 that contains a list of the options and a pointer to the config
2141 fragment that defines them.
2142 Collectively, the files are the key to streamlining the configuration.
2143 </para>
2144
2145 <para>
2146 To streamline the configuration, do the following:
2147 <orderedlist>
2148 <listitem><para>Start with a full configuration that you know
2149 works - it builds and boots successfully.
2150 This configuration file will be your baseline.</para></listitem>
2151 <listitem><para>Separately run the <filename>configme</filename> and
2152 <filename>kernel_configcheck</filename> tasks.</para></listitem>
2153 <listitem><para>Take the resulting list of files from the
2154 <filename>kernel_configcheck</filename> task warnings and do the following:
2155 <itemizedlist>
2156 <listitem><para>Drop values that are redefined in the fragment but do not
2157 change the final <filename>.config</filename> file.</para></listitem>
2158 <listitem><para>Analyze and potentially drop values from the
2159 <filename>.config</filename> file that override required
2160 configurations.</para></listitem>
2161 <listitem><para>Analyze and potentially remove non-board specific options.
2162 </para></listitem>
2163 <listitem><para>Remove repeated and invalid options.</para></listitem>
2164 </itemizedlist></para></listitem>
2165 <listitem><para>After you have worked through the output of the kernel configuration
2166 audit, you can re-run the <filename>configme</filename>
2167 and <filename>kernel_configcheck</filename> tasks to see the results of your
2168 changes.
2169 If you have more issues, you can deal with them as described in the
2170 previous step.</para></listitem>
2171 </orderedlist>
2172 </para>
2173
2174 <para>
2175 Iteratively working through steps two through four eventually yields
2176 a minimal, streamlined configuration file.
2177 Once you have the best <filename>.config</filename>, you can build the Linux
2178 Yocto kernel.
2179 </para>
2180 </section>
2181 </section>
2182
2183 <section id="patching-the-kernel">
2184 <title>Patching the Kernel</title>
2185
2186 <para>
2187 Patching the kernel involves changing or adding configurations to an existing kernel,
2188 changing or adding recipes to the kernel that are needed to support specific hardware features,
2189 or even altering the source code itself.
2190 <note>
2191 You can use the <filename>yocto-kernel</filename> script
2192 found in the <link linkend='source-directory'>Source Directory</link>
2193 under <filename>scripts</filename> to manage kernel patches and configuration.
2194 See the "<ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'>Managing kernel Patches and Config Items with yocto-kernel</ulink>"
2195 section in the Yocto Project Board Support Packages (BSP) Developer's Guide for
2196 more information.</note>
2197 </para>
2198
2199 <para>
2200 This example creates a simple patch by adding some QEMU emulator console
2201 output at boot time through <filename>printk</filename> statements in the kernel's
2202 <filename>calibrate.c</filename> source code file.
2203 Applying the patch and booting the modified image causes the added
2204 messages to appear on the emulator's console.
2205 </para>
2206
2207 <para>
2208 The example assumes a clean build exists for the <filename>qemux86</filename>
2209 machine in a Source Directory named <filename>poky</filename>.
2210 Furthermore, the <link linkend='build-directory'>Build Directory</link> is
2211 <filename>build</filename> and is located in <filename>poky</filename> and
2212 the kernel is based on the Linux 3.4 kernel.
2213 For general information on how to configure the most efficient build, see the
2214 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section
2215 in the Yocto Project Quick Start.
2216 </para>
2217
2218 <para>
2219 Also, for more information on patching the kernel, see the
2220 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#applying-patches'>Applying Patches</ulink>"
2221 section in the Yocto Project Linux Kernel Development Manual.
2222 </para>
2223
2224 <section id='create-a-layer-for-your-changes'>
2225 <title>Create a Layer for your Changes</title>
2226
2227 <para>
2228 The first step is to create a layer so you can isolate your changes:
2229 <literallayout class='monospaced'>
2230 $cd ~/poky
2231 $mkdir meta-mylayer
2232 </literallayout>
2233 Creating a directory that follows the Yocto Project layer naming
2234 conventions sets up the layer for your changes.
2235 The layer is where you place your configuration files, append
2236 files, and patch files.
2237 To learn more about creating a layer and filling it with the
2238 files you need, see the "<link linkend='understanding-and-creating-layers'>Understanding
2239 and Creating Layers</link>" section.
2240 </para>
2241 </section>
2242
2243 <section id='finding-the-kernel-source-code'>
2244 <title>Finding the Kernel Source Code</title>
2245
2246 <para>
2247 Each time you build a kernel image, the kernel source code is fetched
2248 and unpacked into the following directory:
2249 <literallayout class='monospaced'>
2250 ${S}/linux
2251 </literallayout>
2252 See the "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
2253 section and the
2254 <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> variable
2255 for more information about where source is kept during a build.
2256 </para>
2257
2258 <para>
2259 For this example, we are going to patch the
2260 <filename>init/calibrate.c</filename> file
2261 by adding some simple console <filename>printk</filename> statements that we can
2262 see when we boot the image using QEMU.
2263 </para>
2264 </section>
2265
2266 <section id='creating-the-patch'>
2267 <title>Creating the Patch</title>
2268
2269 <para>
2270 Two methods exist by which you can create the patch:
2271 <link linkend='using-a-git-workflow'>Git workflow</link> and
2272 <link linkend='using-a-quilt-workflow'>Quilt workflow</link>.
2273 For kernel patches, the Git workflow is more appropriate.
2274 This section assumes the Git workflow and shows the steps specific to
2275 this example.
2276 <orderedlist>
2277 <listitem><para><emphasis>Change the working directory</emphasis>:
2278 Change to where the kernel source code is before making
2279 your edits to the <filename>calibrate.c</filename> file:
2280 <literallayout class='monospaced'>
2281 $ cd ~/poky/build/tmp/work/qemux86-poky-linux/linux-yocto-${PV}-${PR}/linux
2282 </literallayout>
2283 Because you are working in an established Git repository,
2284 you must be in this directory in order to commit your changes
2285 and create the patch file.
2286 <note>The <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> and
2287 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> variables
2288 represent the version and revision for the
2289 <filename>linux-yocto</filename> recipe.
2290 The <filename>PV</filename> variable includes the Git meta and machine
2291 hashes, which make the directory name longer than you might
2292 expect.
2293 </note></para></listitem>
2294 <listitem><para><emphasis>Edit the source file</emphasis>:
2295 Edit the <filename>init/calibrate.c</filename> file to have the
2296 following changes:
2297 <literallayout class='monospaced'>
2298 void __cpuinit calibrate_delay(void)
2299 {
2300 unsigned long lpj;
2301 static bool printed;
2302 int this_cpu = smp_processor_id();
2303
2304 printk("*************************************\n");
2305 printk("* *\n");
2306 printk("* HELLO YOCTO KERNEL *\n");
2307 printk("* *\n");
2308 printk("*************************************\n");
2309
2310 if (per_cpu(cpu_loops_per_jiffy, this_cpu)) {
2311 .
2312 .
2313 .
2314 </literallayout></para></listitem>
2315 <listitem><para><emphasis>Stage and commit your changes</emphasis>:
2316 These Git commands display the modified file, stage it, and then
2317 commit the file:
2318 <literallayout class='monospaced'>
2319 $ git status
2320 $ git add init/calibrate.c
2321 $ git commit -m "calibrate: Add printk example"
2322 </literallayout></para></listitem>
2323 <listitem><para><emphasis>Generate the patch file</emphasis>:
2324 This Git command creates the a patch file named
2325 <filename>0001-calibrate-Add-printk-example.patch</filename>
2326 in the current directory.
2327 <literallayout class='monospaced'>
2328 $ git format-patch -1
2329 </literallayout>
2330 </para></listitem>
2331 </orderedlist>
2332 </para>
2333 </section>
2334
2335 <section id='set-up-your-layer-for-the-build'>
2336 <title>Set Up Your Layer for the Build</title>
2337
2338 <para>These steps get your layer set up for the build:
2339 <orderedlist>
2340 <listitem><para><emphasis>Create additional structure</emphasis>:
2341 Create the additional layer structure:
2342 <literallayout class='monospaced'>
2343 $ cd ~/poky/meta-mylayer
2344 $ mkdir conf
2345 $ mkdir recipes-kernel
2346 $ mkdir recipes-kernel/linux
2347 $ mkdir recipes-kernel/linux/linux-yocto
2348 </literallayout>
2349 The <filename>conf</filename> directory holds your configuration files, while the
2350 <filename>recipes-kernel</filename> directory holds your append file and
2351 your patch file.</para></listitem>
2352 <listitem><para><emphasis>Create the layer configuration file</emphasis>:
2353 Move to the <filename>meta-mylayer/conf</filename> directory and create
2354 the <filename>layer.conf</filename> file as follows:
2355 <literallayout class='monospaced'>
2356 # We have a conf and classes directory, add to BBPATH
2357 BBPATH .= ":${LAYERDIR}"
2358
2359 # We have recipes-* directories, add to BBFILES
2360 BBFILES += "${LAYERDIR}/recipes-*/*/*.bb \
2361 ${LAYERDIR}/recipes-*/*/*.bbappend"
2362
2363 BBFILE_COLLECTIONS += "mylayer"
2364 BBFILE_PATTERN_mylayer = "^${LAYERDIR}/"
2365 BBFILE_PRIORITY_mylayer = "5"
2366 </literallayout>
2367 Notice <filename>mylayer</filename> as part of the last three
2368 statements.</para></listitem>
2369 <listitem><para><emphasis>Create the kernel recipe append file</emphasis>:
2370 Move to the <filename>meta-mylayer/recipes-kernel/linux</filename> directory and create
2371 the <filename>linux-yocto_3.4.bbappend</filename> file as follows:
2372 <literallayout class='monospaced'>
2373 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
2374
2375 SRC_URI += "file://0001-calibrate-Add-printk-example.patch"
2376
2377 PRINC := "${@int(PRINC) + 1}"
2378 </literallayout>
2379 The <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
2380 and <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
2381 statements enable the OpenEmbedded build system to find the patch file.
2382 For more information on using append files, see the
2383 "<link linkend='using-bbappend-files'>Using .bbappend Files</link>"
2384 section.
2385 </para></listitem>
2386 <listitem><para><emphasis>Put the patch file in your layer</emphasis>:
2387 Move the <filename>0001-calibrate-Add-printk-example.patch</filename> file to
2388 the <filename>meta-mylayer/recipes-kernel/linux/linux-yocto</filename>
2389 directory.</para></listitem>
2390 </orderedlist>
2391 </para>
2392 </section>
2393
2394 <section id='set-up-for-the-build'>
2395 <title>Set Up for the Build</title>
2396
2397 <para>
2398 Do the following to make sure the build parameters are set up for the example.
2399 Once you set up these build parameters, they do not have to change unless you
2400 change the target architecture of the machine you are building:
2401 <itemizedlist>
2402 <listitem><para><emphasis>Build for the correct target architecture:</emphasis> Your
2403 selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
2404 definition within the <filename>local.conf</filename> file in the
2405 <link linkend='build-directory'>Build Directory</link>
2406 specifies the target architecture used when building the Linux kernel.
2407 By default, <filename>MACHINE</filename> is set to
2408 <filename>qemux86</filename>, which specifies a 32-bit
2409 <trademark class='registered'>Intel</trademark> Architecture
2410 target machine suitable for the QEMU emulator.</para></listitem>
2411 <listitem><para><emphasis>Identify your <filename>meta-mylayer</filename>
2412 layer:</emphasis> The
2413 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
2414 variable in the
2415 <filename>bblayers.conf</filename> file found in the
2416 <filename>poky/build/conf</filename> directory needs to have the path to your local
2417 <filename>meta-mylayer</filename> layer.
2418 By default, the <filename>BBLAYERS</filename> variable contains paths to
2419 <filename>meta</filename>, <filename>meta-yocto</filename>, and
2420 <filename>meta-yocto-bsp</filename> in the
2421 <filename>poky</filename> Git repository.
2422 Add the path to your <filename>meta-mylayer</filename> location:
2423 <literallayout class='monospaced'>
2424 BBLAYERS ?= " \
2425 $HOME/poky/meta \
2426 $HOME/poky/meta-yocto \
2427 $HOME/poky/meta-yocto-bsp \
2428 $HOME/poky/meta-mylayer \
2429 "
2430
2431 BBLAYERS_NON_REMOVABLE ?= " \
2432 $HOME/poky/meta \
2433 $HOME/poky/meta-yocto \
2434 "
2435 </literallayout></para></listitem>
2436 </itemizedlist>
2437 </para>
2438 </section>
2439
2440 <section id='build-the-modified-qemu-kernel-image'>
2441 <title>Build the Modified QEMU Kernel Image</title>
2442
2443 <para>
2444 The following steps build your modified kernel image:
2445 <orderedlist>
2446 <listitem><para><emphasis>Be sure your build environment is initialized</emphasis>:
2447 Your environment should be set up since you previously sourced
2448 the
2449 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
2450 script.
2451 If it is not, source the script again from <filename>poky</filename>.
2452 <literallayout class='monospaced'>
2453 $ cd ~/poky
2454 $ source &OE_INIT_FILE;
2455 </literallayout>
2456 </para></listitem>
2457 <listitem><para><emphasis>Clean up</emphasis>:
2458 Be sure to clean the shared state out by running the
2459 <filename>cleansstate</filename> BitBake task as follows from your Build Directory:
2460 <literallayout class='monospaced'>
2461 $ bitbake -c cleansstate linux-yocto
2462 </literallayout></para>
2463 <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename>
2464 directory inside the
2465 <link linkend='build-directory'>Build Directory</link>.
2466 Always use the various BitBake clean tasks to clear out previous
2467 build artifacts.
2468 </note></para></listitem>
2469 <listitem><para><emphasis>Build the image</emphasis>:
2470 Next, build the kernel image using this command:
2471 <literallayout class='monospaced'>
2472 $ bitbake -k linux-yocto
2473 </literallayout></para></listitem>
2474 </orderedlist>
2475 </para>
2476 </section>
2477
2478 <section id='boot-the-image-and-verify-your-changes'>
2479 <title>Boot the Image and Verify Your Changes</title>
2480
2481 <para>
2482 These steps boot the image and allow you to see the changes
2483 <orderedlist>
2484 <listitem><para><emphasis>Boot the image</emphasis>:
2485 Boot the modified image in the QEMU emulator
2486 using this command:
2487 <literallayout class='monospaced'>
2488 $ runqemu qemux86
2489 </literallayout></para></listitem>
2490 <listitem><para><emphasis>Verify the changes</emphasis>:
2491 Log into the machine using <filename>root</filename> with no password and then
2492 use the following shell command to scroll through the console's boot output.
2493 <literallayout class='monospaced'>
2494 # dmesg | less
2495 </literallayout>
2496 You should see the results of your <filename>printk</filename> statements
2497 as part of the output.</para></listitem>
2498 </orderedlist>
2499 </para>
2500 </section>
2501 </section>
2502
2503 <section id='creating-your-own-distribution'>
2504 <title>Creating Your Own Distribution</title>
2505
2506 <para>
2507 When you build an image using the Yocto Project and
2508 do not alter any distribution
2509 <link linkend='metadata'>Metadata</link>, you are creating a
2510 Poky distribution.
2511 If you wish to gain more control over package alternative
2512 selections, compile-time options, and other low-level
2513 configurations, you can create your own distribution.
2514 </para>
2515
2516 <para>
2517 To create your own distribution, the basic steps consist of
2518 creating your own distribution layer, creating your own
2519 distribution configuration file, and then adding any needed
2520 code and Metadata to the layer.
2521 The following steps provide some more detail:
2522 <itemizedlist>
2523 <listitem><para><emphasis>Create a layer for your new distro:</emphasis>
2524 Create your distribution layer so that you can keep your
2525 Metadata and code for the distribution separate.
2526 It is strongly recommended that you create and use your own
2527 layer for configuration and code.
2528 Using your own layer as compared to just placing
2529 configurations in a <filename>local.conf</filename>
2530 configuration file makes it easier to reproduce the same
2531 build configuration when using multiple build machines.
2532 See the
2533 "<link linkend='creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</link>"
2534 section for information on how to quickly set up a layer.
2535 </para></listitem>
2536 <listitem><para><emphasis>Create the distribution configuration file:</emphasis>
2537 The distribution configuration file needs to be created in
2538 the <filename>conf/distro</filename> directory of your
2539 layer.
2540 You need to name it using your distribution name
2541 (e.g. <filename>mydistro.conf</filename>).</para>
2542 <para>You can split out parts of your configuration file
2543 into include files and then "require" them from within
2544 your distribution configuration file.
2545 Be sure to place the include files in the
2546 <filename>conf/distro/include</filename> directory of
2547 your layer.
2548 A common example usage of include files would be to
2549 separate out the selection of desired version and revisions
2550 for individual recipes.
2551</para>
2552 <para>Your configuration file needs to set the following
2553 required variables:
2554 <literallayout class='monospaced'>
2555 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_NAME'><filename>DISTRO_NAME</filename></ulink> [required]
2556 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></ulink> [required]
2557 </literallayout>
2558 These following variables are optional and you typically
2559 set them from the distribution configuration file:
2560 <literallayout class='monospaced'>
2561 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink> [optional]
2562 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RDEPENDS'><filename>DISTRO_EXTRA_RDEPENDS</filename></ulink> [optional]
2563 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_EXTRA_RRECOMMENDS'><filename>DISTRO_EXTRA_RRECOMMENDS</filename></ulink> [optional]
2564 <ulink url='&YOCTO_DOCS_REF_URL;#var-TCLIBC'><filename>TCLIBC</filename></ulink> [optional]
2565 </literallayout>
2566 <tip>
2567 If you want to base your distribution configuration file
2568 on the very basic configuration from OE-Core, you
2569 can use
2570 <filename>conf/distro/defaultsetup.conf</filename> as
2571 a reference and just include variables that differ
2572 as compared to <filename>defaultsetup.conf</filename>.
2573 Alternatively, you can create a distribution
2574 configuration file from scratch using the
2575 <filename>defaultsetup.conf</filename> file
2576 or configuration files from other distributions
2577 such as Poky or Angstrom as references.
2578 </tip></para></listitem>
2579 <listitem><para><emphasis>Provide miscellaneous variables:</emphasis>
2580 Be sure to define any other variables for which you want to
2581 create a default or enforce as part of the distribution
2582 configuration.
2583 You can include nearly any variable from the
2584 <filename>local.conf</filename> file.
2585 The variables you use are not limited to the list in the
2586 previous bulleted item.</para></listitem>
2587 <listitem><para><emphasis>Point to Your distribution configuration file:</emphasis>
2588 In your <filename>local.conf</filename> file in the
2589 <link linkend='build-directory'>Build Directory</link>,
2590 set your
2591 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink>
2592 variable to point to your distribution's configuration file.
2593 For example, if your distribution's configuration file is
2594 named <filename>mydistro.conf</filename>, then you point
2595 to it as follows:
2596 <literallayout class='monospaced'>
2597 DISTRO = "mydistro"
2598 </literallayout></para></listitem>
2599 <listitem><para><emphasis>Add more to the layer if necessary:</emphasis>
2600 Use your layer to hold other information needed for the
2601 distribution:
2602 <itemizedlist>
2603 <listitem><para>Add recipes for installing
2604 distro-specific configuration files that are not
2605 already installed by another recipe.
2606 If you have distro-specific configuration files
2607 that are included by an existing recipe, you should
2608 add a <filename>.bbappend</filename> for those.
2609 For general information and recommendations
2610 on how to add recipes to your layer, see the
2611 "<link linkend='creating-your-own-layer'>Creating Your Own Layer</link>"
2612 and
2613 "<link linkend='best-practices-to-follow-when-creating-layers'>Best Practices to Follow When Creating Layers</link>"
2614 sections.</para></listitem>
2615 <listitem><para>Add any image recipes that are specific
2616 to your distribution.</para></listitem>
2617 <listitem><para>Add a <filename>psplash</filename>
2618 append file for a branded splash screen.
2619 For information on append files, see the
2620 "<link linkend='using-bbappend-files'>Using .bbappend Files</link>"
2621 section.</para></listitem>
2622 <listitem><para>Add any other append files to make
2623 custom changes that are specific to individual
2624 recipes.</para></listitem>
2625 </itemizedlist></para></listitem>
2626 </itemizedlist>
2627 </para>
2628 </section>
2629
2630 <section id='building-a-tiny-system'>
2631 <title>Building a Tiny System</title>
2632
2633 <para>
2634 Very small distributions have some significant advantages such
2635 as requiring less on-die or in-package memory (cheaper), better
2636 performance through efficient cache usage, lower power requirements
2637 due to less memory, faster boot times, and reduced development
2638 overhead.
2639 Some real-world examples where a very small distribution gives
2640 you distinct advantages are digital cameras, medical devices,
2641 and small headless systems.
2642 </para>
2643
2644 <para>
2645 This section presents information that shows you how you can
2646 trim your distribution to even smaller sizes than the
2647 <filename>poky-tiny</filename> distribution, which is around
2648 5 Mbytes, that can be built out-of-the-box using the Yocto Project.
2649 </para>
2650
2651 <section id='tiny-system-overview'>
2652 <title>Overview</title>
2653
2654 <para>
2655 The following list presents the overall steps you need to
2656 consider and perform to create distributions with smaller
2657 root filesystems, faster boot times, maintain your critical
2658 functionality, and avoid initial RAM disks:
2659 <itemizedlist>
2660 <listitem><para>Determine your goals and guiding
2661 principles.</para></listitem>
2662 <listitem><para>Understand what gives your image size.
2663 </para></listitem>
2664 <listitem><para>Reduce the size of the root filesystem.
2665 </para></listitem>
2666 <listitem><para>Reduce the size of the kernel.
2667 </para></listitem>
2668 <listitem><para>Eliminate packaging requirements.
2669 </para></listitem>
2670 <listitem><para>Look for other ways to minimize size.
2671 </para></listitem>
2672 <listitem><para>Iterate on the process.</para></listitem>
2673 </itemizedlist>
2674 </para>
2675 </section>
2676
2677 <section id='goals-and-guiding-principles'>
2678 <title>Goals and Guiding Principles</title>
2679
2680 <para>
2681 Before you can reach your destination, you need to know
2682 where you are going.
2683 Here is an example list that you can use as a guide when
2684 creating very small distributions:
2685 <itemizedlist>
2686 <listitem><para>Determine how much space you need
2687 (e.g. a kernel that is 1 Mbyte or less and
2688 a root filesystem that is 3 Mbytes or less).
2689 </para></listitem>
2690 <listitem><para>Find the areas that are currently
2691 taking 90% of the space and concentrate on reducing
2692 those areas.
2693 </para></listitem>
2694 <listitem><para>Do not create any difficult "hacks"
2695 to achieve your goals.</para></listitem>
2696 <listitem><para>Leverage the device-specific
2697 options.</para></listitem>
2698 <listitem><para>Work in a separate layer so that you
2699 keep changes isolated.
2700 For information on how to create layers, see
2701 the "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>" section.
2702 </para></listitem>
2703 </itemizedlist>
2704 </para>
2705 </section>
2706
2707 <section id='understand-what-gives-your-image-size'>
2708 <title>Understand What Gives Your Image Size</title>
2709
2710 <para>
2711 It is easiest to have something to start with when creating
2712 your own distribution.
2713 You can use the Yocto Project out-of-the-box to create the
2714 <filename>poky-tiny</filename> distribution.
2715 Ultimately, you will want to make changes in your own
2716 distribution that are likely modeled after
2717 <filename>poky-tiny</filename>.
2718 <note>
2719 To use <filename>poky-tiny</filename> in your build,
2720 set the
2721 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink>
2722 variable in your
2723 <filename>local.conf</filename> file to "poky-tiny"
2724 as described in the
2725 "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>"
2726 section.
2727 </note>
2728 </para>
2729
2730 <para>
2731 Understanding some memory concepts will help you reduce the
2732 system size.
2733 Memory consists of static, dynamic, and temporary memory.
2734 Static memory is the TEXT (code), DATA (initialized data
2735 in the code), and BSS (uninitialized data) sections.
2736 Dynamic memory contains memory that is allocated at runtime,
2737 stacks, hash tables, and so forth.
2738 Temporary memory is recovered after the boot process.
2739 This memory consists of memory used for decompressing
2740 the kernel and for the <filename>__init__</filename>
2741 functions.
2742 </para>
2743
2744 <para>
2745 To help you see where you currently are with kernel and root
2746 filesystem sizes, you can use two tools found in the
2747 <link linkend='source-directory'>Source Directory</link> in
2748 the <filename>scripts</filename> directory:
2749 <itemizedlist>
2750 <listitem><para><filename>ksize.py</filename>: Reports
2751 component sizes for the kernel build objects.
2752 </para></listitem>
2753 <listitem><para><filename>dirsize.py</filename>: Reports
2754 component sizes for the root filesystem.</para></listitem>
2755 </itemizedlist>
2756 This next tool and command helps you organize configuration
2757 fragments and view file dependencies in a human-readable form:
2758 <itemizedlist>
2759 <listitem><para><filename>merge_config.sh</filename>:
2760 Helps you manage configuration files and fragments
2761 within the kernel.
2762 With this tool, you can merge individual configuration
2763 fragments together.
2764 The tool allows you to make overrides and warns you
2765 of any missing configuration options.
2766 The tool is ideal for allowing you to iterate on
2767 configurations, create minimal configurations, and
2768 create configuration files for different machines
2769 without having to duplicate your process.</para>
2770 <para>The <filename>merge_config.sh</filename> script is
2771 part of the Linux Yocto kernel Git repository in the
2772 <filename>scripts/kconfig</filename> directory.</para>
2773 <para>For more information on configuration fragments,
2774 see the
2775 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#generating-configuration-files'>Generating Configuration Files</ulink>"
2776 section of the Yocto Project Linux Kernel Development
2777 Manual and the "<link linkend='creating-config-fragments'>Creating Configuration Fragments</link>"
2778 section, which is in this manual.</para></listitem>
2779 <listitem><para><filename>bitbake -u depexp -g &lt;bitbake_target&gt;</filename>:
2780 Using the BitBake command with these options brings up
2781 a Dependency Explorer from which you can view file
2782 dependencies.
2783 Understanding these dependencies allows you to make
2784 informed decisions when cutting out various pieces of the
2785 kernel and root filesystem.</para></listitem>
2786 </itemizedlist>
2787 </para>
2788 </section>
2789
2790 <section id='trim-the-root-filesystem'>
2791 <title>Trim the Root Filesystem</title>
2792
2793 <para>
2794 The root filesystem is made up of packages for booting,
2795 libraries, and applications.
2796 To change things, you can configure how the packaging happens,
2797 which changes the way you build them.
2798 You can also tweak the filesystem itself or select a different
2799 filesystem.
2800 </para>
2801
2802 <para>
2803 First, find out what is hogging your root filesystem by running the
2804 <filename>dirsize.py</filename> script from your root directory:
2805 <literallayout class='monospaced'>
2806 $ cd &lt;root-directory-of-image&gt;
2807 $ dirsize.py 100000 > dirsize-100k.log
2808 $ cat dirsize-100k.log
2809 </literallayout>
2810 You can apply a filter to the script to ignore files under
2811 a certain size.
2812 This example filters out anything below 100 Kbytes.
2813 The sizes reported by the tool are uncompressed and thus,
2814 will be smaller by a relatively constant factor in a
2815 compressed root filesystem.
2816 When you examine your log file, you can focus on areas of the
2817 root filesystem that take up large amounts of memory.
2818 </para>
2819
2820 <para>
2821 You need to be sure that what you eliminate does not cripple
2822 the functionality you need.
2823 One way to see how packages relate to each other is by using
2824 the Dependency Explorer UI with the BitBake command:
2825 <literallayout class='monospaced'>
2826 $ cd &lt;image-directory&gt;
2827 $ bitbake -u depexp -g &lt;image&gt;
2828 </literallayout>
2829 Use the interface to select potential packages you wish to
2830 eliminate and see their dependency relationships.
2831 </para>
2832
2833 <para>
2834 When deciding how to reduce the size, get rid of packages that
2835 result in minimal impact on the feature set.
2836 For example, you might not need a VGA display.
2837 Or, you might be able to get by with <filename>devtmpfs</filename>
2838 and <filename>mdev</filename> instead of
2839 <filename>udev</filename>.
2840 </para>
2841
2842 <para>
2843 Use the <filename>local.conf</filename> file to make changes.
2844 For example, to eliminate <filename>udev</filename> and
2845 <filename>glib</filename>, set the following in the
2846 local configuration file:
2847 <literallayout class='monospaced'>
2848 VIRTUAL-RUNTIME_dev_manager = ""
2849 </literallayout>
2850 </para>
2851
2852 <para>
2853 Finally, you should consider exactly the type of root
2854 filesystem you need to meet your needs while also reducing
2855 its size.
2856 For example, consider <filename>cramfs</filename>,
2857 <filename>squashfs</filename>, <filename>ubifs</filename>,
2858 <filename>ext2</filename>, or an <filename>initramfs</filename>
2859 using <filename>initramfs</filename>.
2860 Be aware that <filename>ext3</filename> requires a 1 Mbyte
2861 journal.
2862 If you are okay with running read-only you do not need this
2863 journal.
2864 </para>
2865
2866 <note>
2867 After each round of elimination, you need to rebuild your
2868 system and then use the tools to see the effects of your
2869 reductions.
2870 </note>
2871
2872
2873 </section>
2874
2875 <section id='trim-the-kernel'>
2876 <title>Trim the Kernel</title>
2877
2878 <para>
2879 The kernel is built by including policies for hardware-independent
2880 aspects.
2881 What subsystems do you enable?
2882 For what architecture are you building?
2883 Which drivers do you build by default.
2884 <note>You can modify the kernel source if you want to help
2885 with boot time.
2886 </note>
2887 </para>
2888
2889 <para>
2890 Run the <filename>ksize.py</filename> script from the top-level
2891 Linux build directory to get an idea of what is making up
2892 the kernel:
2893 <literallayout class='monospaced'>
2894 $ cd &lt;top-level-linux-build-directory&gt;
2895 $ ksize.py > ksize.log
2896 $ cat ksize.log
2897 </literallayout>
2898 When you examine the log, you will see how much space is
2899 taken up with the built-in <filename>.o</filename> files for
2900 drivers, networking, core kernel files, filesystem, sound,
2901 and so forth.
2902 The sizes reported by the tool are uncompressed and thus,
2903 will be smaller by a relatively constant factor in a compressed
2904 kernel image.
2905 Look to reduce the areas that are large and taking up around
2906 the "90% rule."
2907 </para>
2908
2909 <para>
2910 To examine, or drill down, into any particular area, use the
2911 <filename>-d</filename> option with the script:
2912 <literallayout class='monospaced'>
2913 $ ksize.py -d > ksize.log
2914 </literallayout>
2915 Using this option breaks out the individual file information
2916 for each area of the kernel (e.g. drivers, networking, and
2917 so forth).
2918 </para>
2919
2920 <para>
2921 Use your log file to see what you can eliminate from the kernel
2922 based on features you can let go.
2923 For example, if you are not going to need sound, you do not
2924 need any drivers that support sound.
2925 </para>
2926
2927 <para>
2928 After figuring out what to eliminate, you need to reconfigure
2929 the kernel to reflect those changes during the next build.
2930 You could run <filename>menuconfig</filename> and make all your
2931 changes at once.
2932 However, that makes it difficult to see the effects of your
2933 individual eliminations and also makes it difficult to replicate
2934 the changes for perhaps another target device.
2935 A better method is to start with no configurations using
2936 <filename>allnoconfig</filename>, create configuration
2937 fragments for individual changes, and then manage the
2938 fragments into a single configuration file using
2939 <filename>merge_config.sh</filename>.
2940 The tool makes it easy for you to iterate using the
2941 configuration change and build cycle.
2942 </para>
2943
2944 <para>
2945 Each time you make configuration changes, you need to rebuild
2946 the kernel and check to see what impact your changes had on
2947 the overall size.
2948 </para>
2949 </section>
2950
2951 <section id='remove-package-management-requirements'>
2952 <title>Remove Package Management Requirements</title>
2953
2954 <para>
2955 Packaging requirements add size to the image.
2956 One way to reduce the size of the image is to remove all the
2957 packaging requirements from the image.
2958 This reduction includes both removing the package manager
2959 and its unique dependencies as well as removing the package
2960 management data itself.
2961 </para>
2962
2963 <para>
2964 To eliminate all the packaging requirements for an image,
2965 follow these steps:
2966 <orderedlist>
2967 <listitem><para>Put the following line in your main
2968 recipe for the image to remove package management
2969 data files:
2970 <literallayout class='monospaced'>
2971 ROOTFS_POSTPROCESS_COMMAND += "remove_packaging_data_files ;
2972 </literallayout>
2973 For example, the recipe for the
2974 <filename>core-image-minimal</filename> image contains
2975 this line.
2976 You can also add the line to the
2977 <filename>local.conf</filename> configuration file.
2978 </para></listitem>
2979 <listitem><para>Be sure that "package-management" is not
2980 part of your
2981 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
2982 statement for the image.
2983 When you remove this feature, you are removing the
2984 package manager as well as its dependencies
2985 from the root filesystem.
2986 </para></listitem>
2987 </orderedlist>
2988 </para>
2989 </section>
2990
2991 <section id='look-for-other-ways-to-minimize-size'>
2992 <title>Look for Other Ways to Minimize Size</title>
2993
2994 <para>
2995 Depending on your particular circumstances, other areas that you
2996 can trim likely exist.
2997 The key to finding these areas is through tools and methods
2998 described here combined with experimentation and iteration.
2999 Here are a couple of areas to experiment with:
3000 <itemizedlist>
3001 <listitem><para><filename>eglibc</filename>:
3002 In general, follow this process:
3003 <orderedlist>
3004 <listitem><para>Remove <filename>eglibc</filename>
3005 features from
3006 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
3007 that you think you do not need.</para></listitem>
3008 <listitem><para>Build your distribution.
3009 </para></listitem>
3010 <listitem><para>If the build fails due to missing
3011 symbols in a package, determine if you can
3012 reconfigure the package to not need those
3013 features.
3014 For example, change the configuration to not
3015 support wide character support as is done for
3016 <filename>ncurses</filename>.
3017 Or, if support for those characters is needed,
3018 determine what <filename>eglibc</filename>
3019 features provide the support and restore the
3020 configuration.
3021 </para></listitem>
3022 <listitem><para>Rebuild and repeat the process.
3023 </para></listitem>
3024 </orderedlist></para></listitem>
3025 <listitem><para><filename>busybox</filename>:
3026 For BusyBox, use a process similar as described for
3027 <filename>eglibc</filename>.
3028 A difference is you will need to boot the resulting
3029 system to see if you are able to do everything you
3030 expect from the running system.
3031 You need to be sure to integrate configuration fragments
3032 into Busybox because BusyBox handles its own core
3033 features and then allows you to add configuration
3034 fragments on top.
3035 </para></listitem>
3036 </itemizedlist>
3037 </para>
3038 </section>
3039
3040 <section id='iterate-on-the-process'>
3041 <title>Iterate on the Process</title>
3042
3043 <para>
3044 If you have not reached your goals on system size, you need
3045 to iterate on the process.
3046 The process is the same.
3047 Use the tools and see just what is taking up 90% of the root
3048 filesystem and the kernel.
3049 Decide what you can eliminate without limiting your device
3050 beyond what you need.
3051 </para>
3052
3053 <para>
3054 Depending on your system, a good place to look might be
3055 Busybox, which provides a stripped down
3056 version of Unix tools in a single, executable file.
3057 You might be able to drop virtual terminal services or perhaps
3058 ipv6.
3059 </para>
3060 </section>
3061 </section>
3062
3063 <section id='working-with-packages'>
3064 <title>Working with Packages</title>
3065
3066 <para>
3067 This section describes a few tasks that involve packages:
3068 <itemizedlist>
3069 <listitem><para>Excluding packages from an image
3070 </para></listitem>
3071 <listitem><para>Incrementing a package revision number
3072 </para></listitem>
3073 <listitem><para>Handling a package name alias
3074 </para></listitem>
3075 <listitem><para>Handling optional module packaging
3076 </para></listitem>
3077 <listitem><para>Using Runtime Package Management
3078 </para></listitem>
3079 <listitem><para>Setting up and running package test
3080 (ptest)
3081 </para></listitem>
3082 </itemizedlist>
3083 </para>
3084
3085 <section id='excluding-packages-from-an-image'>
3086 <title>Excluding Packages from an Image</title>
3087
3088 <para>
3089 You might find it necessary to prevent specific packages
3090 from being installed into an image.
3091 If so, you can use several variables to direct the build
3092 system to essentially ignore installing recommended packages
3093 or to not install a package at all.
3094 </para>
3095
3096 <para>
3097 The following list introduces variables you can use to
3098 prevent packages from being installed into your image.
3099 Each of these variables only works with IPK and RPM
3100 package types.
3101 Support for Debian packages does not exist.
3102 Also, you can use these variables from your
3103 <filename>local.conf</filename> file or attach them to a
3104 specific image recipe by using a recipe name override.
3105 For more detail on the variables, see the descriptions in the
3106 Yocto Project Reference Manual's glossary chapter.
3107 <itemizedlist>
3108 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></ulink>:
3109 Use this variable to specify "recommended-only"
3110 packages that you do not want installed.
3111 </para></listitem>
3112 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></ulink>:
3113 Use this variable to prevent all "recommended-only"
3114 packages from being installed.
3115 </para></listitem>
3116 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>:
3117 Use this variable to prevent specific packages from
3118 being installed regardless of whether they are
3119 "recommended-only" or not.
3120 You need to realize that the build process could
3121 fail with an error when you
3122 prevent the installation of a package whose presence
3123 is required by an installed package.
3124 </para></listitem>
3125 </itemizedlist>
3126 </para>
3127 </section>
3128
3129 <section id='incrementing-a-package-revision-number'>
3130 <title>Incrementing a Package Revision Number</title>
3131
3132 <para>
3133 If a committed change results in changing the package output,
3134 then the value of the
3135 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
3136 variable needs to be increased (or "bumped").
3137 Increasing <filename>PR</filename> occurs one of two ways:
3138 <itemizedlist>
3139 <listitem><para>Automatically using a Package Revision
3140 Service (PR Service).</para></listitem>
3141 <listitem><para>Manually incrementing the
3142 <filename>PR</filename> variable.</para></listitem>
3143 </itemizedlist>
3144 </para>
3145
3146 <para>
3147 Given that one of the challenges any build system and its
3148 users face is how to maintain a package feed that is compatible
3149 with existing package manager applications such as
3150 RPM, APT, and OPKG, using an automated system is much
3151 preferred over a manual system.
3152 In either system, the main requirement is that version
3153 numbering increases in a linear fashion and that a number of
3154 version components exist that support that linear progression.
3155 </para>
3156
3157 <para>
3158 The following two sections provide information on the PR Service
3159 and on manual <filename>PR</filename> bumping.
3160 </para>
3161
3162 <section id='working-with-a-pr-service'>
3163 <title>Working With a PR Service</title>
3164
3165 <para>
3166 As mentioned, attempting to maintain revision numbers in the
3167 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
3168 is error prone, inaccurate and causes problems for people
3169 submitting recipes.
3170 Conversely, the PR Service automatically generates
3171 increasing numbers, particularly the revision field,
3172 which removes the human element.
3173 <note>
3174 For additional information on using a PR Service, you
3175 can see the
3176 <ulink url='&YOCTO_WIKI_URL;/wiki/PR_Service'>PR Service</ulink>
3177 wiki page.
3178 </note>
3179 </para>
3180
3181 <para>
3182 The Yocto Project uses variables in order of
3183 decreasing priority to facilitate revision numbering (i.e.
3184 <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>,
3185 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and
3186 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
3187 for epoch, version and revision, respectively).
3188 The values are highly dependent on the policies and
3189 procedures of a given distribution and package feed.
3190 </para>
3191
3192 <para>
3193 Because the OpenEmbedded build system uses
3194 "<ulink url='&YOCTO_DOCS_REF_URL;#checksums'>signatures</ulink>",
3195 which are unique to a given build, the build system
3196 knows when to rebuild packages.
3197 All the inputs into a given task are represented by a
3198 signature, which can trigger a rebuild when different.
3199 Thus, the build system itself does not rely on the
3200 <filename>PR</filename> numbers to trigger a rebuild.
3201 The signatures, however, can be used to generate
3202 <filename>PR</filename> values.
3203 </para>
3204
3205 <para>
3206 The PR Service works with both
3207 <filename>OEBasic</filename> and
3208 <filename>OEBasicHash</filename> generators.
3209 The value of <filename>PR</filename> bumps when the
3210 checksum changes and the different generator mechanisms
3211 change signatures under different circumstances.
3212 </para>
3213
3214 <para>
3215 As implemented, the build system includes values from
3216 the PR Service into the <filename>PR</filename> field as
3217 an addition using the form "<filename>.x</filename>" so
3218 <filename>r0</filename> becomes <filename>r0.1</filename>,
3219 <filename>r0.2</filename> and so forth.
3220 This scheme allows existing <filename>PR</filename> values
3221 to be used for whatever reasons, which include manual
3222 <filename>PR</filename> bumps should it be necessary.
3223 </para>
3224
3225 <para>
3226 By default, the PR Service is not enabled or running.
3227 Thus, the packages generated are just "self consistent".
3228 The build system adds and removes packages and
3229 there are no guarantees about upgrade paths but images
3230 will be consistent and correct with the latest changes.
3231 </para>
3232
3233 <para>
3234 The simplest form for a PR Service is for it to exist
3235 for a single host development system that builds the
3236 package feed (building system).
3237 For this scenario, you can enable the PR Service by adding
3238 the following to your <filename>local.conf</filename>
3239 file in the
3240 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
3241 <literallayout class='monospaced'>
3242 PRSERV_HOST = "localhost:0"
3243 </literallayout>
3244 Once the service is started, packages will automatically
3245 get increasing <filename>PR</filename> values and
3246 BitBake will take care of starting and stopping the server.
3247 </para>
3248
3249 <para>
3250 If you have a more complex setup where multiple host
3251 development systems work against a common, shared package
3252 feed, you have a single PR Service running and it is
3253 connected to each building system.
3254 For this scenario, you need to start the PR Service using
3255 the <filename>bitbake-prserv</filename> command:
3256 <literallayout class='monospaced'>
3257 bitbake-prserv &dash;&dash;host &lt;ip&gt; &dash;&dash;port &lt;port&gt; &dash;&dash;start
3258 </literallayout>
3259 In addition to hand-starting the service, you need to
3260 update the <filename>local.conf</filename> file of each
3261 building system as described earlier so each system
3262 points to the server and port.
3263 </para>
3264
3265 <para>
3266 It is also recommended you use Build History, which adds
3267 some sanity checks to package versions, in conjunction with
3268 the server that is running the PR Service.
3269 To enable build history, add the following to each building
3270 system's <filename>local.conf</filename> file:
3271 <literallayout class='monospaced'>
3272 # It is recommended to activate "buildhistory" for testing the PR service
3273 INHERIT += "buildhistory"
3274 BUILDHISTORY_COMMIT = "1"
3275 </literallayout>
3276 For information on Build History, see the
3277 "<ulink url='&YOCTO_DOCS_REF_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>"
3278 section in the Yocto Project Reference Manual.
3279 </para>
3280
3281 <note>
3282 <para>The OpenEmbedded build system does not maintain
3283 <filename>PR</filename> information as part of the
3284 shared state (sstate) packages.
3285 If you maintain an sstate feed, its expected that either
3286 all your building systems that contribute to the sstate
3287 feed use a shared PR Service, or you do not run a PR
3288 Service on any of your building systems.
3289 Having some systems use a PR Service while others do
3290 not leads to obvious problems.</para>
3291 <para>For more information on shared state, see the
3292 "<ulink url='&YOCTO_DOCS_REF_URL;#shared-state-cache'>Shared State Cache</ulink>"
3293 section in the Yocto Project Reference Manual.</para>
3294 </note>
3295 </section>
3296
3297 <section id='manually-bumping-pr'>
3298 <title>Manually Bumping PR</title>
3299
3300 <para>
3301 The alternative to setting up a PR Service is to manually
3302 bump the
3303 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
3304 variable.
3305 </para>
3306
3307 <para>
3308 If a committed change results in changing the package output,
3309 then the value of the PR variable needs to be increased
3310 (or "bumped") as part of that commit.
3311 For new recipes you should add the <filename>PR</filename>
3312 variable and set its initial value equal to "r0", which is the default.
3313 Even though the default value is "r0", the practice of adding it to a new recipe makes
3314 it harder to forget to bump the variable when you make changes
3315 to the recipe in future.
3316 </para>
3317
3318 <para>
3319 If you are sharing a common <filename>.inc</filename> file with multiple recipes,
3320 you can also use the
3321 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-INC_PR'>INC_PR</ulink></filename>
3322 variable to ensure that
3323 the recipes sharing the <filename>.inc</filename> file are rebuilt when the
3324 <filename>.inc</filename> file itself is changed.
3325 The <filename>.inc</filename> file must set <filename>INC_PR</filename>
3326 (initially to "r0"), and all recipes referring to it should set <filename>PR</filename>
3327 to "$(INC_PR).0" initially, incrementing the last number when the recipe is changed.
3328 If the <filename>.inc</filename> file is changed then its
3329 <filename>INC_PR</filename> should be incremented.
3330 </para>
3331
3332 <para>
3333 When upgrading the version of a package, assuming the
3334 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'>PV</ulink></filename>
3335 changes, the <filename>PR</filename> variable should be
3336 reset to "r0" (or "$(INC_PR).0" if you are using
3337 <filename>INC_PR</filename>).
3338 </para>
3339
3340 <para>
3341 Usually, version increases occur only to packages.
3342 However, if for some reason <filename>PV</filename> changes but does not
3343 increase, you can increase the
3344 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PE'>PE</ulink></filename>
3345 variable (Package Epoch).
3346 The <filename>PE</filename> variable defaults to "0".
3347 </para>
3348
3349 <para>
3350 Version numbering strives to follow the
3351 <ulink url='http://www.debian.org/doc/debian-policy/ch-controlfields.html'>
3352 Debian Version Field Policy Guidelines</ulink>.
3353 These guidelines define how versions are compared and what "increasing" a version means.
3354 </para>
3355 </section>
3356 </section>
3357
3358 <section id="usingpoky-configuring-DISTRO_PN_ALIAS">
3359 <title>Handling a Package Name Alias</title>
3360 <para>
3361 Sometimes a package name you are using might exist under an alias or as a similarly named
3362 package in a different distribution.
3363 The OpenEmbedded build system implements a <filename>distro_check</filename>
3364 task that automatically connects to major distributions
3365 and checks for these situations.
3366 If the package exists under a different name in a different distribution, you get a
3367 <filename>distro_check</filename> mismatch.
3368 You can resolve this problem by defining a per-distro recipe name alias using the
3369 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename>
3370 variable.
3371 </para>
3372
3373 <para>
3374 Following is an example that shows how you specify the <filename>DISTRO_PN_ALIAS</filename>
3375 variable:
3376 <literallayout class='monospaced'>
3377 DISTRO_PN_ALIAS_pn-PACKAGENAME = "distro1=package_name_alias1 \
3378 distro2=package_name_alias2 \
3379 distro3=package_name_alias3 \
3380 ..."
3381 </literallayout>
3382 </para>
3383
3384 <para>
3385 If you have more than one distribution alias, separate them with a space.
3386 Note that the build system currently automatically checks the
3387 Fedora, OpenSUSE, Debian, Ubuntu,
3388 and Mandriva distributions for source package recipes without having to specify them
3389 using the <filename>DISTRO_PN_ALIAS</filename> variable.
3390 For example, the following command generates a report that lists the Linux distributions
3391 that include the sources for each of the recipes.
3392 <literallayout class='monospaced'>
3393 $ bitbake world -f -c distro_check
3394 </literallayout>
3395 The results are stored in the <filename>build/tmp/log/distro_check-${DATETIME}.results</filename>
3396 file found in the
3397 <link linkend='source-directory'>Source Directory</link>.
3398 </para>
3399 </section>
3400
3401 <section id='handling-optional-module-packaging'>
3402 <title>Handling Optional Module Packaging</title>
3403
3404 <para>
3405 Many pieces of software split functionality into optional
3406 modules (or plug-ins) and the plug-ins that are built
3407 might depend on configuration options.
3408 To avoid having to duplicate the logic that determines what
3409 modules are available in your recipe or to avoid having
3410 to package each module by hand, the OpenEmbedded build system
3411 provides functionality to handle module packaging dynamically.
3412 </para>
3413
3414 <para>
3415 To handle optional module packaging, you need to do two things:
3416 <itemizedlist>
3417 <listitem><para>Ensure the module packaging is actually
3418 done</para></listitem>
3419 <listitem><para>Ensure that any dependencies on optional
3420 modules from other recipes are satisfied by your recipe
3421 </para></listitem>
3422 </itemizedlist>
3423 </para>
3424
3425 <section id='making-sure-the-packaging-is-done'>
3426 <title>Making Sure the Packaging is Done</title>
3427
3428 <para>
3429 To ensure the module packaging actually gets done, you use
3430 the <filename>do_split_packages</filename> function within
3431 the <filename>populate_packages</filename> Python function
3432 in your recipe.
3433 The <filename>do_split_packages</filename> function
3434 searches for a pattern of files or directories under a
3435 specified path and creates a package for each one it finds
3436 by appending to the
3437 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>
3438 variable and setting the appropriate values for
3439 <filename>FILES_packagename</filename>,
3440 <filename>RDEPENDS_packagename</filename>,
3441 <filename>DESCRIPTION_packagename</filename>, and so forth.
3442 Here is an example from the <filename>lighttpd</filename>
3443 recipe:
3444 <literallayout class='monospaced'>
3445 python populate_packages_prepend () {
3446 lighttpd_libdir = d.expand('${libdir}')
3447 do_split_packages(d, lighttpd_libdir, '^mod_(.*)\.so$',
3448 'lighttpd-module-%s', 'Lighttpd module for %s',
3449 extra_depends='')
3450 }
3451 </literallayout>
3452 The previous example specifies a number of things in the
3453 call to <filename>do_split_packages</filename>.
3454 <itemizedlist>
3455 <listitem><para>A directory within the files installed
3456 by your recipe through <filename>do_install</filename>
3457 in which to search.</para></listitem>
3458 <listitem><para>A regular expression to match module
3459 files in that directory.
3460 In the example, note the parentheses () that mark
3461 the part of the expression from which the module
3462 name should be derived.</para></listitem>
3463 <listitem><para>A pattern to use for the package names.
3464 </para></listitem>
3465 <listitem><para>A description for each package.
3466 </para></listitem>
3467 <listitem><para>An empty string for
3468 <filename>extra_depends</filename>, which disables
3469 the default dependency on the main
3470 <filename>lighttpd</filename> package.
3471 Thus, if a file in <filename>${libdir}</filename>
3472 called <filename>mod_alias.so</filename> is found,
3473 a package called <filename>lighttpd-module-alias</filename>
3474 is created for it and the
3475 <ulink url='&YOCTO_DOCS_REF_URL;#var-DESCRIPTION'><filename>DESCRIPTION</filename></ulink>
3476 is set to "Lighttpd module for alias".</para></listitem>
3477 </itemizedlist>
3478 </para>
3479
3480 <para>
3481 Often, packaging modules is as simple as the previous
3482 example.
3483 However, more advanced options exist that you can use
3484 within <filename>do_split_packages</filename> to modify its
3485 behavior.
3486 And, if you need to, you can add more logic by specifying
3487 a hook function that is called for each package.
3488 It is also perfectly acceptable to call
3489 <filename>do_split_packages</filename> multiple times if
3490 you have more than one set of modules to package.
3491 </para>
3492
3493 <para>
3494 For more examples that show how to use
3495 <filename>do_split_packages</filename>, see the
3496 <filename>connman.inc</filename> file in the
3497 <filename>meta/recipes-connectivity/connman/</filename>
3498 directory of the <filename>poky</filename>
3499 <link linkend='yocto-project-repositories'>source repository</link>.
3500 You can also find examples in
3501 <filename>meta/classes/kernel.bbclass</filename>.
3502 </para>
3503
3504 <para>
3505 Following is a reference that shows
3506 <filename>do_split_packages</filename> mandatory and
3507 optional arguments:
3508 <literallayout class='monospaced'>
3509 Mandatory arguments
3510
3511 root
3512 The path in which to search
3513 file_regex
3514 Regular expression to match searched files.
3515 Use parentheses () to mark the part of this
3516 expression that should be used to derive the
3517 module name (to be substituted where %s is
3518 used in other function arguments as noted below)
3519 output_pattern
3520 Pattern to use for the package names. Must
3521 include %s.
3522 description
3523 Description to set for each package. Must
3524 include %s.
3525
3526 Optional arguments
3527
3528 postinst
3529 Postinstall script to use for all packages
3530 (as a string)
3531 recursive
3532 True to perform a recursive search - default
3533 False
3534 hook
3535 A hook function to be called for every match.
3536 The function will be called with the following
3537 arguments (in the order listed):
3538
3539 f
3540 Full path to the file/directory match
3541 pkg
3542 The package name
3543 file_regex
3544 As above
3545 output_pattern
3546 As above
3547 modulename
3548 The module name derived using file_regex
3549
3550 extra_depends
3551 Extra runtime dependencies (RDEPENDS) to be
3552 set for all packages. The default value of None
3553 causes a dependency on the main package
3554 (${PN}) - if you do not want this, pass empty
3555 string '' for this parameter.
3556 aux_files_pattern
3557 Extra item(s) to be added to FILES for each
3558 package. Can be a single string item or a list
3559 of strings for multiple items. Must include %s.
3560 postrm
3561 postrm script to use for all packages (as a
3562 string)
3563 allow_dirs
3564 True to allow directories to be matched -
3565 default False
3566 prepend
3567 If True, prepend created packages to PACKAGES
3568 instead of the default False which appends them
3569 match_path
3570 match file_regex on the whole relative path to
3571 the root rather than just the file name
3572 aux_files_pattern_verbatim
3573 Extra item(s) to be added to FILES for each
3574 package, using the actual derived module name
3575 rather than converting it to something legal
3576 for a package name. Can be a single string item
3577 or a list of strings for multiple items. Must
3578 include %s.
3579 allow_links
3580 True to allow symlinks to be matched - default
3581 False
3582 </literallayout>
3583 </para>
3584 </section>
3585
3586 <section id='satisfying-dependencies'>
3587 <title>Satisfying Dependencies</title>
3588
3589 <para>
3590 The second part for handling optional module packaging
3591 is to ensure that any dependencies on optional modules
3592 from other recipes are satisfied by your recipe.
3593 You can be sure these dependencies are satisfied by
3594 using the
3595 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></ulink> variable.
3596 Here is an example that continues with the
3597 <filename>lighttpd</filename> recipe shown earlier:
3598 <literallayout class='monospaced'>
3599 PACKAGES_DYNAMIC = "lighttpd-module-.*"
3600 </literallayout>
3601 The name specified in the regular expression can of
3602 course be anything.
3603 In this example, it is <filename>lighttpd-module-</filename>
3604 and is specified as the prefix to ensure that any
3605 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>
3606 and <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>
3607 on a package name starting with the prefix are satisfied
3608 during build time.
3609 If you are using <filename>do_split_packages</filename>
3610 as described in the previous section, the value you put in
3611 <filename>PACKAGES_DYNAMIC</filename> should correspond to
3612 the name pattern specified in the call to
3613 <filename>do_split_packages</filename>.
3614 </para>
3615 </section>
3616 </section>
3617
3618 <section id='using-runtime-package-management'>
3619 <title>Using Runtime Package Management</title>
3620
3621 <para>
3622 During a build, BitBake always transforms a recipe into one or
3623 more packages.
3624 For example, BitBake takes the <filename>bash</filename> recipe
3625 and currently produces the <filename>bash-dbg</filename>,
3626 <filename>bash-staticdev</filename>,
3627 <filename>bash-dev</filename>, <filename>bash-doc</filename>,
3628 <filename>bash-locale</filename>, and
3629 <filename>bash</filename> packages.
3630 Not all generated packages are included in an image.
3631 </para>
3632
3633 <para>
3634 In several situations, you might need to update, add, remove,
3635 or query the packages on a target device at runtime
3636 (i.e. without having to generate a new image).
3637 Examples of such situations include:
3638 <itemizedlist>
3639 <listitem><para>
3640 You want to provide in-the-field updates to deployed
3641 devices (e.g. security updates).
3642 </para></listitem>
3643 <listitem><para>
3644 You want to have a fast turn-around development cycle
3645 for one or more applications that run on your device.
3646 </para></listitem>
3647 <listitem><para>
3648 You want to temporarily install the "debug" packages
3649 of various applications on your device so that
3650 debugging can be greatly improved by allowing
3651 access to symbols and source debugging.
3652 </para></listitem>
3653 <listitem><para>
3654 You want to deploy a more minimal package selection of
3655 your device but allow in-the-field updates to add a
3656 larger selection for customization.
3657 </para></listitem>
3658 </itemizedlist>
3659 </para>
3660
3661 <para>
3662 In all these situations, you have something similar to a more
3663 traditional Linux distribution in that in-field devices
3664 are able to receive pre-compiled packages from a server for
3665 installation or update.
3666 Being able to install these packages on a running,
3667 in-field device is what is termed "runtime package
3668 management".
3669 </para>
3670
3671 <para>
3672 In order to use runtime package management, you
3673 need a host/server machine that serves up the pre-compiled
3674 packages plus the required metadata.
3675 You also need package manipulation tools on the target.
3676 The build machine is a likely candidate to act as the server.
3677 However, that machine does not necessarily have to be the
3678 package server.
3679 The build machine could push its artifacts to another machine
3680 that acts as the server (e.g. Internet-facing).
3681 </para>
3682
3683 <para>
3684 A simple build that targets just one device produces
3685 more than one package database.
3686 In other words, the packages produced by a build are separated
3687 out into a couple of different package groupings based on
3688 criteria such as the target's CPU architecture, the target
3689 board, or the C library used on the target.
3690 For example, a build targeting the <filename>qemuarm</filename>
3691 device produces the following three package databases:
3692 <filename>all</filename>, <filename>armv5te</filename>, and
3693 <filename>qemuarm</filename>.
3694 If you wanted your <filename>qemuarm</filename> device to be
3695 aware of all the packages that were available to it,
3696 you would need to point it to each of these databases
3697 individually.
3698 In a similar way, a traditional Linux distribution usually is
3699 configured to be aware of a number of software repositories
3700 from which it retrieves packages.
3701 </para>
3702
3703 <para>
3704 Using runtime package management is completely optional and
3705 not required for a successful build or deployment in any
3706 way.
3707 But if you want to make use of runtime package management,
3708 you need to do a couple things above and beyond the basics.
3709 The remainder of this section describes what you need to do.
3710 </para>
3711
3712 <section id='runtime-package-management-build'>
3713 <title>Build Considerations</title>
3714
3715 <para>
3716 This section describes build considerations that you need
3717 to be aware of in order to provide support for runtime
3718 package management.
3719 </para>
3720
3721 <para>
3722 When BitBake generates packages it needs to know
3723 what format(s) to use.
3724 In your configuration, you use the
3725 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>
3726 variable to specify the format.
3727 <note>
3728 You can choose to have more than one format but you must
3729 provide at least one.
3730 </note>
3731 </para>
3732
3733 <para>
3734 If you would like your image to start off with a basic
3735 package database of the packages in your current build
3736 as well as have the relevant tools available on the
3737 target for runtime package management, you can include
3738 "package-management" in the
3739 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
3740 variable.
3741 Including "package-management" in this
3742 configuration variable ensures that when the image
3743 is assembled for your target, the image includes
3744 the currently-known package databases as well as
3745 the target-specific tools required for runtime
3746 package management to be performed on the target.
3747 However, this is not strictly necessary.
3748 You could start your image off without any databases
3749 but only include the required on-target package
3750 tool(s).
3751 As an example, you could include "opkg" in your
3752 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
3753 variable if you are using the IPK package format.
3754 You can then initialize your target's package database(s)
3755 later once your image is up and running.
3756 </para>
3757
3758 <para>
3759 Whenever you perform any sort of build step that can
3760 potentially generate a package or modify an existing
3761 package, it is always a good idea to re-generate the
3762 package index with:
3763 <literallayout class='monospaced'>
3764 $ bitbake package-index
3765 </literallayout>
3766 Realize that it is not sufficient to simply do the
3767 following:
3768 <literallayout class='monospaced'>
3769 $ bitbake &lt;some-package&gt; package-index
3770 </literallayout>
3771 This is because BitBake does not properly schedule the
3772 <filename>package-index</filename> target fully after any
3773 other target has completed.
3774 Thus, be sure to run the package update step separately.
3775 </para>
3776
3777 <para>
3778 As described below in the
3779 "<link linkend='runtime-package-management-target-ipk'>Using IPK</link>"
3780 section, if you are using IPK as your package format, you
3781 can make use of the
3782 <filename>distro-feed-configs</filename> recipe provided
3783 by <filename>meta-oe</filename> in order to configure your
3784 target to use your IPK databases.
3785 </para>
3786
3787 <para>
3788 When your build is complete, your packages reside in the
3789 <filename>${TMPDIR}/deploy/&lt;package-format&gt;</filename>
3790 directory.
3791 For example, if <filename>${TMPDIR}</filename>
3792 is <filename>tmp</filename> and your selected package type
3793 is IPK, then your IPK packages are available in
3794 <filename>tmp/deploy/ipk</filename>.
3795 </para>
3796 </section>
3797
3798 <section id='runtime-package-management-server'>
3799 <title>Host or Server Machine Setup</title>
3800
3801 <para>
3802 Typically, packages are served from a server using
3803 HTTP.
3804 However, other protocols are possible.
3805 If you want to use HTTP, then setup and configure a
3806 web server, such as Apache 2 or lighttpd, on the machine
3807 serving the packages.
3808 </para>
3809
3810 <para>
3811 As previously mentioned, the build machine can act as the
3812 package server.
3813 In the following sections that describe server machine
3814 setups, the build machine is assumed to also be the server.
3815 </para>
3816
3817 <section id='package-server-apache'>
3818 <title>Serving Packages via Apache 2</title>
3819
3820 <para>
3821 This example assumes you are using the Apache 2
3822 server:
3823 <orderedlist>
3824 <listitem><para>
3825 Add the directory to your Apache
3826 configuration, which you can find at
3827 <filename>/etc/httpd/conf/httpd.conf</filename>.
3828 Use commands similar to these on the
3829 development system.
3830 These example commands assume a top-level
3831 <link linkend='source-directory'>Source Directory</link>
3832 named <filename>poky</filename> in your home
3833 directory.
3834 The example also assumes an RPM package type.
3835 If you are using a different package type, such
3836 as IPK, use "ipk" in the pathnames:
3837 <literallayout class='monospaced'>
3838 &lt;VirtualHost *:80&gt;
3839 ....
3840 Alias /rpm ~/poky/build/tmp/deploy/rpm
3841 &lt;Directory "~/poky/build/tmp/deploy/rpm"&gt;
3842 Options +Indexes
3843 &lt;/Directory&gt;
3844 &lt;/VirtualHost&gt;
3845 </literallayout></para></listitem>
3846 <listitem><para>
3847 Reload the Apache configuration as described
3848 in this step.
3849 For all commands, be sure you have root
3850 privileges.
3851 </para>
3852
3853 <para>
3854 If your development system is using Fedora or
3855 CentOS, use the following:
3856 <literallayout class='monospaced'>
3857 # service httpd reload
3858 </literallayout>
3859 For Ubuntu and Debian, use the following:
3860 <literallayout class='monospaced'>
3861 # /etc/init.d/apache2 reload
3862 </literallayout>
3863 For OpenSUSE, use the following:
3864 <literallayout class='monospaced'>
3865 # /etc/init.d/apache2 reload
3866 </literallayout></para></listitem>
3867 <listitem><para>
3868 If you are using Security-Enhanced Linux
3869 (SELinux), you need to label the files as
3870 being accessible through Apache.
3871 Use the following command from the development
3872 host.
3873 This example assumes RPM package types:
3874 <literallayout class='monospaced'>
3875 # chcon -R -h -t httpd_sys_content_t tmp/deploy/rpm
3876 </literallayout></para></listitem>
3877 </orderedlist>
3878 </para>
3879 </section>
3880
3881 <section id='package-server-lighttpd'>
3882 <title>Serving Packages via lighttpd</title>
3883
3884 <para>
3885 If you are using lighttpd, all you need
3886 to do is to provide a link from your
3887 <filename>${TMPDIR}/deploy/&lt;package-format&gt;</filename>
3888 directory to lighttpd's document-root.
3889 You can determine the specifics of your lighttpd
3890 installation by looking through its configuration file,
3891 which is usually found at:
3892 <filename>/etc/lighttpd/lighttpd.conf</filename>.
3893 </para>
3894
3895 <para>
3896 For example, if you are using IPK, lighttpd's
3897 document-root is set to
3898 <filename>/var/www/lighttpd</filename>, and you had
3899 packages for a target named "BOARD",
3900 then you might create a link from your build location
3901 to lighttpd's document-root as follows:
3902 <literallayout class='monospaced'>
3903 # ln -s $(PWD)/tmp/deploy/ipk /var/www/lighttpd/BOARD-dir
3904 </literallayout>
3905 </para>
3906
3907 <para>
3908 At this point, you need to start the lighttpd server.
3909 The method used to start the server varies by
3910 distribution.
3911 However, one basic method that starts it by hand is:
3912 <literallayout class='monospaced'>
3913 # lighttpd -f /etc/lighttpd/lighttpd.conf
3914 </literallayout>
3915 </para>
3916 </section>
3917 </section>
3918
3919 <section id='runtime-package-management-target'>
3920 <title>Target Setup</title>
3921
3922 <para>
3923 Setting up the target differs depending on the
3924 package management system.
3925 This section provides information for RPM and IPK.
3926 </para>
3927
3928 <section id='runtime-package-management-target-rpm'>
3929 <title>Using RPM</title>
3930
3931 <para>
3932 The application for performing runtime package
3933 management of RPM packages on the target is called
3934 <filename>smart</filename>.
3935 </para>
3936
3937 <para>
3938 On the target machine, you need to inform
3939 <filename>smart</filename> of every package database
3940 you want to use.
3941 As an example, suppose your target device can use the
3942 following three package databases from a server named
3943 <filename>server.name</filename>:
3944 <filename>all</filename>, <filename>i586</filename>,
3945 and <filename>qemux86</filename>.
3946 Given this example, issue the following commands on the
3947 target:
3948 <literallayout class='monospaced'>
3949 # smart channel --add all type=rpm-md baseurl=http://server.name/rpm/all
3950 # smart channel --add i585 type=rpm-md baseurl=http://server.name/rpm/i586
3951 # smart channel --add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
3952 </literallayout>
3953 Also from the target machine, fetch the repository
3954 information using this command:
3955 <literallayout class='monospaced'>
3956 # smart update
3957 </literallayout>
3958 You can now use the <filename>smart query</filename>
3959 and <filename>smart install</filename> commands to
3960 find and install packages from the repositories.
3961 </para>
3962 </section>
3963
3964 <section id='runtime-package-management-target-ipk'>
3965 <title>Using IPK</title>
3966
3967 <para>
3968 The application for performing runtime package
3969 management of IPK packages on the target is called
3970 <filename>opkg</filename>.
3971 </para>
3972
3973 <para>
3974 In order to inform <filename>opkg</filename> of the
3975 package databases you want to use, simply create one
3976 or more <filename>*.conf</filename> files in the
3977 <filename>/etc/opkg</filename> directory on the target.
3978 The <filename>opkg</filename> application uses them
3979 to find its available package databases.
3980 As an example, suppose you configured your HTTP server
3981 on your machine named
3982 <filename>www.mysite.com</filename> to serve files
3983 from a <filename>BOARD-dir</filename> directory under
3984 its document-root.
3985 In this case, you might create a configuration
3986 file on the target called
3987 <filename>/etc/opkg/base-feeds.conf</filename> that
3988 contains:
3989 <literallayout class='monospaced'>
3990 src/gz all http://www.mysite.com/BOARD-dir/all
3991 src/gz armv7a http://www.mysite.com/BOARD-dir/armv7a
3992 src/gz beagleboard http://www.mysite.com/BOARD-dir/beagleboard
3993 </literallayout>
3994 </para>
3995
3996 <para>
3997 As a way of making it easier to generate and make
3998 these IPK configuration files available on your
3999 target, the <filename>meta-oe</filename> layer
4000 provides a recipe called
4001 <filename>distro-feed-configs</filename>, which
4002 provides a package by the same name.
4003 When you include this package into your image, it will
4004 automatically generate and include a set of
4005 <filename>*.conf</filename> files in the image's
4006 <filename>/etc/opkg</filename> directory that will
4007 provide your target's <filename>opkg</filename>
4008 tool with any and all package databases your build will
4009 generate.
4010 The only catch is that this recipe cannot possibly
4011 imagine your server's DNS name/IP address.
4012 Consequently, somewhere in your configuration you need
4013 to set a variable called
4014 <filename>DISTRO_FEED_URI</filename> to point
4015 to your server and the location within the
4016 document-root that contains the databases.
4017 For example: if you are serving your packages over HTTP,
4018 your server's IP address is 192.168.7.1, and your
4019 databases are located in a directory called
4020 <filename>BOARD-dir</filename> underneath your HTTP
4021 server's document-root, you need to set
4022 <filename>DISTRO_FEED_URI</filename> to
4023 <filename>http://192.168.7.1/BOARD-dir</filename>.
4024 </para>
4025
4026 <para>
4027 On the target machine, fetch (or refresh) the
4028 repository information using this command:
4029 <literallayout class='monospaced'>
4030 # opkg update
4031 </literallayout>
4032 You can now use the <filename>opkg list</filename> and
4033 <filename>opkg install</filename> commands to find and
4034 install packages from the repositories.
4035 </para>
4036 </section>
4037 </section>
4038 </section>
4039
4040 <section id='testing-packages-with-ptest'>
4041 <title>Testing Packages With ptest</title>
4042
4043 <para>
4044 A Package Test (ptest) runs tests against packages built
4045 by the OpenEmbedded build system on the target machine.
4046 A ptest contains at least two items: the actual test, and
4047 a shell script (<filename>run-ptest</filename>) that starts
4048 the test.
4049 The shell script that starts the test must not contain
4050 the actual test, the script only starts it.
4051 On the other hand, the test can be anything from a simple
4052 shell script that runs a binary and checks the output to
4053 an elaborate system of test binaries and data files.
4054 </para>
4055
4056 <para>
4057 The test generates output in the format used by
4058 Automake:
4059 <literallayout class='monospaced'>
4060 &lt;result&gt;: &lt;testname&gt;
4061 </literallayout>
4062 where the result can be <filename>PASS</filename>,
4063 <filename>FAIL</filename>, or <filename>SKIP</filename>,
4064 and the testname can be any identifying string.
4065 </para>
4066
4067 <note>
4068 With this release of the Yocto Project, three recipes exist
4069 that are "ptest-enabled": <filename>bash</filename>,
4070 <filename>glib-2.0</filename>, and
4071 <filename>dbus</filename>.
4072 These three recipes are Autotool-enabled.
4073 </note>
4074
4075 <section id='adding-ptest-to-your-build'>
4076 <title>Adding ptest to Your Build</title>
4077
4078 <para>
4079 To add package testing to your build, add the
4080 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
4081 and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
4082 variables to your <filename>local.conf</filename> file,
4083 which is found in the
4084 <link linkend='build-directory'>Build Directory</link>:
4085 <literallayout class='monospaced'>
4086 DISTRO_FEATURES_append = " ptest"
4087 EXTRA_IMAGE_FEATURES += "ptest-pkgs"
4088 </literallayout>
4089 Once your build is complete, the ptest files are installed
4090 into the <filename>/usr/lib/&lt;package&gt;/ptest</filename>
4091 directory within the image, where
4092 <filename>&lt;package&gt;</filename> is the name of the
4093 package.
4094 </para>
4095 </section>
4096
4097 <section id='running-ptest'>
4098 <title>Running ptest</title>
4099
4100 <para>
4101 The <filename>ptest-runner</filename> package installs a
4102 shell script that loops through all installed ptest test
4103 suites and runs them in sequence.
4104 Consequently, you might want to add this package to
4105 your image.
4106 </para>
4107 </section>
4108
4109 <section id='getting-your-package-ready'>
4110 <title>Getting Your Package Ready</title>
4111
4112 <para>
4113 In order to enable a recipe to run installed ptests
4114 on target hardware,
4115 you need to prepare the recipes that build the packages
4116 you want to test.
4117 Here is what you have to do for each recipe:
4118 <itemizedlist>
4119 <listitem><para><emphasis>Be sure the recipe
4120 inherits ptest:</emphasis>
4121 Include the following line in each recipe:
4122 <literallayout class='monospaced'>
4123 inherit ptest
4124 </literallayout>
4125 </para></listitem>
4126 <listitem><para><emphasis>Create <filename>run-ptest</filename>:</emphasis>
4127 This script starts your test.
4128 Locate the script where you will refer to it
4129 using
4130 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
4131 Here is an example that starts a test for
4132 <filename>dbus</filename>:
4133 <literallayout class='monospaced'>
4134 #!/bin/sh
4135 cd test
4136 make -k runtest-TESTS
4137 </literallayout>
4138 </para></listitem>
4139 <listitem><para><emphasis>Ensure dependencies are
4140 met:</emphasis>
4141 If the test adds build or runtime dependencies
4142 that normally do not exist for the package
4143 (such as requiring "make" to run the test suite),
4144 use the
4145 <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>
4146 and
4147 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>
4148 variables in your recipe in order for the package
4149 to meet the dependencies.
4150 Here is an example where the package has a runtime
4151 dependency on "make":
4152 <literallayout class='monospaced'>
4153 RDEPENDS_${PN}-ptest += "make"
4154 </literallayout>
4155 </para></listitem>
4156 <listitem><para><emphasis>Add a function to build the
4157 test suite:</emphasis>
4158 Not many packages support cross-compilation of
4159 their test suites.
4160 Consequently, you usually need to add a
4161 cross-compilation function to the package.
4162 </para>
4163 <para>Many packages based on Automake compile and
4164 run the test suite by using a single command
4165 such as <filename>make check</filename>.
4166 However, the native <filename>make check</filename>
4167 builds and runs on the same computer, while
4168 cross-compiling requires that the package is built
4169 on the host but executed on the target.
4170 The built version of Automake that ships with the
4171 Yocto Project includes a patch that separates
4172 building and execution.
4173 Consequently, packages that use the unaltered,
4174 patched version of <filename>make check</filename>
4175 automatically cross-compiles.</para>
4176 <para>However, you still must add a
4177 <filename>do_compile_ptest</filename> function to
4178 build the test suite.
4179 Add a function similar to the following to your
4180 recipe:
4181 <literallayout class='monospaced'>
4182 do_compile_ptest() {
4183 oe_runmake buildtest-TESTS
4184 }
4185 </literallayout>
4186 </para></listitem>
4187 <listitem><para><emphasis>Ensure special configurations
4188 are set:</emphasis>
4189 If the package requires special configurations
4190 prior to compiling the test code, you must
4191 insert a <filename>do_configure_ptest</filename>
4192 function into the recipe.
4193 </para></listitem>
4194 <listitem><para><emphasis>Install the test
4195 suite:</emphasis>
4196 The <filename>ptest.bbclass</filename> class
4197 automatically copies the file
4198 <filename>run-ptest</filename> to the target and
4199 then runs make <filename>install-ptest</filename>
4200 to run the tests.
4201 If this is not enough, you need to create a
4202 <filename>do_install_ptest</filename> function and
4203 make sure it gets called after the
4204 "make install-ptest" completes.
4205 </para></listitem>
4206 </itemizedlist>
4207 </para>
4208 </section>
4209 </section>
4210 </section>
4211
4212 <section id="building-software-from-an-external-source">
4213 <title>Building Software from an External Source</title>
4214
4215 <para>
4216 By default, the OpenEmbedded build system uses the
4217 <link linkend='build-directory'>Build Directory</link> to
4218 build source code.
4219 The build process involves fetching the source files, unpacking
4220 them, and then patching them if necessary before the build takes
4221 place.
4222 </para>
4223
4224 <para>
4225 Situations exist where you might want to build software from source
4226 files that are external to and thus outside of the
4227 OpenEmbedded build system.
4228 For example, suppose you have a project that includes a new BSP with
4229 a heavily customized kernel.
4230 And, you want to minimize exposing the build system to the
4231 development team so that they can focus on their project and
4232 maintain everyone's workflow as much as possible.
4233 In this case, you want a kernel source directory on the development
4234 machine where the development occurs.
4235 You want the recipe's
4236 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
4237 variable to point to the external directory and use it as is, not
4238 copy it.
4239 </para>
4240
4241 <para>
4242 To build from software that comes from an external source, all you
4243 need to do is inherit
4244 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink>
4245 and then set the
4246 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC'><filename>EXTERNALSRC</filename></ulink>
4247 variable to point to your external source code.
4248 Here are the statements to put in your
4249 <filename>local.conf</filename> file:
4250 <literallayout class='monospaced'>
4251 INHERIT += "externalsrc"
4252 EXTERNALSRC_pn-myrecipe = "/some/path/to/your/source/tree"
4253 </literallayout>
4254 </para>
4255
4256 <para>
4257 By default, <filename>externalsrc.bbclass</filename> builds
4258 the source code in a directory separate from the external source
4259 directory as specified by
4260 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC'><filename>EXTERNALSRC</filename></ulink>.
4261 If you need to have the source built in the same directory in
4262 which it resides, or some other nominated directory, you can set
4263 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC_BUILD'><filename>EXTERNALSRC_BUILD</filename></ulink>
4264 to point to that directory:
4265 <literallayout class='monospaced'>
4266 EXTERNALSRC_BUILD_pn-myrecipe = "/path/to/my/source/tree"
4267 </literallayout>
4268 </para>
4269 </section>
4270
4271 <section id="selecting-an-initialization-manager">
4272 <title>Selecting an Initialization Manager</title>
4273
4274 <para>
4275 By default, the Yocto Project uses
4276 <filename>SysVinit</filename> as the initialization manager.
4277 However, support also exists for <filename>systemd</filename>,
4278 which is a full replacement for <filename>init</filename> with
4279 parallel starting of services, reduced shell overhead and other
4280 features that are used by many distributions.
4281 </para>
4282
4283 <para>
4284 If you want to use <filename>sysvinit</filename>, you do
4285 not have to do anything.
4286 But, if you want to use <filename>systemd</filename>, you must
4287 take some steps as described in the following sections.
4288 </para>
4289
4290<!--
4291 <note>
4292 It is recommended that you create your own distribution configuration
4293 file to hold these settings instead of using your
4294 <filename>local.conf</filename> file.
4295 For information on creating your own distribution, see the
4296 "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>"
4297 section.
4298 </note>
4299-->
4300
4301 <section id='using-systemd-exclusively'>
4302 <title>Using systemd Exclusively</title>
4303
4304 <para>
4305 Set the following variables in your distribution configuration
4306 file as follows:
4307 <literallayout class='monospaced'>
4308 DISTRO_FEATURES_append = " systemd"
4309 VIRTUAL-RUNTIME_init_manager = "systemd"
4310 </literallayout>
4311 You can also prevent the <filename>sysvinit</filename>
4312 distribution feature from
4313 being automatically enabled as follows:
4314 <literallayout class='monospaced'>
4315 DISTRO_FEATURES_BACKFILL_CONSIDERED = "sysvinit"
4316 </literallayout>
4317 Doing so removes any redundant <filename>sysvinit</filename>
4318 scripts.
4319 </para>
4320
4321 <para>
4322 For information on the backfill variable, see
4323 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></ulink>
4324 in the Yocto Project Reference Manual.
4325 </para>
4326 </section>
4327
4328 <section id='using-systemd-for-the-main-image-and-using-sysvinit-for-the-rescue-image'>
4329 <title>Using systemd for the Main Image and Using SysVinit for the Rescue Image</title>
4330
4331 <para>
4332 Set the following variables in your distribution configuration
4333 file as follows:
4334 <literallayout class='monospaced'>
4335 DISTRO_FEATURES_append = " systemd"
4336 VIRTUAL-RUNTIME_init_manager = "systemd"
4337 </literallayout>
4338 Doing so causes your main image to use the
4339 <filename>packagegroup-core-boot.bb</filename> recipe and
4340 <filename>systemd</filename>.
4341 The rescue/minimal image cannot use this package group.
4342 However, it can install <filename>sysvinit</filename>
4343 and the appropriate packages will have support for both
4344 <filename>systemd</filename> and <filename>sysvinit</filename>.
4345 </para>
4346 </section>
4347 </section>
4348
4349 <section id='excluding-recipes-from-the-build'>
4350 <title>Excluding Recipes From the Build</title>
4351
4352 <para>
4353 You might find that there are groups of recipes or append files
4354 that you want to filter out of the build process.
4355 Usually, this is not necessary.
4356 However, on rare occasions where you might want to use a
4357 layer but exclude parts that are causing problems, such
4358 as introducing a different version of a recipe, you can
4359 use
4360 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'><filename>BBMASK</filename></ulink>
4361 to exclude the recipe.
4362 </para>
4363
4364 <para>
4365 It is possible to filter or mask out <filename>.bb</filename> and
4366 <filename>.bbappend</filename> files.
4367 You can do this by providing an expression with the
4368 <filename>BBMASK</filename> variable.
4369 Here is an example:
4370 <literallayout class='monospaced'>
4371 BBMASK = "/meta-mymachine/recipes-maybe/"
4372 </literallayout>
4373 Here, all <filename>.bb</filename> and
4374 <filename>.bbappend</filename> files in the directory that match
4375 the expression are ignored during the build process.
4376 </para>
4377
4378 <note>
4379 The value you provide is passed to Python's regular expression
4380 compiler.
4381 The expression is compared against the full paths to the files.
4382 For complete syntax information, see Python's documentation at
4383 <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
4384 </note>
4385 </section>
4386
4387 <section id="platdev-appdev-srcrev">
4388 <title>Using an External SCM</title>
4389
4390 <para>
4391 If you're working on a recipe that pulls from an external Source Code Manager (SCM), it
4392 is possible to have the OpenEmbedded build system notice new recipe changes added to the
4393 SCM and then build the resulting package that depends on the new recipes by using the latest
4394 versions.
4395 This only works for SCMs from which it is possible to get a sensible revision number for changes.
4396 Currently, you can do this with Apache Subversion (SVN), Git, and Bazaar (BZR) repositories.
4397 </para>
4398
4399 <para>
4400 To enable this behavior, simply add the following to the <filename>local.conf</filename>
4401 configuration file found in the
4402 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
4403 <literallayout class='monospaced'>
4404 SRCREV_pn-&lt;PN&gt; = "${AUTOREV}"
4405 </literallayout>
4406 where <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>
4407 is the name of the recipe for which you want to enable automatic source
4408 revision updating.
4409 </para>
4410 </section>
4411
4412 <section id='creating-a-read-only-root-filesystem'>
4413 <title>Creating a Read-Only Root Filesystem</title>
4414
4415 <para>
4416 Suppose, for security reasons, you need to disable
4417 your target device's root filesystem's write permissions
4418 (i.e. you need a read-only root filesystem).
4419 Or, perhaps you are running the device's operating system
4420 from a read-only storage device.
4421 For either case, you can customize your image for
4422 that behavior.
4423 </para>
4424
4425 <note>
4426 Supporting a read-only root filesystem requires that the system and
4427 applications do not try to write to the root filesystem.
4428 You must configure all parts of the target system to write
4429 elsewhere, or to gracefully fail in the event of failing to
4430 write to the root filesystem.
4431 </note>
4432
4433 <section id='creating-the-root-filesystem'>
4434 <title>Creating the Root Filesystem</title>
4435
4436 <para>
4437 To create the read-only root filesystem, simply add the
4438 <filename>read-only-rootfs</filename> feature to your image.
4439 Using either of the following statements in your
4440 image recipe or from within the
4441 <filename>local.conf</filename> file found in the
4442 <link linkend='build-directory'>Build Directory</link>
4443 causes the build system to create a read-only root filesystem:
4444 <literallayout class='monospaced'>
4445 IMAGE_FEATURES = "read-only-rootfs"
4446 </literallayout>
4447 or
4448 <literallayout class='monospaced'>
4449 EXTRA_IMAGE_FEATURES = "read-only-rootfs"
4450 </literallayout>
4451 </para>
4452
4453 <para>
4454 For more information on how to use these variables, see the
4455 "<link linkend='usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></link>"
4456 section.
4457 For information on the variables, see
4458 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
4459 and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>.
4460 </para>
4461 </section>
4462
4463 <section id='post-installation-scripts'>
4464 <title>Post-Installation Scripts</title>
4465
4466 <para>
4467 It is very important that you make sure all
4468 post-Installation (<filename>pkg_postinst</filename>) scripts
4469 for packages that are installed into the image can be run
4470 at the time when the root filesystem is created during the
4471 build on the host system.
4472 These scripts cannot attempt to run during first-boot on the
4473 target device.
4474 With the <filename>read-only-rootfs</filename> feature enabled,
4475 the build system checks during root filesystem creation to make
4476 sure all post-installation scripts succeed.
4477 If any of these scripts still need to be run after the root
4478 filesystem is created, the build immediately fails.
4479 These checks during build time ensure that the build fails
4480 rather than the target device fails later during its
4481 initial boot operation.
4482 </para>
4483
4484 <para>
4485 Most of the common post-installation scripts generated by the
4486 build system for the out-of-the-box Yocto Project are engineered
4487 so that they can run during root filesystem creation
4488 (e.g. post-installation scripts for caching fonts).
4489 However, if you create and add custom scripts, you need
4490 to be sure they can be run during file system creation.
4491 </para>
4492
4493 <para>
4494 Here are some common problems that prevent
4495 post-installation scripts from running during root filesystem
4496 creation:
4497 <itemizedlist>
4498 <listitem><para><emphasis>Not using $D in front of absolute paths:</emphasis>
4499 The build system defines
4500 <filename>$</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'><filename>D</filename></ulink>
4501 at root filesystem creation time, and
4502 it is blank when run on the target device.
4503 This implies two purposes for <filename>$D</filename>:
4504 ensuring paths are valid in both the host and target
4505 environments, and checking to determine which
4506 environment is being used as a method for taking
4507 appropriate actions.
4508 </para></listitem>
4509 <listitem><para><emphasis>Attempting to run processes that are
4510 specific to or dependent on the target
4511 architecture:</emphasis>
4512 You can work around these attempts by using native
4513 tools to accomplish the same tasks, or
4514 by alternatively running the processes under QEMU,
4515 which has the <filename>qemu_run_binary</filename>
4516 function.
4517 For more information, see the
4518 <filename>meta/classes/qemu.bbclass</filename>
4519 class in the
4520 <link linkend='source-directory'>Source Directory</link>.
4521 </para></listitem>
4522 </itemizedlist>
4523 </para>
4524 </section>
4525
4526 <section id='areas-with-write-access'>
4527 <title>Areas With Write Access</title>
4528
4529 <para>
4530 With the <filename>read-only-rootfs</filename> feature enabled,
4531 any attempt by the target to write to the root filesystem at
4532 runtime fails.
4533 Consequently, you must make sure that you configure processes
4534 and applications that attempt these types of writes do so
4535 to directories with write access (e.g.
4536 <filename>/tmp</filename> or <filename>/var/run</filename>).
4537 </para>
4538 </section>
4539 </section>
4540
4541 <section id="performing-automated-runtime-testing">
4542 <title>Performing Automated Runtime Testing</title>
4543
4544 <para>
4545 The OpenEmbedded build system makes available a series of automated
4546 tests for images to verify runtime functionality.
4547 <note>
4548 Currently, there is only support for running these tests
4549 under QEMU.
4550 </note>
4551 These tests are written in Python making use of the
4552 <filename>unittest</filename> module, and the majority of them
4553 run commands on the target system over
4554 <filename>ssh</filename>.
4555 This section describes how you set up the environment to use these
4556 tests, run available tests, and write and add your own tests.
4557 </para>
4558
4559 <section id="qemu-image-enabling-tests">
4560 <title>Enabling Tests</title>
4561
4562 <para>
4563 In order to run tests, you need to do the following:
4564 <itemizedlist>
4565 <listitem><para><emphasis>Set up to avoid interaction
4566 with <filename>sudo</filename> for networking:</emphasis>
4567 To accomplish this, you must do one of the
4568 following:
4569 <itemizedlist>
4570 <listitem><para>Add
4571 <filename>NOPASSWD</filename> for your user
4572 in <filename>/etc/sudoers</filename> either for
4573 ALL commands or just for
4574 <filename>runqemu-ifup</filename>.
4575 You must provide the full path as that can
4576 change if you are using multiple clones of the
4577 source repository.
4578 <note>
4579 On some distributions, you also need to
4580 comment out "Defaults requiretty" in
4581 <filename>/etc/sudoers</filename>.
4582 </note></para></listitem>
4583 <listitem><para>Manually configure a tap interface
4584 for your system.</para></listitem>
4585 <listitem><para>Run as root the script in
4586 <filename>scripts/runqemu-gen-tapdevs</filename>,
4587 which should generate a list of tap devices.
4588 This is the option typically chosen for
4589 Autobuilder-type environments.
4590 </para></listitem>
4591 </itemizedlist></para></listitem>
4592 <listitem><para><emphasis>Set the
4593 <filename>DISPLAY</filename> variable:</emphasis>
4594 You need to set this variable so that you have an X
4595 server available (e.g. start
4596 <filename>vncserver</filename> for a headless machine).
4597 </para></listitem>
4598 <listitem><para><emphasis>Be sure your host's firewall
4599 accepts incoming connections from
4600 192.168.7.0/24:</emphasis>
4601 Some of the tests (in particular smart tests) start a
4602 HTTP server on a random high number port, which is
4603 used to serve files to the target.
4604 The smart module serves
4605 <filename>${DEPLOY_DIR}/rpm</filename> so it can run
4606 smart channel commands. That means your host's firewall
4607 must accept incoming connections from 192.168.7.0/24,
4608 which is the default IP range used for tap devices
4609 by <filename>runqemu</filename>.</para></listitem>
4610 </itemizedlist>
4611 </para>
4612
4613 <note>
4614 Regardless of how you initiate the tests, if you built your
4615 image using <filename>rm_work</filename>,
4616 most of the tests will fail with errors because they rely on
4617 <filename>${WORKDIR}/installed_pkgs.txt</filename>.
4618 </note>
4619 </section>
4620
4621 <section id="qemu-image-running-tests">
4622 <title>Running Tests</title>
4623
4624 <para>
4625 You can start the tests automatically or manually:
4626 <itemizedlist>
4627 <listitem><para><emphasis>Automatically Running Tests:</emphasis>
4628 To run the tests automatically after the
4629 OpenEmbedded build system successfully creates an image,
4630 first set the
4631 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink>
4632 variable to "1" in your <filename>local.conf</filename>
4633 file in the
4634 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
4635 <literallayout class='monospaced'>
4636 TEST_IMAGE = "1"
4637 </literallayout>
4638 Next, simply build your image.
4639 If the image successfully builds, the tests will be
4640 run:
4641 <literallayout class='monospaced'>
4642 bitbake core-image-sato
4643 </literallayout></para></listitem>
4644 <listitem><para><emphasis>Manually Running Tests:</emphasis>
4645 To manually run the tests, first globally inherit
4646 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-testimage'><filename>testimage.class</filename></ulink>
4647 by editing your <filename>local.conf</filename> file:
4648 <literallayout class='monospaced'>
4649 INHERIT += "testimage"
4650 </literallayout>
4651 Next, use BitBake to run the tests:
4652 <literallayout class='monospaced'>
4653 bitbake -c testimage &lt;image&gt;
4654 </literallayout></para></listitem>
4655 </itemizedlist>
4656 </para>
4657
4658 <para>
4659 Regardless of how you run the tests, once they start, the
4660 following happens:
4661 <itemizedlist>
4662 <listitem><para>A copy of the root filesystem is written
4663 to <filename>${WORKDIR}/testimage</filename>.
4664 </para></listitem>
4665 <listitem><para>The image is booted under QEMU using the
4666 standard <filename>runqemu</filename> script.
4667 </para></listitem>
4668 <listitem><para>A default timeout of 500 seconds occurs
4669 to allow for the boot process to reach the login prompt.
4670 You can change the timeout period by setting
4671 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_QEMUBOOT_TIMEOUT'><filename>TEST_QEMUBOOT_TIMEOUT</filename></ulink>
4672 in the <filename>local.conf</filename> file.
4673 </para></listitem>
4674 <listitem><para>Once the boot process is reached and the
4675 login prompt appears, the tests run.
4676 The full boot log is written to
4677 <filename>${WORKDIR}/testimage/qemu_boot_log</filename>.
4678 </para></listitem>
4679 <listitem><para>Each test module loads in the order found
4680 in <filename>TEST_SUITES</filename>.
4681 You can find the full output of the commands run over
4682 <filename>ssh</filename> in
4683 <filename>${WORKDIR}/testimgage/ssh_target_log</filename>.
4684 </para></listitem>
4685 <listitem><para>If no failures occur, the task running the
4686 tests ends successfully.
4687 You can find the output from the
4688 <filename>unittest</filename> in the task log at
4689 <filename>${WORKDIR}/temp/log.do_testimage</filename>.
4690 </para></listitem>
4691 </itemizedlist>
4692 </para>
4693
4694 <para>
4695 All test files reside in
4696 <filename>meta/lib/oeqa/runtime</filename> in the
4697 <link linkend='source-directory'>Source Directory</link>.
4698 A test name maps directly to a Python module.
4699 Each test module may contain a number of individual tests.
4700 Tests are usually grouped together by the area
4701 tested (e.g tests for <filename>systemd</filename> reside in
4702 <filename>meta/lib/oeqa/runtime/systemd.py</filename>).
4703 </para>
4704
4705 <para>
4706 You can add tests to any layer provided you place them in the
4707 proper area and you extend
4708 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink>
4709 in the <filename>local.conf</filename> file as normal.
4710 Be sure that tests reside in
4711 <filename>&lt;layer&gt;/lib/oeqa/runtime</filename>.
4712 <note>
4713 Be sure that module names do not collide with module names
4714 used in the default set of test modules in
4715 <filename>meta/lib/oeqa/runtime</filename>.
4716 </note>
4717 </para>
4718
4719 <para>
4720 You can change the set of tests run by appending or overriding
4721 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_SUITES'><filename>TEST_SUITES</filename></ulink>
4722 variable in <filename>local.conf</filename>.
4723 Each name in <filename>TEST_SUITES</filename> represents a
4724 required test for the image.
4725 Test modules named within <filename>TEST_SUITES</filename>
4726 cannot be skipped even if a test is not suitable for an image
4727 (e.g. running the rpm tests on an image without
4728 <filename>rpm</filename>).
4729 Appending "auto" to <filename>TEST_SUITES</filename> causes the
4730 build system to try to run all tests that are suitable for the
4731 image (i.e. each test module may elect to skip itself).
4732 </para>
4733
4734 <para>
4735 The order you list tests in <filename>TEST_SUITES</filename>
4736 is important.
4737 The order influences test dependencies.
4738 Consequently, tests that depend on other tests should be added
4739 after the test on which they depend.
4740 For example, since <filename>ssh</filename> depends on the
4741 <filename>ping</filename> test, <filename>ssh</filename>
4742 needs to come after <filename>ping</filename> in the list.
4743 The test class provides no re-ordering or dependency handling.
4744 <note>
4745 Each module can have multiple classes with multiple test
4746 methods.
4747 And, Python <filename>unittest</filename> rules apply.
4748 </note>
4749 </para>
4750
4751 <para>
4752 Here are some things to keep in mind when running tests:
4753 <itemizedlist>
4754 <listitem><para>The default tests for the image are defined
4755 as:
4756 <literallayout class='monospaced'>
4757 DEFAULT_TEST_SUITES_pn-&lt;image&gt; = "ping ssh df connman syslog xorg scp vnc date rpm smart dmesg"
4758 </literallayout></para></listitem>
4759 <listitem><para>Add your own test to the list of the
4760 by using the following:
4761 <literallayout class='monospaced'>
4762 TEST_SUITES_append = " mytest"
4763 </literallayout></para></listitem>
4764 <listitem><para>Run a specific list of tests as follows:
4765 <literallayout class='monospaced'>
4766 TEST_SUITES = "test1 test2 test3"
4767 </literallayout>
4768 Remember, order is important.
4769 Be sure to place a test that is dependent on another test
4770 later in the order.</para></listitem>
4771 </itemizedlist>
4772 </para>
4773 </section>
4774
4775 <section id="qemu-image-writing-new-tests">
4776 <title>Writing New Tests</title>
4777
4778 <para>
4779 As mentioned previously, all new test files need to be in the
4780 proper place for the build system to find them.
4781 New tests for additional functionality outside of the core
4782 should be added to the layer that adds the functionality, in
4783 <filename>&lt;layer&gt;/lib/oeqa/runtime</filename> (as
4784 long as
4785 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink>
4786 is extended in the layer's
4787 <filename>layer.conf</filename> file as normal).
4788 Just remember that filenames need to map directly to test
4789 (module) names and that you do not use module names that
4790 collide with existing core tests.
4791 </para>
4792
4793 <para>
4794 To create a new test, start by copying an existing module
4795 (e.g. <filename>syslog.py</filename> or
4796 <filename>gcc.py</filename> are good ones to use).
4797 Test modules can use code from
4798 <filename>meta/lib/oeqa/utils</filename>, which are helper
4799 classes.
4800 </para>
4801
4802 <note>
4803 Structure shell commands such that you rely on them and they
4804 return a single code for success.
4805 Be aware that sometimes you will need to parse the output.
4806 See the <filename>df.py</filename> and
4807 <filename>date.py</filename> modules for examples.
4808 </note>
4809
4810 <para>
4811 You will notice that all test classes inherit
4812 <filename>oeRuntimeTest</filename>, which is found in
4813 <filename>meta/lib/oetest.py</filename>.
4814 This base class offers some helper attributes, which are
4815 described in the following sections:
4816 </para>
4817
4818 <section id='qemu-image-writing-tests-class-methods'>
4819 <title>Class Methods</title>
4820
4821 <para>
4822 Class methods are as follows:
4823 <itemizedlist>
4824 <listitem><para><emphasis><filename>hasPackage(pkg)</filename>:</emphasis>
4825 Returns "True" if <filename>pkg</filename> is in the
4826 installed package list of the image, which is based
4827 on
4828 <filename>${WORKDIR}/installed_pkgs.txt</filename>
4829 that is generated during the
4830 <filename>do.rootfs</filename> task.
4831 </para></listitem>
4832 <listitem><para><emphasis><filename>hasFeature(feature)</filename>:</emphasis>
4833 Returns "True" if the feature is in
4834 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
4835 or
4836 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>.
4837 </para></listitem>
4838 <listitem><para><emphasis><filename>restartTarget(params)</filename>:</emphasis>
4839 Restarts the QEMU image optionally passing
4840 <filename>params</filename> to the
4841 <filename>runqemu</filename> script's
4842 <filename>qemuparams</filename> list (e.g "-m 1024" for
4843 more memory).</para></listitem>
4844 </itemizedlist>
4845 </para>
4846 </section>
4847
4848 <section id='qemu-image-writing-tests-class-attributes'>
4849 <title>Class Attributes</title>
4850
4851 <para>
4852 Class attributes are as follows:
4853 <itemizedlist>
4854 <listitem><para><emphasis><filename>pscmd</filename>:</emphasis>
4855 Equals "ps -ef" if <filename>procps</filename> is
4856 installed in the image.
4857 Otherwise, <filename>pscmd</filename> equals
4858 "ps" (busybox).
4859 </para></listitem>
4860 <listitem><para><emphasis><filename>tc</filename>:</emphasis>
4861 The called text context, which gives access to the
4862 following attributes:
4863 <itemizedlist>
4864 <listitem><para><emphasis><filename>d</filename>:</emphasis>
4865 The BitBake data store, which allows you to
4866 use stuff such as
4867 <filename>oeRuntimeTest.tc.d.getVar("VIRTUAL-RUNTIME_init_manager")</filename>.
4868 </para></listitem>
4869 <listitem><para><emphasis><filename>testslist</filename> and <filename>testsrequired</filename>:</emphasis>
4870 Used internally.
4871 The tests do not need these.
4872 </para></listitem>
4873 <listitem><para><emphasis><filename>filesdir</filename>:</emphasis>
4874 The absolute path to
4875 <filename>meta/lib/oeqa/runtime/files</filename>,
4876 which contains helper files for tests meant
4877 for copying on the target such as small
4878 files written in C for compilation.
4879 </para></listitem>
4880 <listitem><para><emphasis><filename>qemu</filename>:</emphasis>
4881 Provides access to the
4882 <filename>QemuRunner</filename> object,
4883 which is the class that boots the image.
4884 The <filename>qemu</filename> attribute
4885 provides the following useful attributes:
4886 <itemizedlist>
4887 <listitem><para><emphasis><filename>ip</filename>:</emphasis>
4888 The machine's IP address.
4889 </para></listitem>
4890 <listitem><para><emphasis><filename>host_ip</filename>:</emphasis>
4891 The host IP address, which is only
4892 used by smart tests.
4893 </para></listitem>
4894 </itemizedlist></para></listitem>
4895 <listitem><para><emphasis><filename>target</filename>:</emphasis>
4896 The <filename>SSHControl</filename> object,
4897 which is used for running the following
4898 commands on the image:
4899 <itemizedlist>
4900 <listitem><para><emphasis><filename>host</filename>:</emphasis>
4901 Used internally.
4902 The tests do not use this command.
4903 </para></listitem>
4904 <listitem><para><emphasis><filename>timeout</filename>:</emphasis>
4905 A global timeout for commands run on
4906 the target for the instance of a
4907 test.
4908 The default is 300 seconds.
4909 </para></listitem>
4910 <listitem><para><emphasis><filename>run(cmd, timeout=None)</filename>:</emphasis>
4911 The single, most used method.
4912 This command is a wrapper for:
4913 <filename>ssh root@host "cmd"</filename>.
4914 The command returns a tuple:
4915 (status, output), which are what
4916 their names imply - the return code
4917 of 'cmd' and whatever output
4918 it produces.
4919 The optional timeout argument
4920 represents the number of seconds the
4921 test should wait for 'cmd' to
4922 return.
4923 If the argument is "None", the
4924 test uses the default instance's
4925 timeout period, which is 300
4926 seconds.
4927 If the argument is "0", the test
4928 runs until the command returns.
4929 </para></listitem>
4930 <listitem><para><emphasis><filename>copy_to(localpath, remotepath)</filename>:</emphasis>
4931 <filename>scp localpath root@ip:remotepath</filename>.
4932 </para></listitem>
4933 <listitem><para><emphasis><filename>copy_from(remotepath, localpath)</filename>:</emphasis>
4934 <filename>scp root@host:remotepath localpath</filename>.
4935 </para></listitem>
4936 </itemizedlist></para></listitem>
4937 </itemizedlist></para></listitem>
4938 </itemizedlist>
4939 </para>
4940 </section>
4941
4942 <section id='qemu-image-writing-tests-instance-attributes'>
4943 <title>Instance Attributes</title>
4944
4945 <para>
4946 A single instance attribute exists, which is
4947 <filename>target</filename>.
4948 The <filename>target</filename> instance attribute is
4949 identical to the class attribute of the same name, which
4950 is described in the previous section.
4951 This attribute exists as both an instance and class
4952 attribute so tests can use
4953 <filename>self.target.run(cmd)</filename> in instance
4954 methods instead of
4955 <filename>oeRuntimeTest.tc.target.run(cmd)</filename>.
4956 </para>
4957 </section>
4958 </section>
4959 </section>
4960
4961 <section id="platdev-gdb-remotedebug">
4962 <title>Debugging With the GNU Project Debugger (GDB) Remotely</title>
4963
4964 <para>
4965 GDB allows you to examine running programs, which in turn helps you to understand and fix problems.
4966 It also allows you to perform post-mortem style analysis of program crashes.
4967 GDB is available as a package within the Yocto Project and is
4968 installed in SDK images by default.
4969 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
4970 in the Yocto Project Reference Manual for a description of these images.
4971 You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>.
4972 </para>
4973
4974 <tip>
4975 For best results, install <filename>-dbg</filename> packages for
4976 the applications you are going to debug.
4977 Doing so makes extra debug symbols available that give you more
4978 meaningful output.
4979 </tip>
4980
4981 <para>
4982 Sometimes, due to memory or disk space constraints, it is not possible
4983 to use GDB directly on the remote target to debug applications.
4984 These constraints arise because GDB needs to load the debugging information and the
4985 binaries of the process being debugged.
4986 Additionally, GDB needs to perform many computations to locate information such as function
4987 names, variable names and values, stack traces and so forth - even before starting the
4988 debugging process.
4989 These extra computations place more load on the target system and can alter the
4990 characteristics of the program being debugged.
4991 </para>
4992
4993 <para>
4994 To help get past the previously mentioned constraints, you can use Gdbserver.
4995 Gdbserver runs on the remote target and does not load any debugging information
4996 from the debugged process.
4997 Instead, a GDB instance processes the debugging information that is run on a
4998 remote computer - the host GDB.
4999 The host GDB then sends control commands to Gdbserver to make it stop or start the debugged
5000 program, as well as read or write memory regions of that debugged program.
5001 All the debugging information loaded and processed as well
5002 as all the heavy debugging is done by the host GDB.
5003 Offloading these processes gives the Gdbserver running on the target a chance to remain
5004 small and fast.
5005 </para>
5006
5007 <para>
5008 Because the host GDB is responsible for loading the debugging information and
5009 for doing the necessary processing to make actual debugging happen, the
5010 user has to make sure the host can access the unstripped binaries complete
5011 with their debugging information and also be sure the target is compiled with no optimizations.
5012 The host GDB must also have local access to all the libraries used by the
5013 debugged program.
5014 Because Gdbserver does not need any local debugging information, the binaries on
5015 the remote target can remain stripped.
5016 However, the binaries must also be compiled without optimization
5017 so they match the host's binaries.
5018 </para>
5019
5020 <para>
5021 To remain consistent with GDB documentation and terminology, the binary being debugged
5022 on the remote target machine is referred to as the "inferior" binary.
5023 For documentation on GDB see the
5024 <ulink url="http://sourceware.org/gdb/documentation/">GDB site</ulink>.
5025 </para>
5026
5027 <para>
5028 The remainder of this section describes the steps you need to take
5029 to debug using the GNU project debugger.
5030 </para>
5031
5032 <section id='platdev-gdb-remotedebug-setup'>
5033 <title>Set Up the Cross-Development Debugging Environment</title>
5034
5035 <para>
5036 Before you can initiate a remote debugging session, you need
5037 to be sure you have set up the cross-development environment,
5038 toolchain, and sysroot.
5039 The "<ulink url='&YOCTO_DOCS_ADT_URL;#adt-prepare'>Preparing for Application Development</ulink>"
5040 chapter of the Yocto Project Application Developer's Guide
5041 describes this process.
5042 Be sure you have read that chapter and have set up
5043 your environment.
5044 </para>
5045 </section>
5046
5047 <section id="platdev-gdb-remotedebug-launch-gdbserver">
5048 <title>Launch Gdbserver on the Target</title>
5049
5050 <para>
5051 Make sure Gdbserver is installed on the target.
5052 If it is not, install the package
5053 <filename>gdbserver</filename>, which needs the
5054 <filename>libthread-db1</filename> package.
5055 </para>
5056
5057 <para>
5058 Here is an example that when entered from the host
5059 connects to the target and launches Gdbserver in order to
5060 "debug" a binary named <filename>helloworld</filename>:
5061 <literallayout class='monospaced'>
5062 $ gdbserver localhost:2345 /usr/bin/helloworld
5063 </literallayout>
5064 Gdbserver should now be listening on port 2345 for debugging
5065 commands coming from a remote GDB process that is running on
5066 the host computer.
5067 Communication between Gdbserver and the host GDB are done
5068 using TCP.
5069 To use other communication protocols, please refer to the
5070 <ulink url='http://www.gnu.org/software/gdb/'>Gdbserver documentation</ulink>.
5071 </para>
5072 </section>
5073
5074 <section id="platdev-gdb-remotedebug-launch-gdb">
5075 <title>Launch GDB on the Host Computer</title>
5076
5077 <para>
5078 Running GDB on the host computer takes a number of stages, which
5079 this section describes.
5080 </para>
5081
5082 <section id="platdev-gdb-remotedebug-launch-gdb-buildcross">
5083 <title>Build the Cross-GDB Package</title>
5084 <para>
5085 A suitable GDB cross-binary is required that runs on your
5086 host computer but also knows about the the ABI of the
5087 remote target.
5088 You can get this binary from the
5089 <link linkend='cross-development-toolchain'>Cross-Development Toolchain</link>.
5090 Here is an example where the toolchain has been installed
5091 in the default directory
5092 <filename>/opt/poky/&DISTRO;</filename>:
5093 <literallayout class='monospaced'>
5094 /opt/poky/1.4/sysroots/i686-pokysdk-linux/usr/bin/armv7a-vfp-neon-poky-linux-gnueabi/arm-poky-linux-gnueabi-gdb
5095 </literallayout>
5096 where <filename>arm</filename> is the target architecture
5097 and <filename>linux-gnueabi</filename> is the target ABI.
5098 </para>
5099
5100 <para>
5101 Alternatively, you can use BitBake to build the
5102 <filename>gdb-cross</filename> binary.
5103 Here is an example:
5104 <literallayout class='monospaced'>
5105 $ bitbake gdb-cross
5106 </literallayout>
5107 Once the binary is built, you can find it here:
5108 <literallayout class='monospaced'>
5109 tmp/sysroots/&lt;host-arch&gt;/usr/bin/&lt;target-platform&gt;/&lt;target-abi&gt;-gdb
5110 </literallayout>
5111 </para>
5112 </section>
5113
5114 <section id='create-the-gdb-initialization-file'>
5115 <title>Create the GDB Initialization File and Point to Your Root Filesystem</title>
5116
5117 <para>
5118 Aside from the GDB cross-binary, you also need a GDB
5119 initialization file in the same top directory in which
5120 your binary resides.
5121 When you start GDB on your host development system, GDB
5122 finds this initialization file and executes all the
5123 commands within.
5124 For information on the <filename>.gdbinit</filename>, see
5125 "<ulink url='http://sourceware.org/gdb/onlinedocs/gdb/'>Debugging with GDB</ulink>",
5126 which is maintained by
5127 <ulink url='http://www.sourceware.org'>sourceware.org</ulink>.
5128 </para>
5129
5130 <para>
5131 You need to add a statement in the
5132 <filename>.gdbinit</filename> file that points to your
5133 root filesystem.
5134 Here is an example that points to the root filesystem for
5135 an ARM-based target device:
5136 <literallayout class='monospaced'>
5137 set sysroot /home/jzhang/sysroot_arm
5138 </literallayout>
5139 </para>
5140 </section>
5141
5142 <section id="platdev-gdb-remotedebug-launch-gdb-launchhost">
5143 <title>Launch the Host GDB</title>
5144
5145 <para>
5146 Before launching the host GDB, you need to be sure
5147 you have sourced the cross-debugging environment script,
5148 which if you installed the root filesystem in the default
5149 location is at <filename>/opt/poky/&DISTRO;</filename>
5150 and begins with the string "environment-setup".
5151 For more information, see the
5152 "<ulink url='&YOCTO_DOCS_ADT_URL;#setting-up-the-cross-development-environment'>Setting Up the Cross-Development Environment</ulink>"
5153 section in the Yocto Project Application Developer's
5154 Guide.
5155 </para>
5156
5157 <para>
5158 Finally, switch to the directory where the binary resides
5159 and run the <filename>cross-gdb</filename> binary.
5160 Provide the binary file you are going to debug.
5161 For example, the following command continues with the
5162 example used in the previous section by loading
5163 the <filename>helloworld</filename> binary as well as the
5164 debugging information:
5165 <literallayout class='monospaced'>
5166 $ arm-poky-linux-gnuabi-gdb helloworld
5167 </literallayout>
5168 The commands in your <filename>.gdbinit</filename> execute
5169 and the GDB prompt appears.
5170 </para>
5171 </section>
5172 </section>
5173
5174 <section id='platdev-gdb-connect-to-the-remote-gdb-server'>
5175 <title>Connect to the Remote GDB Server</title>
5176
5177 <para>
5178 From the target, you need to connect to the remote GDB
5179 server that is running on the host.
5180 You need to specify the remote host and port.
5181 Here is the command continuing with the example:
5182 <literallayout class='monospaced'>
5183 target remote 192.168.7.2:2345
5184 </literallayout>
5185 </para>
5186 </section>
5187
5188 <section id="platdev-gdb-remotedebug-launch-gdb-using">
5189 <title>Use the Debugger</title>
5190
5191 <para>
5192 You can now proceed with debugging as normal - as if you were debugging
5193 on the local machine.
5194 For example, to instruct GDB to break in the "main" function and then
5195 continue with execution of the inferior binary use the following commands
5196 from within GDB:
5197 <literallayout class='monospaced'>
5198 (gdb) break main
5199 (gdb) continue
5200 </literallayout>
5201 </para>
5202
5203 <para>
5204 For more information about using GDB, see the project's online documentation at
5205 <ulink url="http://sourceware.org/gdb/download/onlinedocs/"/>.
5206 </para>
5207 </section>
5208 </section>
5209
5210 <section id="examining-builds-using-toaster">
5211 <title>Examining Builds Using the Toaster API</title>
5212
5213 <para>
5214 Toaster is an Application Programming Interface (API) and
5215 web-based interface to the OpenEmbedded build system, which uses
5216 BitBake.
5217 Both interfaces are based on a Representational State Transfer
5218 (REST) API that queries for and returns build information using
5219 <filename>GET</filename> and <filename>JSON</filename>.
5220 These types of search operations retrieve sets of objects from
5221 a data store used to collect build information.
5222 The results contain all the data for the objects being returned.
5223 You can order the results of the search by key and the search
5224 parameters are consistent for all object types.
5225 </para>
5226
5227 <para>
5228 Using the interfaces you can do the following:
5229 <itemizedlist>
5230 <listitem><para>See information about the tasks executed
5231 and reused during the build.</para></listitem>
5232 <listitem><para>See what is built (recipes and
5233 packages) and what packages were installed into the final
5234 image.</para></listitem>
5235 <listitem><para>See performance-related information such
5236 as build time, CPU usage, and disk I/O.</para></listitem>
5237 <listitem><para>Examine error, warning and trace messages
5238 to aid in debugging.</para></listitem>
5239 </itemizedlist>
5240 </para>
5241
5242 <note>
5243 <para>This release of Toaster provides you with information
5244 about a BitBake run.
5245 The tool does not allow you to configure and launch a build.
5246 However, future development includes plans to integrate the
5247 configuration and build launching capabilities of
5248 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>.
5249 </para>
5250 <para>For more information on using Hob to build an image,
5251 see the
5252 "<link linkend='image-development-using-hob'>Image Development Using Hob</link>"
5253 section.</para>
5254 </note>
5255
5256 <para>
5257 The remainder of this section describes what you need to have in
5258 place to use Toaster, how to start it, use it, and stop it.
5259 For additional information on installing and running Toaster, see the
5260 "<ulink url='https://wiki.yoctoproject.org/wiki/Toaster#Installation_and_Running'>Installation and Running</ulink>"
5261 section of the "Toaster" wiki page.
5262 For complete information on the API and its search operation
5263 URI, parameters, and responses, see the
5264 <ulink url='https://wiki.yoctoproject.org/wiki/REST_API_Contracts'>REST API Contracts</ulink>
5265 Wiki page.
5266 </para>
5267
5268 <section id='starting-toaster'>
5269 <title>Starting Toaster</title>
5270
5271 <para>
5272 Getting set up to use and start Toaster is simple.
5273 First, be sure you have met the following requirements:
5274 <itemizedlist>
5275 <listitem><para>You have set up your
5276 <link linkend='source-directory'>Source Directory</link>
5277 by cloning the upstream <filename>poky</filename>
5278 repository.
5279 See the
5280 <link linkend='local-yp-release'>Yocto Project Release</link>
5281 item for information on how to set up the Source
5282 Directory.</para></listitem>
5283 <listitem><para>You have checked out the
5284 <filename>dora-toaster</filename> branch:
5285 <literallayout class='monospaced'>
5286 $ cd ~/poky
5287 $ git checkout -b dora-toaster origin/dora-toaster
5288 </literallayout></para></listitem>
5289 <listitem><para>Be sure your build machine has
5290 <ulink url='http://en.wikipedia.org/wiki/Django_%28web_framework%29'>Django</ulink>
5291 version 1.4.5 installed.</para></listitem>
5292 <listitem><para>Make sure that port 8000 and 8200 are
5293 free (i.e. they have no servers on them).
5294 </para></listitem>
5295 </itemizedlist>
5296 </para>
5297
5298 <para>
5299 Once you have met the requirements, follow these steps to
5300 start Toaster running in the background of your shell:
5301 <orderedlist>
5302 <listitem><para><emphasis>Set up your build environment:</emphasis>
5303 Source a build environment script (i.e.
5304 <filename>oe-init-build-env</filename> or
5305 <filename>oe-init-build-env-memres</filename>).
5306 </para></listitem>
5307 <listitem><para><emphasis>Prepare your local configuration file:</emphasis>
5308 Toaster needs the Toaster class enabled
5309 in Bitbake in order to record target image package
5310 information.
5311 You can enable it by adding the following line to your
5312 <filename>conf/local.conf</filename> file:
5313 <literallayout class='monospaced'>
5314 INHERIT += "toaster"
5315 </literallayout>
5316 Toaster also needs Build History enabled in Bitbake in
5317 order to record target image package information.
5318 You can enable this by adding the following two lines
5319 to your <filename>conf/local.conf</filename> file:
5320 <literallayout class='monospaced'>
5321 INHERIT += "buildhistory"
5322 BUILDHISTORY_COMMIT = "1"
5323 </literallayout></para></listitem>
5324 <listitem><para><emphasis>Start Toaster:</emphasis>
5325 Start the Toaster service using this
5326 command from within your build directory:
5327 <literallayout class='monospaced'>
5328 $ source toaster start
5329 </literallayout></para></listitem>
5330 <note>
5331 The Toaster must be started and running in order
5332 for it to collect data.
5333 </note>
5334 </orderedlist>
5335 </para>
5336
5337 <para>
5338 When Toaster starts, it creates some additional files in your
5339 Build Directory.
5340 Deleting these files will cause you to lose data or interrupt
5341 Toaster:
5342 <itemizedlist>
5343 <listitem><para><emphasis><filename>toaster.sqlite</filename>:</emphasis>
5344 Toaster's database file.</para></listitem>
5345 <listitem><para><emphasis><filename>toaster_web.log</filename>:</emphasis>
5346 The log file of the web server.</para></listitem>
5347 <listitem><para><emphasis><filename>toaster_ui.log</filename>:</emphasis>
5348 The log file of the user interface component.
5349 </para></listitem>
5350 <listitem><para><emphasis><filename>toastermain.pid</filename>:</emphasis>
5351 The PID of the web server.</para></listitem>
5352 <listitem><para><emphasis><filename>toasterui.pid</filename>:</emphasis>
5353 The PID of the DSI data bridge.</para></listitem>
5354 <listitem><para><emphasis><filename>bitbake-cookerdaemon.log</filename>:</emphasis>
5355 The BitBake server's log file.</para></listitem>
5356 </itemizedlist>
5357 </para>
5358 </section>
5359
5360 <section id='using-toaster'>
5361 <title>Using Toaster</title>
5362
5363 <para>
5364 Once Toaster is running, it logs information for any BitBake
5365 run from your Build Directory.
5366 This logging is automatic.
5367 All you need to do is access and use the information.
5368 </para>
5369
5370 <para>
5371 You access the information one of two ways:
5372 <itemizedlist>
5373 <listitem><para>Open a Browser and type enter in the
5374 <filename>http://localhost:8000</filename> URL.
5375 </para></listitem>
5376 <listitem><para>Use the <filename>xdg-open</filename>
5377 tool from the shell and pass it the same URL.
5378 </para></listitem>
5379 </itemizedlist>
5380 Either method opens the home page for the Toaster interface,
5381 which is temporary for this release.
5382 </para>
5383 </section>
5384
5385 <section id='examining-toaster-data'>
5386 <title>Examining Toaster Data</title>
5387
5388 <para>
5389 The Toaster database is persistent regardless of whether you
5390 start or stop the service.
5391 </para>
5392
5393 <para>
5394 Toaster's interface shows you a list of builds
5395 (successful and unsuccessful) for which it has data.
5396 You can click on any build to see related information.
5397 This information includes configuration details, information
5398 about tasks, all recipes and packages built and their
5399 dependencies, packages installed in your final image,
5400 execution time, CPU usage and disk I/O per task.
5401 </para>
5402 </section>
5403
5404 <section id='stopping-toaster'>
5405 <title>Stopping Toaster</title>
5406
5407 <para>
5408 Stop the Toaster service with the following command:
5409 <literallayout class='monospaced'>
5410 $ source toaster stop
5411 </literallayout>
5412 The service stops but the Toaster database remains persistent.
5413 </para>
5414 </section>
5415 </section>
5416
5417 <section id="platdev-oprofile">
5418 <title>Profiling with OProfile</title>
5419
5420 <para>
5421 <ulink url="http://oprofile.sourceforge.net/">OProfile</ulink> is a
5422 statistical profiler well suited for finding performance
5423 bottlenecks in both user-space software and in the kernel.
5424 This profiler provides answers to questions like "Which functions does my application spend
5425 the most time in when doing X?"
5426 Because the OpenEmbedded build system is well integrated with OProfile, it makes profiling
5427 applications on target hardware straightforward.
5428 <note>
5429 For more information on how to set up and run OProfile, see the
5430 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>"
5431 section in the Yocto Project Profiling and Tracing Manual.
5432 </note>
5433 </para>
5434
5435 <para>
5436 To use OProfile, you need an image that has OProfile installed.
5437 The easiest way to do this is with <filename>tools-profile</filename> in the
5438 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> variable.
5439 You also need debugging symbols to be available on the system where the analysis
5440 takes place.
5441 You can gain access to the symbols by using <filename>dbg-pkgs</filename> in the
5442 <filename>IMAGE_FEATURES</filename> variable or by
5443 installing the appropriate <filename>-dbg</filename> packages.
5444 </para>
5445
5446 <para>
5447 For successful call graph analysis, the binaries must preserve the frame
5448 pointer register and should also be compiled with the
5449 <filename>-fno-omit-framepointer</filename> flag.
5450 You can achieve this by setting the
5451 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</ulink></filename>
5452 variable with the following options:
5453 <literallayout class='monospaced'>
5454 -fexpensive-optimizations
5455 -fno-omit-framepointer
5456 -frename-registers
5457 -O2
5458 </literallayout>
5459 You can also achieve it by setting the
5460 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DEBUG_BUILD'>DEBUG_BUILD</ulink></filename>
5461 variable to "1" in the <filename>local.conf</filename> configuration file.
5462 If you use the <filename>DEBUG_BUILD</filename> variable,
5463 you also add extra debugging information that can make the debug
5464 packages large.
5465 </para>
5466
5467 <section id="platdev-oprofile-target">
5468 <title>Profiling on the Target</title>
5469
5470 <para>
5471 Using OProfile you can perform all the profiling work on the target device.
5472 A simple OProfile session might look like the following:
5473 </para>
5474
5475 <para>
5476 <literallayout class='monospaced'>
5477 # opcontrol --reset
5478 # opcontrol --start --separate=lib --no-vmlinux -c 5
5479 .
5480 .
5481 [do whatever is being profiled]
5482 .
5483 .
5484 # opcontrol --stop
5485 $ opreport -cl
5486 </literallayout>
5487 </para>
5488
5489 <para>
5490 In this example, the <filename>reset</filename> command clears any previously profiled data.
5491 The next command starts OProfile.
5492 The options used when starting the profiler separate dynamic library data
5493 within applications, disable kernel profiling, and enable callgraphing up to
5494 five levels deep.
5495 <note>
5496 To profile the kernel, you would specify the
5497 <filename>--vmlinux=/path/to/vmlinux</filename> option.
5498 The <filename>vmlinux</filename> file is usually in the source directory in the
5499 <filename>/boot/</filename> directory and must match the running kernel.
5500 </note>
5501 </para>
5502
5503 <para>
5504 After you perform your profiling tasks, the next command stops the profiler.
5505 After that, you can view results with the <filename>opreport</filename> command with options
5506 to see the separate library symbols and callgraph information.
5507 </para>
5508
5509 <para>
5510 Callgraphing logs information about time spent in functions and about a function's
5511 calling function (parent) and called functions (children).
5512 The higher the callgraphing depth, the more accurate the results.
5513 However, higher depths also increase the logging overhead.
5514 Consequently, you should take care when setting the callgraphing depth.
5515 <note>
5516 On ARM, binaries need to have the frame pointer enabled for callgraphing to work.
5517 To accomplish this use the <filename>-fno-omit-framepointer</filename> option
5518 with <filename>gcc</filename>.
5519 </note>
5520 </para>
5521
5522 <para>
5523 For more information on using OProfile, see the OProfile
5524 online documentation at
5525 <ulink url="http://oprofile.sourceforge.net/docs/"/>.
5526 </para>
5527 </section>
5528
5529 <section id="platdev-oprofile-oprofileui">
5530 <title>Using OProfileUI</title>
5531
5532 <para>
5533 A graphical user interface for OProfile is also available.
5534 You can download and build this interface from the Yocto Project at
5535 <ulink url="&YOCTO_GIT_URL;/cgit.cgi/oprofileui/"></ulink>.
5536 If the "tools-profile" image feature is selected, all necessary binaries
5537 are installed onto the target device for OProfileUI interaction.
5538 For a list of image features that ship with the Yocto Project,
5539 see the
5540 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-features-image'>Images</ulink>"
5541 section in the Yocto Project Reference Manual.
5542 </para>
5543
5544 <para>
5545 Even though the source directory usually includes all needed patches on the target device, you
5546 might find you need other OProfile patches for recent OProfileUI features.
5547 If so, see the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/oprofileui/tree/README'>
5548 OProfileUI README</ulink> for the most recent information.
5549 </para>
5550
5551 <section id="platdev-oprofile-oprofileui-online">
5552 <title>Online Mode</title>
5553
5554 <para>
5555 Using OProfile in online mode assumes a working network connection with the target
5556 hardware.
5557 With this connection, you just need to run "oprofile-server" on the device.
5558 By default, OProfile listens on port 4224.
5559 <note>
5560 You can change the port using the <filename>--port</filename> command-line
5561 option.
5562 </note>
5563 </para>
5564
5565 <para>
5566 The client program is called <filename>oprofile-viewer</filename> and its UI is relatively
5567 straightforward.
5568 You access key functionality through the buttons on the toolbar, which
5569 are duplicated in the menus.
5570 Here are the buttons:
5571 <itemizedlist>
5572 <listitem><para><emphasis>Connect:</emphasis> Connects to the remote host.
5573 You can also supply the IP address or hostname.</para></listitem>
5574 <listitem><para><emphasis>Disconnect:</emphasis> Disconnects from the target.
5575 </para></listitem>
5576 <listitem><para><emphasis>Start:</emphasis> Starts profiling on the device.
5577 </para></listitem>
5578 <listitem><para><emphasis>Stop:</emphasis> Stops profiling on the device and
5579 downloads the data to the local host.
5580 Stopping the profiler generates the profile and displays it in the viewer.
5581 </para></listitem>
5582 <listitem><para><emphasis>Download:</emphasis> Downloads the data from the
5583 target and generates the profile, which appears in the viewer.</para></listitem>
5584 <listitem><para><emphasis>Reset:</emphasis> Resets the sample data on the device.
5585 Resetting the data removes sample information collected from previous
5586 sampling runs.
5587 Be sure you reset the data if you do not want to include old sample information.
5588 </para></listitem>
5589 <listitem><para><emphasis>Save:</emphasis> Saves the data downloaded from the
5590 target to another directory for later examination.</para></listitem>
5591 <listitem><para><emphasis>Open:</emphasis> Loads previously saved data.
5592 </para></listitem>
5593 </itemizedlist>
5594 </para>
5595
5596 <para>
5597 The client downloads the complete 'profile archive' from
5598 the target to the host for processing.
5599 This archive is a directory that contains the sample data, the object files,
5600 and the debug information for the object files.
5601 The archive is then converted using the <filename>oparchconv</filename> script, which is
5602 included in this distribution.
5603 The script uses <filename>opimport</filename> to convert the archive from
5604 the target to something that can be processed on the host.
5605 </para>
5606
5607 <para>
5608 Downloaded archives reside in the
5609 <link linkend='build-directory'>Build Directory</link> in
5610 <filename>/tmp</filename> and are cleared up when they are no longer in use.
5611 </para>
5612
5613 <para>
5614 If you wish to perform kernel profiling, you need to be sure
5615 a <filename>vmlinux</filename> file that matches the running kernel is available.
5616 In the source directory, that file is usually located in
5617 <filename>/boot/vmlinux-KERNELVERSION</filename>, where
5618 <filename>KERNEL-version</filename> is the version of the kernel.
5619 The OpenEmbedded build system generates separate <filename>vmlinux</filename>
5620 packages for each kernel it builds.
5621 Thus, it should just be a question of making sure a matching package is
5622 installed (e.g. <filename>opkg install kernel-vmlinux</filename>).
5623 The files are automatically installed into development and profiling images
5624 alongside OProfile.
5625 A configuration option exists within the OProfileUI settings page that you can use to
5626 enter the location of the <filename>vmlinux</filename> file.
5627 </para>
5628
5629 <para>
5630 Waiting for debug symbols to transfer from the device can be slow, and it
5631 is not always necessary to actually have them on the device for OProfile use.
5632 All that is needed is a copy of the filesystem with the debug symbols present
5633 on the viewer system.
5634 The "<link linkend='platdev-gdb-remotedebug-launch-gdb'>Launch GDB on the Host Computer</link>"
5635 section covers how to create such a directory with
5636 the <link linkend='source-directory'>Source Directory</link>
5637 and how to use the OProfileUI Settings Dialog to specify the location.
5638 If you specify the directory, it will be used when the file checksums
5639 match those on the system you are profiling.
5640 </para>
5641 </section>
5642
5643 <section id="platdev-oprofile-oprofileui-offline">
5644 <title>Offline Mode</title>
5645
5646 <para>
5647 If network access to the target is unavailable, you can generate
5648 an archive for processing in <filename>oprofile-viewer</filename> as follows:
5649 <literallayout class='monospaced'>
5650 # opcontrol --reset
5651 # opcontrol --start --separate=lib --no-vmlinux -c 5
5652 .
5653 .
5654 [do whatever is being profiled]
5655 .
5656 .
5657 # opcontrol --stop
5658 # oparchive -o my_archive
5659 </literallayout>
5660 </para>
5661
5662 <para>
5663 In the above example, <filename>my_archive</filename> is the name of the
5664 archive directory where you would like the profile archive to be kept.
5665 After the directory is created, you can copy it to another host and load it
5666 using <filename>oprofile-viewer</filename> open functionality.
5667 If necessary, the archive is converted.
5668 </para>
5669 </section>
5670 </section>
5671 </section>
5672
5673 <section id='maintaining-open-source-license-compliance-during-your-products-lifecycle'>
5674 <title>Maintaining Open Source License Compliance During Your Product's Lifecycle</title>
5675
5676 <para>
5677 One of the concerns for a development organization using open source
5678 software is how to maintain compliance with various open source
5679 licensing during the lifecycle of the product.
5680 While this section does not provide legal advice or
5681 comprehensively cover all scenarios, it does
5682 present methods that you can use to
5683 assist you in meeting the compliance requirements during a software
5684 release.
5685 </para>
5686
5687 <para>
5688 With hundreds of different open source licenses that the Yocto
5689 Project tracks, it is difficult to know the requirements of each
5690 and every license.
5691 However, we can begin to cover the requirements of the major FLOSS licenses, by
5692 assuming that there are three main areas of concern:
5693 <itemizedlist>
5694 <listitem><para>Source code must be provided.</para></listitem>
5695 <listitem><para>License text for the software must be
5696 provided.</para></listitem>
5697 <listitem><para>Compilation scripts and modifications to the
5698 source code must be provided.
5699 </para></listitem>
5700 </itemizedlist>
5701 There are other requirements beyond the scope of these
5702 three and the methods described in this section
5703 (e.g. the mechanism through which source code is distributed).
5704 </para>
5705
5706 <para>
5707 As different organizations have different methods of complying with
5708 open source licensing, this section is not meant to imply that
5709 there is only one single way to meet your compliance obligations,
5710 but rather to describe one method of achieving compliance.
5711 The remainder of this section describes methods supported to meet the
5712 previously mentioned three requirements.
5713 Once you take steps to meet these requirements,
5714 and prior to releasing images, sources, and the build system,
5715 you should audit all artifacts to ensure completeness.
5716 <note>
5717 The Yocto Project generates a license manifest during
5718 image creation that is located
5719 in <filename>${DEPLOY_DIR}/licenses/&lt;image_name-datestamp&gt;</filename>
5720 to assist with any audits.
5721 </note>
5722 </para>
5723
5724 <section id='providing-the-source-code'>
5725 <title>Providing the Source Code</title>
5726
5727 <para>
5728 Compliance activities should begin before you generate the
5729 final image.
5730 The first thing you should look at is the requirement that
5731 tops the list for most compliance groups - providing
5732 the source.
5733 The Yocto Project has a few ways of meeting this
5734 requirement.
5735 </para>
5736
5737 <para>
5738 One of the easiest ways to meet this requirement is
5739 to provide the entire
5740 <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink>
5741 used by the build.
5742 This method, however, has a few issues.
5743 The most obvious is the size of the directory since it includes
5744 all sources used in the build and not just the source used in
5745 the released image.
5746 It will include toolchain source, and other artifacts, which
5747 you would not generally release.
5748 However, the more serious issue for most companies is accidental
5749 release of proprietary software.
5750 The Yocto Project provides an archiver class to help avoid
5751 some of these concerns.
5752 See the
5753 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-archiver'>Archiving Sources - <filename>archive*.bbclass</filename></ulink>"
5754 section in the Yocto Project Reference Manual for information
5755 on this class.
5756 </para>
5757
5758 <para>
5759 Before you employ <filename>DL_DIR</filename> or the
5760 archiver class, you need to decide how you choose to
5761 provide source.
5762 The source archiver class can generate tarballs and SRPMs
5763 and can create them with various levels of compliance in mind.
5764 One way of doing this (but certainly not the only way) is to
5765 release just the original source as a tarball.
5766 You can do this by adding the following to the
5767 <filename>local.conf</filename> file found in the
5768 <link linkend='build-directory'>Build Directory</link>:
5769 <literallayout class='monospaced'>
5770 ARCHIVER_MODE ?= "original"
5771 ARCHIVER_CLASS = "${@'archive-${ARCHIVER_MODE}-source' if
5772 ARCHIVER_MODE != 'none' else ''}"
5773 INHERIT += "${ARCHIVER_CLASS}"
5774 SOURCE_ARCHIVE_PACKAGE_TYPE = "tar"
5775 </literallayout>
5776 During the creation of your image, the source from all
5777 recipes that deploy packages to the image is placed within
5778 subdirectories of
5779 <filename>DEPLOY_DIR/sources</filename> based on the
5780 <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink>
5781 for each recipe.
5782 Releasing the entire directory enables you to comply with
5783 requirements concerning providing the unmodified source.
5784 It is important to note that the size of the directory can
5785 get large.
5786 </para>
5787
5788 <para>
5789 A way to help mitigate the size issue is to only release
5790 tarballs for licenses that require the release of
5791 source.
5792 Let's assume you are only concerned with GPL code as
5793 identified with the following:
5794 <literallayout class='monospaced'>
5795 $ cd poky/build/tmp/deploy/sources
5796 $ mkdir ~/gpl_source_release
5797 $ for dir in */*GPL*; do cp -r $dir ~/gpl_source_release; done
5798 </literallayout>
5799 At this point, you could create a tarball from the
5800 <filename>gpl_source_release</filename> directory and
5801 provide that to the end user.
5802 This method would be a step toward achieving compliance
5803 with section 3a of GPLv2 and with section 6 of GPLv3.
5804 </para>
5805 </section>
5806
5807 <section id='providing-license-text'>
5808 <title>Providing License Text</title>
5809
5810 <para>
5811 One requirement that is often overlooked is inclusion
5812 of license text.
5813 This requirement also needs to be dealt with prior to
5814 generating the final image.
5815 Some licenses require the license text to accompany
5816 the binary.
5817 You can achieve this by adding the following to your
5818 <filename>local.conf</filename> file:
5819 <literallayout class='monospaced'>
5820 COPY_LIC_MANIFEST = "1"
5821 COPY_LIC_DIRS = "1"
5822 </literallayout>
5823 Adding these statements to the configuration file ensures
5824 that the licenses collected during package generation
5825 are included on your image.
5826 As the source archiver has already archived the original
5827 unmodified source that contains the license files,
5828 you would have already met the requirements for inclusion
5829 of the license information with source as defined by the GPL
5830 and other open source licenses.
5831 </para>
5832 </section>
5833
5834 <section id='providing-compilation-scripts-and-source-code-modifications'>
5835 <title>Providing Compilation Scripts and Source Code Modifications</title>
5836
5837 <para>
5838 At this point, we have addressed all we need to address
5839 prior to generating the image.
5840 The next two requirements are addressed during the final
5841 packaging of the release.
5842 </para>
5843
5844 <para>
5845 By releasing the version of the OpenEmbedded build system
5846 and the layers used during the build, you will be providing both
5847 compilation scripts and the source code modifications in one
5848 step.
5849 </para>
5850
5851 <para>
5852 If the deployment team has a
5853 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP layer</ulink>
5854 and a distro layer, and those those layers are used to patch,
5855 compile, package, or modify (in any way) any open source
5856 software included in your released images, you
5857 may be required to to release those layers under section 3 of
5858 GPLv2 or section 1 of GPLv3.
5859 One way of doing that is with a clean
5860 checkout of the version of the Yocto Project and layers used
5861 during your build.
5862 Here is an example:
5863 <literallayout class='monospaced'>
5864 # We built using the &DISTRO_NAME; branch of the poky repo
5865 $ git clone -b &DISTRO_NAME; git://git.yoctoproject.org/poky
5866 $ cd poky
5867 # We built using the release_branch for our layers
5868 $ git clone -b release_branch git://git.mycompany.com/meta-my-bsp-layer
5869 $ git clone -b release_branch git://git.mycompany.com/meta-my-software-layer
5870 # clean up the .git repos
5871 $ find . -name ".git" -type d -exec rm -rf {} \;
5872 </literallayout>
5873 One thing a development organization might want to consider
5874 for end-user convenience is to modify
5875 <filename>meta-yocto/conf/bblayers.conf.sample</filename> to
5876 ensure that when the end user utilizes the released build
5877 system to build an image, the development organization's
5878 layers are included in the <filename>bblayers.conf</filename>
5879 file automatically:
5880 <literallayout class='monospaced'>
5881 # LAYER_CONF_VERSION is increased each time build/conf/bblayers.conf
5882 # changes incompatibly
5883 LCONF_VERSION = "6"
5884
5885 BBPATH = "${TOPDIR}"
5886 BBFILES ?= ""
5887
5888 BBLAYERS ?= " \
5889 ##OEROOT##/meta \
5890 ##OEROOT##/meta-yocto \
5891 ##OEROOT##/meta-yocto-bsp \
5892 ##OEROOT##/meta-mylayer \
5893 "
5894
5895 BBLAYERS_NON_REMOVABLE ?= " \
5896 ##OEROOT##/meta \
5897 ##OEROOT##/meta-yocto \
5898 "
5899 </literallayout>
5900 Creating and providing an archive of the
5901 <link linkend='metadata'>Metadata</link> layers
5902 (recipes, configuration files, and so forth)
5903 enables you to meet your
5904 requirements to include the scripts to control compilation
5905 as well as any modifications to the original source.
5906 </para>
5907 </section>
5908 </section>
5909</chapter>
5910
5911<!--
5912vim: expandtab tw=80 ts=4
5913-->
diff --git a/documentation/dev-manual/dev-manual-customization.xsl b/documentation/dev-manual/dev-manual-customization.xsl
new file mode 100644
index 0000000000..8969605989
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-customization.xsl
@@ -0,0 +1,10 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="html.stylesheet" select="'dev-style.css'" />
7 <xsl:param name="chapter.autolabel" select="1" />
8 <xsl:param name="section.autolabel" select="1" />
9 <xsl:param name="section.label.includes.component.label" select="1" />
10</xsl:stylesheet>
diff --git a/documentation/dev-manual/dev-manual-eclipse-customization.xsl b/documentation/dev-manual/dev-manual-eclipse-customization.xsl
new file mode 100644
index 0000000000..8ac4c18f25
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-eclipse-customization.xsl
@@ -0,0 +1,27 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10
11 <xsl:param name="chunker.output.indent" select="'yes'"/>
12 <xsl:param name="chunk.quietly" select="1"/>
13 <xsl:param name="chunk.first.sections" select="1"/>
14 <xsl:param name="chunk.section.depth" select="10"/>
15 <xsl:param name="use.id.as.filename" select="1"/>
16 <xsl:param name="ulink.target" select="'_self'" />
17 <xsl:param name="base.dir" select="'html/dev-manual/'"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="chapter.autolabel" select="1" />
24 <xsl:param name="appendix.autolabel" select="1" />
25 <xsl:param name="section.autolabel" select="1" />
26 <xsl:param name="section.label.includes.component.label" select="1" />
27</xsl:stylesheet>
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
new file mode 100644
index 0000000000..8923a1d2fb
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -0,0 +1,210 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='dev-manual-intro'>
6
7<title>The Yocto Project Development Manual</title>
8 <section id='intro'>
9 <title>Introduction</title>
10
11 <para>
12 Welcome to the Yocto Project Development Manual!
13 This manual provides information on how to use the Yocto Project to
14 develop embedded Linux images and user-space applications that
15 run on targeted devices.
16 The manual provides an overview of image, kernel, and
17 user-space application development using the Yocto Project.
18 Because much of the information in this manual is general, it
19 contains many references to other sources where you can find more
20 detail.
21 For example, you can find detailed information on Git, repositories,
22 and open source in general in many places on the Internet.
23 Another example specific to the Yocto Project is how to quickly
24 set up your host development system and build an image, which you
25 find in the
26 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
27 </para>
28
29 <para>
30 The Yocto Project Development Manual does, however, provide
31 guidance and examples on how to change the kernel source code,
32 reconfigure the kernel, and develop an application using the
33 popular <trademark class='trade'>Eclipse</trademark> IDE.
34 </para>
35
36 <note>
37 By default, using the Yocto Project creates a Poky distribution.
38 However, you can create your own distribution by providing key
39 <link linkend='metadata'>Metadata</link>.
40 A good example is Angstrom, which has had a distribution
41 based on the Yocto Project since its inception.
42 Other examples include commercial distributions like
43 Wind River Linux, Mentor Embedded Linux, and ENEA Linux.
44 See the "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>"
45 section for more information.
46 </note>
47 </section>
48
49 <section id='what-this-manual-provides'>
50 <title>What This Manual Provides</title>
51
52 <para>
53 The following list describes what you can get from this manual:
54 <itemizedlist>
55 <listitem><para>Information that lets you get set
56 up to develop using the Yocto Project.</para></listitem>
57 <listitem><para>Information to help developers who are new to
58 the open source environment and to the distributed revision
59 control system Git, which the Yocto Project uses.
60 </para></listitem>
61 <listitem><para>An understanding of common end-to-end
62 development models and tasks.</para></listitem>
63 <listitem><para>Information about common development tasks
64 generally used during image development for
65 embedded devices.
66 </para></listitem>
67 <listitem><para>Many references to other sources of related
68 information.</para></listitem>
69 </itemizedlist>
70 </para>
71 </section>
72
73 <section id='what-this-manual-does-not-provide'>
74 <title>What this Manual Does Not Provide</title>
75
76 <para>
77 This manual will not give you the following:
78 <itemizedlist>
79 <listitem><para><emphasis>Step-by-step instructions when those instructions exist in other Yocto
80 Project documentation:</emphasis>
81 For example, the Yocto Project Application Developer's Guide contains detailed
82 instructions on how to run the
83 <ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>ADT Installer</ulink>,
84 which is used to set up a cross-development environment.</para></listitem>
85 <listitem><para><emphasis>Reference material:</emphasis>
86 This type of material resides in an appropriate reference manual.
87 For example, system variables are documented in the
88 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.</para></listitem>
89 <listitem><para><emphasis>Detailed public information that is not specific to the Yocto Project:</emphasis>
90 For example, exhaustive information on how to use Git is covered better through the
91 Internet than in this manual.</para></listitem>
92 </itemizedlist>
93 </para>
94 </section>
95
96 <section id='other-information'>
97 <title>Other Information</title>
98
99 <para>
100 Because this manual presents overview information for many different
101 topics, supplemental information is recommended for full
102 comprehension.
103 The following list presents other sources of information you might find helpful:
104 <itemizedlist>
105 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
106 </emphasis> The home page for the Yocto Project provides lots of information on the project
107 as well as links to software and documentation.</para></listitem>
108 <listitem><para><emphasis>
109 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started
110 with the Yocto Project and quickly begin building an image.</para></listitem>
111 <listitem><para><emphasis>
112 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference
113 guide to the OpenEmbedded build system, which is based on BitBake.
114 The build system is sometimes referred to as "Poky".
115 </para></listitem>
116 <listitem><para><emphasis>
117 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis>
118 This guide provides information that lets you get going with the Application
119 Development Toolkit (ADT) and stand-alone cross-development toolchains to
120 develop projects using the Yocto Project.</para></listitem>
121 <listitem><para><emphasis>
122 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
123 This guide defines the structure for BSP components.
124 Having a commonly understood structure encourages standardization.</para></listitem>
125 <listitem><para><emphasis>
126 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis>
127 This manual describes how to work with Linux Yocto kernels as well as provides a bit
128 of conceptual information on the construction of the Yocto Linux kernel tree.
129 </para></listitem>
130 <listitem><para><emphasis>
131 <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis>
132 This manual presents a set of common and generally useful tracing and
133 profiling schemes along with their applications (as appropriate) to each tool.
134 </para></listitem>
135 <listitem><para><emphasis>
136 <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'>
137 Eclipse IDE Yocto Plug-in</ulink>:</emphasis> A step-by-step instructional video that
138 demonstrates how an application developer uses Yocto Plug-in features within
139 the Eclipse IDE.</para></listitem>
140 <listitem><para><emphasis>
141 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
142 A list of commonly asked questions and their answers.</para></listitem>
143 <listitem><para><emphasis>
144 <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
145 Features, updates and known issues for the current
146 release of the Yocto Project.</para></listitem>
147 <listitem><para><emphasis>
148 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>
149 Hob</ulink>:</emphasis> A graphical user interface for BitBake.
150 Hob's primary goal is to enable a user to perform common tasks more easily.</para></listitem>
151 <listitem><para><emphasis>
152 <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'>
153 Build Appliance</ulink>:</emphasis> A virtual machine that
154 enables you to build and boot a custom embedded Linux image
155 with the Yocto Project using a non-Linux development system.
156 For more information, see the
157 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance-manual'>Build Appliance</ulink>
158 page.
159 </para></listitem>
160 <listitem><para><emphasis>
161 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
162 The bug tracking application the Yocto Project uses.
163 If you find problems with the Yocto Project, you should report them using this
164 application.</para></listitem>
165 <listitem><para><emphasis>
166 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing
167 lists, click on the following URLs and follow the instructions:
168 <itemizedlist>
169 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a
170 Yocto Project Discussions mailing list.</para></listitem>
171 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a
172 Yocto Project Discussions mailing list about the
173 OpenEmbedded build system (Poky).
174 </para></listitem>
175 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
176 for a mailing list to receive official Yocto Project announcements
177 as well as Yocto Project milestones.</para></listitem>
178 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a
179 listing of all public mailing lists on <filename>lists.yoctoproject.org</filename>.
180 </para></listitem>
181 </itemizedlist></para></listitem>
182 <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
183 Two IRC channels on freenode are available
184 for Yocto Project and Poky discussions: <filename>#yocto</filename> and
185 <filename>#poky</filename>, respectively.</para></listitem>
186 <listitem><para><emphasis>
187 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
188 The build system used by the Yocto Project.
189 This project is the upstream, generic, embedded distribution that the Yocto
190 Project derives its build system (Poky) from and to which it contributes.</para></listitem>
191 <listitem><para><emphasis>
192 <ulink url='http://developer.berlios.de/projects/bitbake/'>
193 BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system
194 to process project metadata.</para></listitem>
195 <listitem><para><emphasis>
196 BitBake User Manual:</emphasis>
197 A comprehensive guide to the BitBake tool.
198 If you want information on BitBake, see the user manual included in the
199 <filename>bitbake/doc/manual</filename> directory of the
200 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
201 <listitem><para><emphasis>
202 <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:
203 </emphasis> An open-source machine emulator and virtualizer.</para></listitem>
204 </itemizedlist>
205 </para>
206 </section>
207</chapter>
208<!--
209vim: expandtab tw=80 ts=4
210-->
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
new file mode 100644
index 0000000000..cb09627d6e
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -0,0 +1,2058 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='dev-manual-model'>
6
7<title>Common Development Models</title>
8
9<para>
10 Many development models exist for which you can use the Yocto Project.
11 This chapter overviews simple methods that use tools provided by the
12 Yocto Project:
13 <itemizedlist>
14 <listitem><para><emphasis>System Development:</emphasis>
15 System Development covers Board Support Package (BSP) development and kernel
16 modification or configuration.
17 For an example on how to create a BSP, see the
18 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>"
19 section in the Yocto Project Board Support Package (BSP) Developer's Guide.
20 For more complete information on how to work with the kernel, see the
21 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel
22 Development Manual</ulink>.
23 </para></listitem>
24 <listitem><para><emphasis>User Application Development:</emphasis>
25 User Application Development covers development of applications that you intend
26 to run on target hardware.
27 For information on how to set up your host development system for user-space
28 application development, see the
29 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>.
30 For a simple example of user-space application development using the
31 <trademark class='trade'>Eclipse</trademark> IDE, see the
32 "<link linkend='application-development-workflow'>Application
33 Development Workflow</link>" section.
34 </para></listitem>
35 <listitem><para><emphasis>Temporary Source Code Modification:</emphasis>
36 Direct modification of temporary source code is a convenient development model
37 to quickly iterate and develop towards a solution.
38 Once you implement the solution, you should of course take steps to
39 get the changes upstream and applied in the affected recipes.</para></listitem>
40 <listitem><para><emphasis>Image Development using Hob:</emphasis>
41 You can use the <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink> to build
42 custom operating system images within the build environment.
43 Hob provides an efficient interface to the OpenEmbedded build system.</para></listitem>
44 <listitem><para><emphasis>Using a Development Shell:</emphasis>
45 You can use a <filename>devshell</filename> to efficiently debug commands or simply
46 edit packages.
47 Working inside a development shell is a quick way to set up the OpenEmbedded build
48 environment to work on parts of a project.</para></listitem>
49 </itemizedlist>
50</para>
51
52<section id='system-development-model'>
53 <title>System Development Workflow</title>
54
55 <para>
56 System development involves modification or creation of an image that you want to run on
57 a specific hardware target.
58 Usually, when you want to create an image that runs on embedded hardware, the image does
59 not require the same number of features that a full-fledged Linux distribution provides.
60 Thus, you can create a much smaller image that is designed to use only the
61 features for your particular hardware.
62 </para>
63
64 <para>
65 To help you understand how system development works in the Yocto Project, this section
66 covers two types of image development: BSP creation and kernel modification or
67 configuration.
68 </para>
69
70 <section id='developing-a-board-support-package-bsp'>
71 <title>Developing a Board Support Package (BSP)</title>
72
73 <para>
74 A BSP is a package of recipes that, when applied during a build, results in
75 an image that you can run on a particular board.
76 Thus, the package when compiled into the new image, supports the operation of the board.
77 </para>
78
79 <note>
80 For a brief list of terms used when describing the development process in the Yocto Project,
81 see the "<link linkend='yocto-project-terms'>Yocto Project Terms</link>" section.
82 </note>
83
84 <para>
85 The remainder of this section presents the basic
86 steps used to create a BSP using the Yocto Project's
87 <ulink url='&YOCTO_DOCS_BSP_URL;#using-the-yocto-projects-bsp-tools'>BSP Tools</ulink>.
88 Although not required for BSP creation, the
89 <filename>meta-intel</filename> repository, which contains
90 many BSPs supported by the Yocto Project, is part of the example.
91 </para>
92
93 <para>
94 For an example that shows how to create a new layer using the tools, see the
95 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>"
96 section in the Yocto Project Board Support Package (BSP) Developer's Guide.
97 </para>
98
99 <para>
100 The following illustration and list summarize the BSP creation general workflow.
101 </para>
102
103 <para>
104 <imagedata fileref="figures/bsp-dev-flow.png" width="6in" depth="7in" align="center" scalefit="1" />
105 </para>
106
107 <para>
108 <orderedlist>
109 <listitem><para><emphasis>Set up your host development system to support
110 development using the Yocto Project</emphasis>: See the
111 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>"
112 and the
113 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
114 in the Yocto Project Quick Start for requirements.</para></listitem>
115 <listitem><para><emphasis>Establish a local copy of the project files on your
116 system</emphasis>: You need this <link linkend='source-directory'>Source
117 Directory</link> available on your host system.
118 Having these files on your system gives you access to the build
119 process and to the tools you need.
120 For information on how to set up the Source Directory,
121 see the
122 "<link linkend='getting-setup'>Getting Set Up</link>" section.</para></listitem>
123 <listitem><para><emphasis>Establish the <filename>meta-intel</filename>
124 repository on your system</emphasis>: Having local copies
125 of these supported BSP layers on your system gives you
126 access to layers you might be able to build on or modify
127 to create your BSP.
128 For information on how to get these files, see the
129 "<link linkend='getting-setup'>Getting Set Up</link>" section.</para></listitem>
130 <listitem><para><emphasis>Create your own BSP layer using the
131 <ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'><filename>yocto-bsp</filename></ulink> script</emphasis>:
132 Layers are ideal for
133 isolating and storing work for a given piece of hardware.
134 A layer is really just a location or area in which you place
135 the recipes and configurations for your BSP.
136 In fact, a BSP is, in itself, a special type of layer.
137 The simplest way to create a new BSP layer that is compliant with the
138 Yocto Project is to use the <filename>yocto-bsp</filename> script.
139 For information about that script, see the
140 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>"
141 section in the Yocto Project Board Support (BSP) Developer's Guide.
142 </para>
143 <para>
144 Another example that illustrates a layer is an application.
145 Suppose you are creating an application that has library or other dependencies in
146 order for it to compile and run.
147 The layer, in this case, would be where all the recipes that define those dependencies
148 are kept.
149 The key point for a layer is that it is an isolated area that contains
150 all the relevant information for the project that the OpenEmbedded build
151 system knows about.
152 For more information on layers, see the
153 "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>"
154 section.
155 For more information on BSP layers, see the
156 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" section in the
157 Yocto Project Board Support Package (BSP) Developer's Guide.</para>
158 <note>Four BSPs exist that are part of the
159 Yocto Project release: <filename>genericx86</filename>, <filename>beagleboard</filename>,
160 <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>.
161 The recipes and configurations for these four BSPs are located and dispersed
162 within the <link linkend='source-directory'>Source Directory</link>.
163 On the other hand, BSP layers for Chief River, Crown Bay,
164 Crystal Forest, Emenlow, Fish River Island 2, Jasper Forest, N450, NUC DC3217IYE,
165 Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers
166 within the larger <filename>meta-intel</filename> layer.</note>
167 <para>When you set up a layer for a new BSP, you should follow a standard layout.
168 This layout is described in the
169 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>"
170 section of the Board Support Package (BSP) Development Guide.
171 In the standard layout, you will notice a suggested structure for recipes and
172 configuration information.
173 You can see the standard layout for a BSP by examining
174 any supported BSP found in the <filename>meta-intel</filename> layer inside
175 the Source Directory.</para></listitem>
176 <listitem><para><emphasis>Make configuration changes to your new BSP
177 layer</emphasis>: The standard BSP layer structure organizes the files you need
178 to edit in <filename>conf</filename> and several <filename>recipes-*</filename>
179 directories within the BSP layer.
180 Configuration changes identify where your new layer is on the local system
181 and identify which kernel you are going to use.
182 When you run the <filename>yocto-bsp</filename> script, you are able to interactively
183 configure many things for the BSP (e.g. keyboard, touchscreen, and so forth).
184 </para></listitem>
185 <listitem><para><emphasis>Make recipe changes to your new BSP layer</emphasis>: Recipe
186 changes include altering recipes (<filename>.bb</filename> files), removing
187 recipes you don't use, and adding new recipes or append files
188 (<filename>.bbappend</filename>) that you need to support your hardware.
189 </para></listitem>
190 <listitem><para><emphasis>Prepare for the build</emphasis>: Once you have made all the
191 changes to your BSP layer, there remains a few things
192 you need to do for the OpenEmbedded build system in order for it to create your image.
193 You need to get the build environment ready by sourcing an environment setup script
194 and you need to be sure two key configuration files are configured appropriately:
195 the <filename>conf/local.conf</filename> and the
196 <filename>conf/bblayers.conf</filename> file.
197 You must make the OpenEmbedded build system aware of your new layer.
198 See the
199 "<link linkend='enabling-your-layer'>Enabling Your Layer</link>" section
200 for information on how to let the build system know about your new layer.</para>
201 <para>The entire process for building an image is overviewed in the section
202 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section
203 of the Yocto Project Quick Start.
204 You might want to reference this information.</para></listitem>
205 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system
206 uses the BitBake tool to build images based on the type of image you want to create.
207 You can find more information about BitBake in the user manual, which is found in the
208 <filename>bitbake/doc/manual</filename> directory of the
209 <link linkend='source-directory'>Source Directory</link>.</para>
210 <para>The build process supports several types of images to satisfy different needs.
211 See the
212 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
213 in the Yocto Project Reference Manual for information on
214 supported images.</para></listitem>
215 </orderedlist>
216 </para>
217
218 <para>
219 You can view a video presentation on "Building Custom Embedded Images with Yocto"
220 at <ulink url='http://free-electrons.com/blog/elc-2011-videos'>Free Electrons</ulink>.
221 You can also find supplemental information in
222 <ulink url='&YOCTO_DOCS_BSP_URL;'>
223 The Board Support Package (BSP) Development Guide</ulink>.
224 Finally, there is wiki page write up of the example also located
225 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>
226 here</ulink> that you might find helpful.
227 </para>
228 </section>
229
230 <section id='modifying-the-kernel'>
231 <title><anchor id='kernel-spot' />Modifying the Kernel</title>
232
233 <para>
234 Kernel modification involves changing the Yocto Project kernel, which could involve changing
235 configuration options as well as adding new kernel recipes.
236 Configuration changes can be added in the form of configuration fragments, while recipe
237 modification comes through the kernel's <filename>recipes-kernel</filename> area
238 in a kernel layer you create.
239 </para>
240
241 <para>
242 The remainder of this section presents a high-level overview of the Yocto Project
243 kernel architecture and the steps to modify the kernel.
244 You can reference the
245 "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section
246 for an example that changes the source code of the kernel.
247 For information on how to configure the kernel, see the
248 "<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section.
249 For more information on the kernel and on modifying the kernel, see the
250 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>.
251 </para>
252
253 <section id='kernel-overview'>
254 <title>Kernel Overview</title>
255
256 <para>
257 Traditionally, when one thinks of a patched kernel, they think of a base kernel
258 source tree and a fixed structure that contains kernel patches.
259 The Yocto Project, however, employs mechanisms that, in a sense, result in a kernel source
260 generator.
261 By the end of this section, this analogy will become clearer.
262 </para>
263
264 <para>
265 You can find a web interface to the Yocto Project kernel source repositories at
266 <ulink url='&YOCTO_GIT_URL;'></ulink>.
267 If you look at the interface, you will see to the left a grouping of
268 Git repositories titled "Yocto Linux Kernel."
269 Within this group, you will find several kernels supported by
270 the Yocto Project:
271 <itemizedlist>
272 <listitem><para><emphasis><filename>linux-yocto-3.4</filename></emphasis> - The
273 stable Yocto Project kernel to use with the Yocto Project Release 1.3. This kernel
274 is based on the Linux 3.4 released kernel.</para></listitem>
275 <listitem><para><emphasis><filename>linux-yocto-3.8</filename></emphasis> - The
276 stable Yocto Project kernel to use with the Yocto Project Release 1.4. This kernel
277 is based on the Linux 3.8 released kernel.</para></listitem>
278 <listitem><para><emphasis><filename>linux-yocto-3.10</filename></emphasis> - The
279 stable Yocto Project kernel to use with the Yocto Project Release 1.5. This kernel
280 is based on the Linux 3.10 released kernel.</para></listitem>
281 <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development
282 kernel based on the latest upstream release candidate available.</para></listitem>
283 </itemizedlist>
284 </para>
285
286 <para>
287 The kernels are maintained using the Git revision control system
288 that structures them using the familiar "tree", "branch", and "leaf" scheme.
289 Branches represent diversions from general code to more specific code, while leaves
290 represent the end-points for a complete and unique kernel whose source files,
291 when gathered from the root of the tree to the leaf, accumulate to create the files
292 necessary for a specific piece of hardware and its features.
293 The following figure displays this concept:
294 <para>
295 <imagedata fileref="figures/kernel-overview-1.png"
296 width="6in" depth="6in" align="center" scale="100" />
297 </para>
298
299 <para>
300 Within the figure, the "Kernel.org Branch Point" represents the point in the tree
301 where a supported base kernel is modified from the Linux kernel.
302 For example, this could be the branch point for the <filename>linux-yocto-3.4</filename>
303 kernel.
304 Thus, everything further to the right in the structure is based on the
305 <filename>linux-yocto-3.4</filename> kernel.
306 Branch points to right in the figure represent where the
307 <filename>linux-yocto-3.4</filename> kernel is modified for specific hardware
308 or types of kernels, such as real-time kernels.
309 Each leaf thus represents the end-point for a kernel designed to run on a specific
310 targeted device.
311 </para>
312
313 <para>
314 The overall result is a Git-maintained repository from which all the supported
315 kernel types can be derived for all the supported devices.
316 A big advantage to this scheme is the sharing of common features by keeping them in
317 "larger" branches within the tree.
318 This practice eliminates redundant storage of similar features shared among kernels.
319 </para>
320
321 <note>
322 Keep in mind the figure does not take into account all the supported Yocto
323 Project kernel types, but rather shows a single generic kernel just for conceptual purposes.
324 Also keep in mind that this structure represents the Yocto Project source repositories
325 that are either pulled from during the build or established on the host development system
326 prior to the build by either cloning a particular kernel's Git repository or by
327 downloading and unpacking a tarball.
328 </note>
329
330 <para>
331 Upstream storage of all the available kernel source code is one thing, while
332 representing and using the code on your host development system is another.
333 Conceptually, you can think of the kernel source repositories as all the
334 source files necessary for all the supported kernels.
335 As a developer, you are just interested in the source files for the kernel on
336 which you are working.
337 And, furthermore, you need them available on your host system.
338 </para>
339
340 <para>
341 Kernel source code is available on your host system a couple of different
342 ways.
343 If you are working in the kernel all the time, you probably would want
344 to set up your own local Git repository of the kernel tree.
345 If you just need to make some patches to the kernel, you can access
346 temporary kernel source files that were extracted and used
347 during a build.
348 We will just talk about working with the temporary source code.
349 For more information on how to get kernel source code onto your
350 host system, see the
351 "<link linkend='local-kernel-files'>Yocto Project Kernel</link>"
352 bulleted item earlier in the manual.
353 </para>
354
355 <para>
356 What happens during the build?
357 When you build the kernel on your development system, all files needed for the build
358 are taken from the source repositories pointed to by the
359 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable
360 and gathered in a temporary work area
361 where they are subsequently used to create the unique kernel.
362 Thus, in a sense, the process constructs a local source tree specific to your
363 kernel to generate the new kernel image - a source generator if you will.
364 </para>
365 The following figure shows the temporary file structure
366 created on your host system when the build occurs.
367 This
368 <link linkend='build-directory'>Build Directory</link> contains all the
369 source files used during the build.
370 </para>
371
372 <para>
373 <imagedata fileref="figures/kernel-overview-2-generic.png"
374 width="6in" depth="5in" align="center" scale="100" />
375 </para>
376
377 <para>
378 Again, for additional information the Yocto Project kernel's
379 architecture and its branching strategy, see the
380 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>.
381 You can also reference the
382 "<link linkend='patching-the-kernel'>Patching the Kernel</link>"
383 section for a detailed example that modifies the kernel.
384 </para>
385 </section>
386
387 <section id='kernel-modification-workflow'>
388 <title>Kernel Modification Workflow</title>
389
390 <para>
391 This illustration and the following list summarizes the kernel modification general workflow.
392 </para>
393
394 <para>
395 <imagedata fileref="figures/kernel-dev-flow.png"
396 width="6in" depth="5in" align="center" scalefit="1" />
397 </para>
398
399 <para>
400 <orderedlist>
401 <listitem><para><emphasis>Set up your host development system to support
402 development using the Yocto Project</emphasis>: See
403 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>" and
404 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
405 in the Yocto Project Quick Start for requirements.</para></listitem>
406 <listitem><para><emphasis>Establish a local copy of project files on your
407 system</emphasis>: Having the <link linkend='source-directory'>Source
408 Directory</link> on your system gives you access to the build process and tools
409 you need.
410 For information on how to get these files, see the bulleted item
411 "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual.
412 </para></listitem>
413 <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>:
414 Temporary kernel source files are kept in the
415 <link linkend='build-directory'>Build Directory</link>
416 created by the
417 OpenEmbedded build system when you run BitBake.
418 If you have never built the kernel you are interested in, you need to run
419 an initial build to establish local kernel source files.</para>
420 <para>If you are building an image for the first time, you need to get the build
421 environment ready by sourcing
422 the environment setup script.
423 You also need to be sure two key configuration files
424 (<filename>local.conf</filename> and <filename>bblayers.conf</filename>)
425 are configured appropriately.</para>
426 <para>The entire process for building an image is overviewed in the
427 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
428 section of the Yocto Project Quick Start.
429 You might want to reference this information.
430 You can find more information on BitBake in the user manual, which is found in the
431 <filename>bitbake/doc/manual</filename> directory of the
432 Source Directory.</para>
433 <para>The build process supports several types of images to satisfy different needs.
434 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
435 the Yocto Project Reference Manual for information on supported images.
436 </para></listitem>
437 <listitem><para><emphasis>Make changes to the kernel source code if
438 applicable</emphasis>: Modifying the kernel does not always mean directly
439 changing source files.
440 However, if you have to do this, you make the changes to the files in the
441 Build directory.</para></listitem>
442 <listitem><para><emphasis>Make kernel configuration changes
443 if applicable</emphasis>:
444 If your situation calls for changing the kernel's configuration, you can
445 use the <filename>yocto-kernel</filename> script or <filename>menuconfig</filename>
446 to enable and disable kernel configurations.
447 Using the script lets you interactively set up kernel configurations.
448 Using <filename>menuconfig</filename> allows you to interactively develop and test the
449 configuration changes you are making to the kernel.
450 When saved, changes using <filename>menuconfig</filename> update the kernel's
451 <filename>.config</filename> file.
452 Try to resist the temptation of directly editing the <filename>.config</filename>
453 file found in the Build Directory at
454 <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>.
455 Doing so, can produce unexpected results when the OpenEmbedded build system
456 regenerates the configuration file.</para>
457 <para>Once you are satisfied with the configuration changes made using
458 <filename>menuconfig</filename>, you can directly compare the
459 <filename>.config</filename> file against a saved original and gather those
460 changes into a config fragment to be referenced from within the kernel's
461 <filename>.bbappend</filename> file.</para></listitem>
462 <listitem><para><emphasis>Rebuild the kernel image with your changes</emphasis>:
463 Rebuilding the kernel image applies your changes.</para></listitem>
464 </orderedlist>
465 </para>
466 </section>
467 </section>
468</section>
469
470<section id='application-development-workflow'>
471 <title>Application Development Workflow</title>
472
473 <para>
474 Application development involves creating an application that you want
475 to run on your target hardware, which is running a kernel image created using the
476 OpenEmbedded build system.
477 The Yocto Project provides an
478 <ulink url='&YOCTO_DOCS_ADT_URL;#adt-intro-section'>Application Development Toolkit (ADT)</ulink>
479 and stand-alone
480 <ulink url='&YOCTO_DOCS_ADT_URL;#the-cross-development-toolchain'>cross-development toolchains</ulink>
481 that facilitate quick development and integration of your application into its runtime environment.
482 Using the ADT and toolchains, you can compile and link your application.
483 You can then deploy your application to the actual hardware or to the QEMU emulator for testing.
484 If you are familiar with the popular <trademark class='trade'>Eclipse</trademark> IDE,
485 you can use an Eclipse Yocto Plug-in to
486 allow you to develop, deploy, and test your application all from within Eclipse.
487 </para>
488
489 <para>
490 While we strongly suggest using the ADT to develop your application, this option might not
491 be best for you.
492 If this is the case, you can still use pieces of the Yocto Project for your development process.
493 However, because the process can vary greatly, this manual does not provide detail on the process.
494 </para>
495
496 <section id='workflow-using-the-adt-and-eclipse'>
497 <title>Workflow Using the ADT and <trademark class='trade'>Eclipse</trademark></title>
498
499 <para>
500 To help you understand how application development works using the ADT, this section
501 provides an overview of the general development process and a detailed example of the process
502 as it is used from within the Eclipse IDE.
503 </para>
504
505 <para>
506 The following illustration and list summarize the application development general workflow.
507 </para>
508
509 <para>
510 <imagedata fileref="figures/app-dev-flow.png"
511 width="7in" depth="8in" align="center" scale="100" />
512 </para>
513
514 <para>
515 <orderedlist>
516 <listitem><para><emphasis>Prepare the host system for the Yocto Project</emphasis>:
517 See
518 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>" and
519 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both
520 in the Yocto Project Quick Start for requirements.</para></listitem>
521 <listitem><para><emphasis>Secure the Yocto Project kernel target image</emphasis>:
522 You must have a target kernel image that has been built using the OpenEmbedded
523 build system.</para>
524 <para>Depending on whether the Yocto Project has a pre-built image that matches your target
525 architecture and where you are going to run the image while you develop your application
526 (QEMU or real hardware), the area from which you get the image differs.
527 <itemizedlist>
528 <listitem><para>Download the image from
529 <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink>
530 if your target architecture is supported and you are going to develop
531 and test your application on actual hardware.</para></listitem>
532 <listitem><para>Download the image from
533 <ulink url='&YOCTO_QEMU_DL_URL;'>
534 <filename>machines/qemu</filename></ulink> if your target architecture is supported
535 and you are going to develop and test your application using the QEMU
536 emulator.</para></listitem>
537 <listitem><para>Build your image if you cannot find a pre-built image that matches
538 your target architecture.
539 If your target architecture is similar to a supported architecture, you can
540 modify the kernel image before you build it.
541 See the
542 "<link linkend='patching-the-kernel'>Patching the Kernel</link>"
543 section for an example.</para></listitem>
544 </itemizedlist></para>
545 <para>For information on pre-built kernel image naming schemes for images
546 that can run on the QEMU emulator, see the
547 "<ulink url='&YOCTO_DOCS_QS_URL;#downloading-the-pre-built-linux-kernel'>Downloading the Pre-Built Linux Kernel</ulink>"
548 section in the Yocto Project Quick Start.</para></listitem>
549 <listitem><para><emphasis>Install the ADT</emphasis>:
550 The ADT provides a target-specific cross-development toolchain, the root filesystem,
551 the QEMU emulator, and other tools that can help you develop your application.
552 While it is possible to get these pieces separately, the ADT Installer provides an
553 easy, inclusive method.
554 You can get these pieces by running an ADT installer script, which is configurable.
555 For information on how to install the ADT, see the
556 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Using the ADT Installer</ulink>"
557 section
558 in the Yocto Project Application Developer's Guide.</para></listitem>
559 <listitem><para><emphasis>If applicable, secure the target root filesystem
560 and the Cross-development toolchain</emphasis>:
561 If you choose not to install the ADT using the ADT Installer,
562 you need to find and download the appropriate root filesystem and
563 the cross-development toolchain.</para>
564 <para>You can find the tarballs for the root filesystem in the same area used
565 for the kernel image.
566 Depending on the type of image you are running, the root filesystem you need differs.
567 For example, if you are developing an application that runs on an image that
568 supports Sato, you need to get a root filesystem that supports Sato.</para>
569 <para>You can find the cross-development toolchains at
570 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'><filename>toolchains</filename></ulink>.
571 Be sure to get the correct toolchain for your development host and your
572 target architecture.
573 See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>"
574 section in the Yocto Project Application Developer's Guide for information
575 and the
576 "<ulink url='&YOCTO_DOCS_QS_URL;#installing-the-toolchain'>Installing the Toolchain</ulink>"
577 in the Yocto Project Quick Start for information on finding and installing
578 the correct toolchain based on your host development system and your target
579 architecture.
580 </para></listitem>
581 <listitem><para><emphasis>Create and build your application</emphasis>:
582 At this point, you need to have source files for your application.
583 Once you have the files, you can use the Eclipse IDE to import them and build the
584 project.
585 If you are not using Eclipse, you need to use the cross-development tools you have
586 installed to create the image.</para></listitem>
587 <listitem><para><emphasis>Deploy the image with the application</emphasis>:
588 If you are using the Eclipse IDE, you can deploy your image to the hardware or to
589 QEMU through the project's preferences.
590 If you are not using the Eclipse IDE, then you need to deploy the application
591 to the hardware using other methods.
592 Or, if you are using QEMU, you need to use that tool and load your image in for testing.
593 </para></listitem>
594 <listitem><para><emphasis>Test and debug the application</emphasis>:
595 Once your application is deployed, you need to test it.
596 Within the Eclipse IDE, you can use the debugging environment along with the
597 set of user-space tools installed along with the ADT to debug your application.
598 Of course, the same user-space tools are available separately if you choose
599 not to use the Eclipse IDE.</para></listitem>
600 </orderedlist>
601 </para>
602 </section>
603
604 <section id='adt-eclipse'>
605 <title>Working Within Eclipse</title>
606
607 <para>
608 The Eclipse IDE is a popular development environment and it fully
609 supports development using the Yocto Project.
610 <note>
611 This release of the Yocto Project supports both the Kepler
612 and Juno versions of the Eclipse IDE.
613 Thus, the following information provides setup information for
614 both versions.
615 </note>
616 </para>
617
618 <para>
619 When you install and configure the Eclipse Yocto Project Plug-in
620 into the Eclipse IDE, you maximize your Yocto Project experience.
621 Installing and configuring the Plug-in results in an environment
622 that has extensions specifically designed to let you more easily
623 develop software.
624 These extensions allow for cross-compilation, deployment, and
625 execution of your output into a QEMU emulation session as well as
626 actual target hardware.
627 You can also perform cross-debugging and profiling.
628 The environment also supports a suite of tools that allows you
629 to perform remote profiling, tracing, collection of power data,
630 collection of latency data, and collection of performance data.
631 </para>
632
633 <para>
634 This section describes how to install and configure the Eclipse IDE
635 Yocto Plug-in and how to use it to develop your application.
636 </para>
637
638 <section id='setting-up-the-eclipse-ide'>
639 <title>Setting Up the Eclipse IDE</title>
640
641 <para>
642 To develop within the Eclipse IDE, you need to do the following:
643 <orderedlist>
644 <listitem><para>Install the optimal version of the Eclipse
645 IDE.</para></listitem>
646 <listitem><para>Configure the Eclipse IDE.
647 </para></listitem>
648 <listitem><para>Install the Eclipse Yocto Plug-in.
649 </para></listitem>
650 <listitem><para>Configure the Eclipse Yocto Plug-in.
651 </para></listitem>
652 </orderedlist>
653 <note>
654 Do not install Eclipse from your distribution's package
655 repository.
656 Be sure to install Eclipse from the official Eclipse
657 download site as directed in the next section.
658 </note>
659 </para>
660
661 <section id='installing-eclipse-ide'>
662 <title>Installing the Eclipse IDE</title>
663
664 <para>
665 It is recommended that you have the Kepler 4.3 version of
666 the Eclipse IDE installed on your development system.
667 However, if you currently have the Juno 4.2 version
668 installed and you do not want to upgrade the IDE, you can
669 configure Juno to work with the Yocto Project.
670 </para>
671
672 <para>
673 If you do not have the Kepler 4.3 Eclipse IDE installed, you
674 can find the tarball at
675 <ulink url='&ECLIPSE_MAIN_URL;'></ulink>.
676 From that site, choose the Eclipse Standard 4.3 version
677 particular to your development host.
678 This version contains the Eclipse Platform, the Java
679 Development Tools (JDT), and the Plug-in Development
680 Environment.
681 </para>
682
683 <para>
684 Once you have downloaded the tarball, extract it into a
685 clean directory.
686 For example, the following commands unpack and install the
687 downloaded Eclipse IDE tarball into a clean directory
688 using the default name <filename>eclipse</filename>:
689 <literallayout class='monospaced'>
690 $ cd ~
691 $ tar -xzvf ~/Downloads/eclipse-standard-kepler-R-linux-gtk-x86_64.tar.gz
692 </literallayout>
693 </para>
694 </section>
695
696 <section id='configuring-the-eclipse-ide'>
697 <title>Configuring the Eclipse IDE</title>
698
699 <para>
700 This section presents the steps needed to configure the
701 Eclipse IDE.
702 </para>
703
704 <para>
705 Before installing and configuring the Eclipse Yocto Plug-in,
706 you need to configure the Eclipse IDE.
707 Follow these general steps:
708 <orderedlist>
709 <listitem><para>Start the Eclipse IDE.</para></listitem>
710 <listitem><para>Make sure you are in your Workbench and
711 select "Install New Software" from the "Help"
712 pull-down menu.</para></listitem>
713 <listitem><para>Select
714 <filename>Kepler - &ECLIPSE_KEPLER_URL;</filename>
715 from the "Work with:" pull-down menu.
716 <note>
717 For Juno, select
718 <filename>Juno - &ECLIPSE_JUNO_URL;</filename>
719 </note>
720 </para></listitem>
721 <listitem><para>Expand the box next to "Linux Tools"
722 and select the
723 <filename>LTTng - Linux Tracing Toolkit</filename>
724 boxes.</para></listitem>
725 <listitem><para>Expand the box next to "Mobile and
726 Device Development" and select the following boxes:
727 <itemizedlist>
728 <listitem><para><filename>C/C++ Remote Launch</filename></para></listitem>
729 <listitem><para><filename>Remote System Explorer End-user Runtime</filename></para></listitem>
730 <listitem><para><filename>Remote System Explorer User Actions</filename></para></listitem>
731 <listitem><para><filename>Target Management Terminal</filename></para></listitem>
732 <listitem><para><filename>TCF Remote System Explorer add-in</filename></para></listitem>
733 <listitem><para><filename>TCF Target Explorer</filename></para></listitem>
734 </itemizedlist></para></listitem>
735 <listitem><para>Expand the box next to "Programming
736 Languages" and select the
737 <filename>Autotools Support for CDT</filename>
738 and <filename>C/C++ Development Tools</filename>
739 boxes.</para></listitem>
740 <listitem><para>Complete the installation and restart
741 the Eclipse IDE.</para></listitem>
742 </orderedlist>
743 </para>
744 </section>
745
746 <section id='installing-the-eclipse-yocto-plug-in'>
747 <title>Installing or Accessing the Eclipse Yocto Plug-in</title>
748
749 <para>
750 You can install the Eclipse Yocto Plug-in into the Eclipse
751 IDE one of two ways: use the Yocto Project's Eclipse
752 Update site to install the pre-built plug-in or build and
753 install the plug-in from the latest source code.
754 </para>
755
756 <section id='new-software'>
757 <title>Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site</title>
758
759 <para>
760 To install the Eclipse Yocto Plug-in from the update
761 site, follow these steps:
762 <orderedlist>
763 <listitem><para>Start up the Eclipse IDE.
764 </para></listitem>
765 <listitem><para>In Eclipse, select "Install New
766 Software" from the "Help" menu.
767 </para></listitem>
768 <listitem><para>Click "Add..." in the "Work with:"
769 area.</para></listitem>
770 <listitem><para>Enter
771 <filename>&ECLIPSE_DL_PLUGIN_URL;/kepler</filename>
772 in the URL field and provide a meaningful name
773 in the "Name" field.
774 <note>
775 If you are using Juno, use
776 <filename>&ECLIPSE_DL_PLUGIN_URL;/juno</filename>
777 in the URL field.
778 </note></para></listitem>
779 <listitem><para>Click "OK" to have the entry added
780 to the "Work with:" drop-down list.
781 </para></listitem>
782 <listitem><para>Select the entry for the plug-in
783 from the "Work with:" drop-down list.
784 </para></listitem>
785 <listitem><para>Check the boxes next to
786 <filename>Yocto Project ADT Plug-in</filename>,
787 <filename>Yocto Project Bitbake Commander Plug-in</filename>,
788 and
789 <filename>Yocto Project Documentation plug-in</filename>.
790 </para></listitem>
791 <listitem><para>Complete the remaining software
792 installation steps and then restart the Eclipse
793 IDE to finish the installation of the plug-in.
794 </para></listitem>
795 </orderedlist>
796 </para>
797 </section>
798
799 <section id='zip-file-method'>
800 <title>Installing the Plug-in Using the Latest Source Code</title>
801
802 <para>
803 To install the Eclipse Yocto Plug-in from the latest
804 source code, follow these steps:
805 <orderedlist>
806 <listitem><para>Be sure your development system
807 is not using OpenJDK to build the plug-in
808 by doing the following:
809 <orderedlist>
810 <listitem><para>Use the Oracle JDK.
811 If you don't have that, go to
812 <ulink url='http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html'></ulink>
813 and download the appropriate tarball
814 for your development system and
815 extract it into your home directory.
816 </para></listitem>
817 <listitem><para>In the shell you are going
818 to do your work, export the location of
819 the Oracle Java as follows:
820 <literallayout class='monospaced'>
821 export PATH=~/jdk1.7.0_40/bin:$PATH
822 </literallayout></para></listitem>
823 </orderedlist></para></listitem>
824 <listitem><para>In the same shell, create a Git
825 repository with:
826 <literallayout class='monospaced'>
827 $ cd ~
828 $ git clone git://git.yoctoproject.org/eclipse-poky-kepler
829 </literallayout>
830 <note>
831 If you are using Juno, the repository is
832 located at
833 <filename>git://git.yoctoproject.org/eclipse-poky-juno</filename>.
834 </note>
835 For this example, the repository is named
836 <filename>~/eclipse-poky-kepler</filename>.
837 </para></listitem>
838 <listitem><para>Change to the directory where you
839 set up the Git repository:
840 <literallayout class='monospaced'>
841 $ cd ~/eclipse-poky-kepler
842 </literallayout></para></listitem>
843 <listitem><para>Be sure you are in the right branch
844 for your Git repository.
845 For this release set the branch to
846 <filename>&DISTRO_NAME;</filename>:
847 <literallayout class='monospaced'>
848 $ git checkout &DISTRO_NAME;
849 </literallayout></para></listitem>
850 <listitem><para>Change to the
851 <filename>scripts</filename>
852 directory within the Git repository:
853 <literallayout class='monospaced'>
854 $ cd scripts
855 </literallayout></para></listitem>
856 <listitem><para>Set up the local build environment
857 by running the setup script:
858 <literallayout class='monospaced'>
859 $ ./setup.sh
860 </literallayout></para></listitem>
861 <listitem><para>When the script finishes execution,
862 it prompts you with instructions on how to run
863 the <filename>build.sh</filename> script, which
864 is also in the <filename>scripts</filename> of
865 the Git repository created earlier.
866 </para></listitem>
867 <listitem><para>Run the <filename>build.sh</filename> script
868 as directed.
869 Be sure to provide the name of the Git branch
870 along with the Yocto Project release you are
871 using.
872 Here is an example that uses the
873 <filename>&DISTRO_NAME;</filename> branch:
874 <literallayout class='monospaced'>
875 $ ECLIPSE_HOME=/home/scottrif/eclipse-poky-kepler/scripts/eclipse ./build.sh &DISTRO_NAME; &DISTRO_NAME;
876 </literallayout>
877 After running the script, the file
878 <filename>org.yocto.sdk-&lt;release&gt;-&lt;date&gt;-archive.zip</filename>
879 is in the current directory.</para></listitem>
880 <listitem><para>If necessary, start the Eclipse IDE
881 and be sure you are in the Workbench.
882 </para></listitem>
883 <listitem><para>Select "Install New Software" from the "Help" pull-down menu.
884 </para></listitem>
885 <listitem><para>Click "Add".</para></listitem>
886 <listitem><para>Provide anything you want in the
887 "Name" field.</para></listitem>
888 <listitem><para>Click "Archive" and browse to the
889 ZIP file you built in step seven.
890 This ZIP file should not be "unzipped", and must
891 be the <filename>*archive.zip</filename> file
892 created by running the
893 <filename>build.sh</filename> script.
894 </para></listitem>
895 <listitem><para>Click through the "Okay" buttons.
896 </para></listitem>
897 <listitem><para>Check the boxes
898 in the installation window and complete
899 the installation.</para></listitem>
900 <listitem><para>Restart the Eclipse IDE if
901 necessary.</para></listitem>
902 </orderedlist>
903 </para>
904
905 <para>
906 At this point you should be able to configure the
907 Eclipse Yocto Plug-in as described in the
908 "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>"
909 section.</para>
910 </section>
911 </section>
912
913 <section id='configuring-the-eclipse-yocto-plug-in'>
914 <title>Configuring the Eclipse Yocto Plug-in</title>
915
916 <para>
917 Configuring the Eclipse Yocto Plug-in involves setting the
918 Cross Compiler options and the Target options.
919 The configurations you choose become the default settings
920 for all projects.
921 You do have opportunities to change them later when
922 you configure the project (see the following section).
923 </para>
924
925 <para>
926 To start, you need to do the following from within the
927 Eclipse IDE:
928 <itemizedlist>
929 <listitem><para>Choose "Preferences" from the
930 "Windows" menu to display the Preferences Dialog.
931 </para></listitem>
932 <listitem><para>Click "Yocto Project ADT".
933 </para></listitem>
934 </itemizedlist>
935 </para>
936
937 <section id='configuring-the-cross-compiler-options'>
938 <title>Configuring the Cross-Compiler Options</title>
939
940 <para>
941 To configure the Cross Compiler Options, you must select
942 the type of toolchain, point to the toolchain, specify
943 the sysroot location, and select the target
944 architecture.
945 <itemizedlist>
946 <listitem><para><emphasis>Selecting the Toolchain Type:</emphasis>
947 Choose between
948 <filename>Standalone pre-built toolchain</filename>
949 and
950 <filename>Build system derived toolchain</filename>
951 for Cross Compiler Options.
952 <itemizedlist>
953 <listitem><para><emphasis>
954 <filename>Standalone Pre-built Toolchain:</filename></emphasis>
955 Select this mode when you are using
956 a stand-alone cross-toolchain.
957 For example, suppose you are an
958 application developer and do not
959 need to build a target image.
960 Instead, you just want to use an
961 architecture-specific toolchain on
962 an existing kernel and target root
963 filesystem.</para></listitem>
964 <listitem><para><emphasis>
965 <filename>Build System Derived Toolchain:</filename></emphasis>
966 Select this mode if the
967 cross-toolchain has been installed
968 and built as part of the
969 <link linkend='build-directory'>Build Directory</link>.
970 When you select
971 <filename>Build system derived toolchain</filename>,
972 you are using the toolchain bundled
973 inside the Build Directory.
974 </para></listitem>
975 </itemizedlist>
976 </para></listitem>
977 <listitem><para><emphasis>Point to the Toolchain:</emphasis>
978 If you are using a stand-alone pre-built
979 toolchain, you should be pointing to where it is
980 installed.
981 If you used the ADT Installer script and
982 accepted the default installation directory, the
983 toolchain will be installed in the
984 <filename>&YOCTO_ADTPATH_DIR;</filename>
985 directory.
986 Sections "<ulink url='&YOCTO_DOCS_ADT_URL;#configuring-and-running-the-adt-installer-script'>Configuring and Running the ADT Installer Script</ulink>"
987 and
988 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>"
989 in the Yocto Project Application Developer's
990 Guide describe how to install a stand-alone
991 cross-toolchain.</para>
992 <para>If you are using a system-derived
993 toolchain, the path you provide for the
994 <filename>Toolchain Root Location</filename>
995 field is the
996 <link linkend='build-directory'>Build Directory</link>.
997 See the
998 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Build Directory</ulink>"
999 section in the Yocto Project Application
1000 Developer's Guide for information on how to
1001 install the toolchain into the Build
1002 Directory.</para></listitem>
1003 <listitem><para><emphasis>Specify the Sysroot Location:</emphasis>
1004 This location is where the root filesystem for
1005 the target hardware resides.
1006 If you used the ADT Installer script and
1007 accepted the default installation directory,
1008 then the location is
1009 <filename>/opt/poky/&lt;release&gt;</filename>.
1010 Additionally, when you use the ADT Installer
1011 script, the same location is used for the QEMU
1012 user-space tools and the NFS boot process.
1013 </para>
1014 <para>If you used either of the other two
1015 methods to install the toolchain or did not
1016 accept the ADT Installer script's default
1017 installation directory, then the location of
1018 the sysroot filesystem depends on where you
1019 separately extracted and installed the
1020 filesystem.</para>
1021 <para>For information on how to install the
1022 toolchain and on how to extract and install the
1023 sysroot filesystem, see the
1024 "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>" section.
1025 </para></listitem>
1026 <listitem><para><emphasis>Select the Target Architecture:</emphasis>
1027 The target architecture is the type of hardware
1028 you are going to use or emulate.
1029 Use the pull-down
1030 <filename>Target Architecture</filename> menu
1031 to make your selection.
1032 The pull-down menu should have the supported
1033 architectures.
1034 If the architecture you need is not listed in
1035 the menu, you will need to build the image.
1036 See the
1037 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
1038 section of the Yocto Project Quick Start for
1039 more information.</para></listitem>
1040 </itemizedlist>
1041 </para>
1042 </section>
1043
1044 <section id='configuring-the-target-options'>
1045 <title>Configuring the Target Options</title>
1046
1047 <para>
1048 You can choose to emulate hardware using the QEMU
1049 emulator, or you can choose to run your image on actual
1050 hardware.
1051 <itemizedlist>
1052 <listitem><para><emphasis><filename>QEMU:</filename></emphasis>
1053 Select this option if you will be using the
1054 QEMU emulator.
1055 If you are using the emulator, you also need to
1056 locate the kernel and specify any custom
1057 options.</para>
1058 <para>If you selected
1059 <filename>Build system derived toolchain</filename>,
1060 the target kernel you built will be located in
1061 the Build Directory in
1062 <filename>tmp/deploy/images/&lt;machine&gt;</filename>
1063 directory.
1064 If you selected
1065 <filename>Standalone pre-built toolchain</filename>,
1066 the pre-built image you downloaded is located
1067 in the directory you specified when you
1068 downloaded the image.</para>
1069 <para>Most custom options are for advanced QEMU
1070 users to further customize their QEMU instance.
1071 These options are specified between paired
1072 angled brackets.
1073 Some options must be specified outside the
1074 brackets.
1075 In particular, the options
1076 <filename>serial</filename>,
1077 <filename>nographic</filename>, and
1078 <filename>kvm</filename> must all be outside the
1079 brackets.
1080 Use the <filename>man qemu</filename> command
1081 to get help on all the options and their use.
1082 The following is an example:
1083 <literallayout class='monospaced'>
1084 serial ‘&lt;-m 256 -full-screen&gt;’
1085 </literallayout></para>
1086 <para>
1087 Regardless of the mode, Sysroot is already
1088 defined as part of the Cross-Compiler Options
1089 configuration in the
1090 <filename>Sysroot Location:</filename> field.
1091 </para></listitem>
1092 <listitem><para><emphasis><filename>External HW:</filename></emphasis>
1093 Select this option if you will be using actual
1094 hardware.</para></listitem>
1095 </itemizedlist>
1096 </para>
1097
1098 <para>
1099 Click the "OK" to save your plug-in configurations.
1100 </para>
1101 </section>
1102 </section>
1103 </section>
1104
1105 <section id='creating-the-project'>
1106 <title>Creating the Project</title>
1107
1108 <para>
1109 You can create two types of projects: Autotools-based, or
1110 Makefile-based.
1111 This section describes how to create Autotools-based projects
1112 from within the Eclipse IDE.
1113 For information on creating Makefile-based projects in a
1114 terminal window, see the section
1115 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-command-line'>Using the Command Line</ulink>"
1116 in the Yocto Project Application Developer's Guide.
1117 </para>
1118
1119 <para>
1120 To create a project based on a Yocto template and then display
1121 the source code, follow these steps:
1122 <orderedlist>
1123 <listitem><para>Select "Project" from the "File -> New" menu.
1124 </para></listitem>
1125 <listitem><para>Double click <filename>CC++</filename>.
1126 </para></listitem>
1127 <listitem><para>Double click <filename>C Project</filename>
1128 to create the project.</para></listitem>
1129 <listitem><para>Expand <filename>Yocto Project ADT Project</filename>.
1130 </para></listitem>
1131 <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>.
1132 This is an Autotools-based project based on a Yocto
1133 template.</para></listitem>
1134 <listitem><para>Put a name in the <filename>Project name:</filename>
1135 field.
1136 Do not use hyphens as part of the name.
1137 </para></listitem>
1138 <listitem><para>Click "Next".</para></listitem>
1139 <listitem><para>Add information in the
1140 <filename>Author</filename> and
1141 <filename>Copyright notice</filename> fields.
1142 </para></listitem>
1143 <listitem><para>Be sure the <filename>License</filename>
1144 field is correct.</para></listitem>
1145 <listitem><para>Click "Finish".</para></listitem>
1146 <listitem><para>If the "open perspective" prompt appears,
1147 click "Yes" so that you in the C/C++ perspective.
1148 </para></listitem>
1149 <listitem><para>The left-hand navigation pane shows your
1150 project.
1151 You can display your source by double clicking the
1152 project's source file.</para></listitem>
1153 </orderedlist>
1154 </para>
1155 </section>
1156
1157 <section id='configuring-the-cross-toolchains'>
1158 <title>Configuring the Cross-Toolchains</title>
1159
1160 <para>
1161 The earlier section,
1162 "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>",
1163 sets up the default project configurations.
1164 You can override these settings for a given project by following
1165 these steps:
1166 <orderedlist>
1167 <listitem><para>Select "Change Yocto Project Settings" from
1168 the "Project" menu.
1169 This selection brings up the Yocto Project Settings
1170 Dialog and allows you to make changes specific to an
1171 individual project.</para>
1172 <para>By default, the Cross Compiler Options and Target
1173 Options for a project are inherited from settings you
1174 provide using the Preferences Dialog as described
1175 earlier in the
1176 "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" section.
1177 The Yocto Project Settings Dialog allows you to override
1178 those default settings for a given project.
1179 </para></listitem>
1180 <listitem><para>Make your configurations for the project
1181 and click "OK".
1182 If you are running the Juno version of Eclipse, you can
1183 skip down to the next section where you build the
1184 project.
1185 If you are not working with Juno, you need to reconfigure the
1186 project as described in the next step.
1187 </para></listitem>
1188 <listitem><para>Select "Reconfigure Project" from the
1189 "Project" menu.
1190 This selection reconfigures the project by running
1191 <filename>autogen.sh</filename> in the workspace for
1192 your project.
1193 The script also runs <filename>libtoolize</filename>,
1194 <filename>aclocal</filename>,
1195 <filename>autoconf</filename>,
1196 <filename>autoheader</filename>,
1197 <filename>automake --a</filename>, and
1198 <filename>./configure</filename>.
1199 Click on the "Console" tab beneath your source code to
1200 see the results of reconfiguring your project.
1201 </para></listitem>
1202 </orderedlist>
1203 </para>
1204 </section>
1205
1206 <section id='building-the-project'>
1207 <title>Building the Project</title>
1208
1209 <para>
1210 To build the project in Juno, right click on the project in
1211 the navigator pane and select "Build Project".
1212 If you are not running Juno, select "Build Project" from the
1213 "Project" menu.
1214 The console should update and you can note the cross-compiler
1215 you are using.
1216 </para>
1217 </section>
1218
1219 <section id='starting-qemu-in-user-space-nfs-mode'>
1220 <title>Starting QEMU in User-Space NFS Mode</title>
1221
1222 <para>
1223 To start the QEMU emulator from within Eclipse, follow these
1224 steps:
1225 <orderedlist>
1226 <listitem><para>Expose and select "External Tools" from
1227 the "Run" menu.
1228 Your image should appear as a selectable menu item.
1229 </para></listitem>
1230 <listitem><para>Select your image from the menu to launch
1231 the emulator in a new window.</para></listitem>
1232 <listitem><para>If needed, enter your host root password in
1233 the shell window at the prompt.
1234 This sets up a <filename>Tap 0</filename> connection
1235 needed for running in user-space NFS mode.
1236 </para></listitem>
1237 <listitem><para>Wait for QEMU to launch.</para></listitem>
1238 <listitem><para>Once QEMU launches, you can begin operating
1239 within that environment.
1240 For example, you could determine the IP Address
1241 for the user-space NFS by using the
1242 <filename>ifconfig</filename> command.</para></listitem>
1243 </orderedlist>
1244 </para>
1245 </section>
1246
1247 <section id='deploying-and-debugging-the-application'>
1248 <title>Deploying and Debugging the Application</title>
1249
1250 <para>
1251 Once the QEMU emulator is running the image, you can deploy
1252 your application using the Eclipse IDE and use then use
1253 the emulator to perform debugging.
1254 Follow these steps to deploy the application.
1255 <orderedlist>
1256 <listitem><para>Select "Debug Configurations..." from the
1257 "Run" menu.</para></listitem>
1258 <listitem><para>In the left area, expand
1259 <filename>C/C++Remote Application</filename>.
1260 </para></listitem>
1261 <listitem><para>Locate your project and select it to bring
1262 up a new tabbed view in the Debug Configurations Dialog.
1263 </para></listitem>
1264 <listitem><para>Enter the absolute path into which you want
1265 to deploy the application.
1266 Use the "Remote Absolute File Path for
1267 C/C++Application:" field.
1268 For example, enter
1269 <filename>/usr/bin/&lt;programname&gt;</filename>.
1270 </para></listitem>
1271 <listitem><para>Click on the "Debugger" tab to see the
1272 cross-tool debugger you are using.</para></listitem>
1273 <listitem><para>Click on the "Main" tab.</para></listitem>
1274 <listitem><para>Create a new connection to the QEMU instance
1275 by clicking on "new".</para></listitem>
1276 <listitem><para>Select <filename>TCF</filename>, which means
1277 Target Communication Framework.</para></listitem>
1278 <listitem><para>Click "Next".</para></listitem>
1279 <listitem><para>Clear out the "host name" field and enter
1280 the IP Address determined earlier.</para></listitem>
1281 <listitem><para>Click "Finish" to close the
1282 New Connections Dialog.</para></listitem>
1283 <listitem><para>Use the drop-down menu now in the
1284 "Connection" field and pick the IP Address you entered.
1285 </para></listitem>
1286 <listitem><para>Click "Run" to bring up a login screen
1287 and login.</para></listitem>
1288 <listitem><para>Accept the debug perspective.
1289 </para></listitem>
1290 </orderedlist>
1291 </para>
1292 </section>
1293
1294 <section id='running-user-space-tools'>
1295 <title>Running User-Space Tools</title>
1296
1297 <para>
1298 As mentioned earlier in the manual, several tools exist that
1299 enhance your development experience.
1300 These tools are aids in developing and debugging applications
1301 and images.
1302 You can run these user-space tools from within the Eclipse
1303 IDE through the "YoctoTools" menu.
1304 </para>
1305
1306 <para>
1307 Once you pick a tool, you need to configure it for the remote
1308 target.
1309 Every tool needs to have the connection configured.
1310 You must select an existing TCF-based RSE connection to the
1311 remote target.
1312 If one does not exist, click "New" to create one.
1313 </para>
1314
1315 <para>
1316 Here are some specifics about the remote tools:
1317 <itemizedlist>
1318 <listitem><para><emphasis><filename>OProfile</filename>:</emphasis>
1319 Selecting this tool causes the
1320 <filename>oprofile-server</filename> on the remote
1321 target to launch on the local host machine.
1322 The <filename>oprofile-viewer</filename> must be
1323 installed on the local host machine and the
1324 <filename>oprofile-server</filename> must be installed
1325 on the remote target, respectively, in order to use.
1326 You must compile and install the
1327 <filename>oprofile-viewer</filename> from the source
1328 code on your local host machine.
1329 Furthermore, in order to convert the target's sample
1330 format data into a form that the host can use, you must
1331 have OProfile version 0.9.4 or greater installed on the
1332 host.</para>
1333 <para>You can locate both the viewer and server from
1334 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
1335 You can also find more information on setting up and
1336 using this tool in the
1337 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>"
1338 section of the Yocto Project Profiling and Tracing
1339 Manual.
1340 <note>The <filename>oprofile-server</filename> is
1341 installed by default on the
1342 <filename>core-image-sato-sdk</filename> image.</note>
1343 </para></listitem>
1344 <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis>
1345 Selecting this tool transfers the remote target's
1346 <filename>Lttng</filename> tracing data back to the
1347 local host machine and uses the Lttng Eclipse plug-in
1348 to graphically display the output.
1349 For information on how to use Lttng to trace an
1350 application,
1351 see <ulink url='http://lttng.org/documentation'></ulink>
1352 and the
1353 "<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>"
1354 section, which is in the Yocto Project Profiling and
1355 Tracing Manual.
1356 <note>Do not use
1357 <filename>Lttng-user space (legacy)</filename> tool.
1358 This tool no longer has any upstream support.</note>
1359 </para>
1360 <para>Before you use the
1361 <filename>Lttng2.0 ust trace import</filename> tool,
1362 you need to setup the Lttng Eclipse plug-in and create a
1363 Tracing project.
1364 Do the following:
1365 <orderedlist>
1366 <listitem><para>Select "Open Perspective" from the
1367 "Window" menu and then select "Tracing".
1368 </para></listitem>
1369 <listitem><para>Click "OK" to change the Eclipse
1370 perspective into the Tracing perspective.
1371 </para></listitem>
1372 <listitem><para>Create a new Tracing project by
1373 selecting "Project" from the "File -> New" menu.
1374 </para></listitem>
1375 <listitem><para>Choose "Tracing Project" from the
1376 "Tracing" menu.
1377 </para></listitem>
1378 <listitem><para>Generate your tracing data on the
1379 remote target.</para></listitem>
1380 <listitem><para>Select "Lttng2.0 ust trace import"
1381 from the "Yocto Project Tools" menu to
1382 start the data import process.</para></listitem>
1383 <listitem><para>Specify your remote connection name.
1384 </para></listitem>
1385 <listitem><para>For the Ust directory path, specify
1386 the location of your remote tracing data.
1387 Make sure the location ends with
1388 <filename>ust</filename> (e.g.
1389 <filename>/usr/mysession/ust</filename>).
1390 </para></listitem>
1391 <listitem><para>Click "OK" to complete the import
1392 process.
1393 The data is now in the local tracing project
1394 you created.</para></listitem>
1395 <listitem><para>Right click on the data and then use
1396 the menu to Select "Generic CTF Trace" from the
1397 "Trace Type... -> Common Trace Format" menu to
1398 map the tracing type.</para></listitem>
1399 <listitem><para>Right click the mouse and select
1400 "Open" to bring up the Eclipse Lttng Trace
1401 Viewer so you view the tracing data.
1402 </para></listitem>
1403 </orderedlist></para></listitem>
1404 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis>
1405 Selecting this tool runs PowerTOP on the remote target
1406 machine and displays the results in a new view called
1407 PowerTOP.</para>
1408 <para>The "Time to gather data(sec):" field is the time
1409 passed in seconds before data is gathered from the
1410 remote target for analysis.</para>
1411 <para>The "show pids in wakeups list:" field corresponds
1412 to the <filename>-p</filename> argument passed to
1413 <filename>PowerTOP</filename>.</para></listitem>
1414 <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis>
1415 LatencyTOP identifies system latency, while
1416 Perf monitors the system's performance counter
1417 registers.
1418 Selecting either of these tools causes an RSE terminal
1419 view to appear from which you can run the tools.
1420 Both tools refresh the entire screen to display results
1421 while they run.
1422 For more information on setting up and using
1423 <filename>perf</filename>, see the
1424 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
1425 section in the Yocto Project Profiling and Tracing
1426 Manual.
1427 </para></listitem>
1428 </itemizedlist>
1429 </para>
1430 </section>
1431
1432 <section id='customizing-an-image-using-a-bitbake-commander-project-and-hob'>
1433 <title>Customizing an Image Using a BitBake Commander Project and Hob</title>
1434
1435 <para>
1436 Within the Eclipse IDE, you can create a Yocto BitBake Commander
1437 project, edit the <link linkend='metadata'>Metadata</link>, and
1438 then use
1439 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink> to build a customized image all within one IDE.
1440 </para>
1441
1442 <section id='creating-the-yocto-bitbake-commander-project'>
1443 <title>Creating the Yocto BitBake Commander Project</title>
1444
1445 <para>
1446 To create a Yocto BitBake Commander project, follow these
1447 steps:
1448 <orderedlist>
1449 <listitem><para>Select "Other" from the
1450 "Window -> Open Perspective" menu
1451 and then choose "Bitbake Commander".
1452 </para></listitem>
1453 <listitem><para>Click "OK" to change the perspective to
1454 Bitbake Commander.</para></listitem>
1455 <listitem><para>Select "Project" from the "File -> New"
1456 menu to create a new Yocto
1457 Bitbake Commander project.</para></listitem>
1458 <listitem><para>Choose "New Yocto Project" from the
1459 "Yocto Project Bitbake Commander" menu and click
1460 "Next".</para></listitem>
1461 <listitem><para>Enter the Project Name and choose the
1462 Project Location.
1463 The Yocto project's Metadata files will be put under
1464 the directory
1465 <filename>&lt;project_location&gt;/&lt;project_name&gt;</filename>.
1466 If that directory does not exist, you need to check
1467 the "Clone from Yocto Git Repository" box, which
1468 would execute a <filename>git clone</filename>
1469 command to get the project's Metadata files.
1470 <note>
1471 Do not specify your BitBake Commander project
1472 location as your Eclipse workspace.
1473 Doing so causes an error indicating that the
1474 current project overlaps the location of
1475 another project.
1476 This error occurs even if no such project exits.
1477 </note></para></listitem>
1478 <listitem><para>Select <filename>Finish</filename> to
1479 create the project.</para></listitem>
1480 </orderedlist>
1481 </para>
1482 </section>
1483
1484 <section id='editing-the-metadata'>
1485 <title>Editing the Metadata</title>
1486
1487 <para>
1488 After you create the Yocto Bitbake Commander project, you
1489 can modify the <link linkend='metadata'>Metadata</link>
1490 files by opening them in the project.
1491 When editing recipe files (<filename>.bb</filename> files),
1492 you can view BitBake variable values and information by
1493 hovering the mouse pointer over the variable name and
1494 waiting a few seconds.
1495 </para>
1496
1497 <para>
1498 To edit the Metadata, follow these steps:
1499 <orderedlist>
1500 <listitem><para>Select your Yocto Bitbake Commander
1501 project.</para></listitem>
1502 <listitem><para>Select "BitBake Recipe" from the
1503 "File -> New -> Yocto BitBake Commander" menu
1504 to open a new recipe wizard.</para></listitem>
1505 <listitem><para>Point to your source by filling in the
1506 "SRC_URL" field.
1507 For example, you can add a recipe to your
1508 <link linkend='source-directory'>Source Directory</link>
1509 by defining "SRC_URL" as follows:
1510 <literallayout class='monospaced'>
1511 ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz
1512 </literallayout></para></listitem>
1513 <listitem><para>Click "Populate" to calculate the
1514 archive md5, sha256, license checksum values and to
1515 auto-generate the recipe filename.</para></listitem>
1516 <listitem><para>Fill in the "Description" field.
1517 </para></listitem>
1518 <listitem><para>Be sure values for all required
1519 fields exist.</para></listitem>
1520 <listitem><para>Click "Finish".</para></listitem>
1521 </orderedlist>
1522 </para>
1523 </section>
1524
1525 <section id='biding-and-customizing-the-image-using-hob'>
1526 <title>Building and Customizing the Image Using Hob</title>
1527
1528 <para>
1529 To build and customize the image using Hob from within the
1530 Eclipse IDE, follow these steps:
1531 <orderedlist>
1532 <listitem><para>Select your Yocto Bitbake Commander
1533 project.</para></listitem>
1534 <listitem><para>Select "Launch Hob" from the "Project"
1535 menu.</para></listitem>
1536 <listitem><para>Enter the
1537 <link linkend='build-directory'>Build Directory</link>
1538 where you want to put your final images.
1539 </para></listitem>
1540 <listitem><para>Click "OK" to launch Hob.
1541 </para></listitem>
1542 <listitem><para>Use Hob to customize and build your own
1543 images.
1544 For information on Hob, see the
1545 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob Project Page</ulink>
1546 on the Yocto Project website.</para></listitem>
1547 </orderedlist>
1548 </para>
1549 </section>
1550 </section>
1551 </section>
1552
1553 <section id='workflow-using-stand-alone-cross-development-toolchains'>
1554 <title>Workflow Using Stand-Alone Cross-Development Toolchains</title>
1555
1556 <para>
1557 If you want to develop an application without prior installation
1558 of the ADT, you still can employ the
1559 <link linkend='cross-development-toolchain'>Cross Development Toolchain</link>,
1560 the QEMU emulator, and a number of supported target image files.
1561 You just need to follow these general steps:
1562 <orderedlist>
1563 <listitem><para><emphasis>Install the cross-development
1564 toolchain for your target hardware:</emphasis>
1565 For information on how to install the toolchain, see the
1566 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>"
1567 section in the Yocto Project Application Developer's
1568 Guide.</para></listitem>
1569 <listitem><para><emphasis>Download the Target Image:</emphasis>
1570 The Yocto Project supports several target architectures
1571 and has many pre-built kernel images and root filesystem
1572 images.</para>
1573 <para>If you are going to develop your application on
1574 hardware, go to the
1575 <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink>
1576 download area and choose a target machine area
1577 from which to download the kernel image and root filesystem.
1578 This download area could have several files in it that
1579 support development using actual hardware.
1580 For example, the area might contain
1581 <filename>.hddimg</filename> files that combine the
1582 kernel image with the filesystem, boot loaders, and
1583 so forth.
1584 Be sure to get the files you need for your particular
1585 development process.</para>
1586 <para>If you are going to develop your application and
1587 then run and test it using the QEMU emulator, go to the
1588 <ulink url='&YOCTO_QEMU_DL_URL;'><filename>machines/qemu</filename></ulink>
1589 download area.
1590 From this area, go down into the directory for your
1591 target architecture (e.g. <filename>qemux86_64</filename>
1592 for an <trademark class='registered'>Intel</trademark>-based
1593 64-bit architecture).
1594 Download kernel, root filesystem, and any other files you
1595 need for your process.
1596 <note>In order to use the root filesystem in QEMU, you
1597 need to extract it.
1598 See the
1599 "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>"
1600 section for information on how to extract the root
1601 filesystem.</note></para></listitem>
1602 <listitem><para><emphasis>Develop and Test your
1603 Application:</emphasis> At this point, you have the tools
1604 to develop your application.
1605 If you need to separately install and use the QEMU
1606 emulator, you can go to
1607 <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink>
1608 to download and learn about the emulator.</para></listitem>
1609 </orderedlist>
1610 </para>
1611 </section>
1612</section>
1613
1614<section id="modifying-temporary-source-code">
1615 <title>Modifying Temporary Source Code</title>
1616
1617 <para>
1618 You might
1619 find it helpful during development to modify the temporary source code used by recipes
1620 to build packages.
1621 For example, suppose you are developing a patch and you need to experiment a bit
1622 to figure out your solution.
1623 After you have initially built the package, you can iteratively tweak the
1624 source code, which is located in the
1625 <link linkend='build-directory'>Build Directory</link>, and then
1626 you can force a re-compile and quickly test your altered code.
1627 Once you settle on a solution, you can then preserve your changes in the form of
1628 patches.
1629 You can accomplish these steps all within either a
1630 <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> or
1631 <link linkend='git'>Git</link> workflow.
1632 </para>
1633
1634 <section id='finding-the-temporary-source-code'>
1635 <title>Finding the Temporary Source Code</title>
1636
1637 <para>
1638 During a build, the unpacked temporary source code used by recipes
1639 to build packages is available in the Build Directory as
1640 defined by the
1641 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable.
1642 Below is the default value for the <filename>S</filename> variable as defined in the
1643 <filename>meta/conf/bitbake.conf</filename> configuration file in the
1644 <link linkend='source-directory'>Source Directory</link>:
1645 <literallayout class='monospaced'>
1646 S = ${WORKDIR}/${BP}
1647 </literallayout>
1648 You should be aware that many recipes override the <filename>S</filename> variable.
1649 For example, recipes that fetch their source from Git usually set
1650 <filename>S</filename> to <filename>${WORKDIR}/git</filename>.
1651 <note>
1652 The
1653 <ulink url='&YOCTO_DOCS_REF_URL;#var-BP'><filename>BP</filename></ulink>
1654 represents the base recipe name, which consists of the name and version:
1655 <literallayout class='monospaced'>
1656 BP = ${BPN}-${PV}
1657 </literallayout>
1658 </note>
1659 </para>
1660
1661 <para>
1662 The path to the work directory for the recipe
1663 (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends
1664 on the recipe name and the architecture of the target device.
1665 For example, here is the work directory for recipes and resulting packages that are
1666 not device-dependent:
1667 <literallayout class='monospaced'>
1668 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${EXTENDPE}${PV}-${PR}
1669 </literallayout>
1670 Let's look at an example without variables.
1671 Assuming a top-level <link linkend='source-directory'>Source Directory</link>
1672 named <filename>poky</filename>
1673 and a default Build Directory of <filename>poky/build</filename>,
1674 the following is the work directory for the <filename>acl</filename> recipe that
1675 creates the <filename>acl</filename> package:
1676 <literallayout class='monospaced'>
1677 ~/poky/build/tmp/work/i586-poky-linux/acl/2.2.51-r3/
1678 </literallayout>
1679 </para>
1680
1681 <para>
1682 If your resulting package is dependent on the target device,
1683 the work directory varies slightly:
1684 <literallayout class='monospaced'>
1685 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${EXTENDPE}${PV}-${PR}
1686 </literallayout>
1687 Again, assuming top-level Source Directory named <filename>poky</filename>
1688 and a default Build Directory of <filename>poky/build</filename>, the
1689 following are the work and temporary source directories, respectively,
1690 for the <filename>acl</filename> package that is being
1691 built for a MIPS-based device:
1692 <literallayout class='monospaced'>
1693 ~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2
1694 ~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2/acl-2.2.51
1695 </literallayout>
1696 </para>
1697
1698 <note>
1699 To better understand how the OpenEmbedded build system resolves directories during the
1700 build process, see the glossary entries for the
1701 <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>,
1702 <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>,
1703 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>,
1704 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>,
1705 <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>,
1706 <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>,
1707 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>,
1708 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTENDPE'><filename>EXTENDPE</filename></ulink>,
1709 and
1710 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
1711 variables in the Yocto Project Reference Manual.
1712 </note>
1713
1714 <para>
1715 Now that you know where to locate the directory that has the temporary source code,
1716 you can use a Quilt or Git workflow to make your edits, test the changes,
1717 and preserve the changes in the form of patches.
1718 </para>
1719 </section>
1720
1721 <section id="using-a-quilt-workflow">
1722 <title>Using a Quilt Workflow</title>
1723
1724 <para>
1725 <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink>
1726 is a powerful tool that allows you to capture source code changes without having
1727 a clean source tree.
1728 This section outlines the typical workflow you can use to modify temporary source code,
1729 test changes, and then preserve the changes in the form of a patch all using Quilt.
1730 </para>
1731
1732 <para>
1733 Follow these general steps:
1734 <orderedlist>
1735 <listitem><para><emphasis>Find the Source Code:</emphasis>
1736 The temporary source code used by the OpenEmbedded build system is kept in the
1737 Build Directory.
1738 See the
1739 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
1740 section to learn how to locate the directory that has the temporary source code for a
1741 particular package.</para></listitem>
1742 <listitem><para><emphasis>Change Your Working Directory:</emphasis>
1743 You need to be in the directory that has the temporary source code.
1744 That directory is defined by the
1745 <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>
1746 variable.</para></listitem>
1747 <listitem><para><emphasis>Create a New Patch:</emphasis>
1748 Before modifying source code, you need to create a new patch.
1749 To create a new patch file, use <filename>quilt new</filename> as below:
1750 <literallayout class='monospaced'>
1751 $ quilt new my_changes.patch
1752 </literallayout></para></listitem>
1753 <listitem><para><emphasis>Notify Quilt and Add Files:</emphasis>
1754 After creating the patch, you need to notify Quilt about the files
1755 you plan to edit.
1756 You notify Quilt by adding the files to the patch you just created:
1757 <literallayout class='monospaced'>
1758 $ quilt add file1.c file2.c file3.c
1759 </literallayout>
1760 </para></listitem>
1761 <listitem><para><emphasis>Edit the Files:</emphasis>
1762 Make your changes in the temporary source code to the files you added
1763 to the patch.</para></listitem>
1764 <listitem><para><emphasis>Test Your Changes:</emphasis>
1765 Once you have modified the source code, the easiest way to test your changes
1766 is by calling the <filename>compile</filename> task as shown in the following example:
1767 <literallayout class='monospaced'>
1768 $ bitbake -c compile -f &lt;name_of_package&gt;
1769 </literallayout>
1770 The <filename>-f</filename> or <filename>--force</filename>
1771 option forces the specified task to execute.
1772 If you find problems with your code, you can just keep editing and
1773 re-testing iteratively until things work as expected.
1774 <note>All the modifications you make to the temporary source code
1775 disappear once you <filename>-c clean</filename> or
1776 <filename>-c cleanall</filename> with BitBake for the package.
1777 Modifications will also disappear if you use the <filename>rm_work</filename>
1778 feature as described in the
1779 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
1780 section of the Yocto Project Quick Start.
1781 </note></para></listitem>
1782 <listitem><para><emphasis>Generate the Patch:</emphasis>
1783 Once your changes work as expected, you need to use Quilt to generate the final patch that
1784 contains all your modifications.
1785 <literallayout class='monospaced'>
1786 $ quilt refresh
1787 </literallayout>
1788 At this point, the <filename>my_changes.patch</filename> file has all your edits made
1789 to the <filename>file1.c</filename>, <filename>file2.c</filename>, and
1790 <filename>file3.c</filename> files.</para>
1791 <para>You can find the resulting patch file in the <filename>patches/</filename>
1792 subdirectory of the source (<filename>S</filename>) directory.</para></listitem>
1793 <listitem><para><emphasis>Copy the Patch File:</emphasis>
1794 For simplicity, copy the patch file into a directory named <filename>files</filename>,
1795 which you can create in the same directory that holds the recipe
1796 (<filename>.bb</filename>) file or the
1797 append (<filename>.bbappend</filename>) file.
1798 Placing the patch here guarantees that the OpenEmbedded build system will find
1799 the patch.
1800 Next, add the patch into the
1801 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>
1802 of the recipe.
1803 Here is an example:
1804 <literallayout class='monospaced'>
1805 SRC_URI += "file://my_changes.patch"
1806 </literallayout></para></listitem>
1807 <listitem><para><emphasis>Increment the Recipe Revision Number:</emphasis>
1808 Finally, don't forget to 'bump' the
1809 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename>
1810 value in the recipe since the resulting packages have changed.</para></listitem>
1811 </orderedlist>
1812 </para> </section>
1813
1814 <section id='using-a-git-workflow'>
1815 <title>Using a Git Workflow</title>
1816 <para>
1817 Git is an even more powerful tool that allows you to capture source code changes without having
1818 a clean source tree.
1819 This section outlines the typical workflow you can use to modify temporary source code,
1820 test changes, and then preserve the changes in the form of a patch all using Git.
1821 For general information on Git as it is used in the Yocto Project, see the
1822 "<link linkend='git'>Git</link>" section.
1823 </para>
1824
1825 <note>
1826 This workflow uses Git only for its ability to manage local changes to the source code
1827 and produce patches independent of any version control system used with the Yocto Project.
1828 </note>
1829
1830 <para>
1831 Follow these general steps:
1832 <orderedlist>
1833 <listitem><para><emphasis>Find the Source Code:</emphasis>
1834 The temporary source code used by the OpenEmbedded build system is kept in the
1835 Build Directory.
1836 See the
1837 "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>"
1838 section to learn how to locate the directory that has the temporary source code for a
1839 particular package.</para></listitem>
1840 <listitem><para><emphasis>Change Your Working Directory:</emphasis>
1841 You need to be in the directory that has the temporary source code.
1842 That directory is defined by the
1843 <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>
1844 variable.</para></listitem>
1845 <listitem><para><emphasis>If needed, initialize a Git Repository:</emphasis>
1846 If the recipe you are working with does not use a Git fetcher,
1847 you need to set up a Git repository as follows:
1848 <literallayout class='monospaced'>
1849 $ git init
1850 $ git add *
1851 $ git commit -m "initial revision"
1852 </literallayout>
1853 The above Git commands initialize a Git repository that is based on the
1854 files in your current working directory, stage all the files, and commit
1855 the files.
1856 At this point, your Git repository is aware of all the source code files.
1857 Any edits you now make to files can be committed later and will be tracked by
1858 Git.</para></listitem>
1859 <listitem><para><emphasis>Edit the Files:</emphasis>
1860 Make your changes to the temporary source code.</para></listitem>
1861 <listitem><para><emphasis>Test Your Changes:</emphasis>
1862 Once you have modified the source code, the easiest way to test your changes
1863 is by calling the <filename>compile</filename> task as shown in the following example:
1864 <literallayout class='monospaced'>
1865 $ bitbake -c compile -f &lt;name_of_package&gt;
1866 </literallayout>
1867 The <filename>-f</filename> or <filename>--force</filename>
1868 option forces the specified task to execute.
1869 If you find problems with your code, you can just keep editing and
1870 re-testing iteratively until things work as expected.
1871 <note>All the modifications you make to the temporary source code
1872 disappear once you <filename>-c clean</filename>, <filename>-c cleansstate</filename>,
1873 or <filename>-c cleanall</filename> with BitBake for the package.
1874 Modifications will also disappear if you use the <filename>rm_work</filename>
1875 feature as described in the
1876 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
1877 section of the Yocto Project Quick Start.
1878 </note></para></listitem>
1879 <listitem><para><emphasis>See the List of Files You Changed:</emphasis>
1880 Use the <filename>git status</filename> command to see what files you have actually edited.
1881 The ability to have Git track the files you have changed is an advantage that this
1882 workflow has over the Quilt workflow.
1883 Here is the Git command to list your changed files:
1884 <literallayout class='monospaced'>
1885 $ git status
1886 </literallayout></para></listitem>
1887 <listitem><para><emphasis>Stage the Modified Files:</emphasis>
1888 Use the <filename>git add</filename> command to stage the changed files so they
1889 can be committed as follows:
1890 <literallayout class='monospaced'>
1891 $ git add file1.c file2.c file3.c
1892 </literallayout></para></listitem>
1893 <listitem><para><emphasis>Commit the Staged Files and View Your Changes:</emphasis>
1894 Use the <filename>git commit</filename> command to commit the changes to the
1895 local repository.
1896 Once you have committed the files, you can use the <filename>git log</filename>
1897 command to see your changes:
1898 <literallayout class='monospaced'>
1899 $ git commit -m "&lt;commit-summary-message&gt;"
1900 $ git log
1901 </literallayout>
1902 <note>The name of the patch file created in the next step is based on your
1903 <filename>commit-summary-message</filename>.</note></para></listitem>
1904 <listitem><para><emphasis>Generate the Patch:</emphasis>
1905 Once the changes are committed, use the <filename>git format-patch</filename>
1906 command to generate a patch file:
1907 <literallayout class='monospaced'>
1908 $ git format-patch -1
1909 </literallayout>
1910 Specifying "-1" causes Git to generate the
1911 patch file for the most recent commit.</para>
1912 <para>At this point, the patch file has all your edits made
1913 to the <filename>file1.c</filename>, <filename>file2.c</filename>, and
1914 <filename>file3.c</filename> files.
1915 You can find the resulting patch file in the current directory and it
1916 is named according to the <filename>git commit</filename> summary line.
1917 The patch file ends with <filename>.patch</filename>.</para></listitem>
1918 <listitem><para><emphasis>Copy the Patch File:</emphasis>
1919 For simplicity, copy the patch file into a directory named <filename>files</filename>,
1920 which you can create in the same directory that holds the recipe
1921 (<filename>.bb</filename>) file or the
1922 append (<filename>.bbappend</filename>) file.
1923 Placing the patch here guarantees that the OpenEmbedded build system will find
1924 the patch.
1925 Next, add the patch into the
1926 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>
1927 of the recipe.
1928 Here is an example:
1929 <literallayout class='monospaced'>
1930 SRC_URI += "file://0001-&lt;commit-summary-message&gt;.patch"
1931 </literallayout></para></listitem>
1932 <listitem><para><emphasis>Increment the Recipe Revision Number:</emphasis>
1933 Finally, don't forget to 'bump' the
1934 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename>
1935 value in the recipe since the resulting packages have changed.</para></listitem>
1936 </orderedlist>
1937 </para>
1938 </section>
1939</section>
1940
1941<section id='image-development-using-hob'>
1942 <title>Image Development Using Hob</title>
1943
1944 <para>
1945 The <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink> is a graphical user interface for the
1946 OpenEmbedded build system, which is based on BitBake.
1947 You can use the Hob to build custom operating system images within the Yocto Project build environment.
1948 Hob simply provides a friendly interface over the build system used during development.
1949 In other words, building images with the Hob lets you take care of common build tasks more easily.
1950 </para>
1951
1952 <para>
1953 For a better understanding of Hob, see the project page at
1954 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'></ulink>
1955 on the Yocto Project website.
1956 If you follow the "Documentation" link from the Hob page, you will
1957 find a short introductory training video on Hob.
1958 The following lists some features of Hob:
1959 <itemizedlist>
1960 <listitem><para>You can setup and run Hob using these commands:
1961 <literallayout class='monospaced'>
1962 $ source oe-init-build-env
1963 $ hob
1964 </literallayout></para></listitem>
1965 <listitem><para>You can set the
1966 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
1967 for which you are building the image.</para></listitem>
1968 <listitem><para>You can modify various policy settings such as the
1969 package format with which to build,
1970 the parallelism BitBake uses, whether or not to build an
1971 external toolchain, and which host to build against.
1972 </para></listitem>
1973 <listitem><para>You can manage
1974 <link linkend='understanding-and-creating-layers'>layers</link>.</para></listitem>
1975 <listitem><para>You can select a base image and then add extra packages for your custom build.
1976 </para></listitem>
1977 <listitem><para>You can launch and monitor the build from within Hob.</para></listitem>
1978 </itemizedlist>
1979 </para>
1980</section>
1981
1982<section id="platdev-appdev-devshell">
1983 <title>Using a Development Shell</title>
1984
1985 <para>
1986 When debugging certain commands or even when just editing packages,
1987 <filename>devshell</filename> can be a useful tool.
1988 When you invoke <filename>devshell</filename>, source files are
1989 extracted into your working directory and patches are applied.
1990 Then, a new terminal is opened and you are placed in the working directory.
1991 In the new terminal, all the OpenEmbedded build-related environment variables are
1992 still defined so you can use commands such as <filename>configure</filename> and
1993 <filename>make</filename>.
1994 The commands execute just as if the OpenEmbedded build system were executing them.
1995 Consequently, working this way can be helpful when debugging a build or preparing
1996 software to be used with the OpenEmbedded build system.
1997 </para>
1998
1999 <para>
2000 Following is an example that uses <filename>devshell</filename> on a target named
2001 <filename>matchbox-desktop</filename>:
2002 <literallayout class='monospaced'>
2003 $ bitbake matchbox-desktop -c devshell
2004 </literallayout>
2005 </para>
2006
2007 <para>
2008 This command spawns a terminal with a shell prompt within the OpenEmbedded build environment.
2009 The <ulink url='&YOCTO_DOCS_REF_URL;#var-OE_TERMINAL'><filename>OE_TERMINAL</filename></ulink>
2010 variable controls what type of shell is opened.
2011 </para>
2012
2013 <para>
2014 For spawned terminals, the following occurs:
2015 <itemizedlist>
2016 <listitem><para>The <filename>PATH</filename> variable includes the
2017 cross-toolchain.</para></listitem>
2018 <listitem><para>The <filename>pkgconfig</filename> variables find the correct
2019 <filename>.pc</filename> files.</para></listitem>
2020 <listitem><para>The <filename>configure</filename> command finds the
2021 Yocto Project site files as well as any other necessary files.</para></listitem>
2022 </itemizedlist>
2023 </para>
2024
2025 <para>
2026 Within this environment, you can run configure or compile
2027 commands as if they were being run by
2028 the OpenEmbedded build system itself.
2029 As noted earlier, the working directory also automatically changes to the
2030 Source Directory (<ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>).
2031 </para>
2032
2033 <para>
2034 When you are finished, you just exit the shell or close the terminal window.
2035 </para>
2036
2037 <note>
2038 <para>
2039 It is worth remembering that when using <filename>devshell</filename>
2040 you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename>
2041 instead of just using <filename>gcc</filename>.
2042 The same applies to other applications such as <filename>binutils</filename>,
2043 <filename>libtool</filename> and so forth.
2044 BitBake sets up environment variables such as <filename>CC</filename>
2045 to assist applications, such as <filename>make</filename> to find the correct tools.
2046 </para>
2047
2048 <para>
2049 It is also worth noting that <filename>devshell</filename> still works over
2050 X11 forwarding and similar situations.
2051 </para>
2052 </note>
2053</section>
2054
2055</chapter>
2056<!--
2057vim: expandtab tw=80 ts=4
2058-->
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
new file mode 100644
index 0000000000..34326d10b6
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -0,0 +1,1575 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='dev-manual-newbie'>
6
7<title>The Yocto Project Open Source Development Environment</title>
8
9<para>
10 This chapter helps you understand the Yocto Project as an open source development project.
11 In general, working in an open source environment is very different from working in a
12 closed, proprietary environment.
13 Additionally, the Yocto Project uses specific tools and constructs as part of its development
14 environment.
15 This chapter specifically addresses open source philosophy, using the
16 Yocto Project in a team environment, source repositories, Yocto Project
17 terms, licensing, the open source distributed version control system Git,
18 workflows, bug tracking, and how to submit changes.
19</para>
20
21<section id='open-source-philosophy'>
22 <title>Open Source Philosophy</title>
23
24 <para>
25 Open source philosophy is characterized by software development directed by peer production
26 and collaboration through an active community of developers.
27 Contrast this to the more standard centralized development models used by commercial software
28 companies where a finite set of developers produces a product for sale using a defined set
29 of procedures that ultimately result in an end product whose architecture and source material
30 are closed to the public.
31 </para>
32
33 <para>
34 Open source projects conceptually have differing concurrent agendas, approaches, and production.
35 These facets of the development process can come from anyone in the public (community) that has a
36 stake in the software project.
37 The open source environment contains new copyright, licensing, domain, and consumer issues
38 that differ from the more traditional development environment.
39 In an open source environment, the end product, source material, and documentation are
40 all available to the public at no cost.
41 </para>
42
43 <para>
44 A benchmark example of an open source project is the Linux Kernel, which was initially conceived
45 and created by Finnish computer science student Linus Torvalds in 1991.
46 Conversely, a good example of a non-open source project is the
47 <trademark class='registered'>Windows</trademark> family of operating
48 systems developed by <trademark class='registered'>Microsoft</trademark> Corporation.
49 </para>
50
51 <para>
52 Wikipedia has a good historical description of the Open Source Philosophy
53 <ulink url='http://en.wikipedia.org/wiki/Open_source'>here</ulink>.
54 You can also find helpful information on how to participate in the Linux Community
55 <ulink url='http://ldn.linuxfoundation.org/book/how-participate-linux-community'>here</ulink>.
56 </para>
57</section>
58
59<section id="usingpoky-changes-collaborate">
60 <title>Using the Yocto Project in a Team Environment</title>
61
62 <para>
63 It might not be immediately clear how you can use the Yocto
64 Project in a team environment, or scale it for a large team of
65 developers.
66 One of the strengths of the Yocto Project is that it is extremely
67 flexible.
68 Thus, you can adapt it to many different use cases and scenarios.
69 However, these characteristics can cause a struggle if you are trying
70 to create a working setup that scales across a large team.
71 </para>
72
73 <para>
74 To help with these types of situations, this section presents
75 some of the project's most successful experiences,
76 practices, solutions, and available technologies that work well.
77 Keep in mind, the information here is a starting point.
78 You can build off it and customize it to fit any
79 particular working environment and set of practices.
80 </para>
81
82 <section id='best-practices-system-configurations'>
83 <title>System Configurations</title>
84
85 <para>
86 Systems across a large team should meet the needs of
87 two types of developers: those working on the contents of the
88 operating system image itself and those developing applications.
89 Regardless of the type of developer, their workstations must
90 be both reasonably powerful and run Linux.
91 </para>
92
93 <section id='best-practices-application-development'>
94 <title>Application Development</title>
95
96 <para>
97 For developers who mainly do application level work
98 on top of an existing software stack,
99 here are some practices that work best:
100 <itemizedlist>
101 <listitem><para>Use a pre-built toolchain that
102 contains the software stack itself.
103 Then, develop the application code on top of the
104 stack.
105 This method works well for small numbers of relatively
106 isolated applications.</para></listitem>
107 <listitem><para>When possible, use the Yocto Project
108 plug-in for the <trademark class='trade'>Eclipse</trademark> IDE
109 and other pieces of Application Development
110 Technology (ADT).
111 For more information, see the
112 "<link linkend='application-development-workflow'>Application
113 Development Workflow</link>" section as well as the
114 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>.
115 </para></listitem>
116 <listitem><para>Keep your cross-development toolchains
117 updated.
118 You can do this through provisioning either as new
119 toolchain downloads or as updates through a package
120 update mechanism using <filename>opkg</filename>
121 to provide updates to an existing toolchain.
122 The exact mechanics of how and when to do this are a
123 question for local policy.</para></listitem>
124 <listitem><para>Use multiple toolchains installed locally
125 into different locations to allow development across
126 versions.</para></listitem>
127 </itemizedlist>
128 </para>
129 </section>
130
131 <section id='best-practices-core-system-development'>
132 <title>Core System Development</title>
133
134 <para>
135 For core system development, it is often best to have the
136 build system itself available on the developer workstations
137 so developers can run their own builds and directly
138 rebuild the software stack.
139 You should keep the core system unchanged as much as
140 possible and do your work in layers on top of the core system.
141 Doing so gives you a greater level of portability when
142 upgrading to new versions of the core system or Board
143 Support Packages (BSPs).
144 You can share layers amongst the developers of a particular
145 project and contain the policy configuration that defines
146 the project.
147 </para>
148
149 <para>
150 Aside from the previous best practices, there exists a number
151 of tips and tricks that can help speed up core development
152 projects:
153 <itemizedlist>
154 <listitem><para>Use a
155 <ulink url='&YOCTO_DOCS_REF_URL;#shared-state-cache'>Shared State Cache</ulink>
156 (sstate) among groups of developers who are on a
157 fast network.
158 The best way to share sstate is through a
159 Network File System (NFS) share.
160 The first user to build a given component for the
161 first time contributes that object to the sstate,
162 while subsequent builds from other developers then
163 reuse the object rather than rebuild it themselves.
164 </para>
165 <para>Although it is possible to use other protocols for the
166 sstate such as HTTP and FTP, you should avoid these.
167 Using HTTP limits the sstate to read-only and
168 FTP provides poor performance.
169 </para></listitem>
170 <listitem><para>Have autobuilders contribute to the sstate
171 pool similarly to how the developer workstations
172 contribute.
173 For information, see the
174 <link linkend='best-practices-autobuilders'>Autobuilders</link>
175 section.</para></listitem>
176 <listitem><para>Build stand-alone tarballs that contain
177 "missing" system requirements if for some reason
178 developer workstations do not meet minimum system
179 requirements such as latest Python versions,
180 <filename>chrpath</filename>, or other tools.
181 You can install and relocate the tarball exactly as you
182 would the usual cross-development toolchain so that
183 all developers can meet minimum version requirements
184 on most distributions.</para></listitem>
185 <listitem><para>Use a small number of shared,
186 high performance systems for testing purposes
187 (e.g. dual six core Xeons with 24GB RAM and plenty of
188 disk space).
189 Developers can use these systems for wider, more
190 extensive testing while they continue to develop
191 locally using their primary development system.
192 </para></listitem>
193 <listitem><para>Enable the PR Service when package feeds
194 need to be incremental with continually increasing
195 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink>
196 values.
197 Typically, this situation occurs when you use or
198 publish package feeds and use a shared state.
199 You should enable the PR Service for all users who
200 use the shared state pool.
201 For more information on the PR Service, see the
202 "<link linkend='working-with-a-pr-service'>Working With a PR Service</link>".
203 </para></listitem>
204 </itemizedlist>
205 </para>
206 </section>
207 </section>
208
209 <section id='best-practices-source-control-management'>
210 <title>Source Control Management (SCM)</title>
211
212 <para>
213 Keeping your
214 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
215 and any software you are developing under the
216 control of an SCM system that is compatible
217 with the OpenEmbedded build system is advisable.
218 Of the SCMs BitBake supports, the
219 Yocto Project team strongly recommends using
220 <link linkend='git'>Git</link>.
221 Git is a distributed system that is easy to backup,
222 allows you to work remotely, and then connects back to the
223 infrastructure.
224 <note>
225 For information about BitBake and SCMs, see the
226 BitBake manual located in the
227 <filename>bitbake/doc/manual</filename> directory of the
228 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
229 </note>
230 </para>
231
232 <para>
233 It is relatively easy to set up Git services and create
234 infrastructure like
235 <ulink url='&YOCTO_GIT_URL;'>http://git.yoctoproject.org</ulink>,
236 which is based on server software called
237 <filename>gitolite</filename> with <filename>cgit</filename>
238 being used to generate the web interface that lets you view the
239 repositories.
240 The <filename>gitolite</filename> software identifies users
241 using <filename>ssh</filename> keys and allows branch-based
242 access controls to repositories that you can control as little
243 or as much as necessary.
244 </para>
245
246 <note>
247 The setup of these services is beyond the scope of this manual.
248 However, sites such as these exist that describe how to perform
249 setup:
250 <itemizedlist>
251 <listitem><para><ulink url='http://git-scm.com/book/ch4-8.html'>Git documentation</ulink>:
252 Describes how to install <filename>gitolite</filename>
253 on the server.</para></listitem>
254 <listitem><para><ulink url='http://sitaramc.github.com/gitolite/master-toc.html'>The <filename>gitolite</filename> master index</ulink>:
255 All topics for <filename>gitolite</filename>.
256 </para></listitem>
257 <listitem><para><ulink url='https://git.wiki.kernel.org/index.php/Interfaces,_frontends,_and_tools'>Interfaces, frontends, and tools</ulink>:
258 Documentation on how to create interfaces and frontends
259 for Git.</para></listitem>
260 </itemizedlist>
261 </note>
262 </section>
263
264 <section id='best-practices-autobuilders'>
265 <title>Autobuilders</title>
266
267 <para>
268 Autobuilders are often the core of a development project.
269 It is here that changes from individual developers are brought
270 together and centrally tested and subsequent decisions about
271 releases can be made.
272 Autobuilders also allow for "continuous integration" style
273 testing of software components and regression identification
274 and tracking.
275 </para>
276
277 <para>
278 See "<ulink url='http://autobuilder.yoctoproject.org'>Yocto Project Autobuilder</ulink>"
279 for more information and links to buildbot.
280 The Yocto Project team has found this implementation
281 works well in this role.
282 A public example of this is the Yocto Project
283 Autobuilders, which we use to test the overall health of the
284 project.
285 </para>
286
287 <para>
288 The features of this system are:
289 <itemizedlist>
290 <listitem><para>Highlights when commits break the build.
291 </para></listitem>
292 <listitem><para>Populates an sstate cache from which
293 developers can pull rather than requiring local
294 builds.</para></listitem>
295 <listitem><para>Allows commit hook triggers,
296 which trigger builds when commits are made.
297 </para></listitem>
298 <listitem><para>Allows triggering of automated image booting
299 and testing under the QuickEMUlator (QEMU).
300 </para></listitem>
301 <listitem><para>Supports incremental build testing and from
302 scratch builds.</para></listitem>
303 <listitem><para>Shares output that allows developer
304 testing and historical regression investigation.
305 </para></listitem>
306 <listitem><para>Creates output that can be used for releases.
307 </para></listitem>
308 <listitem><para>Allows scheduling of builds so that resources
309 can be used efficiently.</para></listitem>
310 </itemizedlist>
311 </para>
312 </section>
313
314 <section id='best-practices-policies-and-change-flow'>
315 <title>Policies and Change Flow</title>
316
317 <para>
318 The Yocto Project itself uses a hierarchical structure and a
319 pull model.
320 Scripts exist to create and send pull requests
321 (i.e. <filename>create-pull-request</filename> and
322 <filename>send-pull-request</filename>).
323 This model is in line with other open source projects where
324 maintainers are responsible for specific areas of the project
325 and a single maintainer handles the final "top-of-tree" merges.
326 </para>
327
328 <note>
329 You can also use a more collective push model.
330 The <filename>gitolite</filename> software supports both the
331 push and pull models quite easily.
332 </note>
333
334 <para>
335 As with any development environment, it is important
336 to document the policy used as well as any main project
337 guidelines so they are understood by everyone.
338 It is also a good idea to have well structured
339 commit messages, which are usually a part of a project's
340 guidelines.
341 Good commit messages are essential when looking back in time and
342 trying to understand why changes were made.
343 </para>
344
345 <para>
346 If you discover that changes are needed to the core layer of the
347 project, it is worth sharing those with the community as soon
348 as possible.
349 Chances are if you have discovered the need for changes, someone
350 else in the community needs them also.
351 </para>
352 </section>
353
354 <section id='best-practices-summary'>
355 <title>Summary</title>
356
357 <para>
358 This section summarizes the key recommendations described in the
359 previous sections:
360 <itemizedlist>
361 <listitem><para>Use <link linkend='git'>Git</link>
362 as the source control system.</para></listitem>
363 <listitem><para>Maintain your Metadata in layers that make sense
364 for your situation.
365 See the "<link linkend='understanding-and-creating-layers'>Understanding
366 and Creating Layers</link>" section for more information on
367 layers.</para></listitem>
368 <listitem><para>Separate the project's Metadata and code by using
369 separate Git repositories.
370 See the "<link linkend='yocto-project-repositories'>Yocto Project
371 Source Repositories</link>" section for information on these
372 repositories.
373 See the "<link linkend='getting-setup'>Getting Set Up</link>" section
374 for information on how to set up various Yocto Project related
375 Git repositories.</para></listitem>
376 <listitem><para>Set up the directory for the shared state cache
377 (<ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink>)
378 where it makes sense.
379 For example, set up the sstate cache on a system used
380 by developers in the same organization and share the
381 same source directories on their machines.
382 </para></listitem>
383 <listitem><para>Set up an Autobuilder and have it populate the
384 sstate cache and source directories.</para></listitem>
385 <listitem><para>The Yocto Project community encourages you
386 to send patches to the project to fix bugs or add features.
387 If you do submit patches, follow the project commit
388 guidelines for writing good commit messages.
389 See the "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
390 section.</para></listitem>
391 <listitem><para>Send changes to the core sooner than later
392 as others likely run into the same issues.
393 For some guidance on mailing lists to use, see the list in the
394 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
395 section.
396 For a description of the available mailing lists, see the
397 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>"
398 section in the Yocto Project Reference Manual.
399 </para></listitem>
400 </itemizedlist>
401 </para>
402 </section>
403</section>
404
405<section id='yocto-project-repositories'>
406 <title>Yocto Project Source Repositories</title>
407
408 <para>
409 The Yocto Project team maintains complete source repositories for all Yocto Project files
410 at <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>.
411 This web-based source code browser is organized into categories by function such as
412 IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth.
413 From the interface, you can click on any particular item in the "Name" column and
414 see the URL at the bottom of the page that you need to clone a Git repository for
415 that particular item.
416 Having a local Git repository of the Source Directory (poky) allows you to
417 make changes, contribute to the history, and ultimately enhance the Yocto Project's
418 tools, Board Support Packages, and so forth.
419 </para>
420
421 <para>
422 Conversely, if you are a developer that is not interested in contributing back to the
423 Yocto Project, you have the ability to simply download and extract release tarballs
424 and use them within the Yocto Project environment.
425 All that is required is a particular release of the Yocto Project and
426 your application source code.
427 </para>
428
429 <para>
430 For any supported release of Yocto Project, you can go to the
431 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and
432 select the "Downloads" tab and get a tarball of the release.
433 You can also go to this site to download any supported BSP tarballs.
434 Unpacking the tarball gives you a hierarchical Source Directory that lets you develop
435 using the Yocto Project.
436 </para>
437
438 <para>
439 Once you are set up through either tarball extraction or a checkout of Git repositories,
440 you are ready to develop.
441 </para>
442
443 <para>
444 In summary, here is where you can get the project files needed for development:
445 <itemizedlist>
446 <listitem><para id='source-repositories'><emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis>
447 This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto
448 Metadata Layers.
449 You can create local copies of Git repositories for each of these areas.</para>
450 <para>
451 <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" />
452 </para></listitem>
453 <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis>
454 This area contains index releases such as
455 the <trademark class='trade'>Eclipse</trademark>
456 Yocto Plug-in, miscellaneous support, poky, pseudo, installers for cross-development toolchains,
457 and all released versions of Yocto Project in the form of images or tarballs.
458 Downloading and extracting these files does not produce a local copy of the
459 Git repository but rather a snapshot of a particular release or image.</para>
460 <para>
461 <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="3.5in" />
462 </para></listitem>
463 <listitem><para><emphasis>"Downloads" page for the
464 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:</emphasis>
465 Access this page by going to the website and then selecting
466 the "Downloads" tab.
467 This page allows you to download any Yocto Project
468 release or Board Support Package (BSP) in tarball form.
469 The tarballs are similar to those found in the
470 <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink> area.</para>
471 <para>
472 <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" />
473 </para></listitem>
474 </itemizedlist>
475 </para>
476</section>
477
478<section id='yocto-project-terms'>
479 <title>Yocto Project Terms</title>
480
481 <para>
482 Following is a list of terms and definitions users new to the Yocto Project development
483 environment might find helpful.
484 While some of these terms are universal, the list includes them just in case:
485 <itemizedlist>
486 <listitem><para><emphasis>Append Files:</emphasis> Files that append build information to
487 a recipe file.
488 Append files are known as BitBake append files and <filename>.bbappend</filename> files.
489 The OpenEmbedded build system expects every append file to have a corresponding
490 recipe (<filename>.bb</filename>) file.
491 Furthermore, the append file and corresponding recipe file
492 must use the same root filename.
493 The filenames can differ only in the file type suffix used (e.g.
494 <filename>formfactor_0.0.bb</filename> and <filename>formfactor_0.0.bbappend</filename>).
495 </para>
496 <para>Information in append files overrides the information in the similarly-named recipe file.
497 For an example of an append file in use, see the
498 "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" section.
499 </para></listitem>
500 <listitem><para id='bitbake-term'><emphasis>BitBake:</emphasis>
501 The task executor and scheduler used by
502 the OpenEmbedded build system to build images.
503 For more information on BitBake, see the BitBake documentation
504 in the <filename>bitbake/doc/manual</filename> directory of the
505 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
506 <listitem>
507 <para id='build-directory'><emphasis>Build Directory:</emphasis>
508 This term refers to the area used by the OpenEmbedded build system for builds.
509 The area is created when you <filename>source</filename> the setup
510 environment script that is found in the Source Directory
511 (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
512 or
513 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
514 The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>
515 variable points to the Build Directory.</para>
516
517 <para>You have a lot of flexibility when creating the Build Directory.
518 Following are some examples that show how to create the directory:
519 <itemizedlist>
520 <listitem><para>Create the Build Directory in your current working directory
521 and name it <filename>build</filename>.
522 This is the default behavior.
523 <literallayout class='monospaced'>
524 $ source &OE_INIT_PATH;
525 </literallayout></para></listitem>
526 <listitem><para>Provide a directory path and specifically name the build
527 directory.
528 This next example creates a Build Directory named <filename>YP-&POKYVERSION;</filename>
529 in your home directory within the directory <filename>mybuilds</filename>.
530 If <filename>mybuilds</filename> does not exist, the directory is created for you:
531 <literallayout class='monospaced'>
532 $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION;
533 </literallayout></para></listitem>
534 <listitem><para>Provide an existing directory to use as the Build Directory
535 and use the default <filename>build</filename> name.
536 <literallayout class='monospaced'>
537 $ source &OE_INIT_PATH; $HOME/mybuilds/
538 </literallayout></para></listitem>
539 </itemizedlist>
540 </para></listitem>
541 <listitem><para><emphasis>Build System:</emphasis> In the context of the Yocto Project,
542 this term refers to the OpenEmbedded build system used by the project.
543 This build system is based on the project known as "Poky."
544 For some historical information about Poky, see the
545 <link linkend='poky'>Poky</link> term.
546 </para></listitem>
547 <listitem><para><emphasis>Classes:</emphasis> Files that provide for logic encapsulation
548 and inheritance so that commonly used patterns can be defined once and then easily used
549 in multiple recipes.
550 Class files end with the <filename>.bbclass</filename> filename extension.
551 </para></listitem>
552 <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various
553 <filename>.conf</filename> files provides global definitions of variables.
554 The <filename>conf/local.conf</filename> configuration file in the
555 <link linkend='build-directory'>Build Directory</link>
556 contains user-defined variables that affect each build.
557 The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file
558 defines Yocto "distro" configuration
559 variables used only when building with this policy.
560 Machine configuration files, which
561 are located throughout the
562 <link linkend='source-directory'>Source Directory</link>, define
563 variables for specific hardware and are only used when building for that target
564 (e.g. the <filename>machine/beagleboard.conf</filename> configuration file defines
565 variables for the Texas Instruments ARM Cortex-A8 development board).
566 Configuration files end with a <filename>.conf</filename> filename extension.
567 </para></listitem>
568 <listitem><para id='cross-development-toolchain'>
569 <emphasis>Cross-Development Toolchain:</emphasis>
570 In general, a cross-development toolchain is a collection of
571 software development tools and utilities that run on one
572 architecture and allow you to develop software for a
573 different, or targeted, architecture.
574 These toolchains contain cross-compilers, linkers, and
575 debuggers that are specific to the target architecture.
576 </para>
577
578 <para>The Yocto Project supports two different cross-development
579 toolchains:
580 <itemizedlist>
581 <listitem><para>A toolchain only used by and within
582 BitBake when building an image for a target
583 architecture.</para></listitem>
584 <listitem><para>A relocatable toolchain used outside of
585 BitBake by developers when developing applications
586 that will run on a targeted device.
587 Sometimes this relocatable cross-development
588 toolchain is referred to as the meta-toolchain.
589 </para></listitem>
590 </itemizedlist>
591 </para>
592
593 <para>
594 Creation of these toolchains is simple and automated.
595 For information on toolchain concepts as they apply to the
596 Yocto Project, see the
597 "<ulink url='&YOCTO_DOCS_REF_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>"
598 section in the Yocto Project Reference Manual.
599 You can also find more information on using the
600 relocatable toolchain in the
601 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project
602 Application Developer's Guide</ulink>.
603 </para></listitem>
604 <listitem><para><emphasis>Image:</emphasis> An image is the result produced when
605 BitBake processes a given collection of recipes and related Metadata.
606 Images are the binary output that run on specific hardware or QEMU
607 and for specific use cases.
608 For a list of the supported image types that the Yocto Project provides, see the
609 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
610 chapter in the Yocto Project Reference Manual.</para></listitem>
611 <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core,
612 a BSP, or an application stack.
613 For a discussion on BSP Layers, see the
614 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
615 section in the Yocto Project Board Support Packages (BSP)
616 Developer's Guide.</para></listitem>
617 <listitem><para id='meta-toolchain'><emphasis>Meta-Toolchain:</emphasis>
618 A term sometimes used for
619 <link linkend='cross-development-toolchain'>Cross-Development Toolchain</link>.
620 </para></listitem>
621 <listitem><para id='metadata'><emphasis>Metadata:</emphasis>
622 The files that BitBake parses when building an image.
623 In general, Metadata includes recipes, classes, and
624 configuration files.
625 In the context of the kernel ("kernel Metadata"),
626 it refers to Metadata in the <filename>meta</filename>
627 branches of the kernel source Git repositories.
628 </para></listitem>
629 <listitem><para id='oe-core'><emphasis>OE-Core:</emphasis> A core set of Metadata originating
630 with OpenEmbedded (OE) that is shared between OE and the Yocto Project.
631 This Metadata is found in the <filename>meta</filename> directory of the
632 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
633 <listitem><para><emphasis>Package:</emphasis> In the context of the Yocto Project,
634 this term refers to the packaged output from a baked recipe.
635 A package is generally the compiled binaries produced from the recipe's sources.
636 You "bake" something by running it through BitBake.</para>
637 <para>It is worth noting that the term "package" can, in general, have subtle
638 meanings. For example, the packages referred to in the
639 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are
640 compiled binaries that when installed add functionality to your Linux
641 distribution.</para>
642 <para>Another point worth noting is that historically within the Yocto Project,
643 recipes were referred to as packages - thus, the existence of several BitBake
644 variables that are seemingly mis-named,
645 (e.g. <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>,
646 <ulink url='&YOCTO_DOCS_REF_URL;#var-PRINC'><filename>PRINC</filename></ulink>,
647 <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and
648 <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>).
649 </para></listitem>
650 <listitem><para id='poky'><emphasis>Poky:</emphasis> The term "poky" can mean several things.
651 In its most general sense, it is an open-source project that was initially developed
652 by OpenedHand. With OpenedHand, poky was developed off of the existing OpenEmbedded
653 build system becoming a build system for embedded images.
654 After Intel Corporation acquired OpenedHand, the project poky became the basis for
655 the Yocto Project's build system.
656 Within the Yocto Project source repositories, <filename>poky</filename>
657 exists as a separate Git repository
658 that can be cloned to yield a local copy on the host system.
659 Thus, "poky" can refer to the local copy of the Source Directory used to develop within
660 the Yocto Project.</para></listitem>
661 <listitem><para><emphasis>Recipe:</emphasis> A set of instructions for building packages.
662 A recipe describes where you get source code and which patches to apply.
663 Recipes describe dependencies for libraries or for other recipes, and they
664 also contain configuration and compilation options.
665 Recipes contain the logical unit of execution, the software/images to build, and
666 use the <filename>.bb</filename> file extension.</para></listitem>
667 <listitem>
668 <para id='source-directory'><emphasis>Source Directory:</emphasis>
669 This term refers to the directory structure created as a result of either downloading
670 and unpacking a Yocto Project release tarball or creating a local copy of
671 the <filename>poky</filename> Git repository
672 <filename>git://git.yoctoproject.org/poky</filename>.
673 Sometimes you might hear the term "poky directory" used to refer to this
674 directory structure.
675 <note>
676 The OpenEmbedded build system does not support file or directory names that
677 contain spaces.
678 Be sure that the Source Directory you use does not contain these types
679 of names.
680 </note></para>
681 <para>The Source Directory contains BitBake, Documentation, Metadata and
682 other files that all support the Yocto Project.
683 Consequently, you must have the Source Directory in place on your development
684 system in order to do any development using the Yocto Project.</para>
685
686 <para>For tarball expansion, the name of the top-level directory of the Source Directory
687 is derived from the Yocto Project release tarball.
688 For example, downloading and unpacking <filename>&YOCTO_POKY_TARBALL;</filename>
689 results in a Source Directory whose top-level folder is named
690 <filename>&YOCTO_POKY;</filename>.
691 If you create a local copy of the Git repository, you can name the repository
692 anything you like.
693 Throughout much of the documentation, <filename>poky</filename> is used as the name of
694 the top-level folder of the local copy of the poky Git repository.
695 So, for example, cloning the <filename>poky</filename> Git repository results in a
696 local Git repository whose top-level folder is also named <filename>poky</filename>.</para>
697
698 <para>It is important to understand the differences between the Source Directory created
699 by unpacking a released tarball as compared to cloning
700 <filename>git://git.yoctoproject.org/poky</filename>.
701 When you unpack a tarball, you have an exact copy of the files based on the time of
702 release - a fixed release point.
703 Any changes you make to your local files in the Source Directory are on top of the release.
704 On the other hand, when you clone the <filename>poky</filename> Git repository, you have an
705 active development repository.
706 In this case, any local changes you make to the Source Directory can be later applied
707 to active development branches of the upstream <filename>poky</filename> Git
708 repository.</para>
709
710 <para>Finally, if you want to track a set of local changes while starting from the same point
711 as a release tarball, you can create a local Git branch that
712 reflects the exact copy of the files at the time of their release.
713 You do this by using Git tags that are part of the repository.</para>
714
715 <para>For more information on concepts related to Git repositories, branches, and tags,
716 see the
717 "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>"
718 section.</para></listitem>
719 <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes.
720 You use tasks to hold recipes that, when built, usually accomplish a single task.
721 For example, a task could contain the recipes for a company’s proprietary or value-add software.
722 Or, the task could contain the recipes that enable graphics.
723 A task is really just another recipe.
724 Because task files are recipes, they end with the <filename>.bb</filename> filename
725 extension.</para></listitem>
726 <listitem><para><emphasis>Upstream:</emphasis> A reference to source code or repositories
727 that are not local to the development system but located in a master area that is controlled
728 by the maintainer of the source code.
729 For example, in order for a developer to work on a particular piece of code, they need to
730 first get a copy of it from an "upstream" source.</para></listitem>
731 </itemizedlist>
732 </para>
733</section>
734
735<section id='licensing'>
736 <title>Licensing</title>
737
738 <para>
739 Because open source projects are open to the public, they have different licensing structures in place.
740 License evolution for both Open Source and Free Software has an interesting history.
741 If you are interested in this history, you can find basic information here:
742 <itemizedlist>
743 <listitem><para><ulink url='http://en.wikipedia.org/wiki/Open-source_license'>Open source license history</ulink>
744 </para></listitem>
745 <listitem><para><ulink url='http://en.wikipedia.org/wiki/Free_software_license'>Free software license
746 history</ulink></para></listitem>
747 </itemizedlist>
748 </para>
749
750 <para>
751 In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology
752 (MIT) License.
753 MIT licensing permits the reuse of software within proprietary software as long as the
754 license is distributed with that software.
755 MIT is also compatible with the GNU General Public License (GPL).
756 Patches to the Yocto Project follow the upstream licensing scheme.
757 You can find information on the MIT license at
758 <ulink url='http://www.opensource.org/licenses/mit-license.php'>here</ulink>.
759 You can find information on the GNU GPL <ulink url='http://www.opensource.org/licenses/LGPL-3.0'>
760 here</ulink>.
761 </para>
762
763 <para>
764 When you build an image using the Yocto Project, the build process uses a
765 known list of licenses to ensure compliance.
766 You can find this list in the
767 <link linkend='source-directory'>Source Directory</link> at
768 <filename>meta/files/common-licenses</filename>.
769 Once the build completes, the list of all licenses found and used during that build are
770 kept in the
771 <link linkend='build-directory'>Build Directory</link> at
772 <filename>tmp/deploy/licenses</filename>.
773 </para>
774
775 <para>
776 If a module requires a license that is not in the base list, the build process
777 generates a warning during the build.
778 These tools make it easier for a developer to be certain of the licenses with which
779 their shipped products must comply.
780 However, even with these tools it is still up to the developer to resolve potential licensing issues.
781 </para>
782
783 <para>
784 The base list of licenses used by the build process is a combination of the Software Package
785 Data Exchange (SPDX) list and the Open Source Initiative (OSI) projects.
786 <ulink url='http://spdx.org'>SPDX Group</ulink> is a working group of the Linux Foundation
787 that maintains a specification
788 for a standard format for communicating the components, licenses, and copyrights
789 associated with a software package.
790 <ulink url='http://opensource.org'>OSI</ulink> is a corporation dedicated to the Open Source
791 Definition and the effort for reviewing and approving licenses that are OSD-conformant.
792 </para>
793
794 <para>
795 You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses
796 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/files/common-licenses'>here</ulink>.
797 </para>
798
799 <para>
800 For information that can help you to maintain compliance with various open source licensing
801 during the lifecycle of a product created using the Yocto Project, see the
802 "<link linkend='maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</link>" section.
803 </para>
804</section>
805
806<section id='git'>
807 <title>Git</title>
808
809 <para>
810 The Yocto Project uses Git, which is a free, open source distributed version control system.
811 Git supports distributed development, non-linear development, and can handle large projects.
812 It is best that you have some fundamental understanding of how Git tracks projects and
813 how to work with Git if you are going to use the Yocto Project for development.
814 This section provides a quick overview of how Git works and provides you with a summary
815 of some essential Git commands.
816 </para>
817
818 <para>
819 For more information on Git, see
820 <ulink url='http://git-scm.com/documentation'></ulink>.
821 If you need to download Git, go to <ulink url='http://git-scm.com/download'></ulink>.
822 </para>
823
824 <section id='repositories-tags-and-branches'>
825 <title>Repositories, Tags, and Branches</title>
826
827 <para>
828 As mentioned earlier in the section
829 "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>",
830 the Yocto Project maintains source repositories at
831 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
832 If you look at this web-interface of the repositories, each item is a separate
833 Git repository.
834 </para>
835
836 <para>
837 Git repositories use branching techniques that track content change (not files)
838 within a project (e.g. a new feature or updated documentation).
839 Creating a tree-like structure based on project divergence allows for excellent historical
840 information over the life of a project.
841 This methodology also allows for an environment from which you can do lots of
842 local experimentation on projects as you develop changes or new features.
843 </para>
844
845 <para>
846 A Git repository represents all development efforts for a given project.
847 For example, the Git repository <filename>poky</filename> contains all changes
848 and developments for Poky over the course of its entire life.
849 That means that all changes that make up all releases are captured.
850 The repository maintains a complete history of changes.
851 </para>
852
853 <para>
854 You can create a local copy of any repository by "cloning" it with the Git
855 <filename>clone</filename> command.
856 When you clone a Git repository, you end up with an identical copy of the
857 repository on your development system.
858 Once you have a local copy of a repository, you can take steps to develop locally.
859 For examples on how to clone Git repositories, see the
860 "<link linkend='getting-setup'>Getting Set Up</link>" section.
861 </para>
862
863 <para>
864 It is important to understand that Git tracks content change and not files.
865 Git uses "branches" to organize different development efforts.
866 For example, the <filename>poky</filename> repository has
867 <filename>denzil</filename>, <filename>danny</filename>,
868 <filename>dylan</filename>, <filename>dora</filename>,
869 and <filename>master</filename> branches among others.
870 You can see all the branches by going to
871 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and
872 clicking on the
873 <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/heads'>[...]</ulink></filename>
874 link beneath the "Branch" heading.
875 </para>
876
877 <para>
878 Each of these branches represents a specific area of development.
879 The <filename>master</filename> branch represents the current or most recent
880 development.
881 All other branches represent off-shoots of the <filename>master</filename>
882 branch.
883 </para>
884
885 <para>
886 When you create a local copy of a Git repository, the copy has the same set
887 of branches as the original.
888 This means you can use Git to create a local working area (also called a branch)
889 that tracks a specific development branch from the source Git repository.
890 in other words, you can define your local Git environment to work on any development
891 branch in the repository.
892 To help illustrate, here is a set of commands that creates a local copy of the
893 <filename>poky</filename> Git repository and then creates and checks out a local
894 Git branch that tracks the Yocto Project &DISTRO; Release (&DISTRO_NAME;) development:
895 <literallayout class='monospaced'>
896 $ cd ~
897 $ git clone git://git.yoctoproject.org/poky
898 $ cd poky
899 $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
900 </literallayout>
901 In this example, the name of the top-level directory of your local
902 <link linkend='source-directory'>Source Directory</link>
903 is <filename>poky</filename>,
904 and the name of that local working area (local branch) you just
905 created and checked out is <filename>&DISTRO_NAME;</filename>.
906 The files in your local repository now reflect the same files that
907 are in the <filename>&DISTRO_NAME;</filename> development
908 branch of the Yocto Project's <filename>poky</filename>
909 upstream repository.
910 It is important to understand that when you create and checkout a
911 local working branch based on a branch name,
912 your local environment matches the "tip" of that development branch
913 at the time you created your local branch, which could be
914 different than the files at the time of a similarly named release.
915 In other words, creating and checking out a local branch based on the
916 <filename>&DISTRO_NAME;</filename> branch name is not the same as
917 cloning and checking out the <filename>master</filename> branch.
918 Keep reading to see how you create a local snapshot of a Yocto Project Release.
919 </para>
920
921 <para>
922 Git uses "tags" to mark specific changes in a repository.
923 Typically, a tag is used to mark a special point such as the final change
924 before a project is released.
925 You can see the tags used with the <filename>poky</filename> Git repository
926 by going to <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and
927 clicking on the
928 <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/tags'>[...]</ulink></filename>
929 link beneath the "Tag" heading.
930 </para>
931
932 <para>
933 Some key tags are <filename>bernard-5.0</filename>, <filename>denzil-7.0</filename>,
934 and <filename>&DISTRO_NAME;-&POKYVERSION;</filename>.
935 These tags represent Yocto Project releases.
936 </para>
937
938 <para>
939 When you create a local copy of the Git repository, you also have access to all the
940 tags.
941 Similar to branches, you can create and checkout a local working Git branch based
942 on a tag name.
943 When you do this, you get a snapshot of the Git repository that reflects
944 the state of the files when the change was made associated with that tag.
945 The most common use is to checkout a working branch that matches a specific
946 Yocto Project release.
947 Here is an example:
948 <literallayout class='monospaced'>
949 $ cd ~
950 $ git clone git://git.yoctoproject.org/poky
951 $ cd poky
952 $ git checkout -b my-&DISTRO_NAME;-&POKYVERSION; &DISTRO_NAME;-&POKYVERSION;
953 </literallayout>
954 In this example, the name of the top-level directory of your local Yocto Project
955 Files Git repository is <filename>poky</filename>.
956 And, the name of the local branch you have created and checked out is
957 <filename>my-&DISTRO_NAME;-&POKYVERSION;</filename>.
958 The files in your repository now exactly match the Yocto Project &DISTRO;
959 Release tag (<filename>&DISTRO_NAME;-&POKYVERSION;</filename>).
960 It is important to understand that when you create and checkout a local
961 working branch based on a tag, your environment matches a specific point
962 in time and not the entire development branch.
963 </para>
964 </section>
965
966 <section id='basic-commands'>
967 <title>Basic Commands</title>
968
969 <para>
970 Git has an extensive set of commands that lets you manage changes and perform
971 collaboration over the life of a project.
972 Conveniently though, you can manage with a small set of basic operations and workflows
973 once you understand the basic philosophy behind Git.
974 You do not have to be an expert in Git to be functional.
975 A good place to look for instruction on a minimal set of Git commands is
976 <ulink url='http://git-scm.com/documentation'>here</ulink>.
977 If you need to download Git, you can do so
978 <ulink url='http://git-scm.com/download'>here</ulink>.
979 </para>
980
981 <para>
982 If you don’t know much about Git, you should educate
983 yourself by visiting the links previously mentioned.
984 </para>
985
986 <para>
987 The following list briefly describes some basic Git operations as a way to get started.
988 As with any set of commands, this list (in most cases) simply shows the base command and
989 omits the many arguments they support.
990 See the Git documentation for complete descriptions and strategies on how to use these commands:
991 <itemizedlist>
992 <listitem><para><emphasis><filename>git init</filename>:</emphasis> Initializes an empty Git repository.
993 You cannot use Git commands unless you have a <filename>.git</filename> repository.</para></listitem>
994 <listitem><para><emphasis><filename>git clone</filename>:</emphasis> Creates a clone of a repository.
995 During collaboration, this command allows you to create a local repository that is on
996 equal footing with a fellow developer’s repository.</para></listitem>
997 <listitem><para><emphasis><filename>git add</filename>:</emphasis> Stages updated file contents
998 to the index that
999 Git uses to track changes.
1000 You must stage all files that have changed before you can commit them.</para></listitem>
1001 <listitem><para><emphasis><filename>git commit</filename>:</emphasis> Creates a "commit" that documents
1002 the changes you made.
1003 Commits are used for historical purposes, for determining if a maintainer of a project
1004 will allow the change, and for ultimately pushing the change from your local Git repository
1005 into the project’s upstream (or master) repository.</para></listitem>
1006 <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that
1007 possibly need staged and committed.</para></listitem>
1008 <listitem><para><emphasis><filename>git checkout &lt;branch-name&gt;</filename>:</emphasis> Changes
1009 your working branch.
1010 This command is analogous to "cd".</para></listitem>
1011 <listitem><para><emphasis><filename>git checkout –b &lt;working-branch&gt;</filename>:</emphasis> Creates
1012 a working branch on your local machine where you can isolate work.
1013 It is a good idea to use local branches when adding specific features or changes.
1014 This way if you do not like what you have done you can easily get rid of the work.</para></listitem>
1015 <listitem><para><emphasis><filename>git branch</filename>:</emphasis> Reports
1016 existing local branches and
1017 tells you the branch in which you are currently working.</para></listitem>
1018 <listitem><para><emphasis><filename>git branch -D &lt;branch-name&gt;</filename>:</emphasis>
1019 Deletes an existing local branch.
1020 You need to be in a local branch other than the one you are deleting
1021 in order to delete <filename>&lt;branch-name&gt;</filename>.</para></listitem>
1022 <listitem><para><emphasis><filename>git pull</filename>:</emphasis> Retrieves information
1023 from an upstream Git
1024 repository and places it in your local Git repository.
1025 You use this command to make sure you are synchronized with the repository
1026 from which you are basing changes (.e.g. the master branch).</para></listitem>
1027 <listitem><para><emphasis><filename>git push</filename>:</emphasis>
1028 Sends all your committed local changes to an upstream Git
1029 repository (e.g. a contribution repository).
1030 The maintainer of the project draws from these repositories
1031 when adding changes to the project’s master repository or
1032 other development branch.
1033 </para></listitem>
1034 <listitem><para><emphasis><filename>git merge</filename>:</emphasis> Combines or adds changes from one
1035 local branch of your repository with another branch.
1036 When you create a local Git repository, the default branch is named "master".
1037 A typical workflow is to create a temporary branch for isolated work, make and commit your
1038 changes, switch to your local master branch, merge the changes from the temporary branch into the
1039 local master branch, and then delete the temporary branch.</para></listitem>
1040 <listitem><para><emphasis><filename>git cherry-pick</filename>:</emphasis> Choose and apply specific
1041 commits from one branch into another branch.
1042 There are times when you might not be able to merge all the changes in one branch with
1043 another but need to pick out certain ones.</para></listitem>
1044 <listitem><para><emphasis><filename>gitk</filename>:</emphasis> Provides a GUI view of the branches
1045 and changes in your local Git repository.
1046 This command is a good way to graphically see where things have diverged in your
1047 local repository.</para></listitem>
1048 <listitem><para><emphasis><filename>git log</filename>:</emphasis> Reports a history of your changes to the
1049 repository.</para></listitem>
1050 <listitem><para><emphasis><filename>git diff</filename>:</emphasis> Displays line-by-line differences
1051 between your local working files and the same files in the upstream Git repository that your
1052 branch currently tracks.</para></listitem>
1053 </itemizedlist>
1054 </para>
1055 </section>
1056</section>
1057
1058<section id='workflows'>
1059 <title>Workflows</title>
1060
1061 <para>
1062 This section provides some overview on workflows using Git.
1063 In particular, the information covers basic practices that describe roles and actions in a
1064 collaborative development environment.
1065 Again, if you are familiar with this type of development environment, you might want to just
1066 skip this section.
1067 </para>
1068
1069 <para>
1070 The Yocto Project files are maintained using Git in a "master" branch whose Git history
1071 tracks every change and whose structure provides branches for all diverging functionality.
1072 Although there is no need to use Git, many open source projects do so.
1073 For the Yocto Project, a key individual called the "maintainer" is responsible for the "master"
1074 branch of a given Git repository.
1075 The "master" branch is the “upstream” repository where the final builds of the project occur.
1076 The maintainer is responsible for allowing changes in from other developers and for
1077 organizing the underlying branch structure to reflect release strategies and so forth.
1078 <note>For information on finding out who is responsible (maintains)
1079 for a particular area of code, see the
1080 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
1081 section.
1082 </note>
1083 </para>
1084
1085 <para>
1086 The project also has contribution repositories known as "contrib" areas.
1087 These areas temporarily hold changes to the project that have been submitted or committed
1088 by the Yocto Project development team and by community members that contribute to the project.
1089 The maintainer determines if the changes are qualified to be moved from the "contrib" areas
1090 into the "master" branch of the Git repository.
1091 </para>
1092
1093 <para>
1094 Developers (including contributing community members) create and maintain cloned repositories
1095 of the upstream "master" branch.
1096 These repositories are local to their development platforms and are used to develop changes.
1097 When a developer is satisfied with a particular feature or change, they "push" the changes
1098 to the appropriate "contrib" repository.
1099 </para>
1100
1101 <para>
1102 Developers are responsible for keeping their local repository up-to-date with "master".
1103 They are also responsible for straightening out any conflicts that might arise within files
1104 that are being worked on simultaneously by more than one person.
1105 All this work is done locally on the developer’s machines before anything is pushed to a
1106 "contrib" area and examined at the maintainer’s level.
1107 </para>
1108
1109 <para>
1110 A somewhat formal method exists by which developers commit changes and push them into the
1111 "contrib" area and subsequently request that the maintainer include them into "master"
1112 This process is called “submitting a patch” or "submitting a change."
1113 For information on submitting patches and changes, see the
1114 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" section.
1115 </para>
1116
1117 <para>
1118 To summarize the environment: we have a single point of entry for changes into the project’s
1119 "master" branch of the Git repository, which is controlled by the project’s maintainer.
1120 And, we have a set of developers who independently develop, test, and submit changes
1121 to "contrib" areas for the maintainer to examine.
1122 The maintainer then chooses which changes are going to become a permanent part of the project.
1123 </para>
1124
1125 <para>
1126 <imagedata fileref="figures/git-workflow.png" width="6in" depth="3in" align="left" scalefit="1" />
1127 </para>
1128
1129 <para>
1130 While each development environment is unique, there are some best practices or methods
1131 that help development run smoothly.
1132 The following list describes some of these practices.
1133 For more information about Git workflows, see the workflow topics in the
1134 <ulink url='http://book.git-scm.com'>Git Community Book</ulink>.
1135 <itemizedlist>
1136 <listitem><para><emphasis>Make Small Changes:</emphasis> It is best to keep the changes you commit
1137 small as compared to bundling many disparate changes into a single commit.
1138 This practice not only keeps things manageable but also allows the maintainer
1139 to more easily include or refuse changes.</para>
1140 <para>It is also good practice to leave the repository in a state that allows you to
1141 still successfully build your project. In other words, do not commit half of a feature,
1142 then add the other half as a separate, later commit.
1143 Each commit should take you from one buildable project state to another
1144 buildable state.</para></listitem>
1145 <listitem><para><emphasis>Use Branches Liberally:</emphasis> It is very easy to create, use, and
1146 delete local branches in your working Git repository.
1147 You can name these branches anything you like.
1148 It is helpful to give them names associated with the particular feature or change
1149 on which you are working.
1150 Once you are done with a feature or change and have merged it
1151 into your local master branch, simply discard the temporary
1152 branch.</para></listitem>
1153 <listitem><para><emphasis>Merge Changes:</emphasis> The <filename>git merge</filename>
1154 command allows you to take the
1155 changes from one branch and fold them into another branch.
1156 This process is especially helpful when more than a single developer might be working
1157 on different parts of the same feature.
1158 Merging changes also automatically identifies any collisions or "conflicts"
1159 that might happen as a result of the same lines of code being altered by two different
1160 developers.</para></listitem>
1161 <listitem><para><emphasis>Manage Branches:</emphasis> Because branches are easy to use, you should
1162 use a system where branches indicate varying levels of code readiness.
1163 For example, you can have a "work" branch to develop in, a "test" branch where the code or
1164 change is tested, a "stage" branch where changes are ready to be committed, and so forth.
1165 As your project develops, you can merge code across the branches to reflect ever-increasing
1166 stable states of the development.</para></listitem>
1167 <listitem><para><emphasis>Use Push and Pull:</emphasis> The push-pull workflow is based on the
1168 concept of developers "pushing" local commits to a remote repository, which is
1169 usually a contribution repository.
1170 This workflow is also based on developers "pulling" known states of the project down into their
1171 local development repositories.
1172 The workflow easily allows you to pull changes submitted by other developers from the
1173 upstream repository into your work area ensuring that you have the most recent software
1174 on which to develop.
1175 The Yocto Project has two scripts named <filename>create-pull-request</filename> and
1176 <filename>send-pull-request</filename> that ship with the release to facilitate this
1177 workflow.
1178 You can find these scripts in the <filename>scripts</filename>
1179 folder of the
1180 <link linkend='source-directory'>Source Directory</link>.
1181 For information on how to use these scripts, see the
1182 "<link linkend='pushing-a-change-upstream'>Using Scripts to Push a Change Upstream and Request a Pull</link>" section.
1183 </para></listitem>
1184 <listitem><para><emphasis>Patch Workflow:</emphasis> This workflow allows you to notify the
1185 maintainer through an email that you have a change (or patch) you would like considered
1186 for the "master" branch of the Git repository.
1187 To send this type of change, you format the patch and then send the email using the Git commands
1188 <filename>git format-patch</filename> and <filename>git send-email</filename>.
1189 For information on how to use these scripts, see the
1190 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
1191 section.
1192 </para></listitem>
1193 </itemizedlist>
1194 </para>
1195</section>
1196
1197<section id='tracking-bugs'>
1198 <title>Tracking Bugs</title>
1199
1200 <para>
1201 The Yocto Project uses its own implementation of
1202 <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs.
1203 Implementations of Bugzilla work well for group development because they track bugs and code
1204 changes, can be used to communicate changes and problems with developers, can be used to
1205 submit and review patches, and can be used to manage quality assurance.
1206 The home page for the Yocto Project implementation of Bugzilla is
1207 <ulink url='&YOCTO_BUGZILLA_URL;'>&YOCTO_BUGZILLA_URL;</ulink>.
1208 </para>
1209
1210 <para>
1211 Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself
1212 such as when discovering an issue with some component of the build system that acts contrary
1213 to the documentation or your expectations.
1214 Following is the general procedure for submitting a new bug using the Yocto Project
1215 Bugzilla.
1216 You can find more information on defect management, bug tracking, and feature request
1217 processes all accomplished through the Yocto Project Bugzilla on the wiki page
1218 <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>.
1219 <orderedlist>
1220 <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit
1221 a bug.</para></listitem>
1222 <listitem><para>When submitting a new bug, be sure to choose the appropriate
1223 Classification, Product, and Component for which the issue was found.
1224 Defects for the Yocto Project fall into one of six classifications: Yocto Project
1225 Components, Infrastructure, Build System &amp; Metadata, Documentation,
1226 QA/Testing, and Runtime.
1227 Each of these Classifications break down into multiple Products and, in some
1228 cases, multiple Components.</para></listitem>
1229 <listitem><para>Use the bug form to choose the correct Hardware and Architecture
1230 for which the bug applies.</para></listitem>
1231 <listitem><para>Indicate the Yocto Project version you were using when the issue
1232 occurred.</para></listitem>
1233 <listitem><para>Be sure to indicate the Severity of the bug.
1234 Severity communicates how the bug impacted your work.</para></listitem>
1235 <listitem><para>Select the appropriate "Documentation change" item
1236 for the bug.
1237 Fixing a bug may or may not affect the Yocto Project
1238 documentation.</para></listitem>
1239 <listitem><para>Provide a brief summary of the issue.
1240 Try to limit your summary to just a line or two and be sure to capture the
1241 essence of the issue.</para></listitem>
1242 <listitem><para>Provide a detailed description of the issue.
1243 You should provide as much detail as you can about the context, behavior, output,
1244 and so forth that surrounds the issue.
1245 You can even attach supporting files for output from logs by
1246 using the "Add an attachment" button.</para></listitem>
1247 <listitem><para>Be sure to copy the appropriate people in the
1248 "CC List" for the bug.
1249 See the "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
1250 section for information about finding out who is responsible
1251 for code.</para></listitem>
1252 <listitem><para>Submit the bug by clicking the "Submit Bug" button.</para></listitem>
1253 </orderedlist>
1254 </para>
1255</section>
1256
1257<section id='how-to-submit-a-change'>
1258 <title>How to Submit a Change</title>
1259
1260 <para>
1261 Contributions to the Yocto Project and OpenEmbedded are very welcome.
1262 Because the system is extremely configurable and flexible, we recognize that developers
1263 will want to extend, configure or optimize it for their specific uses.
1264 You should send patches to the appropriate mailing list so that they
1265 can be reviewed and merged by the appropriate maintainer.
1266 </para>
1267
1268 <para>
1269 Before submitting any change, be sure to find out who you should be
1270 notifying.
1271 Several methods exist through which you find out who you should be copying
1272 or notifying:
1273 <itemizedlist>
1274 <listitem><para><emphasis>Maintenance File:</emphasis>
1275 Examine the <filename>maintainers.inc</filename> file, which is
1276 located in the
1277 <link linkend='source-directory'>Source Directory</link>
1278 at <filename>meta-yocto/conf/distro/include</filename>, to
1279 see who is responsible for code.
1280 </para></listitem>
1281 <listitem><para><emphasis>Board Support Package (BSP) README Files:</emphasis>
1282 For BSP maintainers of supported BSPs, you can examine
1283 individual BSP <filename>README</filename> files.
1284 Alternatively, you can examine the
1285 <filename>MAINTAINERS</filename> file, which is found in the
1286 <filename>meta-intel</filename>, for a list of all supported
1287 BSP maintainers.
1288 </para></listitem>
1289 <listitem><para><emphasis>Search by File:</emphasis>
1290 Using <link linkend='git'>Git</link>, you can enter the
1291 following command to bring up a short list of all commits
1292 against a specific file:
1293 <literallayout class='monospaced'>
1294 git shortlog -- &lt;filename&gt;
1295 </literallayout>
1296 Just provide the name of the file for which you are interested.
1297 The information returned is not ordered by history but does
1298 include a list of all committers grouped by name.
1299 From the list, you can see who is responsible for the bulk of
1300 the changes against the file.
1301 </para></listitem>
1302 </itemizedlist>
1303 </para>
1304
1305 <para>
1306 For a list of the Yocto Project and related mailing lists, see the
1307 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in
1308 the Yocto Project Reference Manual.
1309 </para>
1310
1311 <para>
1312 Here is some guidance on which mailing list to use for what type of change:
1313 <itemizedlist>
1314 <listitem><para>For changes to the core
1315 <link linkend='metadata'>Metadata</link>, send your patch to the
1316 <ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'>openembedded-core</ulink> mailing list.
1317 For example, a change to anything under the <filename>meta</filename> or
1318 <filename>scripts</filename> directories
1319 should be sent to this mailing list.</para></listitem>
1320 <listitem><para>For changes to BitBake (anything under the <filename>bitbake</filename>
1321 directory), send your patch to the
1322 <ulink url='&OE_LISTS_URL;/listinfo/bitbake-devel'>bitbake-devel</ulink> mailing list.</para></listitem>
1323 <listitem><para>For changes to <filename>meta-yocto</filename>, send your patch to the
1324 <ulink url='&YOCTO_LISTS_URL;/listinfo/poky'>poky</ulink> mailing list.</para></listitem>
1325 <listitem><para>For changes to other layers hosted on
1326 <filename>yoctoproject.org</filename> (unless the
1327 layer's documentation specifies otherwise), tools, and Yocto Project
1328 documentation, use the
1329 <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'>yocto</ulink> mailing list.</para></listitem>
1330 <listitem><para>For additional recipes that do not fit into the core Metadata,
1331 you should determine which layer the recipe should go into and submit the
1332 change in the manner recommended by the documentation (e.g. README) supplied
1333 with the layer. If in doubt, please ask on the
1334 <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'>yocto</ulink> or
1335 <ulink url='&OE_LISTS_URL;/listinfo/openembedded-devel'>openembedded-devel</ulink>
1336 mailing lists.</para></listitem>
1337 </itemizedlist>
1338 </para>
1339
1340 <para>
1341 When you send a patch, be sure to include a "Signed-off-by:"
1342 line in the same style as required by the Linux kernel.
1343 Adding this line signifies that you, the submitter, have agreed to the Developer's Certificate of Origin 1.1
1344 as follows:
1345 <literallayout class='monospaced'>
1346 Developer's Certificate of Origin 1.1
1347
1348 By making a contribution to this project, I certify that:
1349
1350 (a) The contribution was created in whole or in part by me and I
1351 have the right to submit it under the open source license
1352 indicated in the file; or
1353
1354 (b) The contribution is based upon previous work that, to the best
1355 of my knowledge, is covered under an appropriate open source
1356 license and I have the right under that license to submit that
1357 work with modifications, whether created in whole or in part
1358 by me, under the same open source license (unless I am
1359 permitted to submit under a different license), as indicated
1360 in the file; or
1361
1362 (c) The contribution was provided directly to me by some other
1363 person who certified (a), (b) or (c) and I have not modified
1364 it.
1365
1366 (d) I understand and agree that this project and the contribution
1367 are public and that a record of the contribution (including all
1368 personal information I submit with it, including my sign-off) is
1369 maintained indefinitely and may be redistributed consistent with
1370 this project or the open source license(s) involved.
1371 </literallayout>
1372 </para>
1373
1374 <para>
1375 In a collaborative environment, it is necessary to have some sort of standard
1376 or method through which you submit changes.
1377 Otherwise, things could get quite chaotic.
1378 One general practice to follow is to make small, controlled changes.
1379 Keeping changes small and isolated aids review, makes merging/rebasing easier
1380 and keeps the change history clean when anyone needs to refer to it in future.
1381 </para>
1382
1383 <para>
1384 When you make a commit, you must follow certain standards established by the
1385 OpenEmbedded and Yocto Project development teams.
1386 For each commit, you must provide a single-line summary of the change and you
1387 should almost always provide a more detailed description of what you did (i.e.
1388 the body of the commit message).
1389 The only exceptions for not providing a detailed description would be if your
1390 change is a simple, self-explanatory change that needs no further description
1391 beyond the summary.
1392 Here are the guidelines for composing a commit message:
1393 <itemizedlist>
1394 <listitem><para>Provide a single-line, short summary of the change.
1395 This summary is typically viewable in the "shortlist" of changes.
1396 Thus, providing something short and descriptive that gives the reader
1397 a summary of the change is useful when viewing a list of many commits.
1398 This short description should be prefixed by the recipe name (if changing a recipe), or
1399 else the short form path to the file being changed.
1400 </para></listitem>
1401 <listitem><para>For the body of the commit message, provide detailed information
1402 that describes what you changed, why you made the change, and the approach
1403 you used. It may also be helpful if you mention how you tested the change.
1404 Provide as much detail as you can in the body of the commit message.
1405 </para></listitem>
1406 <listitem><para>If the change addresses a specific bug or issue that is
1407 associated with a bug-tracking ID, include a reference to that ID in
1408 your detailed description.
1409 For example, the Yocto Project uses a specific convention for bug
1410 references - any commit that addresses a specific bug should include the
1411 bug ID in the description (typically at the beginning) as follows:
1412 <literallayout class='monospaced'>
1413 [YOCTO #&lt;bug-id&gt;]
1414
1415 &lt;detailed description of change&gt;
1416 </literallayout></para></listitem>
1417 Where &lt;bug-id&gt; is replaced with the specific bug ID from the
1418 Yocto Project Bugzilla instance.
1419 </itemizedlist>
1420 </para>
1421
1422 <para>
1423 You can find more guidance on creating well-formed commit messages at this OpenEmbedded
1424 wiki page:
1425 <ulink url='&OE_HOME_URL;/wiki/Commit_Patch_Message_Guidelines'></ulink>.
1426 </para>
1427
1428 <para>
1429 The next two sections describe general instructions for both pushing
1430 changes upstream and for submitting changes as patches.
1431 </para>
1432
1433 <section id='pushing-a-change-upstream'>
1434 <title>Using Scripts to Push a Change Upstream and Request a Pull</title>
1435
1436 <para>
1437 The basic flow for pushing a change to an upstream "contrib" Git repository is as follows:
1438 <itemizedlist>
1439 <listitem><para>Make your changes in your local Git repository.</para></listitem>
1440 <listitem><para>Stage your changes by using the <filename>git add</filename>
1441 command on each file you changed.</para></listitem>
1442 <listitem><para>Commit the change by using the <filename>git commit</filename>
1443 command and push it to the "contrib" repository.
1444 Be sure to provide a commit message that follows the project’s commit message standards
1445 as described earlier.</para></listitem>
1446 <listitem><para>Notify the maintainer that you have pushed a change by making a pull
1447 request.
1448 The Yocto Project provides two scripts that conveniently let you generate and send
1449 pull requests to the Yocto Project.
1450 These scripts are <filename>create-pull-request</filename> and
1451 <filename>send-pull-request</filename>.
1452 You can find these scripts in the <filename>scripts</filename> directory
1453 within the <link linkend='source-directory'>Source Directory</link>.</para>
1454 <para>Using these scripts correctly formats the requests without introducing any
1455 whitespace or HTML formatting.
1456 The maintainer that receives your patches needs to be able to save and apply them
1457 directly from your emails.
1458 Using these scripts is the preferred method for sending patches.</para>
1459 <para>For help on using these scripts, simply provide the
1460 <filename>-h</filename> argument as follows:
1461 <literallayout class='monospaced'>
1462 $ ~/poky/scripts/create-pull-request -h
1463 $ ~/poky/scripts/send-pull-request -h
1464 </literallayout></para></listitem>
1465 </itemizedlist>
1466 </para>
1467
1468 <para>
1469 You can find general Git information on how to push a change upstream in the
1470 <ulink url='http://book.git-scm.com/3_distributed_workflows.html'>Git Community Book</ulink>.
1471 </para>
1472 </section>
1473
1474 <section id='submitting-a-patch'>
1475 <title>Using Email to Submit a Patch</title>
1476
1477 <para>
1478 You can submit patches without using the <filename>create-pull-request</filename> and
1479 <filename>send-pull-request</filename> scripts described in the previous section.
1480 However, keep in mind, the preferred method is to use the scripts.
1481 </para>
1482
1483 <para>
1484 Depending on the components changed, you need to submit the email to a specific
1485 mailing list.
1486 For some guidance on which mailing list to use, see the list in the
1487 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
1488 section.
1489 For a description of the available mailing lists, see the
1490 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>"
1491 section in the Yocto Project Reference Manual.
1492 </para>
1493
1494 <para>
1495 Here is the general procedure on how to submit a patch through email without using the
1496 scripts:
1497 <itemizedlist>
1498 <listitem><para>Make your changes in your local Git repository.</para></listitem>
1499 <listitem><para>Stage your changes by using the <filename>git add</filename>
1500 command on each file you changed.</para></listitem>
1501 <listitem><para>Commit the change by using the
1502 <filename>git commit --signoff</filename> command.
1503 Using the <filename>--signoff</filename> option identifies you as the person
1504 making the change and also satisfies the Developer's Certificate of
1505 Origin (DCO) shown earlier.</para>
1506 <para>When you form a commit, you must follow certain standards established by the
1507 Yocto Project development team.
1508 See the earlier section
1509 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
1510 for Yocto Project commit message standards.</para></listitem>
1511 <listitem><para>Format the commit into an email message.
1512 To format commits, use the <filename>git format-patch</filename> command.
1513 When you provide the command, you must include a revision list or a number of patches
1514 as part of the command.
1515 For example, either of these two commands takes your most
1516 recent single commit and formats it as an email message in
1517 the current directory:
1518 <literallayout class='monospaced'>
1519 $ git format-patch -1
1520 </literallayout>
1521 or
1522 <literallayout class='monospaced'>
1523 $ git format-patch HEAD~
1524 </literallayout></para>
1525 <para>After the command is run, the current directory contains a
1526 numbered <filename>.patch</filename> file for the commit.</para>
1527 <para>If you provide several commits as part of the command,
1528 the <filename>git format-patch</filename> command produces a
1529 series of numbered files in the current directory – one for each commit.
1530 If you have more than one patch, you should also use the
1531 <filename>--cover</filename> option with the command, which generates a
1532 cover letter as the first "patch" in the series.
1533 You can then edit the cover letter to provide a description for
1534 the series of patches.
1535 For information on the <filename>git format-patch</filename> command,
1536 see <filename>GIT_FORMAT_PATCH(1)</filename> displayed using the
1537 <filename>man git-format-patch</filename> command.</para>
1538 <note>If you are or will be a frequent contributor to the Yocto Project
1539 or to OpenEmbedded, you might consider requesting a contrib area and the
1540 necessary associated rights.</note></listitem>
1541 <listitem><para>Import the files into your mail client by using the
1542 <filename>git send-email</filename> command.
1543 <note>In order to use <filename>git send-email</filename>, you must have the
1544 the proper Git packages installed.
1545 For Ubuntu, Debian, and Fedora the package is <filename>git-email</filename>.</note></para>
1546 <para>The <filename>git send-email</filename> command sends email by using a local
1547 or remote Mail Transport Agent (MTA) such as
1548 <filename>msmtp</filename>, <filename>sendmail</filename>, or through a direct
1549 <filename>smtp</filename> configuration in your Git <filename>config</filename>
1550 file.
1551 If you are submitting patches through email only, it is very important
1552 that you submit them without any whitespace or HTML formatting that
1553 either you or your mailer introduces.
1554 The maintainer that receives your patches needs to be able to save and
1555 apply them directly from your emails.
1556 A good way to verify that what you are sending will be applicable by the
1557 maintainer is to do a dry run and send them to yourself and then
1558 save and apply them as the maintainer would.</para>
1559 <para>The <filename>git send-email</filename> command is the preferred method
1560 for sending your patches since there is no risk of compromising whitespace
1561 in the body of the message, which can occur when you use your own mail client.
1562 The command also has several options that let you
1563 specify recipients and perform further editing of the email message.
1564 For information on how to use the <filename>git send-email</filename> command,
1565 see <filename>GIT-SEND-EMAIL(1)</filename> displayed using
1566 the <filename>man git-send-email</filename> command.
1567 </para></listitem>
1568 </itemizedlist>
1569 </para>
1570 </section>
1571</section>
1572</chapter>
1573<!--
1574vim: expandtab tw=80 ts=4
1575-->
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
new file mode 100644
index 0000000000..0729baa0da
--- /dev/null
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -0,0 +1,407 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='dev-manual-start'>
6
7<title>Getting Started with the Yocto Project</title>
8
9<para>
10 This chapter introduces the Yocto Project and gives you an idea of what you need to get started.
11 You can find enough information to set up your development host and build or use images for
12 hardware supported by the Yocto Project by reading the
13 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
14</para>
15
16<para>
17 The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides
18 some higher-level concepts you might want to consider.
19</para>
20
21<section id='introducing-the-yocto-project'>
22 <title>Introducing the Yocto Project</title>
23
24 <para>
25 The Yocto Project is an open-source collaboration project focused on embedded Linux development.
26 The project currently provides a build system that is
27 referred to as the OpenEmbedded build system in the Yocto Project documentation.
28 The Yocto Project provides various ancillary tools for the embedded developer
29 and also features the Sato reference User Interface, which is optimized for
30 stylus driven, low-resolution screens.
31 </para>
32
33 <para>
34 You can use the OpenEmbedded build system, which uses
35 BitBake, to develop complete Linux
36 images and associated user-space applications for architectures based
37 on ARM, MIPS, PowerPC, x86 and x86-64.
38 <note>
39 By default, using the Yocto Project creates a Poky distribution.
40 However, you can create your own distribution by providing key
41 <link linkend='metadata'>Metadata</link>.
42 See the "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>"
43 section for more information.
44 </note>
45 While the Yocto Project does not provide a strict testing framework,
46 it does provide or generate for you artifacts that let you perform target-level and
47 emulated testing and debugging.
48 Additionally, if you are an <trademark class='trade'>Eclipse</trademark>
49 IDE user, you can install an Eclipse Yocto Plug-in to allow you to
50 develop within that familiar environment.
51 </para>
52</section>
53
54<section id='getting-setup'>
55 <title>Getting Set Up</title>
56
57 <para>
58 Here is what you need to get set up to use the Yocto Project:
59 <itemizedlist>
60 <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current
61 Linux-based host system.
62 You will have the best results with a recent release of Fedora,
63 OpenSUSE, Debian, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project
64 and officially supported.
65 For a list of the distributions under validation and their status, see the
66 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section
67 in the Yocto Project Reference Manual and the wiki page at
68 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>.</para>
69 <para>
70 You should also have about 100 gigabytes of free disk space for building images.
71 </para></listitem>
72 <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system
73 requires certain packages exist on your development system (e.g. Python 2.6 or 2.7).
74 See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>"
75 section in the Yocto Project Quick Start and the
76 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
77 section in the Yocto Project Reference Manual for the exact
78 package requirements and the installation commands to install
79 them for the supported distributions.
80 </para></listitem>
81 <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis>
82 You need a release of the Yocto Project.
83 You set that up with a local <link linkend='source-directory'>Source Directory</link>
84 one of two ways depending on whether you
85 are going to contribute back into the Yocto Project or not.
86 <note>
87 Regardless of the method you use, this manual refers to the resulting local
88 hierarchical set of files as the "Source Directory."
89 </note>
90 <itemizedlist>
91 <listitem><para><emphasis>Tarball Extraction:</emphasis>
92 If you are not going to contribute back into the Yocto
93 Project, you can simply go to the
94 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>,
95 select the "Downloads" tab, and choose what you want.
96 Once you have the tarball, just extract it into a
97 directory of your choice.</para>
98 <para>For example, the following command extracts the
99 Yocto Project &DISTRO; release tarball
100 into the current working directory and sets up the local Source Directory
101 with a top-level folder named <filename>&YOCTO_POKY;</filename>:
102 <literallayout class='monospaced'>
103 $ tar xfj &YOCTO_POKY_TARBALL;
104 </literallayout></para>
105 <para>This method does not produce a local Git repository.
106 Instead, you simply end up with a snapshot of the release.</para></listitem>
107 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing
108 back into the Yocto Project or you simply want to keep up
109 with the latest developments, you should use Git commands to set up a local
110 Git repository of the upstream <filename>poky</filename> source repository.
111 Doing so creates a repository with a complete history of changes and allows
112 you to easily submit your changes upstream to the project.
113 Because you clone the repository, you have access to all the Yocto Project development
114 branches and tag names used in the upstream repository.</para>
115 <note>You can view the Yocto Project Source Repositories at
116 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note>
117 <para>The following transcript shows how to clone the <filename>poky</filename>
118 Git repository into the current working directory.
119 The command creates the local repository in a directory named <filename>poky</filename>.
120 For information on Git used within the Yocto Project, see the
121 "<link linkend='git'>Git</link>" section.
122 <literallayout class='monospaced'>
123 $ git clone git://git.yoctoproject.org/poky
124 Cloning into 'poky'...
125 remote: Counting objects: 203728, done.
126 remote: Compressing objects: 100% (52371/52371), done.
127 remote: Total 203728 (delta 147444), reused 202891 (delta 146614)
128 Receiving objects: 100% (203728/203728), 95.54 MiB | 308 KiB/s, done.
129 Resolving deltas: 100% (147444/147444), done.
130 </literallayout></para>
131 <para>For another example of how to set up your own local Git repositories, see this
132 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>
133 wiki page</ulink>, which describes how to create both <filename>poky</filename>
134 and <filename>meta-intel</filename> Git repositories.</para></listitem>
135 </itemizedlist></para></listitem>
136 <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis>
137 If you are going to be making modifications to a supported Yocto Project kernel, you
138 need to establish local copies of the source.
139 You can find Git repositories of supported Yocto Project Kernels organized under
140 "Yocto Linux Kernel" in the Yocto Project Source Repositories at
141 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
142 <para>This setup can involve creating a bare clone of the Yocto Project kernel and then
143 copying that cloned repository.
144 You can create the bare clone and the copy of the bare clone anywhere you like.
145 For simplicity, it is recommended that you create these structures outside of the
146 Source Directory (usually <filename>poky</filename>).</para>
147 <para>As an example, the following transcript shows how to create the bare clone
148 of the <filename>linux-yocto-3.10</filename> kernel and then create a copy of
149 that clone.
150 <note>When you have a local Yocto Project kernel Git repository, you can
151 reference that repository rather than the upstream Git repository as
152 part of the <filename>clone</filename> command.
153 Doing so can speed up the process.</note></para>
154 <para>In the following example, the bare clone is named
155 <filename>linux-yocto-3.10.git</filename>, while the
156 copy is named <filename>my-linux-yocto-3.10-work</filename>:
157 <literallayout class='monospaced'>
158 $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.10 linux-yocto-3.10.git
159 Cloning into bare repository 'linux-yocto-3.10.git'...
160 remote: Counting objects: 3364487, done.
161 remote: Compressing objects: 100% (507178/507178), done.
162 remote: Total 3364487 (delta 2827715), reused 3364481 (delta 2827709)
163 Receiving objects: 100% (3364487/3364487), 722.95 MiB | 423 KiB/s, done.
164 Resolving deltas: 100% (2827715/2827715), done.
165 </literallayout></para>
166 <para>Now create a clone of the bare clone just created:
167 <literallayout class='monospaced'>
168 $ git clone linux-yocto-3.10.git my-linux-yocto-3.10-work
169 Cloning into 'my-linux-yocto-3.10-work'...
170 done.
171 </literallayout></para></listitem>
172 <listitem id='meta-yocto-kernel-extras-repo'><para><emphasis>
173 The <filename>meta-yocto-kernel-extras</filename> Git Repository</emphasis>:
174 The <filename>meta-yocto-kernel-extras</filename> Git repository contains Metadata needed
175 only if you are modifying and building the kernel image.
176 In particular, it contains the kernel BitBake append (<filename>.bbappend</filename>)
177 files that you
178 edit to point to your locally modified kernel source files and to build the kernel
179 image.
180 Pointing to these local files is much more efficient than requiring a download of the
181 kernel's source files from upstream each time you make changes to the kernel.</para>
182 <para>You can find the <filename>meta-yocto-kernel-extras</filename> Git Repository in the
183 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at
184 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
185 It is good practice to create this Git repository inside the Source Directory.</para>
186 <para>Following is an example that creates the <filename>meta-yocto-kernel-extras</filename> Git
187 repository inside the Source Directory, which is named <filename>poky</filename>
188 in this case:
189 <literallayout class='monospaced'>
190 $ cd ~/poky
191 $ git clone git://git.yoctoproject.org/meta-yocto-kernel-extras meta-yocto-kernel-extras
192 Cloning into 'meta-yocto-kernel-extras'...
193 remote: Counting objects: 727, done.
194 remote: Compressing objects: 100% (452/452), done.
195 remote: Total 727 (delta 260), reused 719 (delta 252)
196 Receiving objects: 100% (727/727), 536.36 KiB | 102 KiB/s, done.
197 Resolving deltas: 100% (260/260), done.
198 </literallayout></para></listitem>
199 <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board
200 Support Packages (BSPs):</emphasis>
201 The Yocto Project provides a layer called <filename>meta-intel</filename> and
202 it is maintained in its own separate Git repository.
203 The <filename>meta-intel</filename> layer contains many supported
204 <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>.</para>
205 <para>Similar considerations exist for setting up the <filename>meta-intel</filename>
206 layer.
207 You can get set up for BSP development one of two ways: tarball extraction or
208 with a local Git repository.
209 It is a good idea to use the same method that you used to set up the Source Directory.
210 Regardless of the method you use, the Yocto Project uses the following BSP layer
211 naming scheme:
212 <literallayout class='monospaced'>
213 meta-&lt;BSP_name&gt;
214 </literallayout>
215 where <filename>&lt;BSP_name&gt;</filename> is the recognized BSP name.
216 Here are some examples:
217 <literallayout class='monospaced'>
218 meta-crownbay
219 meta-emenlow
220 meta-n450
221 </literallayout>
222 See the
223 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
224 section in the Yocto Project Board Support Package (BSP) Developer's Guide for more
225 information on BSP Layers.
226 <itemizedlist>
227 <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released
228 BSP tarball from the same "Downloads" page of the
229 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>
230 to get the Yocto Project release.
231 Once on the "Download" page, look to the right of the
232 page and scroll down to find the BSP tarballs.</para>
233 <para>Once you have the tarball, just extract it into a directory of your choice.
234 Again, this method just produces a snapshot of the BSP layer in the form
235 of a hierarchical directory structure.</para></listitem>
236 <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working
237 with a local Git repository for your Source Directory, you should also use this method
238 to set up the <filename>meta-intel</filename> Git repository.
239 You can locate the <filename>meta-intel</filename> Git repository in the
240 "Yocto Metadata Layers" area of the Yocto Project Source Repositories at
241 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para>
242 <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside
243 the Source Directory.
244 For example, the following transcript shows the steps to clone the
245 <filename>meta-intel</filename>
246 Git repository inside the local <filename>poky</filename> Git repository.
247 <literallayout class='monospaced'>
248 $ cd ~/poky
249 $ git clone git://git.yoctoproject.org/meta-intel.git
250 Cloning into 'meta-intel'...
251 remote: Counting objects: 7366, done.
252 remote: Compressing objects: 100% (2491/2491), done.
253 remote: Total 7366 (delta 3997), reused 7299 (delta 3930)
254 Receiving objects: 100% (7366/7366), 2.31 MiB | 95 KiB/s, done.
255 Resolving deltas: 100% (3997/3997), done.
256 </literallayout></para>
257 <para>The same
258 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'>wiki page</ulink>
259 referenced earlier covers how to
260 set up the <filename>meta-intel</filename> Git repository.
261 </para></listitem>
262 </itemizedlist></para></listitem>
263 <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing
264 applications using the Eclipse Integrated Development Environment (IDE),
265 you will need this plug-in.
266 See the
267 "<link linkend='setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</link>"
268 section for more information.</para></listitem>
269 </itemizedlist>
270 </para>
271</section>
272
273<section id='building-images'>
274 <title>Building Images</title>
275
276 <para>
277 The build process creates an entire Linux distribution, including the toolchain, from source.
278 For more information on this topic, see the
279 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
280 section in the Yocto Project Quick Start.
281 </para>
282
283 <para>
284 The build process is as follows:
285 <orderedlist>
286 <listitem><para>Make sure you have set up the Source Directory described in the
287 previous section.</para></listitem>
288 <listitem><para>Initialize the build environment by sourcing a build environment
289 script.</para></listitem>
290 <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file,
291 which is found in the
292 <link linkend='build-directory'>Build Directory</link>,
293 is set up how you want it.
294 This file defines many aspects of the build environment including
295 the target machine architecture through the
296 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable,
297 the development machine's processor use through the
298 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and
299 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and
300 a centralized tarball download directory through the
301 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem>
302 <listitem><para>Build the image using the <filename>bitbake</filename> command.
303 If you want information on BitBake, see the user manual included in the
304 <filename>bitbake/doc/manual</filename> directory of the
305 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
306 <listitem><para>Run the image either on the actual hardware or using the QEMU
307 emulator.</para></listitem>
308 </orderedlist>
309 </para>
310</section>
311
312<section id='using-pre-built-binaries-and-qemu'>
313 <title>Using Pre-Built Binaries and QEMU</title>
314
315 <para>
316 Another option you have to get started is to use pre-built binaries.
317 The Yocto Project provides many types of binaries with each release.
318 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
319 chapter in the Yocto Project Reference Manual
320 for descriptions of the types of binaries that ship with a Yocto Project
321 release.
322 </para>
323
324 <para>
325 Using a pre-built binary is ideal for developing software applications to run on your
326 target hardware.
327 To do this, you need to be able to access the appropriate cross-toolchain tarball for
328 the architecture on which you are developing.
329 If you are using an SDK type image, the image ships with the complete toolchain native to
330 the architecture.
331 If you are not using an SDK type image, you need to separately download and
332 install the stand-alone Yocto Project cross-toolchain tarball.
333 </para>
334
335 <para>
336 Regardless of the type of image you are using, you need to download the pre-built kernel
337 that you will boot in the QEMU emulator and then download and extract the target root
338 filesystem for your target machine’s architecture.
339 You can get architecture-specific binaries and file systems from
340 <ulink url='&YOCTO_MACHINES_DL_URL;'>machines</ulink>.
341 You can get installation scripts for stand-alone toolchains from
342 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchains</ulink>.
343 Once you have all your files, you set up the environment to emulate the hardware
344 by sourcing an environment setup script.
345 Finally, you start the QEMU emulator.
346 You can find details on all these steps in the
347 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>"
348 section of the Yocto Project Quick Start.
349 </para>
350
351 <para>
352 Using QEMU to emulate your hardware can result in speed issues
353 depending on the target and host architecture mix.
354 For example, using the <filename>qemux86</filename> image in the emulator
355 on an Intel-based 32-bit (x86) host machine is fast because the target and
356 host architectures match.
357 On the other hand, using the <filename>qemuarm</filename> image on the same Intel-based
358 host can be slower.
359 But, you still achieve faithful emulation of ARM-specific issues.
360 </para>
361
362 <para>
363 To speed things up, the QEMU images support using <filename>distcc</filename>
364 to call a cross-compiler outside the emulated system.
365 If you used <filename>runqemu</filename> to start QEMU, and the
366 <filename>distccd</filename> application is present on the host system, any
367 BitBake cross-compiling toolchain available from the build system is automatically
368 used from within QEMU simply by calling <filename>distcc</filename>.
369 You can accomplish this by defining the cross-compiler variable
370 (e.g. <filename>export CC="distcc"</filename>).
371 Alternatively, if you are using a suitable SDK image or the appropriate
372 stand-alone toolchain is present,
373 the toolchain is also automatically used.
374 </para>
375
376 <note>
377 Several mechanisms exist that let you connect to the system running on the
378 QEMU emulator:
379 <itemizedlist>
380 <listitem><para>QEMU provides a framebuffer interface that makes standard
381 consoles available.</para></listitem>
382 <listitem><para>Generally, headless embedded devices have a serial port.
383 If so, you can configure the operating system of the running image
384 to use that port to run a console.
385 The connection uses standard IP networking.</para></listitem>
386 <listitem><para>SSH servers exist in some QEMU images.
387 The <filename>core-image-sato</filename> QEMU image has a Dropbear secure
388 shell (SSH) server that runs with the root password disabled.
389 The <filename>core-image-basic</filename> and <filename>core-image-lsb</filename> QEMU images
390 have OpenSSH instead of Dropbear.
391 Including these SSH servers allow you to use standard <filename>ssh</filename> and
392 <filename>scp</filename> commands.
393 The <filename>core-image-minimal</filename> QEMU image, however, contains no SSH
394 server.</para></listitem>
395 <listitem><para>You can use a provided, user-space NFS server to boot the QEMU session
396 using a local copy of the root filesystem on the host.
397 In order to make this connection, you must extract a root filesystem tarball by using the
398 <filename>runqemu-extract-sdk</filename> command.
399 After running the command, you must then point the <filename>runqemu</filename>
400 script to the extracted directory instead of a root filesystem image file.</para></listitem>
401 </itemizedlist>
402 </note>
403</section>
404</chapter>
405<!--
406vim: expandtab tw=80 ts=4
407-->
diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml
new file mode 100644
index 0000000000..ca400fbd18
--- /dev/null
+++ b/documentation/dev-manual/dev-manual.xml
@@ -0,0 +1,102 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='dev-manual' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/dev-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Development Manual
21 </title>
22
23 <authorgroup>
24 <author>
25 <firstname>Scott</firstname> <surname>Rifenbark</surname>
26 <affiliation>
27 <orgname>Intel Corporation</orgname>
28 </affiliation>
29 <email>scott.m.rifenbark@intel.com</email>
30 </author>
31 </authorgroup>
32
33 <revhistory>
34 <revision>
35 <revnumber>1.1</revnumber>
36 <date>6 October 2011</date>
37 <revremark>The initial document released with the Yocto Project 1.1 Release.</revremark>
38 </revision>
39 <revision>
40 <revnumber>1.2</revnumber>
41 <date>April 2012</date>
42 <revremark>Released with the Yocto Project 1.2 Release.</revremark>
43 </revision>
44 <revision>
45 <revnumber>1.3</revnumber>
46 <date>October 2012</date>
47 <revremark>Released with the Yocto Project 1.3 Release.</revremark>
48 </revision>
49 <revision>
50 <revnumber>1.4</revnumber>
51 <date>April 2013</date>
52 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
53 </revision>
54 <revision>
55 <revnumber>1.5</revnumber>
56 <date>October 2013</date>
57 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
58 </revision>
59 <revision>
60 <revnumber>1.5.1</revnumber>
61 <date>Sometime in 2013</date>
62 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
63 </revision>
64 </revhistory>
65
66 <copyright>
67 <year>&COPYRIGHT_YEAR;</year>
68 <holder>Linux Foundation</holder>
69 </copyright>
70
71 <legalnotice>
72 <para>
73 Permission is granted to copy, distribute and/or modify this document under
74 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">
75 Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by
76 Creative Commons.
77 </para>
78
79 <note>
80 For the latest version of this manual associated with this
81 Yocto Project release, see the
82 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>
83 from the Yocto Project website.
84 </note>
85 </legalnotice>
86
87 </bookinfo>
88
89 <xi:include href="dev-manual-intro.xml"/>
90
91 <xi:include href="dev-manual-start.xml"/>
92
93 <xi:include href="dev-manual-newbie.xml"/>
94
95 <xi:include href="dev-manual-model.xml"/>
96
97 <xi:include href="dev-manual-common-tasks.xml"/>
98
99</book>
100<!--
101vim: expandtab tw=80 ts=4
102-->
diff --git a/documentation/dev-manual/dev-style.css b/documentation/dev-manual/dev-style.css
new file mode 100644
index 0000000000..23c8e74c1e
--- /dev/null
+++ b/documentation/dev-manual/dev-style.css
@@ -0,0 +1,979 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("figures/dev-title.png");
122 background-position: left top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 0px;
126 text-align: right;
127 width: 740px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/yocto-project-bw.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
979
diff --git a/documentation/dev-manual/figures/app-dev-flow.png b/documentation/dev-manual/figures/app-dev-flow.png
new file mode 100644
index 0000000000..ec93374ee7
--- /dev/null
+++ b/documentation/dev-manual/figures/app-dev-flow.png
Binary files differ
diff --git a/documentation/dev-manual/figures/bsp-dev-flow.png b/documentation/dev-manual/figures/bsp-dev-flow.png
new file mode 100644
index 0000000000..1ccd9c3e3b
--- /dev/null
+++ b/documentation/dev-manual/figures/bsp-dev-flow.png
Binary files differ
diff --git a/documentation/dev-manual/figures/dev-title.png b/documentation/dev-manual/figures/dev-title.png
new file mode 100644
index 0000000000..d3cac4a7e5
--- /dev/null
+++ b/documentation/dev-manual/figures/dev-title.png
Binary files differ
diff --git a/documentation/dev-manual/figures/git-workflow.png b/documentation/dev-manual/figures/git-workflow.png
new file mode 100644
index 0000000000..4fdf42f89c
--- /dev/null
+++ b/documentation/dev-manual/figures/git-workflow.png
Binary files differ
diff --git a/documentation/dev-manual/figures/index-downloads.png b/documentation/dev-manual/figures/index-downloads.png
new file mode 100644
index 0000000000..41251d5d18
--- /dev/null
+++ b/documentation/dev-manual/figures/index-downloads.png
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-dev-flow.png b/documentation/dev-manual/figures/kernel-dev-flow.png
new file mode 100644
index 0000000000..edd9e82af7
--- /dev/null
+++ b/documentation/dev-manual/figures/kernel-dev-flow.png
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-overview-1.png b/documentation/dev-manual/figures/kernel-overview-1.png
new file mode 100644
index 0000000000..116c0b9bd4
--- /dev/null
+++ b/documentation/dev-manual/figures/kernel-overview-1.png
Binary files differ
diff --git a/documentation/dev-manual/figures/kernel-overview-2-generic.png b/documentation/dev-manual/figures/kernel-overview-2-generic.png
new file mode 100644
index 0000000000..889ff1bf0d
--- /dev/null
+++ b/documentation/dev-manual/figures/kernel-overview-2-generic.png
Binary files differ
diff --git a/documentation/dev-manual/figures/source-repos.png b/documentation/dev-manual/figures/source-repos.png
new file mode 100644
index 0000000000..65c5f29a43
--- /dev/null
+++ b/documentation/dev-manual/figures/source-repos.png
Binary files differ
diff --git a/documentation/dev-manual/figures/yp-download.png b/documentation/dev-manual/figures/yp-download.png
new file mode 100644
index 0000000000..7f1e5ca118
--- /dev/null
+++ b/documentation/dev-manual/figures/yp-download.png
Binary files differ
diff --git a/documentation/kernel-dev/figures/kernel-architecture-overview.png b/documentation/kernel-dev/figures/kernel-architecture-overview.png
new file mode 100755
index 0000000000..2aad172db3
--- /dev/null
+++ b/documentation/kernel-dev/figures/kernel-architecture-overview.png
Binary files differ
diff --git a/documentation/kernel-dev/figures/kernel-dev-title.png b/documentation/kernel-dev/figures/kernel-dev-title.png
new file mode 100644
index 0000000000..7a8dd54372
--- /dev/null
+++ b/documentation/kernel-dev/figures/kernel-dev-title.png
Binary files differ
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
new file mode 100644
index 0000000000..4589e4b9fc
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -0,0 +1,1071 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='kernel-dev-advanced'>
6<title>Working with Advanced Metadata</title>
7
8<section id='kernel-dev-advanced-overview'>
9 <title>Overview</title>
10
11 <para>
12 In addition to supporting configuration fragments and patches, the
13 Yocto Project kernel tools also support rich
14 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> that you can
15 use to define complex policies and Board Support Package (BSP) support.
16 The purpose of the Metadata and the tools that manage it, known as
17 the kern-tools (<filename>kern-tools-native_git.bb</filename>), is
18 to help you manage the complexity of the configuration and sources
19 used to support multiple BSPs and Linux kernel types.
20 </para>
21</section>
22
23<section id='using-kernel-metadata-in-a-recipe'>
24 <title>Using Kernel Metadata in a Recipe</title>
25
26 <para>
27 The kernel sources in the Yocto Project contain kernel Metadata, which is
28 located in the <filename>meta</filename> branches of the kernel source
29 Git repositories.
30 This Metadata defines Board Support Packages (BSPs) that
31 correspond to definitions in linux-yocto recipes for the same BSPs.
32 A BSP consists of an aggregation of kernel policy and hardware-specific
33 feature enablements.
34 The BSP can be influenced from within the linux-yocto recipe.
35 <note>
36 Linux kernel source that contains kernel Metadata is said to be
37 "linux-yocto style" kernel source.
38 A Linux kernel recipe that inherits from the
39 <filename>linux-yocto.inc</filename> include file is said to be a
40 "linux-yocto style" recipe.
41 </note>
42 </para>
43
44 <para>
45 Every linux-yocto style recipe must define the
46 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>
47 variable.
48 This variable is typically set to the same value as the
49 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
50 variable, which is used by BitBake (e.g. "routerstationpro" or "fri2").
51 Multiple BSPs can reuse the same <filename>KMACHINE</filename>
52 name if they are built using the same BSP description.
53 The "fri2" and "fri2-noemgd" BSP combination
54 in the <filename>meta-intel</filename>
55 layer is a good example of two BSPs using the same
56 <filename>KMACHINE</filename> value (i.e. "fri2").
57 See the <link linkend='bsp-descriptions'>BSP Descriptions</link> section
58 for more information.
59 </para>
60
61 <para>
62 The linux-yocto style recipes can optionally define the following
63 variables:
64 <literallayout class='monospaced'>
65 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'>KBRANCH</ulink>
66 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink>
67 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH_DEFAULT'>KBRANCH_DEFAULT</ulink>
68 <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</ulink>
69 </literallayout>
70 <filename>KBRANCH_DEFAULT</filename> defines the Linux kernel source
71 repository's default branch to use to build the Linux kernel.
72 The value is used as the default for <filename>KBRANCH</filename>, which
73 can define an alternate branch typically with a machine override as
74 follows:
75 <literallayout class='monospaced'>
76 KBRANCH_fri2 = "standard/fri2"
77 </literallayout>
78 Unless you specify otherwise, <filename>KBRANCH_DEFAULT</filename>
79 initializes to "master".
80 </para>
81
82 <para>
83 <filename>LINUX_KERNEL_TYPE</filename> defines the kernel type to be
84 used in assembling the configuration.
85 If you do not specify a <filename>LINUX_KERNEL_TYPE</filename>,
86 it defaults to "standard".
87 Together with
88 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
89 <filename>LINUX_KERNEL_TYPE</filename> defines the search
90 arguments used by the kernel tools to find the
91 appropriate description within the kernel Metadata with which to
92 build out the sources and configuration.
93 The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
94 kernel types.
95 See the <link linkend='kernel-types'>Kernel Types</link> section
96 for more information on kernel types.
97 </para>
98
99 <para>
100 During the build, the kern-tools search for the BSP description
101 file that most closely matches the <filename>KMACHINE</filename>
102 and <filename>LINUX_KERNEL_TYPE</filename> variables passed in from the
103 recipe.
104 The tools use the first BSP description it finds that match
105 both variables.
106 If the tools cannot find a match, they issue a warning such as
107 the following:
108 <literallayout class='monospaced'>
109 WARNING: Can't find any BSP hardware or required configuration fragments.
110 WARNING: Looked at meta/cfg/broken/fri2-broken/hdw_frags.txt and
111 meta/cfg/broken/fri2-broken/required_frags.txt in directory:
112 meta/cfg/broken/fri2-broken
113 </literallayout>
114 In this example, <filename>KMACHINE</filename> was set to "fri2-broken"
115 and <filename>LINUX_KERNEL_TYPE</filename> was set to "broken".
116 </para>
117
118 <para>
119 The tools first search for the <filename>KMACHINE</filename> and
120 then for the <filename>LINUX_KERNEL_TYPE</filename>.
121 If the tools cannot find a partial match, they will use the
122 sources from the <filename>KBRANCH</filename> and any configuration
123 specified in the
124 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
125 </para>
126
127 <para>
128 You can use the <filename>KERNEL_FEATURES</filename> variable
129 to include features (configuration fragments, patches, or both) that
130 are not already included by the <filename>KMACHINE</filename> and
131 <filename>LINUX_KERNEL_TYPE</filename> variable combination.
132 For example, to include a feature specified as "features/netfilter.scc",
133 specify:
134 <literallayout class='monospaced'>
135 KERNEL_FEATURES += "features/netfilter.scc"
136 </literallayout>
137 To include a feature called "cfg/sound.scc" just for the
138 <filename>qemux86</filename> machine, specify:
139 <literallayout class='monospaced'>
140 KERNEL_FEATURES_append_qemux86 = "cfg/sound.scc"
141 </literallayout>
142 The value of the entries in <filename>KERNEL_FEATURES</filename>
143 are dependent on their location within the kernel Metadata itself.
144 The examples here are taken from the
145 <filename>linux-yocto-3.4</filename> repository where "features"
146 and "cfg" are subdirectories within the
147 <filename>meta/cfg/kernel-cache</filename> directory.
148 For more information, see the
149 "<link linkend='kernel-metadata-syntax'>Kernel Metadata Syntax</link>" section.
150 <note>
151 The processing of the these variables has evolved some between the
152 0.9 and 1.3 releases of the Yocto Project and associated
153 kern-tools sources.
154 The descriptions in this section are accurate for 1.3 and later
155 releases of the Yocto Project.
156 </note>
157 </para>
158</section>
159
160<section id='kernel-metadata-location'>
161 <title>Kernel Metadata Location</title>
162
163 <para>
164 Kernel Metadata can be defined in either the kernel recipe
165 (recipe-space) or in the kernel tree (in-tree).
166 Where you choose to define the Metadata depends on what you want
167 to do and how you intend to work.
168 Regardless of where you define the kernel Metadata, the syntax used
169 applies equally.
170 </para>
171
172 <para>
173 If you are unfamiliar with the Linux kernel and only wish
174 to apply a configuration and possibly a couple of patches provided to
175 you by others, the recipe-space method is recommended.
176 This method is also a good approach if you are working with Linux kernel
177 sources you do not control or if you just do not want to maintain a
178 Linux kernel Git repository on your own.
179 For partial information on how you can define kernel Metadata in
180 the recipe-space, see the
181 "<link linkend='modifying-an-existing-recipe'>Modifying an Existing Recipe</link>"
182 section.
183 </para>
184
185 <para>
186 Conversely, if you are actively developing a kernel and are already
187 maintaining a Linux kernel Git repository of your own, you might find
188 it more convenient to work with the kernel Metadata in the same
189 repository as the Linux kernel sources.
190 This method can make iterative development of the Linux kernel
191 more efficient outside of the BitBake environment.
192 </para>
193
194 <section id='recipe-space-metadata'>
195 <title>Recipe-Space Metadata</title>
196
197 <para>
198 When stored in recipe-space, the kernel Metadata files reside in a
199 directory hierarchy below
200 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>.
201 For a linux-yocto recipe or for a Linux kernel recipe derived
202 by copying and modifying
203 <filename>oe-core/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb</filename>
204 to a recipe in your layer, <filename>FILESEXTRAPATHS</filename>
205 is typically set to
206 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-THISDIR'><filename>THISDIR</filename></ulink><filename>}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename>.
207 See the "<link linkend='modifying-an-existing-recipe'>Modifying an Existing Recipe</link>"
208 section for more information.
209 </para>
210
211 <para>
212 Here is an example that shows a trivial tree of kernel Metadata
213 stored in recipe-space within a BSP layer:
214 <literallayout class='monospaced'>
215 meta-my_bsp_layer/
216 `-- recipes-kernel
217 `-- linux
218 `-- linux-yocto
219 |-- bsp-standard.scc
220 |-- bsp.cfg
221 `-- standard.cfg
222 </literallayout>
223 </para>
224
225 <para>
226 When the Metadata is stored in recipe-space, you must take
227 steps to ensure BitBake has the necessary information to decide
228 what files to fetch and when they need to be fetched again.
229 It is only necessary to specify the <filename>.scc</filename>
230 files on the
231 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
232 BitBake parses them and fetches any files referenced in the
233 <filename>.scc</filename> files by the <filename>include</filename>,
234 <filename>patch</filename>, or <filename>kconf</filename> commands.
235 Because of this, it is necessary to bump the recipe
236 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
237 value when changing the content of files not explicitly listed
238 in the <filename>SRC_URI</filename>.
239 </para>
240 </section>
241
242 <section id='in-tree-metadata'>
243 <title>In-Tree Metadata</title>
244
245 <para>
246 When stored in-tree, the kernel Metadata files reside in the
247 <filename>meta</filename> directory of the Linux kernel sources.
248 The <filename>meta</filename> directory can be present in the
249 same repository branch as the sources,
250 such as "master", or <filename>meta</filename> can be its own
251 orphan branch.
252 <note>
253 An orphan branch in Git is a branch with unique history and
254 content to the other branches in the repository.
255 Orphan branches are useful to track Metadata changes
256 independently from the sources of the Linux kernel, while
257 still keeping them together in the same repository.
258 </note>
259 For the purposes of this document, we will discuss all
260 in-tree Metadata as residing below the
261 <filename>meta/cfg/kernel-cache</filename> directory.
262 </para>
263
264 <para>
265 Following is an example that shows how a trivial tree of Metadata
266 is stored in a custom Linux kernel Git repository:
267 <literallayout class='monospaced'>
268 meta/
269 `-- cfg
270 `-- kernel-cache
271 |-- bsp-standard.scc
272 |-- bsp.cfg
273 `-- standard.cfg
274 </literallayout>
275 </para>
276
277 <para>
278 To use a branch different from where the sources reside,
279 specify the branch in the <filename>KMETA</filename> variable
280 in your Linux kernel recipe.
281 Here is an example:
282 <literallayout class='monospaced'>
283 KMETA = "meta"
284 </literallayout>
285 To use the same branch as the sources, set
286 <filename>KMETA</filename> to an empty string:
287 <literallayout class='monospaced'>
288 KMETA = ""
289 </literallayout>
290 If you are working with your own sources and want to create an
291 orphan <filename>meta</filename> branch, use these commands
292 from within your Linux kernel Git repository:
293 <literallayout class='monospaced'>
294 $ git checkout --orphan meta
295 $ git rm -rf .
296 $ git commit --allow-empty -m "Create orphan meta branch"
297 </literallayout>
298 </para>
299
300 <para>
301 If you modify the Metadata in the linux-yocto
302 <filename>meta</filename> branch, you must not forget to update
303 the
304 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink>
305 statements in the kernel's recipe.
306 In particular, you need to update the
307 <filename>SRCREV_meta</filename> variable to match the commit in
308 the <filename>KMETA</filename> branch you wish to use.
309 Changing the data in these branches and not updating the
310 <filename>SRCREV</filename> statements to match will cause the
311 build to fetch an older commit.
312 </para>
313 </section>
314</section>
315
316<section id='kernel-metadata-syntax'>
317 <title>Kernel Metadata Syntax</title>
318
319 <para>
320 The kernel Metadata consists of three primary types of files:
321 <filename>scc</filename>
322 <footnote>
323 <para>
324 <filename>scc</filename> stands for Series Configuration
325 Control, but the naming has less significance in the
326 current implementation of the tooling than it had in the
327 past.
328 Consider <filename>scc</filename> files to be description files.
329 </para>
330 </footnote>
331 description files, configuration fragments, and patches.
332 The <filename>scc</filename> files define variables and include or
333 otherwise reference any of the three file types.
334 The description files are used to aggregate all types of kernel
335 Metadata into
336 what ultimately describes the sources and the configuration required
337 to build a Linux kernel tailored to a specific machine.
338 </para>
339
340 <para>
341 The <filename>scc</filename> description files are used to define two
342 fundamental types of kernel Metadata:
343 <itemizedlist>
344 <listitem><para>Features</para></listitem>
345 <listitem><para>Board Support Packages (BSPs)</para></listitem>
346 </itemizedlist>
347 </para>
348
349 <para>
350 Features aggregate sources in the form of patches and configuration
351 fragments into a modular reusable unit.
352 You can use features to implement conceptually separate kernel
353 Metadata descriptions such as pure configuration fragments,
354 simple patches, complex features, and kernel types.
355 <link linkend='kernel-types'>Kernel types</link> define general
356 kernel features and policy to be reused in the BSPs.
357 </para>
358
359 <para>
360 BSPs define hardware-specific features and aggregate them with kernel
361 types to form the final description of what will be assembled and built.
362 </para>
363
364 <para>
365 While the kernel Metadata syntax does not enforce any logical
366 separation of configuration fragments, patches, features or kernel
367 types, best practices dictate a logical separation of these types
368 of Metadata.
369 The following Metadata file hierarchy is recommended:
370 <literallayout class='monospaced'>
371 &lt;base&gt;/
372 bsp/
373 cfg/
374 features/
375 ktypes/
376 patches/
377 </literallayout>
378 </para>
379
380 <para>
381 The <filename>bsp</filename> directory contains the
382 <link linkend='bsp-descriptions'>BSP descriptions</link>.
383 The remaining directories all contain "features".
384 Separating <filename>bsp</filename> from the rest of the structure
385 aids conceptualizing intended usage.
386 </para>
387
388 <para>
389 Use these guidelines to help place your <filename>scc</filename>
390 description files within the structure:
391 <itemizedlist>
392 <listitem><para>If your file contains
393 only configuration fragments, place the file in the
394 <filename>cfg</filename> directory.</para></listitem>
395 <listitem><para>If your file contains
396 only source-code fixes, place the file in the
397 <filename>patches</filename> directory.</para></listitem>
398 <listitem><para>If your file encapsulates
399 a major feature, often combining sources and configurations,
400 place the file in <filename>features</filename> directory.
401 </para></listitem>
402 <listitem><para>If your file aggregates
403 non-hardware configuration and patches in order to define a
404 base kernel policy or major kernel type to be reused across
405 multiple BSPs, place the file in <filename>ktypes</filename>
406 directory.
407 </para></listitem>
408 </itemizedlist>
409 </para>
410
411 <para>
412 These distinctions can easily become blurred - especially as
413 out-of-tree features slowly merge upstream over time.
414 Also, remember that how the description files are placed is
415 a purely logical organization and has no impact on the functionality
416 of the kernel Metadata.
417 There is no impact because all of <filename>cfg</filename>,
418 <filename>features</filename>, <filename>patches</filename>, and
419 <filename>ktypes</filename>, contain "features" as far as the kernel
420 tools are concerned.
421 </para>
422
423 <para>
424 Paths used in kernel Metadata files are relative to
425 <filename>&lt;base&gt;</filename>, which is either
426 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
427 if you are creating Metadata in
428 <link linkend='recipe-space-metadata'>recipe-space</link>,
429 or <filename>meta/cfg/kernel-cache/</filename> if you are creating
430 Metadata <link linkend='in-tree-metadata'>in-tree</link>.
431 </para>
432
433 <section id='configuration'>
434 <title>Configuration</title>
435
436 <para>
437 The simplest unit of kernel Metadata is the configuration-only
438 feature.
439 This feature consists of one or more Linux kernel configuration
440 parameters in a configuration fragment file
441 (<filename>.cfg</filename>) and an <filename>.scc</filename> file
442 that describes the fragment.
443 </para>
444
445 <para>
446 The Symmetric Multi-Processing (SMP) fragment included in the
447 <filename>linux-yocto-3.4</filename> Git repository
448 consists of the following two files:
449 <literallayout class='monospaced'>
450 cfg/smp.scc:
451 define KFEATURE_DESCRIPTION "Enable SMP"
452 kconf hardware smp.cfg
453
454 cfg/smp.cfg:
455 CONFIG_SMP=y
456 CONFIG_SCHED_SMT=y
457 </literallayout>
458 You can find information on configuration fragment files in the
459 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-config-fragments'>Creating Configuration Fragments</ulink>"
460 section of the Yocto Project Development Manual and in
461 the "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
462 section earlier in this manual.
463 </para>
464
465 <para>
466 <ulink url='&YOCTO_DOCS_REF_URL;#var-KFEATURE_DESCRIPTION'><filename>KFEATURE_DESCRIPTION</filename></ulink>
467 provides a short description of the fragment.
468 Higher level kernel tools use this description.
469 </para>
470
471 <para>
472 The <filename>kconf</filename> command is used to include the
473 actual configuration fragment in an <filename>.scc</filename>
474 file, and the "hardware" keyword identifies the fragment as
475 being hardware enabling, as opposed to general policy,
476 which would use the "non-hardware" keyword.
477 The distinction is made for the benefit of the configuration
478 validation tools, which warn you if a hardware fragment
479 overrides a policy set by a non-hardware fragment.
480 <note>
481 The description file can include multiple
482 <filename>kconf</filename> statements, one per fragment.
483 </note>
484 </para>
485
486 <para>
487 As described in the
488 "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
489 section, you can use the following BitBake command to audit your
490 configuration:
491 <literallayout class='monospaced'>
492 $ bitbake linux-yocto -c kernel_configcheck -f
493 </literallayout>
494 </para>
495 </section>
496
497 <section id='patches'>
498 <title>Patches</title>
499
500 <para>
501 Patch descriptions are very similar to configuration fragment
502 descriptions, which are described in the previous section.
503 However, instead of a <filename>.cfg</filename> file, these
504 descriptions work with source patches.
505 </para>
506
507 <para>
508 A typical patch includes a description file and the patch itself:
509 <literallayout class='monospaced'>
510 patches/mypatch.scc:
511 patch mypatch.patch
512
513 patches/mypatch.patch:
514 &lt;typical-patch&gt;
515 </literallayout>
516 You can create the typical <filename>.patch</filename>
517 file using <filename>diff -Nurp</filename> or
518 <filename>git format-patch</filename>.
519 </para>
520
521 <para>
522 The description file can include multiple patch statements,
523 one per patch.
524 </para>
525 </section>
526
527 <section id='features'>
528 <title>Features</title>
529
530 <para>
531 Features are complex kernel Metadata types that consist
532 of configuration fragments (<filename>kconf</filename>), patches
533 (<filename>patch</filename>), and possibly other feature
534 description files (<filename>include</filename>).
535 </para>
536
537 <para>
538 Here is an example that shows a feature description file:
539 <literallayout class='monospaced'>
540 features/myfeature.scc
541 define KFEATURE_DESCRIPTION "Enable myfeature"
542
543 patch 0001-myfeature-core.patch
544 patch 0002-myfeature-interface.patch
545
546 include cfg/myfeature_dependency.scc
547 kconf non-hardware myfeature.cfg
548 </literallayout>
549 This example shows how the <filename>patch</filename> and
550 <filename>kconf</filename> commands are used as well as
551 how an additional feature description file is included.
552 </para>
553
554 <para>
555 Typically, features are less granular than configuration
556 fragments and are more likely than configuration fragments
557 and patches to be the types of things you want to specify
558 in the <filename>KERNEL_FEATURES</filename> variable of the
559 Linux kernel recipe.
560 See the "<link linkend='using-kernel-metadata-in-a-recipe'>Using Kernel Metadata in a Recipe</link>"
561 section earlier in the manual.
562 </para>
563 </section>
564
565 <section id='kernel-types'>
566 <title>Kernel Types</title>
567
568 <para>
569 A kernel type defines a high-level kernel policy by
570 aggregating non-hardware configuration fragments with
571 patches you want to use when building a Linux kernels of a
572 specific type.
573 Syntactically, kernel types are no different than features
574 as described in the "<link linkend='features'>Features</link>"
575 section.
576 The <filename>LINUX_KERNEL_TYPE</filename> variable in the kernel
577 recipe selects the kernel type.
578 See the "<link linkend='using-kernel-metadata-in-a-recipe'>Using Kernel Metadata in a Recipe</link>"
579 section for more information.
580 </para>
581
582 <para>
583 As an example, the <filename>linux-yocto-3.4</filename>
584 tree defines three kernel types: "standard",
585 "tiny", and "preempt-rt":
586 <itemizedlist>
587 <listitem><para>"standard":
588 Includes the generic Linux kernel policy of the Yocto
589 Project linux-yocto kernel recipes.
590 This policy includes, among other things, which file
591 systems, networking options, core kernel features, and
592 debugging and tracing options are supported.
593 </para></listitem>
594 <listitem><para>"preempt-rt":
595 Applies the <filename>PREEMPT_RT</filename>
596 patches and the configuration options required to
597 build a real-time Linux kernel.
598 This kernel type inherits from the "standard" kernel type.
599 </para></listitem>
600 <listitem><para>"tiny":
601 Defines a bare minimum configuration meant to serve as a
602 base for very small Linux kernels.
603 The "tiny" kernel type is independent from the "standard"
604 configuration.
605 Although the "tiny" kernel type does not currently include
606 any source changes, it might in the future.
607 </para></listitem>
608 </itemizedlist>
609 </para>
610
611 <para>
612 The "standard" kernel type is defined by
613 <filename>standard.scc</filename>:
614 <literallayout class='monospaced'>
615 # Include this kernel type fragment to get the standard features and
616 # configuration values.
617
618 # Include all standard features
619 include standard-nocfg.scc
620
621 kconf non-hardware standard.cfg
622
623 # individual cfg block section
624 include cfg/fs/devtmpfs.scc
625 include cfg/fs/debugfs.scc
626 include cfg/fs/btrfs.scc
627 include cfg/fs/ext2.scc
628 include cfg/fs/ext3.scc
629 include cfg/fs/ext4.scc
630
631 include cfg/net/ipv6.scc
632 include cfg/net/ip_nf.scc
633 include cfg/net/ip6_nf.scc
634 include cfg/net/bridge.scc
635 </literallayout>
636 </para>
637
638 <para>
639 As with any <filename>.scc</filename> file, a
640 kernel type definition can aggregate other
641 <filename>.scc</filename> files with
642 <filename>include</filename> commands.
643 These definitions can also directly pull in
644 configuration fragments and patches with the
645 <filename>kconf</filename> and <filename>patch</filename>
646 commands, respectively.
647 </para>
648
649 <note>
650 It is not strictly necessary to create a kernel type
651 <filename>.scc</filename> file.
652 The Board Support Package (BSP) file can implicitly define
653 the kernel type using a <filename>define
654 <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'>KTYPE</ulink> myktype</filename>
655 line.
656 See the "<link linkend='bsp-descriptions'>BSP Descriptions</link>"
657 section for more information.
658 </note>
659 </section>
660
661 <section id='bsp-descriptions'>
662 <title>BSP Descriptions</title>
663
664 <para>
665 BSP descriptions combine kernel types with hardware-specific
666 features.
667 The hardware-specific portion is typically defined
668 independently, and then aggregated with each supported kernel
669 type.
670 Consider this simple BSP description that supports the "mybsp"
671 machine:
672 <literallayout class='monospaced'>
673 mybsp.scc:
674 define KMACHINE mybsp
675 define KTYPE standard
676 define KARCH i386
677
678 kconf mybsp.cfg
679 </literallayout>
680 Every BSP description should define the
681 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
682 <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>,
683 and <ulink url='&YOCTO_DOCS_REF_URL;#var-KARCH'><filename>KARCH</filename></ulink>
684 variables.
685 These variables allow the OpenEmbedded build system to identify
686 the description as meeting the criteria set by the recipe being
687 built.
688 This simple example supports the "mybsp" machine for the "standard"
689 kernel and the "i386" architecture.
690 </para>
691
692 <para>
693 Be aware that a hard link between the
694 <filename>KTYPE</filename> variable and a kernel type
695 description file does not exist.
696 Thus, if you do not have kernel types defined in your kernel
697 Metadata, you only need to ensure that the kernel recipe's
698 <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink>
699 variable and the <filename>KTYPE</filename> variable in the
700 BSP description file match.
701 <note>
702 Future versions of the tooling make the specification of
703 <filename>KTYPE</filename> in the BSP optional.
704 </note>
705 </para>
706
707 <para>
708 If you did want to separate your kernel policy from your
709 hardware configuration, you could do so by specifying a kernel
710 type, such as "standard" and including that description file
711 in the BSP description file.
712 See the "<link linkend='kernel-types'>Kernel Types</link>" section
713 for more information.
714 </para>
715
716 <para>
717 You might also have multiple hardware configurations that you
718 aggregate into a single hardware description file that you
719 could include in the BSP description file, rather than referencing
720 a single <filename>.cfg</filename> file.
721 Consider the following:
722 <literallayout class='monospaced'>
723 mybsp.scc:
724 define KMACHINE mybsp
725 define KTYPE standard
726 define KARCH i386
727
728 include standard.scc
729 include mybsp-hw.scc
730 </literallayout>
731 </para>
732
733 <para>
734 In the above example, <filename>standard.scc</filename>
735 aggregates all the configuration fragments, patches, and
736 features that make up your standard kernel policy whereas
737 <filename>mybsp-hw.scc</filename> aggregates all those necessary
738 to support the hardware available on the "mybsp" machine.
739 For information on how to break a complete
740 <filename>.config</filename> file into the various
741 configuration fragments, see the
742 "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
743 section.
744 </para>
745
746 <para>
747 Many real-world examples are more complex.
748 Like any other <filename>.scc</filename> file, BSP
749 descriptions can aggregate features.
750 Consider the Fish River Island 2 (fri2)
751 BSP definition from the <filename>linux-yocto-3.4</filename>
752 Git repository:
753 <literallayout class='monospaced'>
754 fri2.scc:
755 kconf hardware fri2.cfg
756
757 include cfg/x86.scc
758 include features/eg20t/eg20t.scc
759 include cfg/dmaengine.scc
760 include features/ericsson-3g/f5521gw.scc
761 include features/power/intel.scc
762 include cfg/efi.scc
763 include features/usb/ehci-hcd.scc
764 include features/usb/ohci-hcd.scc
765 include features/iwlwifi/iwlwifi.scc
766 </literallayout>
767 </para>
768
769 <para>
770 The <filename>fri2.scc</filename> description file includes
771 a hardware configuration fragment
772 (<filename>fri2.cfg</filename>) specific to the Fish River
773 Island 2 BSP as well as several more general configuration
774 fragments and features enabling hardware found on the
775 machine.
776 This description file is then included in each of the three
777 "fri2" description files for the supported kernel types
778 (i.e. "standard", "preempt-rt", and "tiny").
779 Consider the "fri2" description for the "standard" kernel
780 type:
781 <literallayout class='monospaced'>
782 fri2-standard.scc:
783 define KMACHINE fri2
784 define KTYPE standard
785 define KARCH i386
786
787 include ktypes/standard/standard.scc
788 branch fri2
789
790 git merge emgd-1.14
791
792 include fri2.scc
793
794 # Extra fri2 configs above the minimal defined in fri2.scc
795 include cfg/efi-ext.scc
796 include features/drm-emgd/drm-emgd.scc
797 include cfg/vesafb.scc
798
799 # default policy for standard kernels
800 include cfg/usb-mass-storage.scc
801 </literallayout>
802 The <filename>include</filename> command midway through the file
803 includes the <filename>fri2.scc</filename> description that
804 defines all hardware enablements for the BSP that is common to all
805 kernel types.
806 Using this command significantly reduces duplication.
807 </para>
808
809 <para>
810 This "fri2" standard description introduces a few more variables
811 and commands that are worth further discussion.
812 Notice the <filename>branch fri2</filename> command, which creates
813 a machine-specific branch into which source changes are applied.
814 With this branch set up, the <filename>git merge</filename> command
815 uses Git to merge in a feature branch named "emgd-1.14".
816 You could also handle this with the <filename>patch</filename>
817 command.
818 However, for commonly used features such as this, feature branches
819 are a convenient mechanism.
820 See the "<link linkend='feature-branches'>Feature Branches</link>"
821 section for more information.
822 </para>
823
824 <para>
825 Now consider the "fri2" description for the "tiny" kernel type:
826 <literallayout class='monospaced'>
827 fri2-tiny.scc:
828 define KMACHINE fri2
829 define KTYPE tiny
830 define KARCH i386
831
832 include ktypes/tiny/tiny.scc
833 branch fri2
834
835 include fri2.scc
836 </literallayout>
837 As you might expect, the "tiny" description includes quite a
838 bit less.
839 In fact, it includes only the minimal policy defined by the
840 "tiny" kernel type and the hardware-specific configuration required
841 for booting the machine along with the most basic functionality of
842 the system as defined in the base "fri2" description file.
843 </para>
844
845 <para>
846 Notice again the three critical variables:
847 <filename>KMACHINE</filename>, <filename>KTYPE</filename>,
848 and <filename>KARCH</filename>.
849 Of these variables, only the <filename>KTYPE</filename> has changed.
850 It is now set to "tiny".
851 </para>
852 </section>
853</section>
854
855<section id='organizing-your-source'>
856 <title>Organizing Your Source</title>
857
858 <para>
859 Many recipes based on the <filename>linux-yocto-custom.bb</filename>
860 recipe use Linux kernel sources that have only a single
861 branch - "master".
862 This type of repository structure is fine for linear development
863 supporting a single machine and architecture.
864 However, if you work with multiple boards and architectures,
865 a kernel source repository with multiple branches is more
866 efficient.
867 For example, suppose you need a series of patches for one board to boot.
868 Sometimes, these patches are works-in-progress or fundamentally wrong,
869 yet they are still necessary for specific boards.
870 In these situations, you most likely do not want to include these
871 patches in every kernel you build (i.e. have the patches as part of
872 the lone "master" branch).
873 It is situations like these that give rise to multiple branches used
874 within a Linux kernel sources Git repository.
875 </para>
876
877 <para>
878 Repository organization strategies exist that maximize source reuse,
879 remove redundancy, and logically order your changes.
880 This section presents strategies for the following cases:
881 <itemizedlist>
882 <listitem><para>Encapsulating patches in a feature description
883 and only including the patches in the BSP descriptions of
884 the applicable boards.</para></listitem>
885 <listitem><para>Creating a machine branch in your
886 kernel source repository and applying the patches on that
887 branch only.</para></listitem>
888 <listitem><para>Creating a feature branch in your
889 kernel source repository and merging that branch into your
890 BSP when needed.</para></listitem>
891 </itemizedlist>
892 </para>
893
894 <para>
895 The approach you take is entirely up to you
896 and depends on what works best for your development model.
897 </para>
898
899 <section id='encapsulating-patches'>
900 <title>Encapsulating Patches</title>
901
902 <para>
903 if you are reusing patches from an external tree and are not
904 working on the patches, you might find the encapsulated feature
905 to be appropriate.
906 Given this scenario, you do not need to create any branches in the
907 source repository.
908 Rather, you just take the static patches you need and encapsulate
909 them within a feature description.
910 Once you have the feature description, you simply include that into
911 the BSP description as described in the
912 "<link linkend='bsp-descriptions'>BSP Descriptions</link>"
913 section.
914 </para>
915
916 <para>
917 You can find information on how to create patches and BSP
918 descriptions in the "<link linkend='patches'>Patches</link>" and
919 "<link linkend='bsp-descriptions'>BSP Descriptions</link>"
920 sections.
921 </para>
922 </section>
923
924 <section id='machine-branches'>
925 <title>Machine Branches</title>
926
927 <para>
928 When you have multiple machines and architectures to support,
929 or you are actively working on board support, it is more
930 efficient to create branches in the repository based on
931 individual machines.
932 Having machine branches allows common source to remain in the
933 "master" branch with any features specific to a machine stored
934 in the appropriate machine branch.
935 This organization method frees you from continually reintegrating
936 your patches into a feature.
937 </para>
938
939 <para>
940 Once you have a new branch, you can set up your kernel Metadata
941 to use the branch a couple different ways.
942 In the recipe, you can specify the new branch as the
943 <filename>KBRANCH</filename> to use for the board as
944 follows:
945 <literallayout class='monospaced'>
946 KBRANCH = "mynewbranch"
947 </literallayout>
948 Another method is to use the <filename>branch</filename> command
949 in the BSP description:
950 <literallayout class='monospaced'>
951 mybsp.scc:
952 define KMACHINE mybsp
953 define KTYPE standard
954 define KARCH i386
955 include standard.scc
956
957 branch mynewbranch
958
959 include mybsp-hw.scc
960 </literallayout>
961 </para>
962
963 <para>
964 If you find
965 yourself with numerous branches, you might consider using a
966 hierarchical branching system similar to what the linux-yocto Linux
967 kernel repositories use:
968 <literallayout class='monospaced'>
969 &lt;common&gt;/&lt;kernel_type&gt;/&lt;machine&gt;
970 </literallayout>
971 </para>
972
973 <para>
974 If you had two kernel types, "standard" and "small" for
975 instance, and three machines, the branches in your
976 Git repository might look like this:
977 <literallayout class='monospaced'>
978 common/base
979 common/standard/base
980 common/standard/machine_a
981 common/standard/machine_b
982 common/standard/machine_c
983 common/small/base
984 common/small/machine_a
985 </literallayout>
986 </para>
987
988 <para>
989 This organization can help clarify the branch relationships.
990 In this case, <filename>common/standard/machine_a</filename>
991 includes everything in <filename>common/base</filename> and
992 <filename>common/standard/base</filename>.
993 The "standard" and "small" branches add sources specific to those
994 kernel types that for whatever reason are not appropriate for the
995 other branches.
996 <note>The "base" branches are an artifact of the way Git manages
997 its data internally on the filesystem: Git will not allow you
998 to use <filename>common/standard</filename> and
999 <filename>common/standard/machine_a</filename> because it
1000 would have to create a file and a directory named "standard".
1001 </note>
1002 </para>
1003 </section>
1004
1005 <section id='feature-branches'>
1006 <title>Feature Branches</title>
1007
1008 <para>
1009 When you are actively developing new features, it can be more
1010 efficient to work with that feature as a branch, rather than
1011 as a set of patches that have to be regularly updated.
1012 The Yocto Project Linux kernel tools provide for this with
1013 the <filename>git merge</filename> command.
1014 </para>
1015
1016 <para>
1017 To merge a feature branch into a BSP, insert the
1018 <filename>git merge</filename> command after any
1019 <filename>branch</filename> commands:
1020 <literallayout class='monospaced'>
1021 mybsp.scc:
1022 define KMACHINE mybsp
1023 define KTYPE standard
1024 define KARCH i386
1025 include standard.scc
1026
1027 branch mynewbranch
1028 git merge myfeature
1029
1030 include mybsp-hw.scc
1031 </literallayout>
1032 </para>
1033 </section>
1034</section>
1035
1036<section id='scc-reference'>
1037 <title>SCC Description File Reference</title>
1038
1039 <para>
1040 This section provides a brief reference for the commands you can use
1041 within an SCC description file (<filename>.scc</filename>):
1042 <itemizedlist>
1043 <listitem><para><filename>branch [ref]</filename>:
1044 Creates a new branch relative to the current branch
1045 (typically <filename>${KTYPE}</filename>) using
1046 the currently checked-out branch, or "ref" if specified.
1047 </para></listitem>
1048 <listitem><para><filename>define</filename>:
1049 Defines variables, such as <filename>KMACHINE</filename>,
1050 <filename>KTYPE</filename>, <filename>KARCH</filename>,
1051 and <filename>KFEATURE_DESCRIPTION</filename>.</para></listitem>
1052 <listitem><para><filename>include SCC_FILE</filename>:
1053 Includes an SCC file in the current file.
1054 The file is parsed as if you had inserted it inline.
1055 </para></listitem>
1056 <listitem><para><filename>kconf [hardware|non-hardware] CFG_FILE</filename>:
1057 Queues a configuration fragment for merging into the final
1058 Linux <filename>.config</filename> file.</para></listitem>
1059 <listitem><para><filename>git merge GIT_BRANCH</filename>:
1060 Merges the feature branch into the current branch.
1061 </para></listitem>
1062 <listitem><para><filename>patch PATCH_FILE</filename>:
1063 Applies the patch to the current Git branch.</para></listitem>
1064 </itemizedlist>
1065 </para>
1066</section>
1067
1068</chapter>
1069<!--
1070vim: expandtab tw=80 ts=4
1071-->
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
new file mode 100644
index 0000000000..a152f9fbbe
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -0,0 +1,863 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='kernel-dev-common'>
6
7<title>Common Tasks</title>
8
9<para>
10 This chapter presents several common tasks you perform when you
11 work with the Yocto Project Linux kernel.
12 These tasks include preparing a layer, modifying an existing recipe,
13 iterative development, working with your own sources, and incorporating
14 out-of-tree modules.
15 <note>
16 The examples presented in this chapter work with the Yocto Project
17 1.2.2 Release and forward.
18 </note>
19</para>
20
21 <section id='creating-and-preparing-a-layer'>
22 <title>Creating and Preparing a Layer</title>
23
24 <para>
25 If you are going to be modifying kernel recipes, it is recommended
26 that you create and prepare your own layer in which to do your
27 work.
28 Your layer contains its own BitBake append files
29 (<filename>.bbappend</filename>) and provides a convenient
30 mechanism to create your own recipe files
31 (<filename>.bb</filename>).
32 For details on how to create and work with layers, see the following
33 sections in the Yocto Project Development Manual:
34 <itemizedlist>
35 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" for
36 general information on layers and how to create layers.</para></listitem>
37 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#set-up-your-layer-for-the-build'>Set Up Your Layer for the Build</ulink>" for
38 specific instructions on setting up a layer for kernel
39 development.</para></listitem>
40 </itemizedlist>
41 </para>
42 </section>
43
44 <section id='modifying-an-existing-recipe'>
45 <title>Modifying an Existing Recipe</title>
46
47 <para>
48 In many cases, you can customize an existing linux-yocto recipe to
49 meet the needs of your project.
50 Each release of the Yocto Project provides a few Linux
51 kernel recipes from which you can choose.
52 These are located in the
53 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
54 in <filename>meta/recipes-kernel/linux</filename>.
55 </para>
56
57 <para>
58 Modifying an existing recipe can consist of the following:
59 <itemizedlist>
60 <listitem><para>Creating the append file</para></listitem>
61 <listitem><para>Applying patches</para></listitem>
62 <listitem><para>Changing the configuration</para></listitem>
63 </itemizedlist>
64 </para>
65
66 <para>
67 Before modifying an existing recipe, be sure that you have created
68 a minimal, custom layer from which you can work.
69 See the "<link linkend='creating-and-preparing-a-layer'>Creating and Preparing a Layer</link>"
70 section for some general resources.
71 You can also see the
72 "<ulink url='&YOCTO_DOCS_DEV_URL;#set-up-your-layer-for-the-build'>Set Up Your Layer for the Build</ulink>" section
73 of the Yocto Project Development Manual for a detailed
74 example.
75 </para>
76
77 <section id='creating-the-append-file'>
78 <title>Creating the Append File</title>
79
80 <para>
81 You create this file in your custom layer.
82 You also name it accordingly based on the linux-yocto recipe
83 you are using.
84 For example, if you are modifying the
85 <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename>
86 recipe, the append file will typical be located as follows
87 within your custom layer:
88 <literallayout class='monospaced'>
89 &lt;your-layer&gt;/recipes-kernel/linux/linux-yocto_3.4.bbappend
90 </literallayout>
91 The append file should initially extend the
92 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
93 search path by prepending the directory that contains your
94 files to the
95 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
96 variable as follows:
97 <literallayout class='monospaced'>
98 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
99 </literallayout>
100 The path <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-THISDIR'><filename>THISDIR</filename></ulink><filename>}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename>
101 expands to "linux-yocto" in the current directory for this
102 example.
103 If you add any new files that modify the kernel recipe and you
104 have extended <filename>FILESPATH</filename> as
105 described above, you must place the files in your layer in the
106 following area:
107 <literallayout class='monospaced'>
108 &lt;your-layer&gt;/recipes-kernel/linux/linux-yocto/
109 </literallayout>
110 <note>If you are working on a new machine Board Support Package
111 (BSP), be sure to refer to the
112 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
113 </note>
114 </para>
115 </section>
116
117 <section id='applying-patches'>
118 <title>Applying Patches</title>
119
120 <para>
121 If you have a single patch or a small series of patches
122 that you want to apply to the Linux kernel source, you
123 can do so just as you would with any other recipe.
124 You first copy the patches to the path added to
125 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
126 in your <filename>.bbappend</filename> file as described in
127 the previous section, and then reference them in
128 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
129 statements.
130 </para>
131
132 <para>
133 For example, you can apply a three-patch series by adding the
134 following lines to your linux-yocto <filename>.bbappend</filename>
135 file in your layer:
136 <literallayout class='monospaced'>
137 SRC_URI += "file://0001-first-change.patch"
138 SRC_URI += "file://0002-first-change.patch"
139 SRC_URI += "file://0003-first-change.patch"
140 </literallayout>
141 The next time you run BitBake to build the Linux kernel, BitBake
142 detects the change in the recipe and fetches and applies the patches
143 before building the kernel.
144 </para>
145
146 <para>
147 For a detailed example showing how to patch the kernel, see the
148 "<ulink url='&YOCTO_DOCS_DEV_URL;#patching-the-kernel'>Patching the Kernel</ulink>"
149 section in the Yocto Project Development Manual.
150 </para>
151 </section>
152
153 <section id='changing-the-configuration'>
154 <title>Changing the Configuration</title>
155
156 <para>
157 You can make wholesale or incremental changes to the Linux
158 kernel <filename>.config</filename> file by including a
159 <filename>defconfig</filename> and by specifying
160 configuration fragments in the
161 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
162 </para>
163
164 <para>
165 If you have a final Linux kernel <filename>.config</filename>
166 file you want to use, copy it to a directory named
167 <filename>files</filename>, which must be in
168 your layer's <filename>recipes-kernel/linux</filename>
169 directory, and name the file "defconfig".
170 Then, add the following lines to your linux-yocto
171 <filename>.bbappend</filename> file in your layer:
172 <literallayout class='monospaced'>
173 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
174 SRC_URI += "file://defconfig"
175 </literallayout>
176 The <filename>SRC_URI</filename> tells the build system how to
177 search for the file, while the
178 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>
179 extends the
180 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
181 variable (search directories) to include the
182 <filename>files</filename> directory you created for the
183 configuration changes.
184 </para>
185
186 <note>
187 The build system applies the configurations from the
188 <filename>.config</filename> file before applying any
189 subsequent configuration fragments.
190 The final kernel configuration is a combination of the
191 configurations in the <filename>.config</filename> file and
192 any configuration fragments you provide.
193 You need to realize that if you have any configuration
194 fragments, the build system applies these on top of and
195 after applying the existing <filename>.config</filename>
196 file configurations.
197 </note>
198
199 <para>
200 Generally speaking, the preferred approach is to determine the
201 incremental change you want to make and add that as a
202 configuration fragment.
203 For example, if you want to add support for a basic serial
204 console, create a file named <filename>8250.cfg</filename> in
205 the <filename>files</filename> directory with the following
206 content (without indentation):
207 <literallayout class='monospaced'>
208 CONFIG_SERIAL_8250=y
209 CONFIG_SERIAL_8250_CONSOLE=y
210 CONFIG_SERIAL_8250_PCI=y
211 CONFIG_SERIAL_8250_NR_UARTS=4
212 CONFIG_SERIAL_8250_RUNTIME_UARTS=4
213 CONFIG_SERIAL_CORE=y
214 CONFIG_SERIAL_CORE_CONSOLE=y
215 </literallayout>
216 Next, include this configuration fragment and extend the
217 <filename>FILESPATH</filename> variable in your
218 <filename>.bbappend</filename> file:
219 <literallayout class='monospaced'>
220 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
221 SRC_URI += "file://8250.cfg"
222 </literallayout>
223 The next time you run BitBake to build the Linux kernel, BitBake
224 detects the change in the recipe and fetches and applies the
225 new configuration before building the kernel.
226 </para>
227
228 <para>
229 For a detailed example showing how to configure the kernel,
230 see the
231 "<ulink url='&YOCTO_DOCS_DEV_URL;#configuring-the-kernel'>Configuring the Kernel</ulink>"
232 section in the Yocto Project Development Manual.
233 </para>
234 </section>
235 </section>
236
237 <section id='using-an-iterative-development-process'>
238 <title>Using an Iterative Development Process</title>
239
240 <para>
241 If you do not have existing patches or configuration files,
242 you can iteratively generate them from within the BitBake build
243 environment as described within this section.
244 During an iterative workflow, running a previously completed BitBake
245 task causes BitBake to invalidate the tasks that follow the
246 completed task in the build sequence.
247 Invalidated tasks rebuild the next time you run the build using
248 BitBake.
249 </para>
250
251 <para>
252 As you read this section, be sure to substitute the name
253 of your Linux kernel recipe for the term
254 "linux-yocto".
255 </para>
256
257 <section id='tip-dirty-string'>
258 <title>"-dirty" String</title>
259
260<!--
261 <para>
262 <emphasis>AR - Darrren Hart:</emphasis> This section
263 originated from the old Yocto Project Kernel Architecture
264 and Use Manual.
265 It was decided we need to put it in this section here.
266 Darren needs to figure out where we want it and what part
267 of it we want (all, revision???)
268 </para>
269-->
270
271 <para>
272 If kernel images are being built with "-dirty" on the
273 end of the version string, this simply means that
274 modifications in the source directory have not been committed.
275 <literallayout class='monospaced'>
276 $ git status
277 </literallayout>
278 </para>
279
280 <para>
281 You can use the above Git command to report modified,
282 removed, or added files.
283 You should commit those changes to the tree regardless of
284 whether they will be saved, exported, or used.
285 Once you commit the changes, you need to rebuild the kernel.
286 </para>
287
288 <para>
289 To force a pickup and commit of all such pending changes,
290 enter the following:
291 <literallayout class='monospaced'>
292 $ git add .
293 $ git commit -s -a -m "getting rid of -dirty"
294 </literallayout>
295 </para>
296
297 <para>
298 Next, rebuild the kernel.
299 </para>
300 </section>
301
302 <section id='generating-configuration-files'>
303 <title>Generating Configuration Files</title>
304
305 <para>
306 You can manipulate the <filename>.config</filename> file
307 used to build a linux-yocto recipe with the
308 <filename>menuconfig</filename> command as follows:
309 <literallayout class='monospaced'>
310 $ bitbake linux-yocto -c menuconfig
311 </literallayout>
312 This command starts the Linux kernel configuration tool,
313 which allows you to prepare a new
314 <filename>.config</filename> file for the build.
315 When you exit the tool, be sure to save your changes
316 at the prompt.
317 </para>
318
319 <para>
320 The resulting <filename>.config</filename> file is
321 located in
322 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> under the
323 <filename>linux-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink><filename>}-${<ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>}-build</filename> directory.
324 You can use the entire <filename>.config</filename> file as the
325 <filename>defconfig</filename> file as described in the
326 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section.
327 </para>
328
329 <para>
330 A better method is to create a configuration fragment using the
331 differences between two configuration files: one previously
332 created and saved, and one freshly created using the
333 <filename>menuconfig</filename> tool.
334 </para>
335
336 <para>
337 To create a configuration fragment using this method, follow
338 these steps:
339 <orderedlist>
340 <listitem><para>Complete a build at least through the kernel
341 configuration task as follows:
342 <literallayout class='monospaced'>
343 $ bitbake linux-yocto -c kernel_configme -f
344 </literallayout></para></listitem>
345 <listitem><para>Copy and rename the resulting
346 <filename>.config</filename> file (e.g.
347 <filename>config.orig</filename>).
348 </para></listitem>
349 <listitem><para>Run the <filename>menuconfig</filename>
350 command:
351 <literallayout class='monospaced'>
352 $ bitbake linux-yocto -c menuconfig
353 </literallayout></para></listitem>
354 <listitem><para>Prepare a configuration fragment based on
355 the differences between the two files.
356 </para></listitem>
357 </orderedlist>
358 </para>
359
360 <para>
361 Ultimately, the configuration fragment file needs to be a
362 list of Linux kernel <filename>CONFIG_</filename> assignments.
363 It cannot be in <filename>diff</filename> format.
364 Here is an example of a command that creates your
365 configuration fragment file.
366 Regardless of the exact command you use, plan on reviewing
367 the output as you can usually remove some of the defaults:
368 <literallayout class='monospaced'>
369 $ diff -Nurp config.orig .config | sed -n "s/^\+//p" > frag.cfg
370 </literallayout>
371 See the "<link linkend='changing-the-configuration'>Changing the Configuration</link>"
372 section for information on how to use the output as a
373 configuration fragment.
374 <note>
375 You can also use this method to create configuration
376 fragments for a BSP.
377 See the "<link linkend='bsp-descriptions'>BSP Descriptions</link>"
378 section for more information.
379 </note>
380 </para>
381
382 <para>
383 The kernel tools also provide configuration validation.
384 You can use these tools to produce warnings for when a
385 requested configuration does not appear in the final
386 <filename>.config</filename> file or when you override a
387 policy configuration in a hardware configuration fragment.
388 Here is an example with some sample output of the command
389 that runs these tools:
390 <literallayout class='monospaced'>
391 $ bitbake linux-yocto -c kernel_configcheck -f
392
393 ...
394
395 NOTE: validating kernel configuration
396 This BSP sets 3 invalid/obsolete kernel options.
397 These config options are not offered anywhere within this kernel.
398 The full list can be found in your kernel src dir at:
399 meta/cfg/standard/mybsp/invalid.cfg
400
401 This BSP sets 21 kernel options that are possibly non-hardware related.
402 The full list can be found in your kernel src dir at:
403 meta/cfg/standard/mybsp/specified_non_hdw.cfg
404
405 WARNING: There were 2 hardware options requested that do not
406 have a corresponding value present in the final ".config" file.
407 This probably means you are not't getting the config you wanted.
408 The full list can be found in your kernel src dir at:
409 meta/cfg/standard/mybsp/mismatch.cfg
410 </literallayout>
411 </para>
412
413 <para>
414 The output describes the various problems that you can
415 encounter along with where to find the offending configuration
416 items.
417 You can use the information in the logs to adjust your
418 configuration files and then repeat the
419 <filename>kernel_configme</filename> and
420 <filename>kernel_configcheck</filename> commands until
421 they produce no warnings.
422 </para>
423
424 <para>
425 For more information on how to use the
426 <filename>menuconfig</filename> tool, see the
427 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>"
428 section in the Yocto Project Development Manual.
429 </para>
430 </section>
431
432 <section id='modifying-source-code'>
433 <title>Modifying Source Code</title>
434
435 <para>
436 You can experiment with source code changes and create a
437 simple patch without leaving the BitBake environment.
438 To get started, be sure to complete a build at
439 least through the kernel configuration task:
440 <literallayout class='monospaced'>
441 $ bitbake linux-yocto -c kernel_configme -f
442 </literallayout>
443 Taking this step ensures you have the sources prepared
444 and the configuration completed.
445 You can find the sources in the
446 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}/linux</filename> directory.
447 </para>
448
449 <para>
450 You can edit the sources as you would any other Linux source
451 tree.
452 However, keep in mind that you will lose changes if you
453 trigger the <filename>fetch</filename> task for the recipe.
454 You can avoid triggering this task by not issuing BitBake's
455 <filename>cleanall</filename>, <filename>cleansstate</filename>,
456 or forced <filename>fetch</filename> commands.
457 Also, do not modify the recipe itself while working
458 with temporary changes or BitBake might run the
459 <filename>fetch</filename> command depending on the
460 changes to the recipe.
461 </para>
462
463 <para>
464 To test your temporary changes, instruct BitBake to run the
465 <filename>compile</filename> again.
466 The <filename>-f</filename> option forces the command to run
467 even though BitBake might think it has already done so:
468 <literallayout class='monospaced'>
469 $ bitbake linux-yocto -c compile -f
470 </literallayout>
471 If the compile fails, you can update the sources and repeat
472 the <filename>compile</filename>.
473 Once compilation is successful, you can inspect and test
474 the resulting build (i.e. kernel, modules, and so forth) from
475 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
476 <literallayout class='monospaced'>
477 ${WORKDIR}/linux-${MACHINE}-${KTYPE}-build
478 </literallayout>
479 Alternatively, you can run the <filename>deploy</filename>
480 command to place the kernel image in the
481 <filename>tmp/deploy/images</filename> directory:
482 <literallayout class='monospaced'>
483 $ bitbake linux-yocto -c deploy
484 </literallayout>
485 And, of course, you can perform the remaining installation and
486 packaging steps by issuing:
487 <literallayout class='monospaced'>
488 $ bitbake linux-yocto
489 </literallayout>
490 </para>
491
492 <para>
493 For rapid iterative development, the edit-compile-repeat loop
494 described in this section is preferable to rebuilding the
495 entire recipe because the installation and packaging tasks
496 are very time consuming.
497 </para>
498
499 <para>
500 Once you are satisfied with your source code modifications,
501 you can make them permanent by generating patches and
502 applying them to the
503 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
504 statement as described in section
505 "<link linkend='applying-patches'>Applying Patches</link>" section.
506 If you are not familiar with generating patches, refer to the
507 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-the-patch'>Creating the Patch</ulink>"
508 section in the Yocto Project Development Manual.
509 </para>
510 </section>
511 </section>
512
513 <section id='working-with-your-own-sources'>
514 <title>Working With Your Own Sources</title>
515
516 <para>
517 If you cannot work with one of the Linux kernel
518 versions supported by existing linux-yocto recipes, you can
519 still make use of the Yocto Project Linux kernel tooling by
520 working with your own sources.
521 When you use your own sources, you will not be able to
522 leverage the existing kernel
523 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> and
524 stabilization work of the linux-yocto sources.
525 However, you will be able to manage your own Metadata in the same
526 format as the linux-yocto sources.
527 Maintaining format compatibility facilitates converging with
528 linux-yocto on a future, mutually-supported kernel version.
529 </para>
530
531 <para>
532 To help you use your own sources, the Yocto Project provides a
533 linux-yocto custom recipe
534 (<filename>linux-yocto-custom.bb</filename>) that uses
535 <filename>kernel.org</filename> sources
536 and the Yocto Project Linux kernel tools for managing
537 kernel Metadata.
538 You can find this recipe in the
539 <filename>poky</filename> Git repository of the
540 Yocto Project <ulink url='&YOCTO_GIT_URL;'>Source Repository</ulink>
541 at:
542 <literallayout class="monospaced">
543 poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
544 </literallayout>
545 </para>
546
547 <para>
548 Here are some basic steps you can use to work with your own sources:
549 <orderedlist>
550 <listitem><para>Copy the <filename>linux-yocto-custom.bb</filename>
551 recipe to your layer and give it a meaningful name.
552 The name should include the version of the Linux kernel you
553 are using (e.g. <filename>linux-yocto-myproject_3.5.bb</filename>,
554 where "3.5" is the base version of the Linux kernel
555 with which you would be working).</para></listitem>
556 <listitem><para>In the same directory inside your layer,
557 create a matching directory
558 to store your patches and configuration files (e.g.
559 <filename>linux-yocto-myproject</filename>).
560 </para></listitem>
561 <listitem><para>Edit the following variables in your recipe
562 as appropriate for your project:
563 <itemizedlist>
564 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>:
565 The <filename>SRC_URI</filename> should be a Git
566 repository that uses one of the supported Git fetcher
567 protocols (i.e. <filename>file</filename>,
568 <filename>git</filename>, <filename>http</filename>,
569 and so forth).
570 The skeleton recipe provides an example
571 <filename>SRC_URI</filename> as a syntax reference.
572 </para></listitem>
573 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_VERSION'><filename>LINUX_VERSION</filename></ulink>:
574 The Linux kernel version you are using (e.g.
575 "3.4").</para></listitem>
576 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_VERSION_EXTENSION'><filename>LINUX_VERSION_EXTENSION</filename></ulink>:
577 The Linux kernel <filename>CONFIG_LOCALVERSION</filename>
578 that is compiled into the resulting kernel and visible
579 through the <filename>uname</filename> command.
580 </para></listitem>
581 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink>:
582 The commit ID from which you want to build.
583 </para></listitem>
584 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>:
585 Treat this variable the same as you would in any other
586 recipe.
587 Increment the variable to indicate to the OpenEmbedded
588 build system that the recipe has changed.
589 </para></listitem>
590 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>:
591 The default <filename>PV</filename> assignment is
592 typically adequate.
593 It combines the <filename>LINUX_VERSION</filename>
594 with the Source Control Manager (SCM) revision
595 as derived from the
596 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCPV'><filename>SRCPV</filename></ulink>
597 variable.
598 The combined results are a string with
599 the following form:
600 <literallayout class='monospaced'>
601 3.4.11+git1+68a635bf8dfb64b02263c1ac80c948647cc76d5f_1+218bd8d2022b9852c60d32f0d770931e3cf343e2
602 </literallayout>
603 While lengthy, the extra verbosity in <filename>PV</filename>
604 helps ensure you are using the exact
605 sources from which you intend to build.
606 </para></listitem>
607 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></ulink>:
608 A list of the machines supported by your new recipe.
609 This variable in the example recipe is set
610 by default to a regular expression that matches
611 only the empty string, "(^$)".
612 This default setting triggers an explicit build
613 failure.
614 You must change it to match a list of the machines
615 that your new recipe supports.
616 For example, to support the <filename>qemux86</filename>
617 and <filename>qemux86-64</filename> machines, use
618 the following form:
619 <literallayout class='monospaced'>
620 COMPATIBLE_MACHINE = "qemux86|qemux86-64"
621 </literallayout></para></listitem>
622 </itemizedlist></para></listitem>
623 <listitem><para>Provide further customizations to your recipe
624 as needed just as you would customize an existing
625 linux-yocto recipe.
626 See the "<link linkend='modifying-an-existing-recipe'>Modifying
627 an Existing Recipe</link>" section for information.
628 </para></listitem>
629 </orderedlist>
630 </para>
631 </section>
632
633 <section id='incorporating-out-of-tree-modules'>
634 <title>Incorporating Out-of-Tree Modules</title>
635
636 <para>
637 While it is always preferable to work with sources integrated
638 into the Linux kernel sources, if you need an external kernel
639 module, the <filename>hello-mod.bb</filename> recipe is available
640 as a template from which you can create your own out-of-tree
641 Linux kernel module recipe.
642 </para>
643
644 <para>
645 This template recipe is located in the
646 <filename>poky</filename> Git repository of the
647 Yocto Project <ulink url='&YOCTO_GIT_URL;'>Source Repository</ulink>
648 at:
649 <literallayout class="monospaced">
650 poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb
651 </literallayout>
652 </para>
653
654 <para>
655 To get started, copy this recipe to your layer and give it a
656 meaningful name (e.g. <filename>mymodule_1.0.bb</filename>).
657 In the same directory, create a directory named
658 <filename>files</filename> where you can store any source files,
659 patches, or other files necessary for building
660 the module that do not come with the sources.
661 Finally, update the recipe as appropriate for the module.
662 Typically you will need to set the following variables:
663 <itemizedlist>
664 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-DESCRIPTION'><filename>DESCRIPTION</filename></ulink>
665 </para></listitem>
666 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE*</filename></ulink>
667 </para></listitem>
668 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
669 </para></listitem>
670 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>
671 </para></listitem>
672 </itemizedlist>
673 </para>
674
675 <para>
676 Depending on the build system used by the module sources, you might
677 need to make some adjustments.
678 For example, a typical module <filename>Makefile</filename> looks
679 much like the one provided with the <filename>hello-mod</filename>
680 template:
681 <literallayout class='monospaced'>
682 obj-m := hello.o
683
684 SRC := $(shell pwd)
685
686 all:
687 $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
688
689 modules_install:
690 $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
691 ...
692 </literallayout>
693 </para>
694
695 <para>
696 The important point to note here is the
697 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_SRC'><filename>KERNEL_SRC</filename></ulink>
698 variable.
699 The class <filename>module.bbclass</filename> sets this variable,
700 as well as the
701 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_PATH'><filename>KERNEL_PATH</filename></ulink>
702 variable to
703 <filename>${<ulink url='&YOCTO_DOCS_REF_URL;#var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></ulink>}</filename>
704 with the necessary Linux kernel build information to build modules.
705 If your module <filename>Makefile</filename> uses a different
706 variable, you might want to override the
707 <filename>do_compile()</filename> step, or create a patch to
708 the <filename>Makefile</filename> to work with the more typical
709 <filename>KERNEL_SRC</filename> or <filename>KERNEL_PATH</filename>
710 variables.
711 </para>
712
713 <para>
714 After you have prepared your recipe, you will likely want to
715 include the module in your images.
716 To do this, see the documentation for the following variables in
717 the Yocto Project Reference Manual and set one of them as
718 appropriate in your machine configuration file:
719 <itemizedlist>
720 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</filename></ulink>
721 </para></listitem>
722 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink>
723 </para></listitem>
724 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RDEPENDS'><filename>MACHINE_EXTRA_RDEPENDS</filename></ulink>
725 </para></listitem>
726 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RRECOMMENDS'><filename>MACHINE_EXTRA_RRECOMMENDS</filename></ulink>
727 </para></listitem>
728 </itemizedlist>
729 </para>
730
731 <para>
732 modules are often not required for boot and can be excluded from
733 certain build configurations.
734 The following allows for the most flexibility:
735 <literallayout class='monospaced'>
736 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-mymodule"
737 </literallayout>
738 Where the value is derived by appending the module filename without
739 the <filename>.ko</filename> extension to the string
740 "kernel-module-".
741 </para>
742
743 <para>
744 Because the variable is
745 <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>
746 and not a
747 <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>
748 variable, the build will not fail if this module is not available
749 to include in the image.
750 </para>
751 </section>
752
753 <section id='inspecting-changes-and-commits'>
754 <title>Inspecting Changes and Commits</title>
755
756 <para>
757 A common question when working with a kernel is:
758 "What changes have been applied to this tree?"
759 Rather than using "grep" across directories to see what has
760 changed, you can use Git to inspect or search the kernel tree.
761 Using Git is an efficient way to see what has changed in the tree.
762 </para>
763
764 <section id='what-changed-in-a-kernel'>
765 <title>What Changed in a Kernel?</title>
766
767 <para>
768 Following are a few examples that show how to use Git
769 commands to examine changes.
770 These examples are by no means the only way to see changes.
771 <note>
772 In the following examples, unless you provide a commit
773 range, <filename>kernel.org</filename> history is blended
774 with Yocto Project kernel changes.
775 You can form ranges by using branch names from the
776 kernel tree as the upper and lower commit markers with
777 the Git commands.
778 You can see the branch names through the web interface
779 to the Yocto Project source repositories at
780 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.
781 </note>
782 To see a full range of the changes, use the
783 <filename>git whatchanged</filename> command and specify a
784 commit range for the branch
785 (<filename>&lt;commit&gt;..&lt;commit&gt;</filename>).
786 </para>
787
788 <para>
789 Here is an example that looks at what has changed in the
790 <filename>emenlow</filename> branch of the
791 <filename>linux-yocto-3.4</filename> kernel.
792 The lower commit range is the commit associated with the
793 <filename>standard/base</filename> branch, while
794 the upper commit range is the commit associated with the
795 <filename>standard/emenlow</filename> branch.
796 <literallayout class='monospaced'>
797 $ git whatchanged origin/standard/base..origin/standard/emenlow
798 </literallayout>
799 </para>
800
801 <para>
802 To see short, one line summaries of changes use the
803 <filename>git log</filename> command:
804 <literallayout class='monospaced'>
805 $ git log --oneline origin/standard/base..origin/standard/emenlow
806 </literallayout>
807 </para>
808
809 <para>
810 Use this command to see code differences for the changes:
811 <literallayout class='monospaced'>
812 $ git diff origin/standard/base..origin/standard/emenlow
813 </literallayout>
814 </para>
815
816 <para>
817 Use this command to see the commit log messages and the
818 text differences:
819 <literallayout class='monospaced'>
820 $ git show origin/standard/base..origin/standard/emenlow
821 </literallayout>
822 </para>
823
824 <para>
825 Use this command to create individual patches for
826 each change.
827 Here is an example that that creates patch files for each
828 commit and places them in your <filename>Documents</filename>
829 directory:
830 <literallayout class='monospaced'>
831 $ git format-patch -o $HOME/Documents origin/standard/base..origin/standard/emenlow
832 </literallayout>
833 </para>
834 </section>
835
836 <section id='showing-a-particular-feature-or-branch-change'>
837 <title>Showing a Particular Feature or Branch Change</title>
838
839 <para>
840 Tags in the Yocto Project kernel tree divide changes for
841 significant features or branches.
842 The <filename>git show &lt;tag&gt;</filename> command shows
843 changes based on a tag.
844 Here is an example that shows <filename>systemtap</filename>
845 changes:
846 <literallayout class='monospaced'>
847 $ git show systemtap
848 </literallayout>
849 You can use the
850 <filename>git branch --contains &lt;tag&gt;</filename> command
851 to show the branches that contain a particular feature.
852 This command shows the branches that contain the
853 <filename>systemtap</filename> feature:
854 <literallayout class='monospaced'>
855 $ git branch --contains systemtap
856 </literallayout>
857 </para>
858 </section>
859 </section>
860</chapter>
861<!--
862vim: expandtab tw=80 ts=4
863-->
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.xml b/documentation/kernel-dev/kernel-dev-concepts-appx.xml
new file mode 100644
index 0000000000..ac91749cd6
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-concepts-appx.xml
@@ -0,0 +1,253 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<appendix id='kernel-dev-concepts-appx'>
6<title>Advanced Kernel Concepts</title>
7
8 <section id='kernel-big-picture'>
9 <title>Yocto Project Kernel Development and Maintenance</title>
10 <para>
11 Kernels available through the Yocto Project, like other kernels, are based off the Linux
12 kernel releases from <ulink url='http://www.kernel.org'></ulink>.
13 At the beginning of a major development cycle, the Yocto Project team
14 chooses its kernel based on factors such as release timing, the anticipated release
15 timing of final upstream <filename>kernel.org</filename> versions, and Yocto Project
16 feature requirements.
17 Typically, the kernel chosen is in the
18 final stages of development by the community.
19 In other words, the kernel is in the release
20 candidate or "rc" phase and not yet a final release.
21 But, by being in the final stages of external development, the team knows that the
22 <filename>kernel.org</filename> final release will clearly be within the early stages of
23 the Yocto Project development window.
24 </para>
25 <para>
26 This balance allows the team to deliver the most up-to-date kernel
27 possible, while still ensuring that the team has a stable official release for
28 the baseline Linux kernel version.
29 </para>
30 <para>
31 The ultimate source for kernels available through the Yocto Project are released kernels
32 from <filename>kernel.org</filename>.
33 In addition to a foundational kernel from <filename>kernel.org</filename>, the
34 kernels available contain a mix of important new mainline
35 developments, non-mainline developments (when there is no alternative),
36 Board Support Package (BSP) developments,
37 and custom features.
38 These additions result in a commercially released Yocto Project Linux kernel that caters
39 to specific embedded designer needs for targeted hardware.
40 </para>
41 <para>
42 Once a kernel is officially released, the Yocto Project team goes into
43 their next development cycle, or upward revision (uprev) cycle, while still
44 continuing maintenance on the released kernel.
45 It is important to note that the most sustainable and stable way
46 to include feature development upstream is through a kernel uprev process.
47 Back-porting hundreds of individual fixes and minor features from various
48 kernel versions is not sustainable and can easily compromise quality.
49 </para>
50 <para>
51 During the uprev cycle, the Yocto Project team uses an ongoing analysis of
52 kernel development, BSP support, and release timing to select the best
53 possible <filename>kernel.org</filename> version.
54 The team continually monitors community kernel
55 development to look for significant features of interest.
56 The team does consider back-porting large features if they have a significant advantage.
57 User or community demand can also trigger a back-port or creation of new
58 functionality in the Yocto Project baseline kernel during the uprev cycle.
59 </para>
60 <para>
61 Generally speaking, every new kernel both adds features and introduces new bugs.
62 These consequences are the basic properties of upstream kernel development and are
63 managed by the Yocto Project team's kernel strategy.
64 It is the Yocto Project team's policy to not back-port minor features to the released kernel.
65 They only consider back-porting significant technological jumps - and, that is done
66 after a complete gap analysis.
67 The reason for this policy is that back-porting any small to medium sized change
68 from an evolving kernel can easily create mismatches, incompatibilities and very
69 subtle errors.
70 </para>
71 <para>
72 These policies result in both a stable and a cutting
73 edge kernel that mixes forward ports of existing features and significant and critical
74 new functionality.
75 Forward porting functionality in the kernels available through the Yocto Project kernel
76 can be thought of as a "micro uprev."
77 The many “micro uprevs” produce a kernel version with a mix of
78 important new mainline, non-mainline, BSP developments and feature integrations.
79 This kernel gives insight into new features and allows focused
80 amounts of testing to be done on the kernel, which prevents
81 surprises when selecting the next major uprev.
82 The quality of these cutting edge kernels is evolving and the kernels are used in leading edge
83 feature and BSP development.
84 </para>
85 </section>
86
87 <section id='kernel-architecture'>
88 <title>Kernel Architecture</title>
89 <para>
90 This section describes the architecture of the kernels available through the
91 Yocto Project and provides information
92 on the mechanisms used to achieve that architecture.
93 </para>
94
95 <section id='architecture-overview'>
96 <title>Overview</title>
97 <para>
98 As mentioned earlier, a key goal of the Yocto Project is to present the
99 developer with
100 a kernel that has a clear and continuous history that is visible to the user.
101 The architecture and mechanisms used achieve that goal in a manner similar to the
102 upstream <filename>kernel.org</filename>.
103 </para>
104 <para>
105 You can think of a Yocto Project kernel as consisting of a baseline Linux kernel with
106 added features logically structured on top of the baseline.
107 The features are tagged and organized by way of a branching strategy implemented by the
108 source code manager (SCM) Git.
109 For information on Git as applied to the Yocto Project, see the
110 "<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>" section in the
111 Yocto Project Development Manual.
112 </para>
113 <para>
114 The result is that the user has the ability to see the added features and
115 the commits that make up those features.
116 In addition to being able to see added features, the user can also view the history of what
117 made up the baseline kernel.
118 </para>
119 <para>
120 The following illustration shows the conceptual Yocto Project kernel.
121 </para>
122 <para>
123 <imagedata fileref="figures/kernel-architecture-overview.png" width="6in" depth="7in" align="center" scale="100" />
124 </para>
125 <para>
126 In the illustration, the "Kernel.org Branch Point"
127 marks the specific spot (or release) from
128 which the Yocto Project kernel is created.
129 From this point "up" in the tree, features and differences are organized and tagged.
130 </para>
131 <para>
132 The "Yocto Project Baseline Kernel" contains functionality that is common to every kernel
133 type and BSP that is organized further up the tree.
134 Placing these common features in the
135 tree this way means features do not have to be duplicated along individual branches of the
136 structure.
137 </para>
138 <para>
139 From the Yocto Project Baseline Kernel, branch points represent specific functionality
140 for individual BSPs as well as real-time kernels.
141 The illustration represents this through three BSP-specific branches and a real-time
142 kernel branch.
143 Each branch represents some unique functionality for the BSP or a real-time kernel.
144 </para>
145 <para>
146 In this example structure, the real-time kernel branch has common features for all
147 real-time kernels and contains
148 more branches for individual BSP-specific real-time kernels.
149 The illustration shows three branches as an example.
150 Each branch points the way to specific, unique features for a respective real-time
151 kernel as they apply to a given BSP.
152 </para>
153 <para>
154 The resulting tree structure presents a clear path of markers (or branches) to the
155 developer that, for all practical purposes, is the kernel needed for any given set
156 of requirements.
157 </para>
158 </section>
159
160 <section id='branching-and-workflow'>
161 <title>Branching Strategy and Workflow</title>
162 <para>
163 The Yocto Project team creates kernel branches at points where functionality is
164 no longer shared and thus, needs to be isolated.
165 For example, board-specific incompatibilities would require different functionality
166 and would require a branch to separate the features.
167 Likewise, for specific kernel features, the same branching strategy is used.
168 </para>
169 <para>
170 This branching strategy results in a tree that has features organized to be specific
171 for particular functionality, single kernel types, or a subset of kernel types.
172 This strategy also results in not having to store the same feature twice
173 internally in the tree.
174 Rather, the kernel team stores the unique differences required to apply the
175 feature onto the kernel type in question.
176 <note>
177 The Yocto Project team strives to place features in the tree such that they can be
178 shared by all boards and kernel types where possible.
179 However, during development cycles or when large features are merged,
180 the team cannot always follow this practice.
181 In those cases, the team uses isolated branches to merge features.
182 </note>
183 </para>
184 <para>
185 BSP-specific code additions are handled in a similar manner to kernel-specific additions.
186 Some BSPs only make sense given certain kernel types.
187 So, for these types, the team creates branches off the end of that kernel type for all
188 of the BSPs that are supported on that kernel type.
189 From the perspective of the tools that create the BSP branch, the BSP is really no
190 different than a feature.
191 Consequently, the same branching strategy applies to BSPs as it does to features.
192 So again, rather than store the BSP twice, the team only stores the unique
193 differences for the BSP across the supported multiple kernels.
194 </para>
195 <para>
196 While this strategy can result in a tree with a significant number of branches, it is
197 important to realize that from the developer's point of view, there is a linear
198 path that travels from the baseline <filename>kernel.org</filename>, through a select
199 group of features and ends with their BSP-specific commits.
200 In other words, the divisions of the kernel are transparent and are not relevant
201 to the developer on a day-to-day basis.
202 From the developer's perspective, this path is the "master" branch.
203 The developer does not need to be aware of the existence of any other branches at all.
204 Of course, there is value in the existence of these branches
205 in the tree, should a person decide to explore them.
206 For example, a comparison between two BSPs at either the commit level or at the line-by-line
207 code <filename>diff</filename> level is now a trivial operation.
208 </para>
209 <para>
210 Working with the kernel as a structured tree follows recognized community best practices.
211 In particular, the kernel as shipped with the product, should be
212 considered an "upstream source" and viewed as a series of
213 historical and documented modifications (commits).
214 These modifications represent the development and stabilization done
215 by the Yocto Project kernel development team.
216 </para>
217 <para>
218 Because commits only change at significant release points in the product life cycle,
219 developers can work on a branch created
220 from the last relevant commit in the shipped Yocto Project kernel.
221 As mentioned previously, the structure is transparent to the developer
222 because the kernel tree is left in this state after cloning and building the kernel.
223 </para>
224 </section>
225
226 <section id='source-code-manager-git'>
227 <title>Source Code Manager - Git</title>
228 <para>
229 The Source Code Manager (SCM) is Git.
230 This SCM is the obvious mechanism for meeting the previously mentioned goals.
231 Not only is it the SCM for <filename>kernel.org</filename> but,
232 Git continues to grow in popularity and supports many different work flows,
233 front-ends and management techniques.
234 </para>
235 <para>
236 You can find documentation on Git at <ulink url='http://git-scm.com/documentation'></ulink>.
237 You can also get an introduction to Git as it applies to the Yocto Project in the
238 "<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>"
239 section in the Yocto Project Development Manual.
240 These referenced sections overview Git and describe a minimal set of
241 commands that allows you to be functional using Git.
242 <note>
243 You can use as much, or as little, of what Git has to offer to accomplish what
244 you need for your project.
245 You do not have to be a "Git Master" in order to use it with the Yocto Project.
246 </note>
247 </para>
248 </section>
249 </section>
250</appendix>
251<!--
252vim: expandtab tw=80 ts=4
253-->
diff --git a/documentation/kernel-dev/kernel-dev-customization.xsl b/documentation/kernel-dev/kernel-dev-customization.xsl
new file mode 100644
index 0000000000..43e9dadf21
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-customization.xsl
@@ -0,0 +1,11 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="html.stylesheet" select="'kernel-dev-style.css'" />
7 <xsl:param name="chapter.autolabel" select="1" />
8 <xsl:param name="appendix.autolabel">A</xsl:param>
9 <xsl:param name="section.autolabel" select="1" />
10 <xsl:param name="section.label.includes.component.label" select="1" />
11</xsl:stylesheet>
diff --git a/documentation/kernel-dev/kernel-dev-eclipse-customization.xsl b/documentation/kernel-dev/kernel-dev-eclipse-customization.xsl
new file mode 100644
index 0000000000..7d1bb8dc08
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-eclipse-customization.xsl
@@ -0,0 +1,27 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10
11 <xsl:param name="chunker.output.indent" select="'yes'"/>
12 <xsl:param name="chunk.quietly" select="1"/>
13 <xsl:param name="chunk.first.sections" select="1"/>
14 <xsl:param name="chunk.section.depth" select="10"/>
15 <xsl:param name="use.id.as.filename" select="1"/>
16 <xsl:param name="ulink.target" select="'_self'" />
17 <xsl:param name="base.dir" select="'html/kernel-dev/'"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="chapter.autolabel" select="1" />
24 <xsl:param name="appendix.autolabel">A</xsl:param>
25 <xsl:param name="section.autolabel" select="1" />
26 <xsl:param name="section.label.includes.component.label" select="1" />
27</xsl:stylesheet>
diff --git a/documentation/kernel-dev/kernel-dev-examples.xml b/documentation/kernel-dev/kernel-dev-examples.xml
new file mode 100644
index 0000000000..9d9aef6d06
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-examples.xml
@@ -0,0 +1,918 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='kernel-how-to'>
6
7<title>Working with the Yocto Project Kernel</title>
8
9
10<section id='actions-org'>
11 <title>Introduction</title>
12 <para>
13 This chapter describes how to accomplish tasks involving a kernel's tree structure.
14 The information is designed to help the developer that wants to modify the Yocto
15 Project kernel and contribute changes upstream to the Yocto Project.
16 The information covers the following:
17 <itemizedlist>
18 <listitem><para>Tree construction</para></listitem>
19 <listitem><para>Build strategies</para></listitem>
20 <listitem><para>Workflow examples</para></listitem>
21 </itemizedlist>
22 </para>
23</section>
24
25 <section id='tree-construction'>
26 <title>Tree Construction</title>
27 <para>
28 This section describes construction of the Yocto Project kernel source repositories
29 as accomplished by the Yocto Project team to create kernel repositories.
30 These kernel repositories are found under the heading "Yocto Linux Kernel" at
31 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>&YOCTO_GIT_URL;/cgit.cgi</ulink>
32 and can be shipped as part of a Yocto Project release.
33 The team creates these repositories by
34 compiling and executing the set of feature descriptions for every BSP/feature
35 in the product.
36 Those feature descriptions list all necessary patches,
37 configuration, branching, tagging and feature divisions found in a kernel.
38 Thus, the Yocto Project kernel repository (or tree) is built.
39 </para>
40 <para>
41 The existence of this tree allows you to access and clone a particular
42 Yocto Project kernel repository and use it to build images based on their configurations
43 and features.
44 </para>
45 <para>
46 You can find the files used to describe all the valid features and BSPs
47 in the Yocto Project kernel in any clone of the Yocto Project kernel source repository
48 Git tree.
49 For example, the following command clones the Yocto Project baseline kernel that
50 branched off of <filename>linux.org</filename> version 3.4:
51 <literallayout class='monospaced'>
52 $ git clone git://git.yoctoproject.org/linux-yocto-3.4
53 </literallayout>
54 For another example of how to set up a local Git repository of the Yocto Project
55 kernel files, see the
56 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink>" bulleted
57 item in the Yocto Project Development Manual.
58 </para>
59 <para>
60 Once you have cloned the kernel Git repository on your local machine, you can
61 switch to the <filename>meta</filename> branch within the repository.
62 Here is an example that assumes the local Git repository for the kernel is in
63 a top-level directory named <filename>linux-yocto-3.4</filename>:
64 <literallayout class='monospaced'>
65 $ cd ~/linux-yocto-3.4
66 $ git checkout -b meta origin/meta
67 </literallayout>
68 Once you have checked out and switched to the <filename>meta</filename> branch,
69 you can see a snapshot of all the kernel configuration and feature descriptions that are
70 used to build that particular kernel repository.
71 These descriptions are in the form of <filename>.scc</filename> files.
72 </para>
73 <para>
74 You should realize, however, that browsing your local kernel repository
75 for feature descriptions and patches is not an effective way to determine what is in a
76 particular kernel branch.
77 Instead, you should use Git directly to discover the changes in a branch.
78 Using Git is an efficient and flexible way to inspect changes to the kernel.
79 For examples showing how to use Git to inspect kernel commits, see the following sections
80 in this chapter.
81 <note>
82 Ground up reconstruction of the complete kernel tree is an action only taken by the
83 Yocto Project team during an active development cycle.
84 When you create a clone of the kernel Git repository, you are simply making it
85 efficiently available for building and development.
86 </note>
87 </para>
88 <para>
89 The following steps describe what happens when the Yocto Project Team constructs
90 the Yocto Project kernel source Git repository (or tree) found at
91 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the
92 introduction of a new top-level kernel feature or BSP.
93 These are the actions that effectively create the tree
94 that includes the new feature, patch or BSP:
95 <orderedlist>
96 <listitem><para>A top-level kernel feature is passed to the kernel build subsystem.
97 Normally, this feature is a BSP for a particular kernel type.</para></listitem>
98 <listitem><para>The file that describes the top-level feature is located by searching
99 these system directories:
100 <itemizedlist>
101 <listitem><para>The in-tree kernel-cache directories, which are located
102 in <filename>meta/cfg/kernel-cache</filename></para></listitem>
103 <listitem><para>Areas pointed to by <filename>SRC_URI</filename> statements
104 found in recipes</para></listitem>
105 </itemizedlist>
106 For a typical build, the target of the search is a
107 feature description in an <filename>.scc</filename> file
108 whose name follows this format:
109 <literallayout class='monospaced'>
110 &lt;bsp_name&gt;-&lt;kernel_type&gt;.scc
111 </literallayout>
112 </para></listitem>
113 <listitem><para>Once located, the feature description is either compiled into a simple script
114 of actions, or into an existing equivalent script that is already part of the
115 shipped kernel.</para></listitem>
116 <listitem><para>Extra features are appended to the top-level feature description.
117 These features can come from the
118 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'><filename>KERNEL_FEATURES</filename></ulink>
119 variable in recipes.</para></listitem>
120 <listitem><para>Each extra feature is located, compiled and appended to the script
121 as described in step three.</para></listitem>
122 <listitem><para>The script is executed to produce a series of <filename>meta-*</filename>
123 directories.
124 These directories are descriptions of all the branches, tags, patches and configurations that
125 need to be applied to the base Git repository to completely create the
126 source (build) branch for the new BSP or feature.</para></listitem>
127 <listitem><para>The base repository is cloned, and the actions
128 listed in the <filename>meta-*</filename> directories are applied to the
129 tree.</para></listitem>
130 <listitem><para>The Git repository is left with the desired branch checked out and any
131 required branching, patching and tagging has been performed.</para></listitem>
132 </orderedlist>
133 </para>
134 <para>
135 The kernel tree is now ready for developer consumption to be locally cloned,
136 configured, and built into a Yocto Project kernel specific to some target hardware.
137 <note><para>The generated <filename>meta-*</filename> directories add to the kernel
138 as shipped with the Yocto Project release.
139 Any add-ons and configuration data are applied to the end of an existing branch.
140 The full repository generation that is found in the
141 official Yocto Project kernel repositories at
142 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>http://git.yoctoproject.org/cgit.cgi</ulink>
143 is the combination of all supported boards and configurations.</para>
144 <para>The technique the Yocto Project team uses is flexible and allows for seamless
145 blending of an immutable history with additional patches specific to a
146 deployment.
147 Any additions to the kernel become an integrated part of the branches.</para>
148 </note>
149 </para>
150 </section>
151
152 <section id='build-strategy'>
153 <title>Build Strategy</title>
154 <para>
155 Once a local Git repository of the Yocto Project kernel exists on a development system,
156 you can consider the compilation phase of kernel development - building a kernel image.
157 Some prerequisites exist that are validated by the build process before compilation
158 starts:
159 </para>
160
161 <itemizedlist>
162 <listitem><para>The
163 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> points
164 to the kernel Git repository.</para></listitem>
165 <listitem><para>A BSP build branch exists.
166 This branch has the following form:
167 <literallayout class='monospaced'>
168 &lt;kernel_type&gt;/&lt;bsp_name&gt;
169 </literallayout></para></listitem>
170 </itemizedlist>
171
172 <para>
173 The OpenEmbedded build system makes sure these conditions exist before attempting compilation.
174 Other means, however, do exist, such as as bootstrapping a BSP, see
175 the "<link linkend='workflow-examples'>Workflow Examples</link>".
176 </para>
177
178 <para>
179 Before building a kernel, the build process verifies the tree
180 and configures the kernel by processing all of the
181 configuration "fragments" specified by feature descriptions in the <filename>.scc</filename>
182 files.
183 As the features are compiled, associated kernel configuration fragments are noted
184 and recorded in the <filename>meta-*</filename> series of directories in their compilation order.
185 The fragments are migrated, pre-processed and passed to the Linux Kernel
186 Configuration subsystem (<filename>lkc</filename>) as raw input in the form
187 of a <filename>.config</filename> file.
188 The <filename>lkc</filename> uses its own internal dependency constraints to do the final
189 processing of that information and generates the final <filename>.config</filename> file
190 that is used during compilation.
191 </para>
192
193 <para>
194 Using the board's architecture and other relevant values from the board's template,
195 kernel compilation is started and a kernel image is produced.
196 </para>
197
198 <para>
199 The other thing that you notice once you configure a kernel is that
200 the build process generates a build tree that is separate from your kernel's local Git
201 source repository tree.
202 This build tree has a name that uses the following form, where
203 <filename>${MACHINE}</filename> is the metadata name of the machine (BSP) and "kernel_type" is one
204 of the Yocto Project supported kernel types (e.g. "standard"):
205 <literallayout class='monospaced'>
206 linux-${MACHINE}-&lt;kernel_type&gt;-build
207 </literallayout>
208 </para>
209
210 <para>
211 The existing support in the <filename>kernel.org</filename> tree achieves this
212 default functionality.
213 </para>
214
215 <para>
216 This behavior means that all the generated files for a particular machine or BSP are now in
217 the build tree directory.
218 The files include the final <filename>.config</filename> file, all the <filename>.o</filename>
219 files, the <filename>.a</filename> files, and so forth.
220 Since each machine or BSP has its own separate build directory in its own separate branch
221 of the Git repository, you can easily switch between different builds.
222 </para>
223 </section>
224
225 <section id='workflow-examples'>
226 <title>Workflow Examples</title>
227
228 <para>
229 As previously noted, the Yocto Project kernel has built-in Git integration.
230 However, these utilities are not the only way to work with the kernel repository.
231 The Yocto Project has not made changes to Git or to other tools that
232 would invalidate alternate workflows.
233 Additionally, the way the kernel repository is constructed results in using
234 only core Git functionality, thus allowing any number of tools or front ends to use the
235 resulting tree.
236 </para>
237
238 <para>
239 This section contains several workflow examples.
240 Many of the examples use Git commands.
241 You can find Git documentation at
242 <ulink url='http://git-scm.com/documentation'></ulink>.
243 You can find a simple overview of using Git with the Yocto Project in the
244 "<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>"
245 section of the Yocto Project Development Manual.
246 </para>
247
248 <section id='change-inspection-kernel-changes-commits'>
249 <title>Change Inspection: Changes/Commits</title>
250
251 <para>
252 A common question when working with a kernel is:
253 "What changes have been applied to this tree?"
254 </para>
255
256 <para>
257 In projects that have a collection of directories that
258 contain patches to the kernel, it is possible to inspect or "grep" the contents
259 of the directories to get a general feel for the changes.
260 This sort of patch inspection is not an efficient way to determine what has been
261 done to the kernel.
262 The reason it is inefficient is because there are many optional patches that are
263 selected based on the kernel type and the feature description.
264 Additionally, patches could exist in directories that are not included in the search.
265 </para>
266
267 <para>
268 A more efficient way to determine what has changed in the branch is to use
269 Git and inspect or search the kernel tree.
270 This method gives you a full view of not only the source code modifications,
271 but also provides the reasons for the changes.
272 </para>
273
274 <section id='what-changed-in-a-kernel'>
275 <title>What Changed in a Kernel?</title>
276
277 <para>
278 Following are a few examples that show how to use Git commands to examine changes.
279 Because Git repositories in the Yocto Project do not break existing Git
280 functionality, and because there exists many permutations of these types of
281 Git commands, many methods exist by which you can discover changes.
282 <note>
283 In the following examples, unless you provide a commit range,
284 <filename>kernel.org</filename> history is blended with Yocto Project
285 kernel changes.
286 You can form ranges by using branch names from the kernel tree as the
287 upper and lower commit markers with the Git commands.
288 You can see the branch names through the web interface to the
289 Yocto Project source repositories at
290 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink>.
291 For example, the branch names for the <filename>linux-yocto-3.4</filename>
292 kernel repository can be seen at
293 <ulink url='http://git.yoctoproject.org/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
294 </note>
295 To see a full range of the changes, use the
296 <filename>git whatchanged</filename> command and specify a commit range
297 for the branch (<filename>&lt;commit&gt;..&lt;commit&gt;</filename>).
298 </para>
299
300 <para>
301 Here is an example that looks at what has changed in the
302 <filename>emenlow</filename> branch of the
303 <filename>linux-yocto-3.4</filename> kernel.
304 The lower commit range is the commit associated with the
305 <filename>standard/base</filename> branch, while
306 the upper commit range is the commit associated with the
307 <filename>standard/emenlow</filename> branch.
308 <literallayout class='monospaced'>
309 $ git whatchanged origin/standard/base..origin/standard/emenlow
310 </literallayout>
311 </para>
312
313 <para>
314 To see a summary of changes use the <filename>git log</filename> command.
315 Here is an example using the same branches:
316 <literallayout class='monospaced'>
317 $ git log --oneline origin/standard/base..origin/standard/emenlow
318 </literallayout>
319 The <filename>git log</filename> output might be more useful than
320 the <filename>git whatchanged</filename> as you get
321 a short, one-line summary of each change and not the entire commit.
322 </para>
323
324 <para>
325 If you want to see code differences associated with all the changes, use
326 the <filename>git diff</filename> command.
327 Here is an example:
328 <literallayout class='monospaced'>
329 $ git diff origin/standard/base..origin/standard/emenlow
330 </literallayout>
331 </para>
332
333 <para>
334 You can see the commit log messages and the text differences using the
335 <filename>git show</filename> command:
336 Here is an example:
337 <literallayout class='monospaced'>
338 $ git show origin/standard/base..origin/standard/emenlow
339 </literallayout>
340 </para>
341
342 <para>
343 You can create individual patches for each change by using the
344 <filename>git format-patch</filename> command.
345 Here is an example that that creates patch files for each commit and
346 places them in your <filename>Documents</filename> directory:
347 <literallayout class='monospaced'>
348 $ git format-patch -o $HOME/Documents origin/standard/base..origin/standard/emenlow
349 </literallayout>
350 </para>
351 </section>
352
353 <section id='show-a-particular-feature-or-branch-change'>
354 <title>Show a Particular Feature or Branch Change</title>
355
356 <para>
357 Developers use tags in the Yocto Project kernel tree to divide changes for significant
358 features or branches.
359 Once you know a particular tag, you can use Git commands
360 to show changes associated with the tag and find the branches that contain
361 the feature.
362 <note>
363 Because BSP branch, <filename>kernel.org</filename>, and feature tags are all
364 present, there could be many tags.
365 </note>
366 The <filename>git show &lt;tag&gt;</filename> command shows changes that are tagged by
367 a feature.
368 Here is an example that shows changes tagged by the <filename>systemtap</filename>
369 feature:
370 <literallayout class='monospaced'>
371 $ git show systemtap
372 </literallayout>
373 You can use the <filename>git branch --contains &lt;tag&gt;</filename> command
374 to show the branches that contain a particular feature.
375 This command shows the branches that contain the <filename>systemtap</filename>
376 feature:
377 <literallayout class='monospaced'>
378 $ git branch --contains systemtap
379 </literallayout>
380 </para>
381
382 <para>
383 You can use many other comparisons to isolate BSP and kernel changes.
384 For example, you can compare against <filename>kernel.org</filename> tags
385 such as the <filename>v3.4</filename> tag.
386 </para>
387 </section>
388 </section>
389
390 <section id='development-saving-kernel-modifications'>
391 <title>Development: Saving Kernel Modifications</title>
392
393 <para>
394 Another common operation is to build a BSP supplied by the Yocto Project, make some
395 changes, rebuild, and then test.
396 Those local changes often need to be exported, shared or otherwise maintained.
397 </para>
398
399 <para>
400 Since the Yocto Project kernel source tree is backed by Git, this activity is
401 much easier as compared to with previous releases.
402 Because Git tracks file modifications, additions and deletions, it is easy
403 to modify the code and later realize that you need to save the changes.
404 It is also easy to determine what has changed.
405 This method also provides many tools to commit, undo and export those modifications.
406 </para>
407
408 <para>
409 This section and its sub-sections, describe general application of Git's
410 <filename>push</filename> and <filename>pull</filename> commands, which are used to
411 get your changes upstream or source your code from an upstream repository.
412 The Yocto Project provides scripts that help you work in a collaborative development
413 environment.
414 For information on these scripts, see the
415 "<ulink url='&YOCTO_DOCS_DEV_URL;#pushing-a-change-upstream'>Using Scripts to Push a Change
416 Upstream and Request a Pull</ulink>" and
417 "<ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-patch'>Using Email to Submit a Patch</ulink>"
418 sections in the Yocto Project Development Manual.
419 </para>
420
421 <para>
422 There are many ways to save kernel modifications.
423 The technique employed
424 depends on the destination for the patches:
425
426 <itemizedlist>
427 <listitem><para>Bulk storage</para></listitem>
428 <listitem><para>Internal sharing either through patches or by using Git</para></listitem>
429 <listitem><para>External submissions</para></listitem>
430 <listitem><para>Exporting for integration into another Source Code
431 Manager (SCM)</para></listitem>
432 </itemizedlist>
433 </para>
434
435 <para>
436 Because of the following list of issues, the destination of the patches also influences
437 the method for gathering them:
438
439 <itemizedlist>
440 <listitem><para>Bisectability</para></listitem>
441 <listitem><para>Commit headers</para></listitem>
442 <listitem><para>Division of subsystems for separate submission or review</para></listitem>
443 </itemizedlist>
444 </para>
445
446 <section id='bulk-export'>
447 <title>Bulk Export</title>
448
449 <para>
450 This section describes how you can "bulk" export changes that have not
451 been separated or divided.
452 This situation works well when you are simply storing patches outside of the kernel
453 source repository, either permanently or temporarily, and you are not committing
454 incremental changes during development.
455 <note>
456 This technique is not appropriate for full integration of upstream submission
457 because changes are not properly divided and do not provide an avenue for per-change
458 commit messages.
459 Therefore, this example assumes that changes have not been committed incrementally
460 during development and that you simply must gather and export them.
461 </note>
462 <literallayout class='monospaced'>
463 # bulk export of ALL modifications without separation or division
464 # of the changes
465
466 $ git add .
467 $ git commit -s -a -m &lt;msg&gt;
468 or
469 $ git commit -s -a # and interact with $EDITOR
470 </literallayout>
471 </para>
472
473 <para>
474 The previous operations capture all the local changes in the project source
475 tree in a single Git commit.
476 And, that commit is also stored in the project's source tree.
477 </para>
478
479 <para>
480 Once the changes are exported, you can restore them manually using a template
481 or through integration with the <filename>default_kernel</filename>.
482 </para>
483
484 </section>
485
486 <section id='incremental-planned-sharing'>
487 <title>Incremental/Planned Sharing</title>
488
489 <para>
490 This section describes how to save modifications when you are making incremental
491 commits or practicing planned sharing.
492 The examples in this section assume that you have incrementally committed
493 changes to the tree during development and now need to export them.
494 The sections that follow
495 describe how you can export your changes internally through either patches or by
496 using Git commands.
497 </para>
498
499 <para>
500 During development, the following commands are of interest.
501 For full Git documentation, refer to the Git documentation at
502 <ulink url='http://github.com'></ulink>.
503
504 <literallayout class='monospaced'>
505 # edit a file
506 $ vi &lt;path&gt;/file
507 # stage the change
508 $ git add &lt;path&gt;/file
509 # commit the change
510 $ git commit -s
511 # remove a file
512 $ git rm &lt;path&gt;/file
513 # commit the change
514 $ git commit -s
515
516 ... etc.
517 </literallayout>
518 </para>
519
520 <para>
521 Distributed development with Git is possible when you use a universally
522 agreed-upon unique commit identifier (set by the creator of the commit) that maps to a
523 specific change set with a specific parent.
524 This identifier is created for you when
525 you create a commit, and is re-created when you amend, alter or re-apply
526 a commit.
527 As an individual in isolation, this is of no interest.
528 However, if you
529 intend to share your tree with normal Git <filename>push</filename> and
530 <filename>pull</filename> operations for
531 distributed development, you should consider the ramifications of changing a
532 commit that you have already shared with others.
533 </para>
534
535 <para>
536 Assuming that the changes have not been pushed upstream, or pulled into
537 another repository, you can update both the commit content and commit messages
538 associated with development by using the following commands:
539
540 <literallayout class='monospaced'>
541 $ Git add &lt;path&gt;/file
542 $ Git commit --amend
543 $ Git rebase or Git rebase -i
544 </literallayout>
545 </para>
546
547 <para>
548 Again, assuming that the changes have not been pushed upstream, and that
549 no pending works-in-progress exist (use <filename>git status</filename> to check), then
550 you can revert (undo) commits by using the following commands:
551
552 <literallayout class='monospaced'>
553 # remove the commit, update working tree and remove all
554 # traces of the change
555 $ git reset --hard HEAD^
556 # remove the commit, but leave the files changed and staged for re-commit
557 $ git reset --soft HEAD^
558 # remove the commit, leave file change, but not staged for commit
559 $ git reset --mixed HEAD^
560 </literallayout>
561 </para>
562
563 <para>
564 You can create branches, "cherry-pick" changes, or perform any number of Git
565 operations until the commits are in good order for pushing upstream
566 or for pull requests.
567 After a <filename>push</filename> or <filename>pull</filename> command,
568 commits are normally considered
569 "permanent" and you should not modify them.
570 If the commits need to be changed, you can incrementally do so with new commits.
571 These practices follow standard Git workflow and the <filename>kernel.org</filename> best
572 practices, which is recommended.
573 <note>
574 It is recommended to tag or branch before adding changes to a Yocto Project
575 BSP or before creating a new one.
576 The reason for this recommendation is because the branch or tag provides a
577 reference point to facilitate locating and exporting local changes.
578 </note>
579 </para>
580
581 <section id='export-internally-via-patches'>
582 <title>Exporting Changes Internally by Using Patches</title>
583
584 <para>
585 This section describes how you can extract committed changes from a working directory
586 by exporting them as patches.
587 Once the changes have been extracted, you can use the patches for upstream submission,
588 place them in a Yocto Project template for automatic kernel patching,
589 or apply them in many other common uses.
590 </para>
591
592 <para>
593 This example shows how to create a directory with sequentially numbered patches.
594 Once the directory is created, you can apply it to a repository using the
595 <filename>git am</filename> command to reproduce the original commit and all
596 the related information such as author, date, commit log, and so forth.
597 <note>
598 The new commit identifiers (ID) will be generated upon re-application.
599 This action reflects that the commit is now applied to an underlying commit
600 with a different ID.
601 </note>
602 <literallayout class='monospaced'>
603 # &lt;first-commit&gt; can be a tag if one was created before development
604 # began. It can also be the parent branch if a branch was created
605 # before development began.
606
607 $ git format-patch -o &lt;dir&gt; &lt;first commit&gt;..&lt;last commit&gt;
608 </literallayout>
609 </para>
610
611 <para>
612 In other words:
613 <literallayout class='monospaced'>
614 # Identify commits of interest.
615
616 # If the tree was tagged before development
617 $ git format-patch -o &lt;save dir&gt; &lt;tag&gt;
618
619 # If no tags are available
620 $ git format-patch -o &lt;save dir&gt; HEAD^ # last commit
621 $ git format-patch -o &lt;save dir&gt; HEAD^^ # last 2 commits
622 $ git whatchanged # identify last commit
623 $ git format-patch -o &lt;save dir&gt; &lt;commit id&gt;
624 $ git format-patch -o &lt;save dir&gt; &lt;rev-list&gt;
625 </literallayout>
626 </para>
627 </section>
628
629 <section id='export-internally-via-git'>
630 <title>Exporting Changes Internally by Using Git</title>
631
632 <para>
633 This section describes how you can export changes from a working directory
634 by pushing the changes into a master repository or by making a pull request.
635 Once you have pushed the changes to the master repository, you can then
636 pull those same changes into a new kernel build at a later time.
637 </para>
638
639 <para>
640 Use this command form to push the changes:
641 <literallayout class='monospaced'>
642 $ git push ssh://&lt;master_server&gt;/&lt;path_to_repo&gt;
643 &lt;local_branch&gt;:&lt;remote_branch&gt;
644 </literallayout>
645 </para>
646
647 <para>
648 For example, the following command pushes the changes from your local branch
649 <filename>yocto/standard/common-pc/base</filename> to the remote branch with the same name
650 in the master repository <filename>//git.mycompany.com/pub/git/kernel-3.4</filename>.
651 <literallayout class='monospaced'>
652 $ git push ssh://git.mycompany.com/pub/git/kernel-3.4 \
653 yocto/standard/common-pc/base:yocto/standard/common-pc/base
654 </literallayout>
655 </para>
656
657 <para>
658 A pull request entails using the <filename>git request-pull</filename> command to compose
659 an email to the
660 maintainer requesting that a branch be pulled into the master repository, see
661 <ulink url='http://github.com/guides/pull-requests'></ulink> for an example.
662 <note>
663 Other commands such as <filename>git stash</filename> or branching can also be used to save
664 changes, but are not covered in this document.
665 </note>
666 </para>
667 </section>
668 </section>
669
670 <section id='export-for-external-upstream-submission'>
671 <title>Exporting Changes for External (Upstream) Submission</title>
672
673 <para>
674 This section describes how to export changes for external upstream submission.
675 If the patch series is large or the maintainer prefers to pull
676 changes, you can submit these changes by using a pull request.
677 However, it is common to send patches as an email series.
678 This method allows easy review and integration of the changes.
679 <note>
680 Before sending patches for review be sure you understand the
681 community standards for submitting and documenting changes and follow their best practices.
682 For example, kernel patches should follow standards such as:
683 <itemizedlist>
684 <listitem><para>
685 <ulink url='http://linux.yyz.us/patch-format.html'></ulink></para></listitem>
686 <listitem><para>Documentation/SubmittingPatches (in any linux
687 kernel source tree)</para></listitem>
688 </itemizedlist>
689 </note>
690 </para>
691
692 <para>
693 The messages used to commit changes are a large part of these standards.
694 Consequently, be sure that the headers for each commit have the required information.
695 For information on how to follow the Yocto Project commit message standards, see the
696 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a
697 Change</ulink>" section in the Yocto Project Development Manual.
698 </para>
699
700 <para>
701 If the initial commits were not properly documented or do not meet those standards,
702 you can re-base by using the <filename>git rebase -i</filename> command to
703 manipulate the commits and
704 get them into the required format.
705 Other techniques such as branching and cherry-picking commits are also viable options.
706 </para>
707
708 <para>
709 Once you complete the commits, you can generate the email that sends the patches
710 to the maintainer(s) or lists that review and integrate changes.
711 The command <filename>git send-email</filename> is commonly used to ensure
712 that patches are properly
713 formatted for easy application and avoid mailer-induced patch damage.
714 </para>
715
716 <para>
717 The following is an example of dumping patches for external submission:
718 <literallayout class='monospaced'>
719 # dump the last 4 commits
720 $ git format-patch --thread -n -o ~/rr/ HEAD^^^^
721 $ git send-email --compose --subject '[RFC 0/N] &lt;patch series summary&gt;' \
722 --to foo@yoctoproject.org --to bar@yoctoproject.org \
723 --cc list@yoctoproject.org ~/rr
724 # the editor is invoked for the 0/N patch, and when complete the entire
725 # series is sent via email for review
726 </literallayout>
727 </para>
728 </section>
729
730 <section id='export-for-import-into-other-scm'>
731 <title>Exporting Changes for Import into Another SCM</title>
732
733 <para>
734 When you want to export changes for import into another
735 Source Code Manager (SCM), you can use any of the previously discussed
736 techniques.
737 However, if the patches are manually applied to a secondary tree and then
738 that tree is checked into the SCM, you can lose change information such as
739 commit logs.
740 This process is not recommended.
741 </para>
742
743 <para>
744 Many SCMs can directly import Git commits, or can translate Git patches so that
745 information is not lost.
746 Those facilities are SCM-dependent and you should use them whenever possible.
747 </para>
748 </section>
749 </section>
750
751 <section id='scm-working-with-the-yocto-project-kernel-in-another-scm'>
752 <title>Working with the Yocto Project Kernel in Another SCM</title>
753
754 <para>
755 This section describes kernel development in an SCM other than Git,
756 which is not the same as exporting changes to another SCM described earlier.
757 For this scenario, you use the OpenEmbedded build system to
758 develop the kernel in a different SCM.
759 The following must be true for you to accomplish this:
760 <itemizedlist>
761 <listitem><para>The delivered Yocto Project kernel must be exported into the second
762 SCM.</para></listitem>
763 <listitem><para>Development must be exported from that secondary SCM into a
764 format that can be used by the OpenEmbedded build system.</para></listitem>
765 </itemizedlist>
766 </para>
767
768 <section id='exporting-delivered-kernel-to-scm'>
769 <title>Exporting the Delivered Kernel to the SCM</title>
770
771 <para>
772 Depending on the SCM, it might be possible to export the entire Yocto Project
773 kernel Git repository, branches and all, into a new environment.
774 This method is preferred because it has the most flexibility and potential to maintain
775 the meta data associated with each commit.
776 </para>
777
778 <para>
779 When a direct import mechanism is not available, it is still possible to
780 export a branch (or series of branches) and check them into a new repository.
781 </para>
782
783 <para>
784 The following commands illustrate some of the steps you could use to
785 import the <filename>yocto/standard/common-pc/base</filename>
786 kernel into a secondary SCM:
787 <literallayout class='monospaced'>
788 $ git checkout yocto/standard/common-pc/base
789 $ cd .. ; echo linux/.git &gt; .cvsignore
790 $ cvs import -m "initial import" linux MY_COMPANY start
791 </literallayout>
792 </para>
793
794 <para>
795 You could now relocate the CVS repository and use it in a centralized manner.
796 </para>
797
798 <para>
799 The following commands illustrate how you can condense and merge two BSPs into a
800 second SCM:
801 <literallayout class='monospaced'>
802 $ git checkout yocto/standard/common-pc/base
803 $ git merge yocto/standard/common-pc-64/base
804 # resolve any conflicts and commit them
805 $ cd .. ; echo linux/.git &gt; .cvsignore
806 $ cvs import -m "initial import" linux MY_COMPANY start
807 </literallayout>
808 </para>
809 </section>
810
811 <section id='importing-changes-for-build'>
812 <title>Importing Changes for the Build</title>
813
814 <para>
815 Once development has reached a suitable point in the second development
816 environment, you need to export the changes as patches.
817 To export them, place the changes in a recipe and
818 automatically apply them to the kernel during patching.
819 </para>
820 </section>
821 </section>
822
823 <section id='bsp-creating'>
824 <title>Creating a BSP Based on an Existing Similar BSP</title>
825
826 <para>
827 This section overviews the process of creating a BSP based on an
828 existing similar BSP.
829 The information is introductory in nature and does not provide step-by-step examples.
830 For detailed information on how to create a new BSP, see
831 the "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" section in the
832 Yocto Project Board Support Package (BSP) Developer's Guide, or see the
833 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>Transcript:_creating_one_generic_Atom_BSP_from_another</ulink>
834 wiki page.
835 </para>
836
837 <para>
838 The basic steps you need to follow are:
839 <orderedlist>
840 <listitem><para><emphasis>Make sure you have set up a local Source Directory:</emphasis>
841 You must create a local
842 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
843 by either creating a Git repository (recommended) or
844 extracting a Yocto Project release tarball.</para></listitem>
845 <listitem><para><emphasis>Choose an existing BSP available with the Yocto Project:</emphasis>
846 Try to map your board features as closely to the features of a BSP that is
847 already supported and exists in the Yocto Project.
848 Starting with something as close as possible to your board makes developing
849 your BSP easier.
850 You can find all the BSPs that are supported and ship with the Yocto Project
851 on the Yocto Project's Download page at
852 <ulink url='&YOCTO_HOME_URL;/download'></ulink>.</para></listitem>
853 <listitem><para><emphasis>Be sure you have the Base BSP:</emphasis>
854 You need to either have a local Git repository of the base BSP set up or
855 have downloaded and extracted the files from a release BSP tarball.
856 Either method gives you access to the BSP source files.</para></listitem>
857 <listitem><para><emphasis>Make a copy of the existing BSP, thus isolating your new
858 BSP work:</emphasis>
859 Copying the existing BSP file structure gives you a new area in which to work.</para></listitem>
860 <listitem><para><emphasis>Make configuration and recipe changes to your new BSP:</emphasis>
861 Configuration changes involve the files in the BSP's <filename>conf</filename>
862 directory.
863 Changes include creating a machine-specific configuration file and editing the
864 <filename>layer.conf</filename> file.
865 The configuration changes identify the kernel you will be using.
866 Recipe changes include removing, modifying, or adding new recipe files that
867 instruct the build process on what features to include in the image.</para></listitem>
868 <listitem><para><emphasis>Prepare for the build:</emphasis>
869 Before you actually initiate the build, you need to set up the build environment
870 by sourcing the environment initialization script.
871 After setting up the environment, you need to make some build configuration
872 changes to the <filename>local.conf</filename> and <filename>bblayers.conf</filename>
873 files.</para></listitem>
874 <listitem><para><emphasis>Build the image:</emphasis>
875 The OpenEmbedded build system uses BitBake to create the image.
876 You need to decide on the type of image you are going to build (e.g. minimal, base,
877 core, sato, and so forth) and then start the build using the <filename>bitbake</filename>
878 command.</para></listitem>
879 </orderedlist>
880 </para>
881 </section>
882
883 <section id='tip-dirty-string'>
884 <title>"-dirty" String</title>
885
886 <para>
887 If kernel images are being built with "-dirty" on the end of the version
888 string, this simply means that modifications in the source
889 directory have not been committed.
890 <literallayout class='monospaced'>
891 $ git status
892 </literallayout>
893 </para>
894
895 <para>
896 You can use the above Git command to report modified, removed, or added files.
897 You should commit those changes to the tree regardless of whether they will be saved,
898 exported, or used.
899 Once you commit the changes you need to rebuild the kernel.
900 </para>
901
902 <para>
903 To brute force pickup and commit all such pending changes, enter the following:
904 <literallayout class='monospaced'>
905 $ git add .
906 $ git commit -s -a -m "getting rid of -dirty"
907 </literallayout>
908 </para>
909
910 <para>
911 Next, rebuild the kernel.
912 </para>
913 </section>
914 </section>
915</chapter>
916<!--
917vim: expandtab tw=80 ts=4
918-->
diff --git a/documentation/kernel-dev/kernel-dev-faq.xml b/documentation/kernel-dev/kernel-dev-faq.xml
new file mode 100644
index 0000000000..7389c9c9c5
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-faq.xml
@@ -0,0 +1,131 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<appendix id='kernel-dev-faq'>
6<title>Kernel Development FAQ</title>
7<qandaset>
8 <qandaentry>
9 <question>
10 <para>
11 How do I use my own Linux kernel <filename>.config</filename>
12 file?
13 </para>
14 </question>
15 <answer>
16 <para>
17 Refer to the "<link linkend='changing-the-configuration'>Changing the Configuration</link>"
18 section for information.
19 </para>
20 </answer>
21 </qandaentry>
22
23 <qandaentry>
24 <question>
25 <para>
26 How do I create configuration fragments?
27 </para>
28 </question>
29 <answer>
30 <para>
31 Refer to the "<link linkend='generating-configuration-files'>Generating Configuration Files</link>"
32 section for information.
33 </para>
34 </answer>
35 </qandaentry>
36
37 <qandaentry>
38 <question>
39 <para>
40 How do I use my own Linux kernel sources?
41 </para>
42 </question>
43 <answer>
44 <para>
45 Refer to the "<link linkend='working-with-your-own-sources'>Working With Your Own Sources</link>"
46 section for information.
47 </para>
48 </answer>
49 </qandaentry>
50
51 <qandaentry>
52 <question>
53 <para>
54 How do I install/not-install the kernel image on the rootfs?
55 </para>
56 </question>
57 <answer>
58 <para>
59 The kernel image (e.g. <filename>vmlinuz</filename>) is provided
60 by the <filename>kernel-image</filename> package.
61 Image recipes depend on <filename>kernel-base</filename>.
62 To specify whether or not the kernel
63 image is installed in the generated root filesystem, override
64 <filename>RDEPENDS_kernel-base</filename> to include or not
65 include "kernel-image".</para>
66 <para>See the
67 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>"
68 section in the Yocto Project Development Manual for information on
69 how to use an append file to override metadata.
70 </para>
71 </answer>
72 </qandaentry>
73
74 <qandaentry>
75 <question>
76 <para>
77 How do I install a specific kernel module?
78 </para>
79 </question>
80 <answer>
81 <para>
82 Linux kernel modules are packaged individually.
83 To ensure a specific kernel module is included in an image,
84 include it in the appropriate machine
85 <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>
86 variable.</para>
87 <para>These other variables are useful for installing specific
88 modules:
89 <literallayout class='monospaced'>
90 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</filename></ulink>
91 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink>
92 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RDEPENDS'><filename>MACHINE_EXTRA_RDEPENDS</filename></ulink>
93 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_EXTRA_RRECOMMENDS'><filename>MACHINE_EXTRA_RRECOMMENDS</filename></ulink>
94 </literallayout>
95 For example, set the following in the <filename>qemux86.conf</filename>
96 file to include the <filename>ab123</filename> kernel modules
97 with images built for the <filename>qemux86</filename> machine:
98 <literallayout class='monospaced'>
99 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-ab123"
100 </literallayout>
101 For more information, see the
102 "<link linkend='incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</link>"
103 section.
104 </para>
105 </answer>
106 </qandaentry>
107
108 <qandaentry>
109 <question>
110 <para>
111 How do I change the Linux kernel command line?
112 </para>
113 </question>
114 <answer>
115 <para>
116 The Linux kernel command line is typically specified in
117 the machine config using the <filename>APPEND</filename> variable.
118 For example, you can add some helpful debug information doing
119 the following:
120 <literallayout class='monospaced'>
121 APPEND += "printk.time=y initcall_debug debug"
122 </literallayout>
123 </para>
124 </answer>
125 </qandaentry>
126
127</qandaset>
128</appendix>
129<!--
130vim: expandtab tw=80 ts=4
131-->
diff --git a/documentation/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml
new file mode 100644
index 0000000000..297696c965
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-intro.xml
@@ -0,0 +1,147 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='kernel-dev-intro'>
6<title>Introduction</title>
7
8<!--
9<para>
10 <emphasis>AR - Darrren Hart:</emphasis> See if the concepts in these
11 three bullets are adequately covered in somewhere in this manual:
12 <itemizedlist>
13 <listitem><para>Do we convey that our kernel Git repositories
14 have a clear and continuous history, similar to the way the
15 kernel Git repositories for <filename>kernel.org</filename>
16 do.
17 </para></listitem>
18 <listitem><para>Does the manual note that Yocto Project delivers
19 a key set of supported kernel types, where
20 each type is tailored to meet a specific use (e.g. networking,
21 consumer, devices, and so forth).</para></listitem>
22 <listitem><para>Do we convey that the Yocto Project uses a
23 Git branching strategy that, from a
24 developer's point of view, results in a linear path from the
25 baseline kernel.org, through a select group of features and
26 ends with their BSP-specific commits.</para></listitem>
27 </itemizedlist>
28</para>
29-->
30
31 <section id='kernel-dev-overview'>
32 <title>Overview</title>
33
34 <para>
35 Regardless of how you intend to make use of the Yocto Project,
36 chances are you will work with the Linux kernel.
37 This manual provides background information on the Yocto Linux kernel
38 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
39 describes common tasks you can perform using the kernel tools,
40 and shows you how to use the kernel Metadata needed to work with
41 the kernel inside the Yocto Project.
42 </para>
43
44 <para>
45 Each Yocto Project release has a set of linux-yocto recipes, whose
46 Git repositories you can view in the Yocto
47 <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink> under
48 the "Yocto Linux Kernel" heading.
49 New recipes for the release track the latest upstream developments
50 and introduce newly supported platforms.
51 Previous recipes in the release are refreshed and supported for at
52 least one additional release.
53 As they align, these previous releases are updated to include the
54 latest from the Long Term Support Initiative (LTSI) project.
55 Also included is a linux-yocto development recipe
56 (<filename>linux-yocto-dev.bb</filename>) should you want to work
57 with the very latest in upstream Linux kernel development and
58 kernel Metadata development.
59 </para>
60
61 <para>
62 The Yocto Project also provides a powerful set of kernel
63 tools for managing Linux kernel sources and configuration data.
64 You can use these tools to make a single configuration change,
65 apply multiple patches, or work with your own kernel sources.
66 </para>
67
68 <para>
69 In particular, the kernel tools allow you to generate configuration
70 fragments that specify only what you must, and nothing more.
71 Configuration fragments only need to contain the highest level
72 visible <filename>CONFIG</filename> options as presented by the Linux
73 kernel <filename>menuconfig</filename> system.
74 Contrast this against a complete Linux kernel
75 <filename>.config</filename>, which includes all the automatically
76 selected <filename>CONFIG</filename> options.
77 This efficiency reduces your maintenance effort and allows you
78 to further separate your configuration in ways that make sense for
79 your project.
80 A common split separates policy and hardware.
81 For example, all your kernels might support
82 the <filename>proc</filename> and <filename>sys</filename> filesystems,
83 but only specific boards require sound, USB, or specific drivers.
84 Specifying these configurations individually allows you to aggregate
85 them together as needed, but maintains them in only one place.
86 Similar logic applies to separating source changes.
87 </para>
88
89 <para>
90 If you do not maintain your own kernel sources and need to make
91 only minimal changes to the sources, the released recipes provide a
92 vetted base upon which to layer your changes.
93 Doing so allows you to benefit from the continual kernel
94 integration and testing performed during development of the
95 Yocto Project.
96 </para>
97
98 <para>
99 If, instead, you have a very specific Linux kernel source tree
100 and are unable to align with one of the official linux-yocto
101 recipes, an alternative exists by which you can use the Yocto
102 Project Linux kernel tools with your own kernel sources.
103 </para>
104 </section>
105
106 <section id='kernel-dev-other-resources'>
107 <title>Other Resources</title>
108
109 <para>
110 The sections that follow provide instructions for completing
111 specific Linux kernel development tasks.
112 These instructions assume you are comfortable working with
113 <ulink url='http://developer.berlios.de/projects/bitbake/'>BitBake</ulink>
114 recipes and basic open-source development tools.
115 Understanding these concepts will facilitate the process of working
116 with the kernel recipes.
117 If you find you need some additional background, please be sure to
118 review and understand the following documentation:
119 <itemizedlist>
120 <listitem><para><ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>
121 </para></listitem>
122 <listitem><para>The "<ulink url='&YOCTO_DOCS_DEV_URL;#modifying-temporary-source-code'>Modifying Temporary Source Code</ulink>"
123 section in the Yocto Project Development Manual
124 </para></listitem>
125 <listitem><para>The "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" section
126 in the Yocto Project Development Manual</para></listitem>
127 <listitem><para>The "<ulink url='&YOCTO_DOCS_DEV_URL;#modifying-the-kernel'>Modifying the Kernel</ulink>" section
128 in the Yocto Project Development Manual.</para></listitem>
129 </itemizedlist>
130 </para>
131
132 <para>
133 Finally, while this document focuses on the manual creation of
134 recipes, patches, and configuration files, the Yocto Project
135 Board Support Package (BSP) tools are available to automate
136 this process with existing content and work well to create the
137 initial framework and boilerplate code.
138 For details on these tools, see the
139 "<ulink url='&YOCTO_DOCS_BSP_URL;#using-the-yocto-projects-bsp-tools'>Using the Yocto Project's BSP Tools</ulink>"
140 section in the Yocto Project Board Support Package (BSP) Developer's
141 Guide.
142 </para>
143 </section>
144</chapter>
145<!--
146vim: expandtab tw=80 ts=4
147-->
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.xml b/documentation/kernel-dev/kernel-dev-maint-appx.xml
new file mode 100644
index 0000000000..5f9788aa31
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml
@@ -0,0 +1,220 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<appendix id='kernel-dev-maint-appx'>
6<title>Kernel Maintenance</title>
7
8 <section id='tree-construction'>
9 <title>Tree Construction</title>
10 <para>
11 This section describes construction of the Yocto Project kernel source repositories
12 as accomplished by the Yocto Project team to create kernel repositories.
13 These kernel repositories are found under the heading "Yocto Linux Kernel" at
14 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>&YOCTO_GIT_URL;/cgit.cgi</ulink>
15 and can be shipped as part of a Yocto Project release.
16 The team creates these repositories by
17 compiling and executing the set of feature descriptions for every BSP
18 and feature in the product.
19 Those feature descriptions list all necessary patches,
20 configuration, branching, tagging and feature divisions found in a kernel.
21 Thus, the Yocto Project kernel repository (or tree) is built.
22 </para>
23 <para>
24 The existence of this tree allows you to access and clone a particular
25 Yocto Project kernel repository and use it to build images based on their configurations
26 and features.
27 </para>
28 <para>
29 You can find the files used to describe all the valid features and BSPs
30 in the Yocto Project kernel in any clone of the Yocto Project kernel source repository
31 Git tree.
32 For example, the following command clones the Yocto Project baseline kernel that
33 branched off of <filename>linux.org</filename> version 3.4:
34 <literallayout class='monospaced'>
35 $ git clone git://git.yoctoproject.org/linux-yocto-3.4
36 </literallayout>
37 For another example of how to set up a local Git repository of the Yocto Project
38 kernel files, see the
39 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink>" bulleted
40 item in the Yocto Project Development Manual.
41 </para>
42 <para>
43 Once you have cloned the kernel Git repository on your local machine, you can
44 switch to the <filename>meta</filename> branch within the repository.
45 Here is an example that assumes the local Git repository for the kernel is in
46 a top-level directory named <filename>linux-yocto-3.4</filename>:
47 <literallayout class='monospaced'>
48 $ cd ~/linux-yocto-3.4
49 $ git checkout -b meta origin/meta
50 </literallayout>
51 Once you have checked out and switched to the <filename>meta</filename> branch,
52 you can see a snapshot of all the kernel configuration and feature descriptions that are
53 used to build that particular kernel repository.
54 These descriptions are in the form of <filename>.scc</filename> files.
55 </para>
56 <para>
57 You should realize, however, that browsing your local kernel repository
58 for feature descriptions and patches is not an effective way to determine what is in a
59 particular kernel branch.
60 Instead, you should use Git directly to discover the changes in a branch.
61 Using Git is an efficient and flexible way to inspect changes to the kernel.
62 <note>
63 Ground up reconstruction of the complete kernel tree is an action only taken by the
64 Yocto Project team during an active development cycle.
65 When you create a clone of the kernel Git repository, you are simply making it
66 efficiently available for building and development.
67 </note>
68 </para>
69 <para>
70 The following steps describe what happens when the Yocto Project Team constructs
71 the Yocto Project kernel source Git repository (or tree) found at
72 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the
73 introduction of a new top-level kernel feature or BSP.
74 These are the actions that effectively create the tree
75 that includes the new feature, patch or BSP:
76 <orderedlist>
77 <listitem><para>A top-level kernel feature is passed to the kernel build subsystem.
78 Normally, this feature is a BSP for a particular kernel type.</para></listitem>
79 <listitem><para>The file that describes the top-level feature is located by searching
80 these system directories:
81 <itemizedlist>
82 <listitem><para>The in-tree kernel-cache directories, which are located
83 in <filename>meta/cfg/kernel-cache</filename></para></listitem>
84 <listitem><para>Areas pointed to by <filename>SRC_URI</filename> statements
85 found in recipes</para></listitem>
86 </itemizedlist>
87 For a typical build, the target of the search is a
88 feature description in an <filename>.scc</filename> file
89 whose name follows this format:
90 <literallayout class='monospaced'>
91 &lt;bsp_name&gt;-&lt;kernel_type&gt;.scc
92 </literallayout>
93 </para></listitem>
94 <listitem><para>Once located, the feature description is either compiled into a simple script
95 of actions, or into an existing equivalent script that is already part of the
96 shipped kernel.</para></listitem>
97 <listitem><para>Extra features are appended to the top-level feature description.
98 These features can come from the
99 <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'><filename>KERNEL_FEATURES</filename></ulink>
100 variable in recipes.</para></listitem>
101 <listitem><para>Each extra feature is located, compiled and appended to the script
102 as described in step three.</para></listitem>
103 <listitem><para>The script is executed to produce a series of <filename>meta-*</filename>
104 directories.
105 These directories are descriptions of all the branches, tags, patches and configurations that
106 need to be applied to the base Git repository to completely create the
107 source (build) branch for the new BSP or feature.</para></listitem>
108 <listitem><para>The base repository is cloned, and the actions
109 listed in the <filename>meta-*</filename> directories are applied to the
110 tree.</para></listitem>
111 <listitem><para>The Git repository is left with the desired branch checked out and any
112 required branching, patching and tagging has been performed.</para></listitem>
113 </orderedlist>
114 </para>
115 <para>
116 The kernel tree is now ready for developer consumption to be locally cloned,
117 configured, and built into a Yocto Project kernel specific to some target hardware.
118 <note><para>The generated <filename>meta-*</filename> directories add to the kernel
119 as shipped with the Yocto Project release.
120 Any add-ons and configuration data are applied to the end of an existing branch.
121 The full repository generation that is found in the
122 official Yocto Project kernel repositories at
123 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>http://git.yoctoproject.org/cgit.cgi</ulink>
124 is the combination of all supported boards and configurations.</para>
125 <para>The technique the Yocto Project team uses is flexible and allows for seamless
126 blending of an immutable history with additional patches specific to a
127 deployment.
128 Any additions to the kernel become an integrated part of the branches.</para>
129 </note>
130 </para>
131 </section>
132
133 <section id='build-strategy'>
134 <title>Build Strategy</title>
135
136<!--
137 <para>
138 <emphasis>AR - Darrren Hart:</emphasis> Some parts of this section
139 need to be in the
140 "<link linkend='using-an-iterative-development-process'>Using an Iterative Development Process</link>"
141 section.
142 Darren needs to figure out which parts and identify them.
143 </para>
144-->
145
146 <para>
147 Once a local Git repository of the Yocto Project kernel exists on a development system,
148 you can consider the compilation phase of kernel development - building a kernel image.
149 Some prerequisites exist that are validated by the build process before compilation
150 starts:
151 </para>
152
153 <itemizedlist>
154 <listitem><para>The
155 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> points
156 to the kernel Git repository.</para></listitem>
157 <listitem><para>A BSP build branch exists.
158 This branch has the following form:
159 <literallayout class='monospaced'>
160 &lt;kernel_type&gt;/&lt;bsp_name&gt;
161 </literallayout></para></listitem>
162 </itemizedlist>
163
164 <para>
165 The OpenEmbedded build system makes sure these conditions exist before attempting compilation.
166 Other means, however, do exist, such as as bootstrapping a BSP.
167 </para>
168
169 <para>
170 Before building a kernel, the build process verifies the tree
171 and configures the kernel by processing all of the
172 configuration "fragments" specified by feature descriptions in the <filename>.scc</filename>
173 files.
174 As the features are compiled, associated kernel configuration fragments are noted
175 and recorded in the <filename>meta-*</filename> series of directories in their compilation order.
176 The fragments are migrated, pre-processed and passed to the Linux Kernel
177 Configuration subsystem (<filename>lkc</filename>) as raw input in the form
178 of a <filename>.config</filename> file.
179 The <filename>lkc</filename> uses its own internal dependency constraints to do the final
180 processing of that information and generates the final <filename>.config</filename> file
181 that is used during compilation.
182 </para>
183
184 <para>
185 Using the board's architecture and other relevant values from the board's template,
186 kernel compilation is started and a kernel image is produced.
187 </para>
188
189 <para>
190 The other thing that you notice once you configure a kernel is that
191 the build process generates a build tree that is separate from your kernel's local Git
192 source repository tree.
193 This build tree has a name that uses the following form, where
194 <filename>${MACHINE}</filename> is the metadata name of the machine (BSP) and "kernel_type" is one
195 of the Yocto Project supported kernel types (e.g. "standard"):
196 <literallayout class='monospaced'>
197 linux-${MACHINE}-&lt;kernel_type&gt;-build
198 </literallayout>
199 </para>
200
201 <para>
202 The existing support in the <filename>kernel.org</filename> tree achieves this
203 default functionality.
204 </para>
205
206 <para>
207 This behavior means that all the generated files for a particular machine or BSP are now in
208 the build tree directory.
209 The files include the final <filename>.config</filename> file, all the <filename>.o</filename>
210 files, the <filename>.a</filename> files, and so forth.
211 Since each machine or BSP has its own separate
212 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
213 in its own separate branch
214 of the Git repository, you can easily switch between different builds.
215 </para>
216 </section>
217</appendix>
218<!--
219vim: expandtab tw=80 ts=4
220-->
diff --git a/documentation/kernel-dev/kernel-dev-style.css b/documentation/kernel-dev/kernel-dev-style.css
new file mode 100644
index 0000000000..52be14388d
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev-style.css
@@ -0,0 +1,978 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("figures/kernel-dev-title.png");
122 background-position: left top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 0px;
126 text-align: right;
127 width: 740px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/yocto-project-bw.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
diff --git a/documentation/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml
new file mode 100644
index 0000000000..f4cddba76e
--- /dev/null
+++ b/documentation/kernel-dev/kernel-dev.xml
@@ -0,0 +1,95 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='kernel-dev' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/kernel-dev-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Linux Kernel Development Manual
21 </title>
22
23 <authorgroup>
24 <author>
25 <firstname>Darren</firstname> <surname>Hart</surname>
26 <affiliation>
27 <orgname>Intel Corporation</orgname>
28 </affiliation>
29 <email>darren.hart@intel.com</email>
30 </author>
31 </authorgroup>
32
33 <revhistory>
34 <revision>
35 <revnumber>1.4</revnumber>
36 <date>April 2013</date>
37 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
38 </revision>
39 <revision>
40 <revnumber>1.5</revnumber>
41 <date>October 2013</date>
42 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
43 </revision>
44 <revision>
45 <revnumber>1.5.1</revnumber>
46 <date>Sometime in 2013</date>
47 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
48 </revision>
49 </revhistory>
50
51 <copyright>
52 <year>&COPYRIGHT_YEAR;</year>
53 <holder>Linux Foundation</holder>
54 </copyright>
55
56 <legalnotice>
57 <para>
58 Permission is granted to copy, distribute and/or modify this document under
59 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
60 </para>
61 <note>
62 For the latest version of this manual associated with this
63 Yocto Project release, see the
64 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>
65 from the Yocto Project website.
66 </note>
67 </legalnotice>
68
69 </bookinfo>
70
71 <xi:include href="kernel-dev-intro.xml"/>
72
73 <xi:include href="kernel-dev-common.xml"/>
74
75 <xi:include href="kernel-dev-advanced.xml"/>
76
77 <xi:include href="kernel-dev-concepts-appx.xml"/>
78
79 <xi:include href="kernel-dev-maint-appx.xml"/>
80
81<!--
82 <xi:include href="kernel-dev-examples.xml"/>
83-->
84
85 <xi:include href="kernel-dev-faq.xml"/>
86
87<!-- <index id='index'>
88 <title>Index</title>
89 </index>
90-->
91
92</book>
93<!--
94vim: expandtab tw=80 ts=4
95-->
diff --git a/documentation/mega-manual/figures/adt-title.png b/documentation/mega-manual/figures/adt-title.png
new file mode 100644
index 0000000000..6e71e41f1a
--- /dev/null
+++ b/documentation/mega-manual/figures/adt-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/analysis-for-package-splitting.png b/documentation/mega-manual/figures/analysis-for-package-splitting.png
new file mode 100644
index 0000000000..04f2794ea9
--- /dev/null
+++ b/documentation/mega-manual/figures/analysis-for-package-splitting.png
Binary files differ
diff --git a/documentation/mega-manual/figures/app-dev-flow.png b/documentation/mega-manual/figures/app-dev-flow.png
new file mode 100644
index 0000000000..4927b93d67
--- /dev/null
+++ b/documentation/mega-manual/figures/app-dev-flow.png
Binary files differ
diff --git a/documentation/mega-manual/figures/bsp-dev-flow.png b/documentation/mega-manual/figures/bsp-dev-flow.png
new file mode 100644
index 0000000000..b20ee19223
--- /dev/null
+++ b/documentation/mega-manual/figures/bsp-dev-flow.png
Binary files differ
diff --git a/documentation/mega-manual/figures/bsp-title.png b/documentation/mega-manual/figures/bsp-title.png
new file mode 100644
index 0000000000..f624dd4f94
--- /dev/null
+++ b/documentation/mega-manual/figures/bsp-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/buildhistory-web.png b/documentation/mega-manual/figures/buildhistory-web.png
new file mode 100644
index 0000000000..f6db86c977
--- /dev/null
+++ b/documentation/mega-manual/figures/buildhistory-web.png
Binary files differ
diff --git a/documentation/mega-manual/figures/buildhistory.png b/documentation/mega-manual/figures/buildhistory.png
new file mode 100644
index 0000000000..edf98d95cf
--- /dev/null
+++ b/documentation/mega-manual/figures/buildhistory.png
Binary files differ
diff --git a/documentation/mega-manual/figures/building-an-image.png b/documentation/mega-manual/figures/building-an-image.png
new file mode 100755
index 0000000000..1fbea5ab00
--- /dev/null
+++ b/documentation/mega-manual/figures/building-an-image.png
Binary files differ
diff --git a/documentation/mega-manual/figures/configuration-compile-autoreconf.png b/documentation/mega-manual/figures/configuration-compile-autoreconf.png
new file mode 100644
index 0000000000..a07464f04c
--- /dev/null
+++ b/documentation/mega-manual/figures/configuration-compile-autoreconf.png
Binary files differ
diff --git a/documentation/mega-manual/figures/cross-development-toolchains.png b/documentation/mega-manual/figures/cross-development-toolchains.png
new file mode 100644
index 0000000000..d36670a198
--- /dev/null
+++ b/documentation/mega-manual/figures/cross-development-toolchains.png
Binary files differ
diff --git a/documentation/mega-manual/figures/dev-title.png b/documentation/mega-manual/figures/dev-title.png
new file mode 100644
index 0000000000..d3cac4a7e5
--- /dev/null
+++ b/documentation/mega-manual/figures/dev-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/git-workflow.png b/documentation/mega-manual/figures/git-workflow.png
new file mode 100644
index 0000000000..4fdf42f89c
--- /dev/null
+++ b/documentation/mega-manual/figures/git-workflow.png
Binary files differ
diff --git a/documentation/mega-manual/figures/image-generation.png b/documentation/mega-manual/figures/image-generation.png
new file mode 100644
index 0000000000..5594658200
--- /dev/null
+++ b/documentation/mega-manual/figures/image-generation.png
Binary files differ
diff --git a/documentation/mega-manual/figures/images.png b/documentation/mega-manual/figures/images.png
new file mode 100644
index 0000000000..d99eac1fbf
--- /dev/null
+++ b/documentation/mega-manual/figures/images.png
Binary files differ
diff --git a/documentation/mega-manual/figures/index-downloads.png b/documentation/mega-manual/figures/index-downloads.png
new file mode 100644
index 0000000000..c907997db2
--- /dev/null
+++ b/documentation/mega-manual/figures/index-downloads.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-architecture-overview.png b/documentation/mega-manual/figures/kernel-architecture-overview.png
new file mode 100755
index 0000000000..2aad172db3
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-architecture-overview.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-dev-flow.png b/documentation/mega-manual/figures/kernel-dev-flow.png
new file mode 100644
index 0000000000..edd9e82af7
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-dev-flow.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-dev-title.png b/documentation/mega-manual/figures/kernel-dev-title.png
new file mode 100644
index 0000000000..7a8dd54372
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-dev-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-overview-1.png b/documentation/mega-manual/figures/kernel-overview-1.png
new file mode 100644
index 0000000000..116c0b9bd4
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-overview-1.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-overview-2-generic.png b/documentation/mega-manual/figures/kernel-overview-2-generic.png
new file mode 100644
index 0000000000..889ff1bf0d
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-overview-2-generic.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernel-title.png b/documentation/mega-manual/figures/kernel-title.png
new file mode 100644
index 0000000000..59d86c00dc
--- /dev/null
+++ b/documentation/mega-manual/figures/kernel-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernelshark-all.png b/documentation/mega-manual/figures/kernelshark-all.png
new file mode 100644
index 0000000000..99b40bafe5
--- /dev/null
+++ b/documentation/mega-manual/figures/kernelshark-all.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernelshark-choose-events.png b/documentation/mega-manual/figures/kernelshark-choose-events.png
new file mode 100644
index 0000000000..e8dd62a571
--- /dev/null
+++ b/documentation/mega-manual/figures/kernelshark-choose-events.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernelshark-i915-display.png b/documentation/mega-manual/figures/kernelshark-i915-display.png
new file mode 100644
index 0000000000..bb0edfb7fd
--- /dev/null
+++ b/documentation/mega-manual/figures/kernelshark-i915-display.png
Binary files differ
diff --git a/documentation/mega-manual/figures/kernelshark-output-display.png b/documentation/mega-manual/figures/kernelshark-output-display.png
new file mode 100644
index 0000000000..ae2d0e5730
--- /dev/null
+++ b/documentation/mega-manual/figures/kernelshark-output-display.png
Binary files differ
diff --git a/documentation/mega-manual/figures/layer-input.png b/documentation/mega-manual/figures/layer-input.png
new file mode 100644
index 0000000000..0a4f2e74f3
--- /dev/null
+++ b/documentation/mega-manual/figures/layer-input.png
Binary files differ
diff --git a/documentation/mega-manual/figures/lttngmain0.png b/documentation/mega-manual/figures/lttngmain0.png
new file mode 100644
index 0000000000..5f60113cc3
--- /dev/null
+++ b/documentation/mega-manual/figures/lttngmain0.png
Binary files differ
diff --git a/documentation/mega-manual/figures/oprofileui-busybox.png b/documentation/mega-manual/figures/oprofileui-busybox.png
new file mode 100644
index 0000000000..a8275c65d2
--- /dev/null
+++ b/documentation/mega-manual/figures/oprofileui-busybox.png
Binary files differ
diff --git a/documentation/mega-manual/figures/oprofileui-copy-to-user.png b/documentation/mega-manual/figures/oprofileui-copy-to-user.png
new file mode 100644
index 0000000000..deb6470204
--- /dev/null
+++ b/documentation/mega-manual/figures/oprofileui-copy-to-user.png
Binary files differ
diff --git a/documentation/mega-manual/figures/oprofileui-downloading.png b/documentation/mega-manual/figures/oprofileui-downloading.png
new file mode 100644
index 0000000000..57742d6723
--- /dev/null
+++ b/documentation/mega-manual/figures/oprofileui-downloading.png
Binary files differ
diff --git a/documentation/mega-manual/figures/oprofileui-processes.png b/documentation/mega-manual/figures/oprofileui-processes.png
new file mode 100644
index 0000000000..ae547028f4
--- /dev/null
+++ b/documentation/mega-manual/figures/oprofileui-processes.png
Binary files differ
diff --git a/documentation/mega-manual/figures/package-feeds.png b/documentation/mega-manual/figures/package-feeds.png
new file mode 100644
index 0000000000..4bc311f3d6
--- /dev/null
+++ b/documentation/mega-manual/figures/package-feeds.png
Binary files differ
diff --git a/documentation/mega-manual/figures/patching.png b/documentation/mega-manual/figures/patching.png
new file mode 100644
index 0000000000..8ecd018502
--- /dev/null
+++ b/documentation/mega-manual/figures/patching.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-probe-do_fork-profile.png b/documentation/mega-manual/figures/perf-probe-do_fork-profile.png
new file mode 100644
index 0000000000..1a1070deb8
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-probe-do_fork-profile.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-report-cycles-u.png b/documentation/mega-manual/figures/perf-report-cycles-u.png
new file mode 100644
index 0000000000..68ec6af80b
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-report-cycles-u.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-systemwide-libc.png b/documentation/mega-manual/figures/perf-systemwide-libc.png
new file mode 100644
index 0000000000..2b72869c77
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-systemwide-libc.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-systemwide.png b/documentation/mega-manual/figures/perf-systemwide.png
new file mode 100644
index 0000000000..12ce2444ae
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-systemwide.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-busybox-annotate-menu.png b/documentation/mega-manual/figures/perf-wget-busybox-annotate-menu.png
new file mode 100644
index 0000000000..ceb34eaead
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-busybox-annotate-menu.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-busybox-annotate-udhcpc.png b/documentation/mega-manual/figures/perf-wget-busybox-annotate-udhcpc.png
new file mode 100644
index 0000000000..3581e9daa6
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-busybox-annotate-udhcpc.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-busybox-debuginfo.png b/documentation/mega-manual/figures/perf-wget-busybox-debuginfo.png
new file mode 100644
index 0000000000..c317b49a4e
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-busybox-debuginfo.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-busybox-dso-zoom-menu.png b/documentation/mega-manual/figures/perf-wget-busybox-dso-zoom-menu.png
new file mode 100644
index 0000000000..1913c867d0
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-busybox-dso-zoom-menu.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-busybox-dso-zoom.png b/documentation/mega-manual/figures/perf-wget-busybox-dso-zoom.png
new file mode 100644
index 0000000000..a1962c437a
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-busybox-dso-zoom.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-busybox-expanded-stripped.png b/documentation/mega-manual/figures/perf-wget-busybox-expanded-stripped.png
new file mode 100644
index 0000000000..b642d06c8b
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-busybox-expanded-stripped.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-flat-stripped.png b/documentation/mega-manual/figures/perf-wget-flat-stripped.png
new file mode 100644
index 0000000000..c8f395ab53
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-flat-stripped.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.png b/documentation/mega-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.png
new file mode 100644
index 0000000000..bb7c764ce0
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.png b/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.png
new file mode 100644
index 0000000000..a799af5127
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png b/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png
new file mode 100644
index 0000000000..e91808ae40
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png
Binary files differ
diff --git a/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.png b/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.png
new file mode 100644
index 0000000000..812302d0a8
--- /dev/null
+++ b/documentation/mega-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.png
Binary files differ
diff --git a/documentation/mega-manual/figures/poky-title.png b/documentation/mega-manual/figures/poky-title.png
new file mode 100644
index 0000000000..2893d84620
--- /dev/null
+++ b/documentation/mega-manual/figures/poky-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/profile-title.png b/documentation/mega-manual/figures/profile-title.png
new file mode 100644
index 0000000000..ce5c682b58
--- /dev/null
+++ b/documentation/mega-manual/figures/profile-title.png
Binary files differ
diff --git a/documentation/mega-manual/figures/pybootchartgui-linux-yocto.png b/documentation/mega-manual/figures/pybootchartgui-linux-yocto.png
new file mode 100644
index 0000000000..2b6bfdacf9
--- /dev/null
+++ b/documentation/mega-manual/figures/pybootchartgui-linux-yocto.png
Binary files differ
diff --git a/documentation/mega-manual/figures/pychart-linux-yocto-rpm-nostrip.png b/documentation/mega-manual/figures/pychart-linux-yocto-rpm-nostrip.png
new file mode 100644
index 0000000000..444675c543
--- /dev/null
+++ b/documentation/mega-manual/figures/pychart-linux-yocto-rpm-nostrip.png
Binary files differ
diff --git a/documentation/mega-manual/figures/pychart-linux-yocto-rpm.png b/documentation/mega-manual/figures/pychart-linux-yocto-rpm.png
new file mode 100644
index 0000000000..8ee35352d8
--- /dev/null
+++ b/documentation/mega-manual/figures/pychart-linux-yocto-rpm.png
Binary files differ
diff --git a/documentation/mega-manual/figures/sched-wakeup-profile.png b/documentation/mega-manual/figures/sched-wakeup-profile.png
new file mode 100644
index 0000000000..2f25811889
--- /dev/null
+++ b/documentation/mega-manual/figures/sched-wakeup-profile.png
Binary files differ
diff --git a/documentation/mega-manual/figures/sdk-generation.png b/documentation/mega-manual/figures/sdk-generation.png
new file mode 100644
index 0000000000..c37e2748ca
--- /dev/null
+++ b/documentation/mega-manual/figures/sdk-generation.png
Binary files differ
diff --git a/documentation/mega-manual/figures/sdk.png b/documentation/mega-manual/figures/sdk.png
new file mode 100644
index 0000000000..a539cc52f0
--- /dev/null
+++ b/documentation/mega-manual/figures/sdk.png
Binary files differ
diff --git a/documentation/mega-manual/figures/source-fetching.png b/documentation/mega-manual/figures/source-fetching.png
new file mode 100644
index 0000000000..26aefb50c2
--- /dev/null
+++ b/documentation/mega-manual/figures/source-fetching.png
Binary files differ
diff --git a/documentation/mega-manual/figures/source-input.png b/documentation/mega-manual/figures/source-input.png
new file mode 100644
index 0000000000..f7515058ef
--- /dev/null
+++ b/documentation/mega-manual/figures/source-input.png
Binary files differ
diff --git a/documentation/mega-manual/figures/source-repos.png b/documentation/mega-manual/figures/source-repos.png
new file mode 100644
index 0000000000..65c5f29a43
--- /dev/null
+++ b/documentation/mega-manual/figures/source-repos.png
Binary files differ
diff --git a/documentation/mega-manual/figures/sysprof-callers.png b/documentation/mega-manual/figures/sysprof-callers.png
new file mode 100644
index 0000000000..640c8d9140
--- /dev/null
+++ b/documentation/mega-manual/figures/sysprof-callers.png
Binary files differ
diff --git a/documentation/mega-manual/figures/sysprof-copy-from-user.png b/documentation/mega-manual/figures/sysprof-copy-from-user.png
new file mode 100644
index 0000000000..8d31427824
--- /dev/null
+++ b/documentation/mega-manual/figures/sysprof-copy-from-user.png
Binary files differ
diff --git a/documentation/mega-manual/figures/sysprof-copy-to-user.png b/documentation/mega-manual/figures/sysprof-copy-to-user.png
new file mode 100644
index 0000000000..7a5bab7991
--- /dev/null
+++ b/documentation/mega-manual/figures/sysprof-copy-to-user.png
Binary files differ
diff --git a/documentation/mega-manual/figures/user-configuration.png b/documentation/mega-manual/figures/user-configuration.png
new file mode 100644
index 0000000000..f2b3f8e7fe
--- /dev/null
+++ b/documentation/mega-manual/figures/user-configuration.png
Binary files differ
diff --git a/documentation/mega-manual/figures/using-a-pre-built-image.png b/documentation/mega-manual/figures/using-a-pre-built-image.png
new file mode 100644
index 0000000000..b03130d123
--- /dev/null
+++ b/documentation/mega-manual/figures/using-a-pre-built-image.png
Binary files differ
diff --git a/documentation/mega-manual/figures/yocto-environment-ref.png b/documentation/mega-manual/figures/yocto-environment-ref.png
new file mode 100644
index 0000000000..650c6c8030
--- /dev/null
+++ b/documentation/mega-manual/figures/yocto-environment-ref.png
Binary files differ
diff --git a/documentation/mega-manual/figures/yocto-environment.png b/documentation/mega-manual/figures/yocto-environment.png
new file mode 100644
index 0000000000..82b7a55a35
--- /dev/null
+++ b/documentation/mega-manual/figures/yocto-environment.png
Binary files differ
diff --git a/documentation/mega-manual/figures/yocto-project-transp.png b/documentation/mega-manual/figures/yocto-project-transp.png
new file mode 100755
index 0000000000..31d2b147fd
--- /dev/null
+++ b/documentation/mega-manual/figures/yocto-project-transp.png
Binary files differ
diff --git a/documentation/mega-manual/figures/yp-download.png b/documentation/mega-manual/figures/yp-download.png
new file mode 100644
index 0000000000..7f1e5ca118
--- /dev/null
+++ b/documentation/mega-manual/figures/yp-download.png
Binary files differ
diff --git a/documentation/mega-manual/mega-manual-customization.xsl b/documentation/mega-manual/mega-manual-customization.xsl
new file mode 100644
index 0000000000..3be182d6c2
--- /dev/null
+++ b/documentation/mega-manual/mega-manual-customization.xsl
@@ -0,0 +1,8 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="generate.toc" select="'chapter toc'"></xsl:param>
7
8</xsl:stylesheet>
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml
new file mode 100644
index 0000000000..01af789aed
--- /dev/null
+++ b/documentation/mega-manual/mega-manual.xml
@@ -0,0 +1,53 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5
6<book id='mega-manual' lang='en'
7 xmlns:xi="http://www.w3.org/2003/XInclude"
8 xmlns="http://docbook.org/ns/docbook"
9 >
10
11 <xi:include
12 xmlns:xi="http://www.w3.org/2003/XInclude" href="../yocto-project-qs/yocto-project-qs.xml"/>
13
14<para><imagedata fileref="figures/dev-title.png" width="100%" align="left" scalefit="1" /></para>
15
16 <xi:include
17 xmlns:xi="http://www.w3.org/2003/XInclude" href="../dev-manual/dev-manual.xml"/>
18
19<para><imagedata fileref="figures/adt-title.png" width="100%" align="left" scalefit="1" /></para>
20
21 <xi:include
22 xmlns:xi="http://www.w3.org/2003/XInclude" href="../adt-manual/adt-manual.xml"/>
23
24<para><imagedata fileref="figures/bsp-title.png" width="100%" align="left" scalefit="1" /></para>
25
26 <xi:include
27 xmlns:xi="http://www.w3.org/2003/XInclude" href="../bsp-guide/bsp-guide.xml"/>
28
29<para><imagedata fileref="figures/kernel-dev-title.png" width="100%" align="left" scalefit="1" /></para>
30
31 <xi:include
32 xmlns:xi="http://www.w3.org/2003/XInclude" href="../kernel-dev/kernel-dev.xml"/>
33
34<para><imagedata fileref="figures/profile-title.png" width="100%" align="left" scalefit="1" /></para>
35
36 <xi:include
37 xmlns:xi="http://www.w3.org/2003/XInclude" href="../profile-manual/profile-manual.xml"/>
38
39<para><imagedata fileref="figures/poky-title.png" width="100%" align="left" scalefit="1" /></para>
40
41 <xi:include
42 xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-manual.xml"/>
43
44<!-- <index id='index'>
45 <title>Index</title>
46 </index>
47-->
48
49</book>
50
51<!--
52vim: expandtab tw=80 ts=4
53-->
diff --git a/documentation/mega-manual/mega-style.css b/documentation/mega-manual/mega-style.css
new file mode 100644
index 0000000000..a97d691836
--- /dev/null
+++ b/documentation/mega-manual/mega-style.css
@@ -0,0 +1,979 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("../figures/yocto-project-bw.png");
122 background-position: top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 50px;
126 text-align: center;
127 width: 600px;
128}
129
130h3.author {
131 margin: 0em 0em 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/yocto-project-bw.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
979
diff --git a/documentation/poky.ent b/documentation/poky.ent
new file mode 100644
index 0000000000..ef00fcec74
--- /dev/null
+++ b/documentation/poky.ent
@@ -0,0 +1,65 @@
1<!ENTITY DISTRO "1.5.1">
2<!ENTITY DISTRO_COMPRESSED "151">
3<!ENTITY DISTRO_NAME "dora">
4<!ENTITY YOCTO_DOC_VERSION "1.5.1">
5<!ENTITY POKYVERSION "10.0.1">
6<!ENTITY POKYVERSION_COMPRESSED "1001">
7<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME;-&POKYVERSION;">
8<!ENTITY COPYRIGHT_YEAR "2010-2013">
9<!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org">
10<!ENTITY YOCTO_HOME_URL "http://www.yoctoproject.org">
11<!ENTITY YOCTO_LISTS_URL "http://lists.yoctoproject.org">
12<!ENTITY YOCTO_BUGZILLA_URL "http://bugzilla.yoctoproject.org">
13<!ENTITY YOCTO_WIKI_URL "https://wiki.yoctoproject.org">
14<!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org">
15<!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org">
16<!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org">
17<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/download/yocto-project-&DISTRO_COMPRESSED;-poky-&POKYVERSION_COMPRESSED;">
18<!ENTITY OE_HOME_URL "http://www.openembedded.org">
19<!ENTITY OE_LISTS_URL "http://lists.linuxtogo.org/cgi-bin/mailman">
20<!ENTITY OE_DOCS_URL "http://docs.openembedded.org">
21<!ENTITY OH_HOME_URL "http://o-hand.com">
22<!ENTITY BITBAKE_HOME_URL "http://developer.berlios.de/projects/bitbake/">
23<!ENTITY ECLIPSE_MAIN_URL "http://www.eclipse.org/downloads">
24<!ENTITY ECLIPSE_DL_URL "http://download.eclipse.org">
25<!ENTITY ECLIPSE_DL_PLUGIN_URL "&YOCTO_DL_URL;/releases/eclipse-plugin/&DISTRO;">
26<!ENTITY ECLIPSE_UPDATES_URL "&ECLIPSE_DL_URL;/tm/updates/3.3">
27<!ENTITY ECLIPSE_INDIGO_URL "&ECLIPSE_DL_URL;/releases/indigo">
28<!ENTITY ECLIPSE_JUNO_URL "&ECLIPSE_DL_URL;/releases/juno">
29<!ENTITY ECLIPSE_KEPLER_URL "&ECLIPSE_DL_URL;/releases/kepler">
30<!ENTITY ECLIPSE_INDIGO_CDT_URL "&ECLIPSE_DL_URL;tools/cdt/releases/indigo">
31<!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs">
32<!ENTITY YOCTO_SOURCES_URL "&YOCTO_HOME_URL;/sources/">
33<!ENTITY YOCTO_AB_PORT_URL "&YOCTO_AB_URL;:8010">
34<!ENTITY YOCTO_AB_NIGHTLY_URL "&YOCTO_AB_URL;/nightly/">
35<!ENTITY YOCTO_POKY_URL "&YOCTO_DL_URL;/releases/poky/">
36<!ENTITY YOCTO_RELEASE_DL_URL "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;">
37<!ENTITY YOCTO_TOOLCHAIN_DL_URL "&YOCTO_RELEASE_DL_URL;/toolchain/">
38<!ENTITY YOCTO_ECLIPSE_DL_URL "&YOCTO_RELEASE_DL_URL;/eclipse-plugin/indigo;">
39<!ENTITY YOCTO_ADTINSTALLER_DL_URL "&YOCTO_RELEASE_DL_URL;/adt-installer">
40<!ENTITY YOCTO_POKY_DL_URL "&YOCTO_RELEASE_DL_URL;/&YOCTO_POKY;.tar.bz2">
41<!ENTITY YOCTO_MACHINES_DL_URL "&YOCTO_RELEASE_DL_URL;/machines">
42<!ENTITY YOCTO_QEMU_DL_URL "&YOCTO_MACHINES_DL_URL;/qemu">
43<!ENTITY YOCTO_PYTHON-i686_DL_URL "&YOCTO_DL_URL;/releases/miscsupport/python-nativesdk-standalone-i686.tar.bz2">
44<!ENTITY YOCTO_PYTHON-x86_64_DL_URL "&YOCTO_DL_URL;/releases/miscsupport/python-nativesdk-standalone-x86_64.tar.bz2">
45<!ENTITY YOCTO_DOCS_QS_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/yocto-project-qs/yocto-project-qs.html">
46<!ENTITY YOCTO_DOCS_ADT_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/adt-manual/adt-manual.html">
47<!ENTITY YOCTO_DOCS_REF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/ref-manual/ref-manual.html">
48<!ENTITY YOCTO_DOCS_BSP_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/bsp-guide/bsp-guide.html">
49<!ENTITY YOCTO_DOCS_DEV_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/dev-manual/dev-manual.html">
50<!ENTITY YOCTO_DOCS_KERNEL_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-manual/kernel-manual.html">
51<!ENTITY YOCTO_DOCS_KERNEL_DEV_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/kernel-dev/kernel-dev.html">
52<!ENTITY YOCTO_DOCS_PROF_URL "&YOCTO_DOCS_URL;/&YOCTO_DOC_VERSION;/profile-manual/profile-manual.html">
53<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;">
54<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
55<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
56<!ENTITY OE_INIT_FILE "oe-init-build-env">
57<!ENTITY UBUNTU_HOST_PACKAGES_ESSENTIAL "gawk wget git-core diffstat unzip texinfo \
58 build-essential chrpath">
59<!ENTITY FEDORA_HOST_PACKAGES_ESSENTIAL "gawk make wget tar bzip2 gzip python unzip perl patch \
60 diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
61 ccache perl-Data-Dumper perl-Text-ParseWords">
62<!ENTITY OPENSUSE_HOST_PACKAGES_ESSENTIAL "python gcc gcc-c++ git chrpath make wget python-xml \
63 diffstat texinfo python-curses patch">
64<!ENTITY CENTOS_HOST_PACKAGES_ESSENTIAL "gawk make wget tar bzip2 gzip python unzip perl patch \
65 diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath">
diff --git a/documentation/profile-manual/figures/kernelshark-all.png b/documentation/profile-manual/figures/kernelshark-all.png
new file mode 100644
index 0000000000..99b40bafe5
--- /dev/null
+++ b/documentation/profile-manual/figures/kernelshark-all.png
Binary files differ
diff --git a/documentation/profile-manual/figures/kernelshark-choose-events.png b/documentation/profile-manual/figures/kernelshark-choose-events.png
new file mode 100644
index 0000000000..e8dd62a571
--- /dev/null
+++ b/documentation/profile-manual/figures/kernelshark-choose-events.png
Binary files differ
diff --git a/documentation/profile-manual/figures/kernelshark-i915-display.png b/documentation/profile-manual/figures/kernelshark-i915-display.png
new file mode 100644
index 0000000000..bb0edfb7fd
--- /dev/null
+++ b/documentation/profile-manual/figures/kernelshark-i915-display.png
Binary files differ
diff --git a/documentation/profile-manual/figures/kernelshark-output-display.png b/documentation/profile-manual/figures/kernelshark-output-display.png
new file mode 100644
index 0000000000..ae2d0e5730
--- /dev/null
+++ b/documentation/profile-manual/figures/kernelshark-output-display.png
Binary files differ
diff --git a/documentation/profile-manual/figures/lttngmain0.png b/documentation/profile-manual/figures/lttngmain0.png
new file mode 100644
index 0000000000..5f60113cc3
--- /dev/null
+++ b/documentation/profile-manual/figures/lttngmain0.png
Binary files differ
diff --git a/documentation/profile-manual/figures/oprofileui-busybox.png b/documentation/profile-manual/figures/oprofileui-busybox.png
new file mode 100644
index 0000000000..a8275c65d2
--- /dev/null
+++ b/documentation/profile-manual/figures/oprofileui-busybox.png
Binary files differ
diff --git a/documentation/profile-manual/figures/oprofileui-copy-to-user.png b/documentation/profile-manual/figures/oprofileui-copy-to-user.png
new file mode 100644
index 0000000000..deb6470204
--- /dev/null
+++ b/documentation/profile-manual/figures/oprofileui-copy-to-user.png
Binary files differ
diff --git a/documentation/profile-manual/figures/oprofileui-downloading.png b/documentation/profile-manual/figures/oprofileui-downloading.png
new file mode 100644
index 0000000000..57742d6723
--- /dev/null
+++ b/documentation/profile-manual/figures/oprofileui-downloading.png
Binary files differ
diff --git a/documentation/profile-manual/figures/oprofileui-processes.png b/documentation/profile-manual/figures/oprofileui-processes.png
new file mode 100644
index 0000000000..ae547028f4
--- /dev/null
+++ b/documentation/profile-manual/figures/oprofileui-processes.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-probe-do_fork-profile.png b/documentation/profile-manual/figures/perf-probe-do_fork-profile.png
new file mode 100644
index 0000000000..1a1070deb8
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-probe-do_fork-profile.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-report-cycles-u.png b/documentation/profile-manual/figures/perf-report-cycles-u.png
new file mode 100644
index 0000000000..68ec6af80b
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-report-cycles-u.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-systemwide-libc.png b/documentation/profile-manual/figures/perf-systemwide-libc.png
new file mode 100644
index 0000000000..2b72869c77
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-systemwide-libc.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-systemwide.png b/documentation/profile-manual/figures/perf-systemwide.png
new file mode 100644
index 0000000000..12ce2444ae
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-systemwide.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-busybox-annotate-menu.png b/documentation/profile-manual/figures/perf-wget-busybox-annotate-menu.png
new file mode 100644
index 0000000000..ceb34eaead
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-busybox-annotate-menu.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-busybox-annotate-udhcpc.png b/documentation/profile-manual/figures/perf-wget-busybox-annotate-udhcpc.png
new file mode 100644
index 0000000000..3581e9daa6
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-busybox-annotate-udhcpc.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-busybox-debuginfo.png b/documentation/profile-manual/figures/perf-wget-busybox-debuginfo.png
new file mode 100644
index 0000000000..c317b49a4e
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-busybox-debuginfo.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-busybox-dso-zoom-menu.png b/documentation/profile-manual/figures/perf-wget-busybox-dso-zoom-menu.png
new file mode 100644
index 0000000000..1913c867d0
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-busybox-dso-zoom-menu.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-busybox-dso-zoom.png b/documentation/profile-manual/figures/perf-wget-busybox-dso-zoom.png
new file mode 100644
index 0000000000..a1962c437a
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-busybox-dso-zoom.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-busybox-expanded-stripped.png b/documentation/profile-manual/figures/perf-wget-busybox-expanded-stripped.png
new file mode 100644
index 0000000000..b642d06c8b
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-busybox-expanded-stripped.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-flat-stripped.png b/documentation/profile-manual/figures/perf-wget-flat-stripped.png
new file mode 100644
index 0000000000..c8f395ab53
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-flat-stripped.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.png b/documentation/profile-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.png
new file mode 100644
index 0000000000..bb7c764ce0
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-g-copy-from-user-expanded-stripped.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.png b/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.png
new file mode 100644
index 0000000000..a799af5127
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-debuginfo.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png b/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png
new file mode 100644
index 0000000000..e91808ae40
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped-unresolved-hidden.png
Binary files differ
diff --git a/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.png b/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.png
new file mode 100644
index 0000000000..812302d0a8
--- /dev/null
+++ b/documentation/profile-manual/figures/perf-wget-g-copy-to-user-expanded-stripped.png
Binary files differ
diff --git a/documentation/profile-manual/figures/profile-title.png b/documentation/profile-manual/figures/profile-title.png
new file mode 100644
index 0000000000..ce5c682b58
--- /dev/null
+++ b/documentation/profile-manual/figures/profile-title.png
Binary files differ
diff --git a/documentation/profile-manual/figures/pybootchartgui-linux-yocto.png b/documentation/profile-manual/figures/pybootchartgui-linux-yocto.png
new file mode 100644
index 0000000000..2b6bfdacf9
--- /dev/null
+++ b/documentation/profile-manual/figures/pybootchartgui-linux-yocto.png
Binary files differ
diff --git a/documentation/profile-manual/figures/pychart-linux-yocto-rpm-nostrip.png b/documentation/profile-manual/figures/pychart-linux-yocto-rpm-nostrip.png
new file mode 100644
index 0000000000..444675c543
--- /dev/null
+++ b/documentation/profile-manual/figures/pychart-linux-yocto-rpm-nostrip.png
Binary files differ
diff --git a/documentation/profile-manual/figures/pychart-linux-yocto-rpm.png b/documentation/profile-manual/figures/pychart-linux-yocto-rpm.png
new file mode 100644
index 0000000000..8ee35352d8
--- /dev/null
+++ b/documentation/profile-manual/figures/pychart-linux-yocto-rpm.png
Binary files differ
diff --git a/documentation/profile-manual/figures/sched-wakeup-profile.png b/documentation/profile-manual/figures/sched-wakeup-profile.png
new file mode 100644
index 0000000000..2f25811889
--- /dev/null
+++ b/documentation/profile-manual/figures/sched-wakeup-profile.png
Binary files differ
diff --git a/documentation/profile-manual/figures/sysprof-callers.png b/documentation/profile-manual/figures/sysprof-callers.png
new file mode 100644
index 0000000000..640c8d9140
--- /dev/null
+++ b/documentation/profile-manual/figures/sysprof-callers.png
Binary files differ
diff --git a/documentation/profile-manual/figures/sysprof-copy-from-user.png b/documentation/profile-manual/figures/sysprof-copy-from-user.png
new file mode 100644
index 0000000000..8d31427824
--- /dev/null
+++ b/documentation/profile-manual/figures/sysprof-copy-from-user.png
Binary files differ
diff --git a/documentation/profile-manual/figures/sysprof-copy-to-user.png b/documentation/profile-manual/figures/sysprof-copy-to-user.png
new file mode 100644
index 0000000000..7a5bab7991
--- /dev/null
+++ b/documentation/profile-manual/figures/sysprof-copy-to-user.png
Binary files differ
diff --git a/documentation/profile-manual/profile-manual-arch.xml b/documentation/profile-manual/profile-manual-arch.xml
new file mode 100644
index 0000000000..19d1155229
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-arch.xml
@@ -0,0 +1,45 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='profile-manual-arch'>
6
7<title>Overall Architecture of the Linux Tracing and Profiling Tools</title>
8
9<section id='architecture-of-the-tracing-and-profiling-tools'>
10 <title>Architecture of the Tracing and Profiling Tools</title>
11
12 <para>
13 It may seem surprising to see a section covering an 'overall architecture'
14 for what seems to be a random collection of tracing tools that together
15 make up the Linux tracing and profiling space.
16 The fact is, however, that in recent years this seemingly disparate
17 set of tools has started to converge on a 'core' set of underlying
18 mechanisms:
19 </para>
20
21 <para>
22 <itemizedlist>
23 <listitem>static tracepoints</listitem>
24 <listitem>dynamic tracepoints
25 <itemizedlist>
26 <listitem>kprobes</listitem>
27 <listitem>uprobes</listitem>
28 </itemizedlist>
29 </listitem>
30 <listitem>the perf_events subsystem</listitem>
31 <listitem>debugfs</listitem>
32 </itemizedlist>
33 </para>
34
35 <informalexample>
36 <emphasis>Tying it Together:</emphasis> Rather than enumerating here how each tool makes use of
37 these common mechanisms, textboxes like this will make note of the
38 specific usages in each tool as they come up in the course
39 of the text.
40 </informalexample>
41</section>
42</chapter>
43<!--
44vim: expandtab tw=80 ts=4
45-->
diff --git a/documentation/profile-manual/profile-manual-customization.xsl b/documentation/profile-manual/profile-manual-customization.xsl
new file mode 100644
index 0000000000..ead52ee7ac
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-customization.xsl
@@ -0,0 +1,11 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="html.stylesheet" select="'profile-manual-style.css'" />
7 <xsl:param name="chapter.autolabel" select="1" />
8 <xsl:param name="appendix.autolabel">A</xsl:param>
9 <xsl:param name="section.autolabel" select="1" />
10 <xsl:param name="section.label.includes.component.label" select="1" />
11</xsl:stylesheet>
diff --git a/documentation/profile-manual/profile-manual-eclipse-customization.xsl b/documentation/profile-manual/profile-manual-eclipse-customization.xsl
new file mode 100644
index 0000000000..e4ff6e99ab
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-eclipse-customization.xsl
@@ -0,0 +1,27 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10
11 <xsl:param name="chunker.output.indent" select="'yes'"/>
12 <xsl:param name="chunk.quietly" select="1"/>
13 <xsl:param name="chunk.first.sections" select="1"/>
14 <xsl:param name="chunk.section.depth" select="10"/>
15 <xsl:param name="use.id.as.filename" select="1"/>
16 <xsl:param name="ulink.target" select="'_self'" />
17 <xsl:param name="base.dir" select="'html/profile-manual/'"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="chapter.autolabel" select="1" />
24 <xsl:param name="appendix.autolabel">A</xsl:param>
25 <xsl:param name="section.autolabel" select="1" />
26 <xsl:param name="section.label.includes.component.label" select="1" />
27</xsl:stylesheet>
diff --git a/documentation/profile-manual/profile-manual-examples.xml b/documentation/profile-manual/profile-manual-examples.xml
new file mode 100644
index 0000000000..9630c6c307
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-examples.xml
@@ -0,0 +1,39 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='profile-manual-examples'>
6
7<title>Real-World Examples</title>
8
9<para>
10 This chapter contains real-world examples.
11</para>
12
13<section id='slow-write-speed-on-live-images'>
14 <title>Slow Write Speed on Live Images</title>
15
16 <para>
17 In one of our previous releases (denzil), users noticed that booting
18 off of a live image and writing to disk was noticeably slower.
19 This included the boot itself, especially the first one, since first
20 boots tend to do a significant amount of writing due to certain
21 post-install scripts.
22 </para>
23
24 <para>
25 The problem (and solution) was discovered by using the Yocto tracing
26 tools, in this case 'perf stat', 'perf script', 'perf record'
27 and 'perf report'.
28 </para>
29
30 <para>
31 See all the unvarnished details of how this bug was diagnosed and
32 solved here: Yocto Bug #3049
33 </para>
34</section>
35
36</chapter>
37<!--
38vim: expandtab tw=80 ts=4
39-->
diff --git a/documentation/profile-manual/profile-manual-intro.xml b/documentation/profile-manual/profile-manual-intro.xml
new file mode 100644
index 0000000000..9ed807f356
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-intro.xml
@@ -0,0 +1,102 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='profile-manual-intro'>
6
7<title>Yocto Project Tracing and Profiling Manual</title>
8 <section id='intro'>
9 <title>Introduction</title>
10
11 <para>
12 Yocto bundles a number of tracing and profiling tools - this 'HOWTO'
13 describes their basic usage and shows by example how to make use
14 of them to examine application and system behavior.
15 </para>
16
17 <para>
18 The tools presented are for the most part completely open-ended and
19 have quite good and/or extensive documentation of their own which
20 can be used to solve just about any problem you might come across
21 in Linux.
22 Each section that describes a particular tool has links to that
23 tool's documentation and website.
24 </para>
25
26 <para>
27 The purpose of this 'HOWTO' is to present a set of common and
28 generally useful tracing and profiling idioms along with their
29 application (as appropriate) to each tool, in the context of a
30 general-purpose 'drill-down' methodology that can be applied
31 to solving a large number (90%?) of problems.
32 For help with more advanced usages and problems, please see
33 the documentation and/or websites listed for each tool.
34 </para>
35
36 <para>
37 The final section of this 'HOWTO' is a collection of real-world
38 examples which we'll be continually adding to as we solve more
39 problems using the tools - feel free to add your own examples
40 to the list!
41 </para>
42 </section>
43
44 <section id='profile-manual-general-setup'>
45 <title>General Setup</title>
46
47 <para>
48 Most of the tools are available only in 'sdk' images or in images
49 built after adding 'tools-profile' to your local.conf.
50 So, in order to be able to access all of the tools described here,
51 please first build and boot an 'sdk' image e.g.
52 <literallayout class='monospaced'>
53 $ bitbake core-image-sato-sdk
54 </literallayout>
55 or alternatively by adding 'tools-profile' to the
56 EXTRA_IMAGE_FEATURES line in your local.conf:
57 <literallayout class='monospaced'>
58 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile"
59 </literallayout>
60 If you use the 'tools-profile' method, you don't need to build an
61 sdk image - the tracing and profiling tools will be included in
62 non-sdk images as well e.g.:
63 <literallayout class='monospaced'>
64 $ bitbake core-image-sato
65 </literallayout>
66 <note><para>
67 By default, the Yocto build system strips symbols from the
68 binaries it packages, which makes it difficult to use some
69 of the tools.
70 </para><para>You can prevent that by putting the following
71 in your local.conf when you build the image:
72 </para>
73 </note>
74 <literallayout class='monospaced'>
75 INHIBIT_PACKAGE_STRIP = "1"
76 </literallayout>
77 The above setting will noticeably increase the size of your image.
78 </para>
79
80 <para>
81 If you've already build a stripped image, you can generate
82 debug packages (xxx-dbg) which you can manually install as
83 needed.
84 </para>
85
86 <para>
87 To generate debug info for packages, you can add dbg-pkgs to
88 EXTRA_IMAGE_FEATURES in local.conf. For example:
89 <literallayout class='monospaced'>
90 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs"
91 </literallayout>
92 Additionally, in order to generate the right type of
93 debuginfo, we also need to add the following to local.conf:
94 <literallayout class='monospaced'>
95 PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory'
96 </literallayout>
97 </para>
98 </section>
99</chapter>
100<!--
101vim: expandtab tw=80 ts=4
102-->
diff --git a/documentation/profile-manual/profile-manual-style.css b/documentation/profile-manual/profile-manual-style.css
new file mode 100644
index 0000000000..7b1b342087
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-style.css
@@ -0,0 +1,978 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("figures/profile-title.png");
122 background-position: left top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 0px;
126 text-align: right;
127 width: 740px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/yocto-project-bw.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
diff --git a/documentation/profile-manual/profile-manual-usage.xml b/documentation/profile-manual/profile-manual-usage.xml
new file mode 100644
index 0000000000..9116d5bf71
--- /dev/null
+++ b/documentation/profile-manual/profile-manual-usage.xml
@@ -0,0 +1,3684 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='profile-manual-usage'>
6
7<title>Basic Usage (with examples) for each of the Yocto Tracing Tools</title>
8
9<para>
10 This chapter presents basic usage examples for each of the tracing
11 tools.
12</para>
13
14<section id='profile-manual-perf'>
15 <title>perf</title>
16
17 <para>
18 The 'perf' tool is the profiling and tracing tool that comes
19 bundled with the Linux kernel.
20 </para>
21
22 <para>
23 Don't let the fact that it's part of the kernel fool you into thinking
24 that it's only for tracing and profiling the kernel - you can indeed
25 use it to trace and profile just the kernel , but you can also use it
26 to profile specific applications separately (with or without kernel
27 context), and you can also use it to trace and profile the kernel
28 and all applications on the system simultaneously to gain a system-wide
29 view of what's going on.
30 </para>
31
32 <para>
33 In many ways, it aims to be a superset of all the tracing and profiling
34 tools available in Linux today, including all the other tools covered
35 in this HOWTO. The past couple of years have seen perf subsume a lot
36 of the functionality of those other tools, and at the same time those
37 other tools have removed large portions of their previous functionality
38 and replaced it with calls to the equivalent functionality now
39 implemented by the perf subsystem. Extrapolation suggests that at
40 some point those other tools will simply become completely redundant
41 and go away; until then, we'll cover those other tools in these pages
42 and in many cases show how the same things can be accomplished in
43 perf and the other tools when it seems useful to do so.
44 </para>
45
46 <para>
47 The coverage below details some of the most common ways you'll likely
48 want to apply the tool; full documentation can be found either within
49 the tool itself or in the man pages at
50 <ulink url='http://linux.die.net/man/1/perf'>perf(1)</ulink>.
51 </para>
52
53 <section id='perf-setup'>
54 <title>Setup</title>
55
56 <para>
57 For this section, we'll assume you've already performed the basic
58 setup outlined in the General Setup section.
59 </para>
60
61 <para>
62 In particular, you'll get the most mileage out of perf if you
63 profile an image built with INHIBIT_PACKAGE_STRIP = "1" in your
64 local.conf.
65 </para>
66
67 <para>
68 perf runs on the target system for the most part. You can archive
69 profile data and copy it to the host for analysis, but for the
70 rest of this document we assume you've ssh'ed to the host and
71 will be running the perf commands on the target.
72 </para>
73 </section>
74
75 <section id='perf-basic-usage'>
76 <title>Basic Usage</title>
77
78 <para>
79 The perf tool is pretty much self-documenting. To remind yourself
80 of the available commands, simply type 'perf', which will show you
81 basic usage along with the available perf subcommands:
82 <literallayout class='monospaced'>
83 root@crownbay:~# perf
84
85 usage: perf [--version] [--help] COMMAND [ARGS]
86
87 The most commonly used perf commands are:
88 annotate Read perf.data (created by perf record) and display annotated code
89 archive Create archive with object files with build-ids found in perf.data file
90 bench General framework for benchmark suites
91 buildid-cache Manage build-id cache.
92 buildid-list List the buildids in a perf.data file
93 diff Read two perf.data files and display the differential profile
94 evlist List the event names in a perf.data file
95 inject Filter to augment the events stream with additional information
96 kmem Tool to trace/measure kernel memory(slab) properties
97 kvm Tool to trace/measure kvm guest os
98 list List all symbolic event types
99 lock Analyze lock events
100 probe Define new dynamic tracepoints
101 record Run a command and record its profile into perf.data
102 report Read perf.data (created by perf record) and display the profile
103 sched Tool to trace/measure scheduler properties (latencies)
104 script Read perf.data (created by perf record) and display trace output
105 stat Run a command and gather performance counter statistics
106 test Runs sanity tests.
107 timechart Tool to visualize total system behavior during a workload
108 top System profiling tool.
109
110 See 'perf help COMMAND' for more information on a specific command.
111 </literallayout>
112 </para>
113
114 <section id='using-perf-to-do-basic-profiling'>
115 <title>Using perf to do Basic Profiling</title>
116
117 <para>
118 As a simple test case, we'll profile the 'wget' of a fairly large
119 file, which is a minimally interesting case because it has both
120 file and network I/O aspects, and at least in the case of standard
121 Yocto images, it's implemented as part of busybox, so the methods
122 we use to analyze it can be used in a very similar way to the whole
123 host of supported busybox applets in Yocto.
124 <literallayout class='monospaced'>
125 root@crownbay:~# rm linux-2.6.19.2.tar.bz2; \
126 wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
127 </literallayout>
128 The quickest and easiest way to get some basic overall data about
129 what's going on for a particular workload it to profile it using
130 'perf stat'. 'perf stat' basically profiles using a few default
131 counters and displays the summed counts at the end of the run:
132 <literallayout class='monospaced'>
133 root@crownbay:~# perf stat wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
134 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
135 linux-2.6.19.2.tar.b 100% |***************************************************| 41727k 0:00:00 ETA
136
137 Performance counter stats for 'wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>':
138
139 4597.223902 task-clock # 0.077 CPUs utilized
140 23568 context-switches # 0.005 M/sec
141 68 CPU-migrations # 0.015 K/sec
142 241 page-faults # 0.052 K/sec
143 3045817293 cycles # 0.663 GHz
144 &lt;not supported&gt; stalled-cycles-frontend
145 &lt;not supported&gt; stalled-cycles-backend
146 858909167 instructions # 0.28 insns per cycle
147 165441165 branches # 35.987 M/sec
148 19550329 branch-misses # 11.82% of all branches
149
150 59.836627620 seconds time elapsed
151 </literallayout>
152 Many times such a simple-minded test doesn't yield much of
153 interest, but sometimes it does (see Real-world Yocto bug
154 (slow loop-mounted write speed)).
155 </para>
156
157 <para>
158 Also, note that 'perf stat' isn't restricted to a fixed set of
159 counters - basically any event listed in the output of 'perf list'
160 can be tallied by 'perf stat'. For example, suppose we wanted to
161 see a summary of all the events related to kernel memory
162 allocation/freeing along with cache hits and misses:
163 <literallayout class='monospaced'>
164 root@crownbay:~# perf stat -e kmem:* -e cache-references -e cache-misses wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
165 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
166 linux-2.6.19.2.tar.b 100% |***************************************************| 41727k 0:00:00 ETA
167
168 Performance counter stats for 'wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>':
169
170 5566 kmem:kmalloc
171 125517 kmem:kmem_cache_alloc
172 0 kmem:kmalloc_node
173 0 kmem:kmem_cache_alloc_node
174 34401 kmem:kfree
175 69920 kmem:kmem_cache_free
176 133 kmem:mm_page_free
177 41 kmem:mm_page_free_batched
178 11502 kmem:mm_page_alloc
179 11375 kmem:mm_page_alloc_zone_locked
180 0 kmem:mm_page_pcpu_drain
181 0 kmem:mm_page_alloc_extfrag
182 66848602 cache-references
183 2917740 cache-misses # 4.365 % of all cache refs
184
185 44.831023415 seconds time elapsed
186 </literallayout>
187 So 'perf stat' gives us a nice easy way to get a quick overview of
188 what might be happening for a set of events, but normally we'd
189 need a little more detail in order to understand what's going on
190 in a way that we can act on in a useful way.
191 </para>
192
193 <para>
194 To dive down into a next level of detail, we can use 'perf
195 record'/'perf report' which will collect profiling data and
196 present it to use using an interactive text-based UI (or
197 simply as text if we specify --stdio to 'perf report').
198 </para>
199
200 <para>
201 As our first attempt at profiling this workload, we'll simply
202 run 'perf record', handing it the workload we want to profile
203 (everything after 'perf record' and any perf options we hand
204 it - here none - will be executedin a new shell). perf collects
205 samples until the process exits and records them in a file named
206 'perf.data' in the current working directory.
207 <literallayout class='monospaced'>
208 root@crownbay:~# perf record wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
209
210 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
211 linux-2.6.19.2.tar.b 100% |************************************************| 41727k 0:00:00 ETA
212 [ perf record: Woken up 1 times to write data ]
213 [ perf record: Captured and wrote 0.176 MB perf.data (~7700 samples) ]
214 </literallayout>
215 To see the results in a 'text-based UI' (tui), simply run
216 'perf report', which will read the perf.data file in the current
217 working directory and display the results in an interactive UI:
218 <literallayout class='monospaced'>
219 root@crownbay:~# perf report
220 </literallayout>
221 </para>
222
223 <para>
224 <imagedata fileref="figures/perf-wget-flat-stripped.png" width="6in" depth="7in" align="center" scalefit="1" />
225 </para>
226
227 <para>
228 The above screenshot displays a 'flat' profile, one entry for
229 each 'bucket' corresponding to the functions that were profiled
230 during the profiling run, ordered from the most popular to the
231 least (perf has options to sort in various orders and keys as
232 well as display entries only above a certain threshold and so
233 on - see the perf documentation for details). Note that this
234 includes both userspace functions (entries containing a [.]) and
235 kernel functions accounted to the process (entries containing
236 a [k]). (perf has command-line modifiers that can be used to
237 restrict the profiling to kernel or userspace, among others).
238 </para>
239
240 <para>
241 Notice also that the above report shows an entry for 'busybox',
242 which is the executable that implements 'wget' in Yocto, but that
243 instead of a useful function name in that entry, it displays
244 an not-so-friendly hex value instead. The steps below will show
245 how to fix that problem.
246 </para>
247
248 <para>
249 Before we do that, however, let's try running a different profile,
250 one which shows something a little more interesting. The only
251 difference between the new profile and the previous one is that
252 we'll add the -g option, which will record not just the address
253 of a sampled function, but the entire callchain to the sampled
254 function as well:
255 <literallayout class='monospaced'>
256 root@crownbay:~# perf record -g wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
257 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
258 linux-2.6.19.2.tar.b 100% |************************************************| 41727k 0:00:00 ETA
259 [ perf record: Woken up 3 times to write data ]
260 [ perf record: Captured and wrote 0.652 MB perf.data (~28476 samples) ]
261
262
263 root@crownbay:~# perf report
264 </literallayout>
265 </para>
266
267 <para>
268 <imagedata fileref="figures/perf-wget-g-copy-to-user-expanded-stripped.png" width="6in" depth="7in" align="center" scalefit="1" />
269 </para>
270
271 <para>
272 Using the callgraph view, we can actually see not only which
273 functions took the most time, but we can also see a summary of
274 how those functions were called and learn something about how the
275 program interacts with the kernel in the process.
276 </para>
277
278 <para>
279 Notice that each entry in the above screenshot now contains a '+'
280 on the left-hand side. This means that we can expand the entry and
281 drill down into the callchains that feed into that entry.
282 Pressing 'enter' on any one of them will expand the callchain
283 (you can also press 'E' to expand them all at the same time or 'C'
284 to collapse them all).
285 </para>
286
287 <para>
288 In the screenshot above, we've toggled the __copy_to_user_ll()
289 entry and several subnodes all the way down. This lets us see
290 which callchains contributed to the profiled __copy_to_user_ll()
291 function which contributed 1.77% to the total profile.
292 </para>
293
294 <para>
295 As a bit of background explanation for these callchains, think
296 about what happens at a high level when you run wget to get a file
297 out on the network. Basically what happens is that the data comes
298 into the kernel via the network connection (socket) and is passed
299 to the userspace program 'wget' (which is actually a part of
300 busybox, but that's not important for now), which takes the buffers
301 the kernel passes to it and writes it to a disk file to save it.
302 </para>
303
304 <para>
305 The part of this process that we're looking at in the above call
306 stacks is the part where the kernel passes the data it's read from
307 the socket down to wget i.e. a copy-to-user.
308 </para>
309
310 <para>
311 Notice also that here there's also a case where the a hex value
312 is displayed in the callstack, here in the expanded
313 sys_clock_gettime() function. Later we'll see it resolve to a
314 userspace function call in busybox.
315 </para>
316
317 <para>
318 <imagedata fileref="figures/perf-wget-g-copy-from-user-expanded-stripped.png" width="6in" depth="7in" align="center" scalefit="1" />
319 </para>
320
321 <para>
322 The above screenshot shows the other half of the journey for the
323 data - from the wget program's userspace buffers to disk. To get
324 the buffers to disk, the wget program issues a write(2), which
325 does a copy-from-user to the kernel, which then takes care via
326 some circuitous path (probably also present somewhere in the
327 profile data), to get it safely to disk.
328 </para>
329
330 <para>
331 Now that we've seen the basic layout of the profile data and the
332 basics of how to extract useful information out of it, let's get
333 back to the task at hand and see if we can get some basic idea
334 about where the time is spent in the program we're profiling,
335 wget. Remember that wget is actually implemented as an applet
336 in busybox, so while the process name is 'wget', the executable
337 we're actually interested in is busybox. So let's expand the
338 first entry containing busybox:
339 </para>
340
341 <para>
342 <imagedata fileref="figures/perf-wget-busybox-expanded-stripped.png" width="6in" depth="7in" align="center" scalefit="1" />
343 </para>
344
345 <para>
346 Again, before we expanded we saw that the function was labeled
347 with a hex value instead of a symbol as with most of the kernel
348 entries. Expanding the busybox entry doesn't make it any better.
349 </para>
350
351 <para>
352 The problem is that perf can't find the symbol information for the
353 busybox binary, which is actually stripped out by the Yocto build
354 system.
355 </para>
356
357 <para>
358 One way around that is to put the following in your local.conf
359 when you build the image:
360 <literallayout class='monospaced'>
361 INHIBIT_PACKAGE_STRIP = "1"
362 </literallayout>
363 However, we already have an image with the binaries stripped,
364 so what can we do to get perf to resolve the symbols? Basically
365 we need to install the debuginfo for the busybox package.
366 </para>
367
368 <para>
369 To generate the debug info for the packages in the image, we can
370 to add dbg-pkgs to EXTRA_IMAGE_FEATURES in local.conf. For example:
371 <literallayout class='monospaced'>
372 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs"
373 </literallayout>
374 Additionally, in order to generate the type of debuginfo that
375 perf understands, we also need to add the following to local.conf:
376 <literallayout class='monospaced'>
377 PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory'
378 </literallayout>
379 Once we've done that, we can install the debuginfo for busybox.
380 The debug packages once built can be found in
381 build/tmp/deploy/rpm/* on the host system. Find the
382 busybox-dbg-...rpm file and copy it to the target. For example:
383 <literallayout class='monospaced'>
384 [trz@empanada core2]$ scp /home/trz/yocto/crownbay-tracing-dbg/build/tmp/deploy/rpm/core2/busybox-dbg-1.20.2-r2.core2.rpm root@192.168.1.31:
385 root@192.168.1.31's password:
386 busybox-dbg-1.20.2-r2.core2.rpm 100% 1826KB 1.8MB/s 00:01
387 </literallayout>
388 Now install the debug rpm on the target:
389 <literallayout class='monospaced'>
390 root@crownbay:~# rpm -i busybox-dbg-1.20.2-r2.core2.rpm
391 </literallayout>
392 Now that the debuginfo is installed, we see that the busybox
393 entries now display their functions symbolically:
394 </para>
395
396 <para>
397 <imagedata fileref="figures/perf-wget-busybox-debuginfo.png" width="6in" depth="7in" align="center" scalefit="1" />
398 </para>
399
400 <para>
401 If we expand one of the entries and press 'enter' on a leaf node,
402 we're presented with a menu of actions we can take to get more
403 information related to that entry:
404 </para>
405
406 <para>
407 <imagedata fileref="figures/perf-wget-busybox-dso-zoom-menu.png" width="6in" depth="2in" align="center" scalefit="1" />
408 </para>
409
410 <para>
411 One of these actions allows us to show a view that displays a
412 busybox-centric view of the profiled functions (in this case we've
413 also expanded all the nodes using the 'E' key):
414 </para>
415
416 <para>
417 <imagedata fileref="figures/perf-wget-busybox-dso-zoom.png" width="6in" depth="7in" align="center" scalefit="1" />
418 </para>
419
420 <para>
421 Finally, we can see that now that the busybox debuginfo is
422 installed, the previously unresolved symbol in the
423 sys_clock_gettime() entry mentioned previously is now resolved,
424 and shows that the sys_clock_gettime system call that was the
425 source of 6.75% of the copy-to-user overhead was initiated by
426 the handle_input() busybox function:
427 </para>
428
429 <para>
430 <imagedata fileref="figures/perf-wget-g-copy-to-user-expanded-debuginfo.png" width="6in" depth="7in" align="center" scalefit="1" />
431 </para>
432
433 <para>
434 At the lowest level of detail, we can dive down to the assembly
435 level and see which instructions caused the most overhead in a
436 function. Pressing 'enter' on the 'udhcpc_main' function, we're
437 again presented with a menu:
438 </para>
439
440 <para>
441 <imagedata fileref="figures/perf-wget-busybox-annotate-menu.png" width="6in" depth="2in" align="center" scalefit="1" />
442 </para>
443
444 <para>
445 Selecting 'Annotate udhcpc_main', we get a detailed listing of
446 percentages by instruction for the udhcpc_main function. From the
447 display, we can see that over 50% of the time spent in this
448 function is taken up by a couple tests and the move of a
449 constant (1) to a register:
450 </para>
451
452 <para>
453 <imagedata fileref="figures/perf-wget-busybox-annotate-udhcpc.png" width="6in" depth="7in" align="center" scalefit="1" />
454 </para>
455
456 <para>
457 As a segue into tracing, let's try another profile using a
458 different counter, something other than the default 'cycles'.
459 </para>
460
461 <para>
462 The tracing and profiling infrastructure in Linux has become
463 unified in a way that allows us to use the same tool with a
464 completely different set of counters, not just the standard
465 hardware counters that traditionally tools have had to restrict
466 themselves to (of course the traditional tools can also make use
467 of the expanded possibilities now available to them, and in some
468 cases have, as mentioned previously).
469 </para>
470
471 <para>
472 We can get a list of the available events that can be used to
473 profile a workload via 'perf list':
474 <literallayout class='monospaced'>
475 root@crownbay:~# perf list
476
477 List of pre-defined events (to be used in -e):
478 cpu-cycles OR cycles [Hardware event]
479 stalled-cycles-frontend OR idle-cycles-frontend [Hardware event]
480 stalled-cycles-backend OR idle-cycles-backend [Hardware event]
481 instructions [Hardware event]
482 cache-references [Hardware event]
483 cache-misses [Hardware event]
484 branch-instructions OR branches [Hardware event]
485 branch-misses [Hardware event]
486 bus-cycles [Hardware event]
487 ref-cycles [Hardware event]
488
489 cpu-clock [Software event]
490 task-clock [Software event]
491 page-faults OR faults [Software event]
492 minor-faults [Software event]
493 major-faults [Software event]
494 context-switches OR cs [Software event]
495 cpu-migrations OR migrations [Software event]
496 alignment-faults [Software event]
497 emulation-faults [Software event]
498
499 L1-dcache-loads [Hardware cache event]
500 L1-dcache-load-misses [Hardware cache event]
501 L1-dcache-prefetch-misses [Hardware cache event]
502 L1-icache-loads [Hardware cache event]
503 L1-icache-load-misses [Hardware cache event]
504 .
505 .
506 .
507 rNNN [Raw hardware event descriptor]
508 cpu/t1=v1[,t2=v2,t3 ...]/modifier [Raw hardware event descriptor]
509 (see 'perf list --help' on how to encode it)
510
511 mem:&lt;addr&gt;[:access] [Hardware breakpoint]
512
513 sunrpc:rpc_call_status [Tracepoint event]
514 sunrpc:rpc_bind_status [Tracepoint event]
515 sunrpc:rpc_connect_status [Tracepoint event]
516 sunrpc:rpc_task_begin [Tracepoint event]
517 skb:kfree_skb [Tracepoint event]
518 skb:consume_skb [Tracepoint event]
519 skb:skb_copy_datagram_iovec [Tracepoint event]
520 net:net_dev_xmit [Tracepoint event]
521 net:net_dev_queue [Tracepoint event]
522 net:netif_receive_skb [Tracepoint event]
523 net:netif_rx [Tracepoint event]
524 napi:napi_poll [Tracepoint event]
525 sock:sock_rcvqueue_full [Tracepoint event]
526 sock:sock_exceed_buf_limit [Tracepoint event]
527 udp:udp_fail_queue_rcv_skb [Tracepoint event]
528 hda:hda_send_cmd [Tracepoint event]
529 hda:hda_get_response [Tracepoint event]
530 hda:hda_bus_reset [Tracepoint event]
531 scsi:scsi_dispatch_cmd_start [Tracepoint event]
532 scsi:scsi_dispatch_cmd_error [Tracepoint event]
533 scsi:scsi_eh_wakeup [Tracepoint event]
534 drm:drm_vblank_event [Tracepoint event]
535 drm:drm_vblank_event_queued [Tracepoint event]
536 drm:drm_vblank_event_delivered [Tracepoint event]
537 random:mix_pool_bytes [Tracepoint event]
538 random:mix_pool_bytes_nolock [Tracepoint event]
539 random:credit_entropy_bits [Tracepoint event]
540 gpio:gpio_direction [Tracepoint event]
541 gpio:gpio_value [Tracepoint event]
542 block:block_rq_abort [Tracepoint event]
543 block:block_rq_requeue [Tracepoint event]
544 block:block_rq_issue [Tracepoint event]
545 block:block_bio_bounce [Tracepoint event]
546 block:block_bio_complete [Tracepoint event]
547 block:block_bio_backmerge [Tracepoint event]
548 .
549 .
550 writeback:writeback_wake_thread [Tracepoint event]
551 writeback:writeback_wake_forker_thread [Tracepoint event]
552 writeback:writeback_bdi_register [Tracepoint event]
553 .
554 .
555 writeback:writeback_single_inode_requeue [Tracepoint event]
556 writeback:writeback_single_inode [Tracepoint event]
557 kmem:kmalloc [Tracepoint event]
558 kmem:kmem_cache_alloc [Tracepoint event]
559 kmem:mm_page_alloc [Tracepoint event]
560 kmem:mm_page_alloc_zone_locked [Tracepoint event]
561 kmem:mm_page_pcpu_drain [Tracepoint event]
562 kmem:mm_page_alloc_extfrag [Tracepoint event]
563 vmscan:mm_vmscan_kswapd_sleep [Tracepoint event]
564 vmscan:mm_vmscan_kswapd_wake [Tracepoint event]
565 vmscan:mm_vmscan_wakeup_kswapd [Tracepoint event]
566 vmscan:mm_vmscan_direct_reclaim_begin [Tracepoint event]
567 .
568 .
569 module:module_get [Tracepoint event]
570 module:module_put [Tracepoint event]
571 module:module_request [Tracepoint event]
572 sched:sched_kthread_stop [Tracepoint event]
573 sched:sched_wakeup [Tracepoint event]
574 sched:sched_wakeup_new [Tracepoint event]
575 sched:sched_process_fork [Tracepoint event]
576 sched:sched_process_exec [Tracepoint event]
577 sched:sched_stat_runtime [Tracepoint event]
578 rcu:rcu_utilization [Tracepoint event]
579 workqueue:workqueue_queue_work [Tracepoint event]
580 workqueue:workqueue_execute_end [Tracepoint event]
581 signal:signal_generate [Tracepoint event]
582 signal:signal_deliver [Tracepoint event]
583 timer:timer_init [Tracepoint event]
584 timer:timer_start [Tracepoint event]
585 timer:hrtimer_cancel [Tracepoint event]
586 timer:itimer_state [Tracepoint event]
587 timer:itimer_expire [Tracepoint event]
588 irq:irq_handler_entry [Tracepoint event]
589 irq:irq_handler_exit [Tracepoint event]
590 irq:softirq_entry [Tracepoint event]
591 irq:softirq_exit [Tracepoint event]
592 irq:softirq_raise [Tracepoint event]
593 printk:console [Tracepoint event]
594 task:task_newtask [Tracepoint event]
595 task:task_rename [Tracepoint event]
596 syscalls:sys_enter_socketcall [Tracepoint event]
597 syscalls:sys_exit_socketcall [Tracepoint event]
598 .
599 .
600 .
601 syscalls:sys_enter_unshare [Tracepoint event]
602 syscalls:sys_exit_unshare [Tracepoint event]
603 raw_syscalls:sys_enter [Tracepoint event]
604 raw_syscalls:sys_exit [Tracepoint event]
605 </literallayout>
606 </para>
607
608 <informalexample>
609 <emphasis>Tying it Together:</emphasis> These are exactly the same set of events defined
610 by the trace event subsystem and exposed by
611 ftrace/tracecmd/kernelshark as files in
612 /sys/kernel/debug/tracing/events, by SystemTap as
613 kernel.trace("tracepoint_name") and (partially) accessed by LTTng.
614 </informalexample>
615
616 <para>
617 Only a subset of these would be of interest to us when looking at
618 this workload, so let's choose the most likely subsystems
619 (identified by the string before the colon in the Tracepoint events)
620 and do a 'perf stat' run using only those wildcarded subsystems:
621 <literallayout class='monospaced'>
622 root@crownbay:~# perf stat -e skb:* -e net:* -e napi:* -e sched:* -e workqueue:* -e irq:* -e syscalls:* wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
623 Performance counter stats for 'wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>':
624
625 23323 skb:kfree_skb
626 0 skb:consume_skb
627 49897 skb:skb_copy_datagram_iovec
628 6217 net:net_dev_xmit
629 6217 net:net_dev_queue
630 7962 net:netif_receive_skb
631 2 net:netif_rx
632 8340 napi:napi_poll
633 0 sched:sched_kthread_stop
634 0 sched:sched_kthread_stop_ret
635 3749 sched:sched_wakeup
636 0 sched:sched_wakeup_new
637 0 sched:sched_switch
638 29 sched:sched_migrate_task
639 0 sched:sched_process_free
640 1 sched:sched_process_exit
641 0 sched:sched_wait_task
642 0 sched:sched_process_wait
643 0 sched:sched_process_fork
644 1 sched:sched_process_exec
645 0 sched:sched_stat_wait
646 2106519415641 sched:sched_stat_sleep
647 0 sched:sched_stat_iowait
648 147453613 sched:sched_stat_blocked
649 12903026955 sched:sched_stat_runtime
650 0 sched:sched_pi_setprio
651 3574 workqueue:workqueue_queue_work
652 3574 workqueue:workqueue_activate_work
653 0 workqueue:workqueue_execute_start
654 0 workqueue:workqueue_execute_end
655 16631 irq:irq_handler_entry
656 16631 irq:irq_handler_exit
657 28521 irq:softirq_entry
658 28521 irq:softirq_exit
659 28728 irq:softirq_raise
660 1 syscalls:sys_enter_sendmmsg
661 1 syscalls:sys_exit_sendmmsg
662 0 syscalls:sys_enter_recvmmsg
663 0 syscalls:sys_exit_recvmmsg
664 14 syscalls:sys_enter_socketcall
665 14 syscalls:sys_exit_socketcall
666 .
667 .
668 .
669 16965 syscalls:sys_enter_read
670 16965 syscalls:sys_exit_read
671 12854 syscalls:sys_enter_write
672 12854 syscalls:sys_exit_write
673 .
674 .
675 .
676
677 58.029710972 seconds time elapsed
678 </literallayout>
679 Let's pick one of these tracepoints and tell perf to do a profile
680 using it as the sampling event:
681 <literallayout class='monospaced'>
682 root@crownbay:~# perf record -g -e sched:sched_wakeup wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
683 </literallayout>
684 </para>
685
686 <para>
687 <imagedata fileref="figures/sched-wakeup-profile.png" width="6in" depth="7in" align="center" scalefit="1" />
688 </para>
689
690 <para>
691 The screenshot above shows the results of running a profile using
692 sched:sched_switch tracepoint, which shows the relative costs of
693 various paths to sched_wakeup (note that sched_wakeup is the
694 name of the tracepoint - it's actually defined just inside
695 ttwu_do_wakeup(), which accounts for the function name actually
696 displayed in the profile:
697 <literallayout class='monospaced'>
698 /*
699 * Mark the task runnable and perform wakeup-preemption.
700 */
701 static void
702 ttwu_do_wakeup(struct rq *rq, struct task_struct *p, int wake_flags)
703 {
704 trace_sched_wakeup(p, true);
705 .
706 .
707 .
708 }
709 </literallayout>
710 A couple of the more interesting callchains are expanded and
711 displayed above, basically some network receive paths that
712 presumably end up waking up wget (busybox) when network data is
713 ready.
714 </para>
715
716 <para>
717 Note that because tracepoints are normally used for tracing,
718 the default sampling period for tracepoints is 1 i.e. for
719 tracepoints perf will sample on every event occurrence (this
720 can be changed using the -c option). This is in contrast to
721 hardware counters such as for example the default 'cycles'
722 hardware counter used for normal profiling, where sampling
723 periods are much higher (in the thousands) because profiling should
724 have as low an overhead as possible and sampling on every cycle
725 would be prohibitively expensive.
726 </para>
727 </section>
728
729 <section id='using-perf-to-do-basic-tracing'>
730 <title>Using perf to do Basic Tracing</title>
731
732 <para>
733 Profiling is a great tool for solving many problems or for
734 getting a high-level view of what's going on with a workload or
735 across the system. It is however by definition an approximation,
736 as suggested by the most prominent word associated with it,
737 'sampling'. On the one hand, it allows a representative picture of
738 what's going on in the system to be cheaply taken, but on the other
739 hand, that cheapness limits its utility when that data suggests a
740 need to 'dive down' more deeply to discover what's really going
741 on. In such cases, the only way to see what's really going on is
742 to be able to look at (or summarize more intelligently) the
743 individual steps that go into the higher-level behavior exposed
744 by the coarse-grained profiling data.
745 </para>
746
747 <para>
748 As a concrete example, we can trace all the events we think might
749 be applicable to our workload:
750 <literallayout class='monospaced'>
751 root@crownbay:~# perf record -g -e skb:* -e net:* -e napi:* -e sched:sched_switch -e sched:sched_wakeup -e irq:*
752 -e syscalls:sys_enter_read -e syscalls:sys_exit_read -e syscalls:sys_enter_write -e syscalls:sys_exit_write
753 wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
754 </literallayout>
755 We can look at the raw trace output using 'perf script' with no
756 arguments:
757 <literallayout class='monospaced'>
758 root@crownbay:~# perf script
759
760 perf 1262 [000] 11624.857082: sys_exit_read: 0x0
761 perf 1262 [000] 11624.857193: sched_wakeup: comm=migration/0 pid=6 prio=0 success=1 target_cpu=000
762 wget 1262 [001] 11624.858021: softirq_raise: vec=1 [action=TIMER]
763 wget 1262 [001] 11624.858074: softirq_entry: vec=1 [action=TIMER]
764 wget 1262 [001] 11624.858081: softirq_exit: vec=1 [action=TIMER]
765 wget 1262 [001] 11624.858166: sys_enter_read: fd: 0x0003, buf: 0xbf82c940, count: 0x0200
766 wget 1262 [001] 11624.858177: sys_exit_read: 0x200
767 wget 1262 [001] 11624.858878: kfree_skb: skbaddr=0xeb248d80 protocol=0 location=0xc15a5308
768 wget 1262 [001] 11624.858945: kfree_skb: skbaddr=0xeb248000 protocol=0 location=0xc15a5308
769 wget 1262 [001] 11624.859020: softirq_raise: vec=1 [action=TIMER]
770 wget 1262 [001] 11624.859076: softirq_entry: vec=1 [action=TIMER]
771 wget 1262 [001] 11624.859083: softirq_exit: vec=1 [action=TIMER]
772 wget 1262 [001] 11624.859167: sys_enter_read: fd: 0x0003, buf: 0xb7720000, count: 0x0400
773 wget 1262 [001] 11624.859192: sys_exit_read: 0x1d7
774 wget 1262 [001] 11624.859228: sys_enter_read: fd: 0x0003, buf: 0xb7720000, count: 0x0400
775 wget 1262 [001] 11624.859233: sys_exit_read: 0x0
776 wget 1262 [001] 11624.859573: sys_enter_read: fd: 0x0003, buf: 0xbf82c580, count: 0x0200
777 wget 1262 [001] 11624.859584: sys_exit_read: 0x200
778 wget 1262 [001] 11624.859864: sys_enter_read: fd: 0x0003, buf: 0xb7720000, count: 0x0400
779 wget 1262 [001] 11624.859888: sys_exit_read: 0x400
780 wget 1262 [001] 11624.859935: sys_enter_read: fd: 0x0003, buf: 0xb7720000, count: 0x0400
781 wget 1262 [001] 11624.859944: sys_exit_read: 0x400
782 </literallayout>
783 This gives us a detailed timestamped sequence of events that
784 occurred within the workload with respect to those events.
785 </para>
786
787 <para>
788 In many ways, profiling can be viewed as a subset of tracing -
789 theoretically, if you have a set of trace events that's sufficient
790 to capture all the important aspects of a workload, you can derive
791 any of the results or views that a profiling run can.
792 </para>
793
794 <para>
795 Another aspect of traditional profiling is that while powerful in
796 many ways, it's limited by the granularity of the underlying data.
797 Profiling tools offer various ways of sorting and presenting the
798 sample data, which make it much more useful and amenable to user
799 experimentation, but in the end it can't be used in an open-ended
800 way to extract data that just isn't present as a consequence of
801 the fact that conceptually, most of it has been thrown away.
802 </para>
803
804 <para>
805 Full-blown detailed tracing data does however offer the opportunity
806 to manipulate and present the information collected during a
807 tracing run in an infinite variety of ways.
808 </para>
809
810 <para>
811 Another way to look at it is that there are only so many ways that
812 the 'primitive' counters can be used on their own to generate
813 interesting output; to get anything more complicated than simple
814 counts requires some amount of additional logic, which is typically
815 very specific to the problem at hand. For example, if we wanted to
816 make use of a 'counter' that maps to the value of the time
817 difference between when a process was scheduled to run on a
818 processor and the time it actually ran, we wouldn't expect such
819 a counter to exist on its own, but we could derive one called say
820 'wakeup_latency' and use it to extract a useful view of that metric
821 from trace data. Likewise, we really can't figure out from standard
822 profiling tools how much data every process on the system reads and
823 writes, along with how many of those reads and writes fail
824 completely. If we have sufficient trace data, however, we could
825 with the right tools easily extract and present that information,
826 but we'd need something other than pre-canned profiling tools to
827 do that.
828 </para>
829
830 <para>
831 Luckily, there is general-purpose way to handle such needs,
832 called 'programming languages'. Making programming languages
833 easily available to apply to such problems given the specific
834 format of data is called a 'programming language binding' for
835 that data and language. Perf supports two programming language
836 bindings, one for Python and one for Perl.
837 </para>
838
839 <informalexample>
840 <emphasis>Tying it Together:</emphasis> Language bindings for manipulating and
841 aggregating trace data are of course not a new
842 idea. One of the first projects to do this was IBM's DProbes
843 dpcc compiler, an ANSI C compiler which targeted a low-level
844 assembly language running on an in-kernel interpreter on the
845 target system. This is exactly analagous to what Sun's DTrace
846 did, except that DTrace invented its own language for the purpose.
847 Systemtap, heavily inspired by DTrace, also created its own
848 one-off language, but rather than running the product on an
849 in-kernel interpreter, created an elaborate compiler-based
850 machinery to translate its language into kernel modules written
851 in C.
852 </informalexample>
853
854 <para>
855 Now that we have the trace data in perf.data, we can use
856 'perf script -g' to generate a skeleton script with handlers
857 for the read/write entry/exit events we recorded:
858 <literallayout class='monospaced'>
859 root@crownbay:~# perf script -g python
860 generated Python script: perf-script.py
861 </literallayout>
862 The skeleton script simply creates a python function for each
863 event type in the perf.data file. The body of each function simply
864 prints the event name along with its parameters. For example:
865 <literallayout class='monospaced'>
866 def net__netif_rx(event_name, context, common_cpu,
867 common_secs, common_nsecs, common_pid, common_comm,
868 skbaddr, len, name):
869 print_header(event_name, common_cpu, common_secs, common_nsecs,
870 common_pid, common_comm)
871
872 print "skbaddr=%u, len=%u, name=%s\n" % (skbaddr, len, name),
873 </literallayout>
874 We can run that script directly to print all of the events
875 contained in the perf.data file:
876 <literallayout class='monospaced'>
877 root@crownbay:~# perf script -s perf-script.py
878
879 in trace_begin
880 syscalls__sys_exit_read 0 11624.857082795 1262 perf nr=3, ret=0
881 sched__sched_wakeup 0 11624.857193498 1262 perf comm=migration/0, pid=6, prio=0, success=1, target_cpu=0
882 irq__softirq_raise 1 11624.858021635 1262 wget vec=TIMER
883 irq__softirq_entry 1 11624.858074075 1262 wget vec=TIMER
884 irq__softirq_exit 1 11624.858081389 1262 wget vec=TIMER
885 syscalls__sys_enter_read 1 11624.858166434 1262 wget nr=3, fd=3, buf=3213019456, count=512
886 syscalls__sys_exit_read 1 11624.858177924 1262 wget nr=3, ret=512
887 skb__kfree_skb 1 11624.858878188 1262 wget skbaddr=3945041280, location=3243922184, protocol=0
888 skb__kfree_skb 1 11624.858945608 1262 wget skbaddr=3945037824, location=3243922184, protocol=0
889 irq__softirq_raise 1 11624.859020942 1262 wget vec=TIMER
890 irq__softirq_entry 1 11624.859076935 1262 wget vec=TIMER
891 irq__softirq_exit 1 11624.859083469 1262 wget vec=TIMER
892 syscalls__sys_enter_read 1 11624.859167565 1262 wget nr=3, fd=3, buf=3077701632, count=1024
893 syscalls__sys_exit_read 1 11624.859192533 1262 wget nr=3, ret=471
894 syscalls__sys_enter_read 1 11624.859228072 1262 wget nr=3, fd=3, buf=3077701632, count=1024
895 syscalls__sys_exit_read 1 11624.859233707 1262 wget nr=3, ret=0
896 syscalls__sys_enter_read 1 11624.859573008 1262 wget nr=3, fd=3, buf=3213018496, count=512
897 syscalls__sys_exit_read 1 11624.859584818 1262 wget nr=3, ret=512
898 syscalls__sys_enter_read 1 11624.859864562 1262 wget nr=3, fd=3, buf=3077701632, count=1024
899 syscalls__sys_exit_read 1 11624.859888770 1262 wget nr=3, ret=1024
900 syscalls__sys_enter_read 1 11624.859935140 1262 wget nr=3, fd=3, buf=3077701632, count=1024
901 syscalls__sys_exit_read 1 11624.859944032 1262 wget nr=3, ret=1024
902 </literallayout>
903 That in itself isn't very useful; after all, we can accomplish
904 pretty much the same thing by simply running 'perf script'
905 without arguments in the same directory as the perf.data file.
906 </para>
907
908 <para>
909 We can however replace the print statements in the generated
910 function bodies with whatever we want, and thereby make it
911 infinitely more useful.
912 </para>
913
914 <para>
915 As a simple example, let's just replace the print statements in
916 the function bodies with a simple function that does nothing but
917 increment a per-event count. When the program is run against a
918 perf.data file, each time a particular event is encountered,
919 a tally is incremented for that event. For example:
920 <literallayout class='monospaced'>
921 def net__netif_rx(event_name, context, common_cpu,
922 common_secs, common_nsecs, common_pid, common_comm,
923 skbaddr, len, name):
924 inc_counts(event_name)
925 </literallayout>
926 Each event handler function in the generated code is modified
927 to do this. For convenience, we define a common function called
928 inc_counts() that each handler calls; inc_counts simply tallies
929 a count for each event using the 'counts' hash, which is a
930 specialized has function that does Perl-like autovivification, a
931 capability that's extremely useful for kinds of multi-level
932 aggregation commonly used in processing traces (see perf's
933 documentation on the Python language binding for details):
934 <literallayout class='monospaced'>
935 counts = autodict()
936
937 def inc_counts(event_name):
938 try:
939 counts[event_name] += 1
940 except TypeError:
941 counts[event_name] = 1
942 </literallayout>
943 Finally, at the end of the trace processing run, we want to
944 print the result of all the per-event tallies. For that, we
945 use the special 'trace_end()' function:
946 <literallayout class='monospaced'>
947 def trace_end():
948 for event_name, count in counts.iteritems():
949 print "%-40s %10s\n" % (event_name, count)
950 </literallayout>
951 The end result is a summary of all the events recorded in the
952 trace:
953 <literallayout class='monospaced'>
954 skb__skb_copy_datagram_iovec 13148
955 irq__softirq_entry 4796
956 irq__irq_handler_exit 3805
957 irq__softirq_exit 4795
958 syscalls__sys_enter_write 8990
959 net__net_dev_xmit 652
960 skb__kfree_skb 4047
961 sched__sched_wakeup 1155
962 irq__irq_handler_entry 3804
963 irq__softirq_raise 4799
964 net__net_dev_queue 652
965 syscalls__sys_enter_read 17599
966 net__netif_receive_skb 1743
967 syscalls__sys_exit_read 17598
968 net__netif_rx 2
969 napi__napi_poll 1877
970 syscalls__sys_exit_write 8990
971 </literallayout>
972 Note that this is pretty much exactly the same information we get
973 from 'perf stat', which goes a little way to support the idea
974 mentioned previously that given the right kind of trace data,
975 higher-level profiling-type summaries can be derived from it.
976 </para>
977
978 <para>
979 Documentation on using the
980 <ulink url='http://linux.die.net/man/1/perf-script-python'>'perf script' python binding</ulink>.
981 </para>
982 </section>
983
984 <section id='system-wide-tracing-and-profiling'>
985 <title>System-Wide Tracing and Profiling</title>
986
987 <para>
988 The examples so far have focused on tracing a particular program or
989 workload - in other words, every profiling run has specified the
990 program to profile in the command-line e.g. 'perf record wget ...'.
991 </para>
992
993 <para>
994 It's also possible, and more interesting in many cases, to run a
995 system-wide profile or trace while running the workload in a
996 separate shell.
997 </para>
998
999 <para>
1000 To do system-wide profiling or tracing, you typically use
1001 the -a flag to 'perf record'.
1002 </para>
1003
1004 <para>
1005 To demonstrate this, open up one window and start the profile
1006 using the -a flag (press Ctrl-C to stop tracing):
1007 <literallayout class='monospaced'>
1008 root@crownbay:~# perf record -g -a
1009 ^C[ perf record: Woken up 6 times to write data ]
1010 [ perf record: Captured and wrote 1.400 MB perf.data (~61172 samples) ]
1011 </literallayout>
1012 In another window, run the wget test:
1013 <literallayout class='monospaced'>
1014 root@crownbay:~# wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>
1015 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
1016 linux-2.6.19.2.tar.b 100% |*******************************| 41727k 0:00:00 ETA
1017 </literallayout>
1018 Here we see entries not only for our wget load, but for other
1019 processes running on the system as well:
1020 </para>
1021
1022 <para>
1023 <imagedata fileref="figures/perf-systemwide.png" width="6in" depth="7in" align="center" scalefit="1" />
1024 </para>
1025
1026 <para>
1027 In the snapshot above, we can see callchains that originate in
1028 libc, and a callchain from Xorg that demonstrates that we're
1029 using a proprietary X driver in userspace (notice the presence
1030 of 'PVR' and some other unresolvable symbols in the expanded
1031 Xorg callchain).
1032 </para>
1033
1034 <para>
1035 Note also that we have both kernel and userspace entries in the
1036 above snapshot. We can also tell perf to focus on userspace but
1037 providing a modifier, in this case 'u', to the 'cycles' hardware
1038 counter when we record a profile:
1039 <literallayout class='monospaced'>
1040 root@crownbay:~# perf record -g -a -e cycles:u
1041 ^C[ perf record: Woken up 2 times to write data ]
1042 [ perf record: Captured and wrote 0.376 MB perf.data (~16443 samples) ]
1043 </literallayout>
1044 </para>
1045
1046 <para>
1047 <imagedata fileref="figures/perf-report-cycles-u.png" width="6in" depth="7in" align="center" scalefit="1" />
1048 </para>
1049
1050 <para>
1051 Notice in the screenshot above, we see only userspace entries ([.])
1052 </para>
1053
1054 <para>
1055 Finally, we can press 'enter' on a leaf node and select the 'Zoom
1056 into DSO' menu item to show only entries associated with a
1057 specific DSO. In the screenshot below, we've zoomed into the
1058 'libc' DSO which shows all the entries associated with the
1059 libc-xxx.so DSO.
1060 </para>
1061
1062 <para>
1063 <imagedata fileref="figures/perf-systemwide-libc.png" width="6in" depth="7in" align="center" scalefit="1" />
1064 </para>
1065
1066 <para>
1067 We can also use the system-wide -a switch to do system-wide
1068 tracing. Here we'll trace a couple of scheduler events:
1069 <literallayout class='monospaced'>
1070 root@crownbay:~# perf record -a -e sched:sched_switch -e sched:sched_wakeup
1071 ^C[ perf record: Woken up 38 times to write data ]
1072 [ perf record: Captured and wrote 9.780 MB perf.data (~427299 samples) ]
1073 </literallayout>
1074 We can look at the raw output using 'perf script' with no
1075 arguments:
1076 <literallayout class='monospaced'>
1077 root@crownbay:~# perf script
1078
1079 perf 1383 [001] 6171.460045: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1080 perf 1383 [001] 6171.460066: sched_switch: prev_comm=perf prev_pid=1383 prev_prio=120 prev_state=R+ ==> next_comm=kworker/1:1 next_pid=21 next_prio=120
1081 kworker/1:1 21 [001] 6171.460093: sched_switch: prev_comm=kworker/1:1 prev_pid=21 prev_prio=120 prev_state=S ==> next_comm=perf next_pid=1383 next_prio=120
1082 swapper 0 [000] 6171.468063: sched_wakeup: comm=kworker/0:3 pid=1209 prio=120 success=1 target_cpu=000
1083 swapper 0 [000] 6171.468107: sched_switch: prev_comm=swapper/0 prev_pid=0 prev_prio=120 prev_state=R ==> next_comm=kworker/0:3 next_pid=1209 next_prio=120
1084 kworker/0:3 1209 [000] 6171.468143: sched_switch: prev_comm=kworker/0:3 prev_pid=1209 prev_prio=120 prev_state=S ==> next_comm=swapper/0 next_pid=0 next_prio=120
1085 perf 1383 [001] 6171.470039: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1086 perf 1383 [001] 6171.470058: sched_switch: prev_comm=perf prev_pid=1383 prev_prio=120 prev_state=R+ ==> next_comm=kworker/1:1 next_pid=21 next_prio=120
1087 kworker/1:1 21 [001] 6171.470082: sched_switch: prev_comm=kworker/1:1 prev_pid=21 prev_prio=120 prev_state=S ==> next_comm=perf next_pid=1383 next_prio=120
1088 perf 1383 [001] 6171.480035: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1089 </literallayout>
1090 </para>
1091
1092 <section id='perf-filtering'>
1093 <title>Filtering</title>
1094
1095 <para>
1096 Notice that there are a lot of events that don't really have
1097 anything to do with what we're interested in, namely events
1098 that schedule 'perf' itself in and out or that wake perf up.
1099 We can get rid of those by using the '--filter' option -
1100 for each event we specify using -e, we can add a --filter
1101 after that to filter out trace events that contain fields
1102 with specific values:
1103 <literallayout class='monospaced'>
1104 root@crownbay:~# perf record -a -e sched:sched_switch --filter 'next_comm != perf &amp;&amp; prev_comm != perf' -e sched:sched_wakeup --filter 'comm != perf'
1105 ^C[ perf record: Woken up 38 times to write data ]
1106 [ perf record: Captured and wrote 9.688 MB perf.data (~423279 samples) ]
1107
1108
1109 root@crownbay:~# perf script
1110
1111 swapper 0 [000] 7932.162180: sched_switch: prev_comm=swapper/0 prev_pid=0 prev_prio=120 prev_state=R ==> next_comm=kworker/0:3 next_pid=1209 next_prio=120
1112 kworker/0:3 1209 [000] 7932.162236: sched_switch: prev_comm=kworker/0:3 prev_pid=1209 prev_prio=120 prev_state=S ==> next_comm=swapper/0 next_pid=0 next_prio=120
1113 perf 1407 [001] 7932.170048: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1114 perf 1407 [001] 7932.180044: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1115 perf 1407 [001] 7932.190038: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1116 perf 1407 [001] 7932.200044: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1117 perf 1407 [001] 7932.210044: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1118 perf 1407 [001] 7932.220044: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1119 swapper 0 [001] 7932.230111: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001
1120 swapper 0 [001] 7932.230146: sched_switch: prev_comm=swapper/1 prev_pid=0 prev_prio=120 prev_state=R ==> next_comm=kworker/1:1 next_pid=21 next_prio=120
1121 kworker/1:1 21 [001] 7932.230205: sched_switch: prev_comm=kworker/1:1 prev_pid=21 prev_prio=120 prev_state=S ==> next_comm=swapper/1 next_pid=0 next_prio=120
1122 swapper 0 [000] 7932.326109: sched_wakeup: comm=kworker/0:3 pid=1209 prio=120 success=1 target_cpu=000
1123 swapper 0 [000] 7932.326171: sched_switch: prev_comm=swapper/0 prev_pid=0 prev_prio=120 prev_state=R ==> next_comm=kworker/0:3 next_pid=1209 next_prio=120
1124 kworker/0:3 1209 [000] 7932.326214: sched_switch: prev_comm=kworker/0:3 prev_pid=1209 prev_prio=120 prev_state=S ==> next_comm=swapper/0 next_pid=0 next_prio=120
1125 </literallayout>
1126 In this case, we've filtered out all events that have 'perf'
1127 in their 'comm' or 'comm_prev' or 'comm_next' fields. Notice
1128 that there are still events recorded for perf, but notice
1129 that those events don't have values of 'perf' for the filtered
1130 fields. To completely filter out anything from perf will
1131 require a bit more work, but for the purpose of demonstrating
1132 how to use filters, it's close enough.
1133 </para>
1134
1135 <informalexample>
1136 <emphasis>Tying it Together:</emphasis> These are exactly the same set of event
1137 filters defined by the trace event subsystem. See the
1138 ftrace/tracecmd/kernelshark section for more discussion about
1139 these event filters.
1140 </informalexample>
1141
1142 <informalexample>
1143 <emphasis>Tying it Together:</emphasis> These event filters are implemented by a
1144 special-purpose pseudo-interpreter in the kernel and are an
1145 integral and indispensable part of the perf design as it
1146 relates to tracing. kernel-based event filters provide a
1147 mechanism to precisely throttle the event stream that appears
1148 in user space, where it makes sense to provide bindings to real
1149 programming languages for postprocessing the event stream.
1150 This architecture allows for the intelligent and flexible
1151 partitioning of processing between the kernel and user space.
1152 Contrast this with other tools such as SystemTap, which does
1153 all of its processing in the kernel and as such requires a
1154 special project-defined language in order to accommodate that
1155 design, or LTTng, where everything is sent to userspace and
1156 as such requires a super-efficient kernel-to-userspace
1157 transport mechanism in order to function properly. While
1158 perf certainly can benefit from for instance advances in
1159 the design of the transport, it doesn't fundamentally depend
1160 on them. Basically, if you find that your perf tracing
1161 application is causing buffer I/O overruns, it probably
1162 means that you aren't taking enough advantage of the
1163 kernel filtering engine.
1164 </informalexample>
1165 </section>
1166 </section>
1167
1168 <section id='using-dynamic-tracepoints'>
1169 <title>Using Dynamic Tracepoints</title>
1170
1171 <para>
1172 perf isn't restricted to the fixed set of static tracepoints
1173 listed by 'perf list'. Users can also add their own 'dynamic'
1174 tracepoints anywhere in the kernel. For instance, suppose we
1175 want to define our own tracepoint on do_fork(). We can do that
1176 using the 'perf probe' perf subcommand:
1177 <literallayout class='monospaced'>
1178 root@crownbay:~# perf probe do_fork
1179 Added new event:
1180 probe:do_fork (on do_fork)
1181
1182 You can now use it in all perf tools, such as:
1183
1184 perf record -e probe:do_fork -aR sleep 1
1185 </literallayout>
1186 Adding a new tracepoint via 'perf probe' results in an event
1187 with all the expected files and format in
1188 /sys/kernel/debug/tracing/events, just the same as for static
1189 tracepoints (as discussed in more detail in the trace events
1190 subsystem section:
1191 <literallayout class='monospaced'>
1192 root@crownbay:/sys/kernel/debug/tracing/events/probe/do_fork# ls -al
1193 drwxr-xr-x 2 root root 0 Oct 28 11:42 .
1194 drwxr-xr-x 3 root root 0 Oct 28 11:42 ..
1195 -rw-r--r-- 1 root root 0 Oct 28 11:42 enable
1196 -rw-r--r-- 1 root root 0 Oct 28 11:42 filter
1197 -r--r--r-- 1 root root 0 Oct 28 11:42 format
1198 -r--r--r-- 1 root root 0 Oct 28 11:42 id
1199
1200 root@crownbay:/sys/kernel/debug/tracing/events/probe/do_fork# cat format
1201 name: do_fork
1202 ID: 944
1203 format:
1204 field:unsigned short common_type; offset:0; size:2; signed:0;
1205 field:unsigned char common_flags; offset:2; size:1; signed:0;
1206 field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
1207 field:int common_pid; offset:4; size:4; signed:1;
1208 field:int common_padding; offset:8; size:4; signed:1;
1209
1210 field:unsigned long __probe_ip; offset:12; size:4; signed:0;
1211
1212 print fmt: "(%lx)", REC->__probe_ip
1213 </literallayout>
1214 We can list all dynamic tracepoints currently in existence:
1215 <literallayout class='monospaced'>
1216 root@crownbay:~# perf probe -l
1217 probe:do_fork (on do_fork)
1218 probe:schedule (on schedule)
1219 </literallayout>
1220 Let's record system-wide ('sleep 30' is a trick for recording
1221 system-wide but basically do nothing and then wake up after
1222 30 seconds):
1223 <literallayout class='monospaced'>
1224 root@crownbay:~# perf record -g -a -e probe:do_fork sleep 30
1225 [ perf record: Woken up 1 times to write data ]
1226 [ perf record: Captured and wrote 0.087 MB perf.data (~3812 samples) ]
1227 </literallayout>
1228 Using 'perf script' we can see each do_fork event that fired:
1229 <literallayout class='monospaced'>
1230 root@crownbay:~# perf script
1231
1232 # ========
1233 # captured on: Sun Oct 28 11:55:18 2012
1234 # hostname : crownbay
1235 # os release : 3.4.11-yocto-standard
1236 # perf version : 3.4.11
1237 # arch : i686
1238 # nrcpus online : 2
1239 # nrcpus avail : 2
1240 # cpudesc : Intel(R) Atom(TM) CPU E660 @ 1.30GHz
1241 # cpuid : GenuineIntel,6,38,1
1242 # total memory : 1017184 kB
1243 # cmdline : /usr/bin/perf record -g -a -e probe:do_fork sleep 30
1244 # event : name = probe:do_fork, type = 2, config = 0x3b0, config1 = 0x0, config2 = 0x0, excl_usr = 0, excl_kern
1245 = 0, id = { 5, 6 }
1246 # HEADER_CPU_TOPOLOGY info available, use -I to display
1247 # ========
1248 #
1249 matchbox-deskto 1197 [001] 34211.378318: do_fork: (c1028460)
1250 matchbox-deskto 1295 [001] 34211.380388: do_fork: (c1028460)
1251 pcmanfm 1296 [000] 34211.632350: do_fork: (c1028460)
1252 pcmanfm 1296 [000] 34211.639917: do_fork: (c1028460)
1253 matchbox-deskto 1197 [001] 34217.541603: do_fork: (c1028460)
1254 matchbox-deskto 1299 [001] 34217.543584: do_fork: (c1028460)
1255 gthumb 1300 [001] 34217.697451: do_fork: (c1028460)
1256 gthumb 1300 [001] 34219.085734: do_fork: (c1028460)
1257 gthumb 1300 [000] 34219.121351: do_fork: (c1028460)
1258 gthumb 1300 [001] 34219.264551: do_fork: (c1028460)
1259 pcmanfm 1296 [000] 34219.590380: do_fork: (c1028460)
1260 matchbox-deskto 1197 [001] 34224.955965: do_fork: (c1028460)
1261 matchbox-deskto 1306 [001] 34224.957972: do_fork: (c1028460)
1262 matchbox-termin 1307 [000] 34225.038214: do_fork: (c1028460)
1263 matchbox-termin 1307 [001] 34225.044218: do_fork: (c1028460)
1264 matchbox-termin 1307 [000] 34225.046442: do_fork: (c1028460)
1265 matchbox-deskto 1197 [001] 34237.112138: do_fork: (c1028460)
1266 matchbox-deskto 1311 [001] 34237.114106: do_fork: (c1028460)
1267 gaku 1312 [000] 34237.202388: do_fork: (c1028460)
1268 </literallayout>
1269 And using 'perf report' on the same file, we can see the
1270 callgraphs from starting a few programs during those 30 seconds:
1271 </para>
1272
1273 <para>
1274 <imagedata fileref="figures/perf-probe-do_fork-profile.png" width="6in" depth="7in" align="center" scalefit="1" />
1275 </para>
1276
1277 <informalexample>
1278 <emphasis>Tying it Together:</emphasis> The trace events subsystem accomodate static
1279 and dynamic tracepoints in exactly the same way - there's no
1280 difference as far as the infrastructure is concerned. See the
1281 ftrace section for more details on the trace event subsystem.
1282 </informalexample>
1283
1284 <informalexample>
1285 <emphasis>Tying it Together:</emphasis> Dynamic tracepoints are implemented under the
1286 covers by kprobes and uprobes. kprobes and uprobes are also used
1287 by and in fact are the main focus of SystemTap.
1288 </informalexample>
1289 </section>
1290 </section>
1291
1292 <section id='perf-documentation'>
1293 <title>Documentation</title>
1294
1295 <para>
1296 Online versions of the man pages for the commands discussed in this
1297 section can be found here:
1298 <itemizedlist>
1299 <listitem><para>The <ulink url='http://linux.die.net/man/1/perf-stat'>'perf stat' manpage</ulink>.
1300 </para></listitem>
1301 <listitem><para>The <ulink url='http://linux.die.net/man/1/perf-record'>'perf record' manpage</ulink>.
1302 </para></listitem>
1303 <listitem><para>The <ulink url='http://linux.die.net/man/1/perf-report'>'perf report' manpage</ulink>.
1304 </para></listitem>
1305 <listitem><para>The <ulink url='http://linux.die.net/man/1/perf-probe'>'perf probe' manpage</ulink>.
1306 </para></listitem>
1307 <listitem><para>The <ulink url='http://linux.die.net/man/1/perf-script'>'perf script' manpage</ulink>.
1308 </para></listitem>
1309 <listitem><para>Documentation on using the
1310 <ulink url='http://linux.die.net/man/1/perf-script-python'>'perf script' python binding</ulink>.
1311 </para></listitem>
1312 <listitem><para>The top-level
1313 <ulink url='http://linux.die.net/man/1/perf'>perf(1) manpage</ulink>.
1314 </para></listitem>
1315 </itemizedlist>
1316 </para>
1317
1318 <para>
1319 Normally, you should be able to invoke the man pages via perf
1320 itself e.g. 'perf help' or 'perf help record'.
1321 </para>
1322
1323 <para>
1324 However, by default Yocto doesn't install man pages, but perf
1325 invokes the man pages for most help functionality. This is a bug
1326 and is being addressed by a Yocto bug:
1327 <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=3388'>Bug 3388 - perf: enable man pages for basic 'help' functionality</ulink>.
1328 </para>
1329
1330 <para>
1331 The man pages in text form, along with some other files, such as
1332 a set of examples, can be found in the 'perf' directory of the
1333 kernel tree:
1334 <literallayout class='monospaced'>
1335 tools/perf/Documentation
1336 </literallayout>
1337 There's also a nice perf tutorial on the perf wiki that goes
1338 into more detail than we do here in certain areas:
1339 <ulink url='https://perf.wiki.kernel.org/index.php/Tutorial'>Perf Tutorial</ulink>
1340 </para>
1341 </section>
1342</section>
1343
1344<section id='profile-manual-ftrace'>
1345 <title>ftrace</title>
1346
1347 <para>
1348 'ftrace' literally refers to the 'ftrace function tracer' but in
1349 reality this encompasses a number of related tracers along with
1350 the infrastructure that they all make use of.
1351 </para>
1352
1353 <section id='ftrace-setup'>
1354 <title>Setup</title>
1355
1356 <para>
1357 For this section, we'll assume you've already performed the basic
1358 setup outlined in the General Setup section.
1359 </para>
1360
1361 <para>
1362 ftrace, trace-cmd, and kernelshark run on the target system,
1363 and are ready to go out-of-the-box - no additional setup is
1364 necessary. For the rest of this section we assume you've ssh'ed
1365 to the host and will be running ftrace on the target. kernelshark
1366 is a GUI application and if you use the '-X' option to ssh you
1367 can have the kernelshark GUI run on the target but display
1368 remotely on the host if you want.
1369 </para>
1370 </section>
1371
1372 <section id='basic-ftrace-usage'>
1373 <title>Basic ftrace usage</title>
1374
1375 <para>
1376 'ftrace' essentially refers to everything included in
1377 the /tracing directory of the mounted debugfs filesystem
1378 (Yocto follows the standard convention and mounts it
1379 at /sys/kernel/debug). Here's a listing of all the files
1380 found in /sys/kernel/debug/tracing on a Yocto system.:
1381 <literallayout class='monospaced'>
1382 root@sugarbay:/sys/kernel/debug/tracing# ls
1383 README kprobe_events trace
1384 available_events kprobe_profile trace_clock
1385 available_filter_functions options trace_marker
1386 available_tracers per_cpu trace_options
1387 buffer_size_kb printk_formats trace_pipe
1388 buffer_total_size_kb saved_cmdlines tracing_cpumask
1389 current_tracer set_event tracing_enabled
1390 dyn_ftrace_total_info set_ftrace_filter tracing_on
1391 enabled_functions set_ftrace_notrace tracing_thresh
1392 events set_ftrace_pid
1393 free_buffer set_graph_function
1394 </literallayout>
1395 The files listed above are used for various purposes -
1396 some relate directly to the tracers themselves, others are
1397 used to set tracing options, and yet others actually contain
1398 the tracing output when a tracer is in effect. Some of the
1399 functions can be guessed from their names, others need
1400 explanation; in any case, we'll cover some of the files we
1401 see here below but for an explanation of the others, please
1402 see the ftrace documentation.
1403 </para>
1404
1405 <para>
1406 We'll start by looking at some of the available built-in
1407 tracers.
1408 </para>
1409
1410 <para>
1411 cat'ing the 'available_tracers' file lists the set of
1412 available tracers:
1413 <literallayout class='monospaced'>
1414 root@sugarbay:/sys/kernel/debug/tracing# cat available_tracers
1415 blk function_graph function nop
1416 </literallayout>
1417 The 'current_tracer' file contains the tracer currently in
1418 effect:
1419 <literallayout class='monospaced'>
1420 root@sugarbay:/sys/kernel/debug/tracing# cat current_tracer
1421 nop
1422 </literallayout>
1423 The above listing of current_tracer shows that
1424 the 'nop' tracer is in effect, which is just another
1425 way of saying that there's actually no tracer
1426 currently in effect.
1427 </para>
1428
1429 <para>
1430 echo'ing one of the available_tracers into current_tracer
1431 makes the specified tracer the current tracer:
1432 <literallayout class='monospaced'>
1433 root@sugarbay:/sys/kernel/debug/tracing# echo function > current_tracer
1434 root@sugarbay:/sys/kernel/debug/tracing# cat current_tracer
1435 function
1436 </literallayout>
1437 The above sets the current tracer to be the
1438 'function tracer'. This tracer traces every function
1439 call in the kernel and makes it available as the
1440 contents of the 'trace' file. Reading the 'trace' file
1441 lists the currently buffered function calls that have been
1442 traced by the function tracer:
1443 <literallayout class='monospaced'>
1444 root@sugarbay:/sys/kernel/debug/tracing# cat trace | less
1445
1446 # tracer: function
1447 #
1448 # entries-in-buffer/entries-written: 310629/766471 #P:8
1449 #
1450 # _-----=&gt; irqs-off
1451 # / _----=&gt; need-resched
1452 # | / _---=&gt; hardirq/softirq
1453 # || / _--=&gt; preempt-depth
1454 # ||| / delay
1455 # TASK-PID CPU# |||| TIMESTAMP FUNCTION
1456 # | | | |||| | |
1457 &lt;idle&gt;-0 [004] d..1 470.867169: ktime_get_real &lt;-intel_idle
1458 &lt;idle&gt;-0 [004] d..1 470.867170: getnstimeofday &lt;-ktime_get_real
1459 &lt;idle&gt;-0 [004] d..1 470.867171: ns_to_timeval &lt;-intel_idle
1460 &lt;idle&gt;-0 [004] d..1 470.867171: ns_to_timespec &lt;-ns_to_timeval
1461 &lt;idle&gt;-0 [004] d..1 470.867172: smp_apic_timer_interrupt &lt;-apic_timer_interrupt
1462 &lt;idle&gt;-0 [004] d..1 470.867172: native_apic_mem_write &lt;-smp_apic_timer_interrupt
1463 &lt;idle&gt;-0 [004] d..1 470.867172: irq_enter &lt;-smp_apic_timer_interrupt
1464 &lt;idle&gt;-0 [004] d..1 470.867172: rcu_irq_enter &lt;-irq_enter
1465 &lt;idle&gt;-0 [004] d..1 470.867173: rcu_idle_exit_common.isra.33 &lt;-rcu_irq_enter
1466 &lt;idle&gt;-0 [004] d..1 470.867173: local_bh_disable &lt;-irq_enter
1467 &lt;idle&gt;-0 [004] d..1 470.867173: add_preempt_count &lt;-local_bh_disable
1468 &lt;idle&gt;-0 [004] d.s1 470.867174: tick_check_idle &lt;-irq_enter
1469 &lt;idle&gt;-0 [004] d.s1 470.867174: tick_check_oneshot_broadcast &lt;-tick_check_idle
1470 &lt;idle&gt;-0 [004] d.s1 470.867174: ktime_get &lt;-tick_check_idle
1471 &lt;idle&gt;-0 [004] d.s1 470.867174: tick_nohz_stop_idle &lt;-tick_check_idle
1472 &lt;idle&gt;-0 [004] d.s1 470.867175: update_ts_time_stats &lt;-tick_nohz_stop_idle
1473 &lt;idle&gt;-0 [004] d.s1 470.867175: nr_iowait_cpu &lt;-update_ts_time_stats
1474 &lt;idle&gt;-0 [004] d.s1 470.867175: tick_do_update_jiffies64 &lt;-tick_check_idle
1475 &lt;idle&gt;-0 [004] d.s1 470.867175: _raw_spin_lock &lt;-tick_do_update_jiffies64
1476 &lt;idle&gt;-0 [004] d.s1 470.867176: add_preempt_count &lt;-_raw_spin_lock
1477 &lt;idle&gt;-0 [004] d.s2 470.867176: do_timer &lt;-tick_do_update_jiffies64
1478 &lt;idle&gt;-0 [004] d.s2 470.867176: _raw_spin_lock &lt;-do_timer
1479 &lt;idle&gt;-0 [004] d.s2 470.867176: add_preempt_count &lt;-_raw_spin_lock
1480 &lt;idle&gt;-0 [004] d.s3 470.867177: ntp_tick_length &lt;-do_timer
1481 &lt;idle&gt;-0 [004] d.s3 470.867177: _raw_spin_lock_irqsave &lt;-ntp_tick_length
1482 .
1483 .
1484 .
1485 </literallayout>
1486 Each line in the trace above shows what was happening in
1487 the kernel on a given cpu, to the level of detail of
1488 function calls. Each entry shows the function called,
1489 followed by its caller (after the arrow).
1490 </para>
1491
1492 <para>
1493 The function tracer gives you an extremely detailed idea
1494 of what the kernel was doing at the point in time the trace
1495 was taken, and is a great way to learn about how the kernel
1496 code works in a dynamic sense.
1497 </para>
1498
1499 <informalexample>
1500 <emphasis>Tying it Together:</emphasis> The ftrace function tracer is also
1501 available from within perf, as the ftrace:function tracepoint.
1502 </informalexample>
1503
1504 <para>
1505 It is a little more difficult to follow the call chains than
1506 it needs to be - luckily there's a variant of the function
1507 tracer that displays the callchains explicitly, called the
1508 'function_graph' tracer:
1509 <literallayout class='monospaced'>
1510 root@sugarbay:/sys/kernel/debug/tracing# echo function_graph &gt; current_tracer
1511 root@sugarbay:/sys/kernel/debug/tracing# cat trace | less
1512
1513 tracer: function_graph
1514
1515 CPU DURATION FUNCTION CALLS
1516 | | | | | | |
1517 7) 0.046 us | pick_next_task_fair();
1518 7) 0.043 us | pick_next_task_stop();
1519 7) 0.042 us | pick_next_task_rt();
1520 7) 0.032 us | pick_next_task_fair();
1521 7) 0.030 us | pick_next_task_idle();
1522 7) | _raw_spin_unlock_irq() {
1523 7) 0.033 us | sub_preempt_count();
1524 7) 0.258 us | }
1525 7) 0.032 us | sub_preempt_count();
1526 7) + 13.341 us | } /* __schedule */
1527 7) 0.095 us | } /* sub_preempt_count */
1528 7) | schedule() {
1529 7) | __schedule() {
1530 7) 0.060 us | add_preempt_count();
1531 7) 0.044 us | rcu_note_context_switch();
1532 7) | _raw_spin_lock_irq() {
1533 7) 0.033 us | add_preempt_count();
1534 7) 0.247 us | }
1535 7) | idle_balance() {
1536 7) | _raw_spin_unlock() {
1537 7) 0.031 us | sub_preempt_count();
1538 7) 0.246 us | }
1539 7) | update_shares() {
1540 7) 0.030 us | __rcu_read_lock();
1541 7) 0.029 us | __rcu_read_unlock();
1542 7) 0.484 us | }
1543 7) 0.030 us | __rcu_read_lock();
1544 7) | load_balance() {
1545 7) | find_busiest_group() {
1546 7) 0.031 us | idle_cpu();
1547 7) 0.029 us | idle_cpu();
1548 7) 0.035 us | idle_cpu();
1549 7) 0.906 us | }
1550 7) 1.141 us | }
1551 7) 0.022 us | msecs_to_jiffies();
1552 7) | load_balance() {
1553 7) | find_busiest_group() {
1554 7) 0.031 us | idle_cpu();
1555 .
1556 .
1557 .
1558 4) 0.062 us | msecs_to_jiffies();
1559 4) 0.062 us | __rcu_read_unlock();
1560 4) | _raw_spin_lock() {
1561 4) 0.073 us | add_preempt_count();
1562 4) 0.562 us | }
1563 4) + 17.452 us | }
1564 4) 0.108 us | put_prev_task_fair();
1565 4) 0.102 us | pick_next_task_fair();
1566 4) 0.084 us | pick_next_task_stop();
1567 4) 0.075 us | pick_next_task_rt();
1568 4) 0.062 us | pick_next_task_fair();
1569 4) 0.066 us | pick_next_task_idle();
1570 ------------------------------------------
1571 4) kworker-74 =&gt; &lt;idle&gt;-0
1572 ------------------------------------------
1573
1574 4) | finish_task_switch() {
1575 4) | _raw_spin_unlock_irq() {
1576 4) 0.100 us | sub_preempt_count();
1577 4) 0.582 us | }
1578 4) 1.105 us | }
1579 4) 0.088 us | sub_preempt_count();
1580 4) ! 100.066 us | }
1581 .
1582 .
1583 .
1584 3) | sys_ioctl() {
1585 3) 0.083 us | fget_light();
1586 3) | security_file_ioctl() {
1587 3) 0.066 us | cap_file_ioctl();
1588 3) 0.562 us | }
1589 3) | do_vfs_ioctl() {
1590 3) | drm_ioctl() {
1591 3) 0.075 us | drm_ut_debug_printk();
1592 3) | i915_gem_pwrite_ioctl() {
1593 3) | i915_mutex_lock_interruptible() {
1594 3) 0.070 us | mutex_lock_interruptible();
1595 3) 0.570 us | }
1596 3) | drm_gem_object_lookup() {
1597 3) | _raw_spin_lock() {
1598 3) 0.080 us | add_preempt_count();
1599 3) 0.620 us | }
1600 3) | _raw_spin_unlock() {
1601 3) 0.085 us | sub_preempt_count();
1602 3) 0.562 us | }
1603 3) 2.149 us | }
1604 3) 0.133 us | i915_gem_object_pin();
1605 3) | i915_gem_object_set_to_gtt_domain() {
1606 3) 0.065 us | i915_gem_object_flush_gpu_write_domain();
1607 3) 0.065 us | i915_gem_object_wait_rendering();
1608 3) 0.062 us | i915_gem_object_flush_cpu_write_domain();
1609 3) 1.612 us | }
1610 3) | i915_gem_object_put_fence() {
1611 3) 0.097 us | i915_gem_object_flush_fence.constprop.36();
1612 3) 0.645 us | }
1613 3) 0.070 us | add_preempt_count();
1614 3) 0.070 us | sub_preempt_count();
1615 3) 0.073 us | i915_gem_object_unpin();
1616 3) 0.068 us | mutex_unlock();
1617 3) 9.924 us | }
1618 3) + 11.236 us | }
1619 3) + 11.770 us | }
1620 3) + 13.784 us | }
1621 3) | sys_ioctl() {
1622 </literallayout>
1623 As you can see, the function_graph display is much easier to
1624 follow. Also note that in addition to the function calls and
1625 associated braces, other events such as scheduler events
1626 are displayed in context. In fact, you can freely include
1627 any tracepoint available in the trace events subsystem described
1628 in the next section by simply enabling those events, and they'll
1629 appear in context in the function graph display. Quite a
1630 powerful tool for understanding kernel dynamics.
1631 </para>
1632
1633 <para>
1634 Also notice that there are various annotations on the left
1635 hand side of the display. For example if the total time it
1636 took for a given function to execute is above a certain
1637 threshold, and exclamation point or plus sign appears on the
1638 left hand side. Please see the ftrace documentation for
1639 details on all these fields.
1640 </para>
1641 </section>
1642
1643 <section id='the-trace-events-subsystem'>
1644 <title>The 'trace events' Subsystem</title>
1645
1646 <para>
1647 One especially important directory contained within
1648 the /sys/kernel/debug/tracing directory is the 'events'
1649 subdirectory, which contains representations of every
1650 tracepoint in the system. Listing out the contents of
1651 the 'events' subdirectory, we see mainly another set of
1652 subdirectories:
1653 <literallayout class='monospaced'>
1654 root@sugarbay:/sys/kernel/debug/tracing# cd events
1655 root@sugarbay:/sys/kernel/debug/tracing/events# ls -al
1656 drwxr-xr-x 38 root root 0 Nov 14 23:19 .
1657 drwxr-xr-x 5 root root 0 Nov 14 23:19 ..
1658 drwxr-xr-x 19 root root 0 Nov 14 23:19 block
1659 drwxr-xr-x 32 root root 0 Nov 14 23:19 btrfs
1660 drwxr-xr-x 5 root root 0 Nov 14 23:19 drm
1661 -rw-r--r-- 1 root root 0 Nov 14 23:19 enable
1662 drwxr-xr-x 40 root root 0 Nov 14 23:19 ext3
1663 drwxr-xr-x 79 root root 0 Nov 14 23:19 ext4
1664 drwxr-xr-x 14 root root 0 Nov 14 23:19 ftrace
1665 drwxr-xr-x 8 root root 0 Nov 14 23:19 hda
1666 -r--r--r-- 1 root root 0 Nov 14 23:19 header_event
1667 -r--r--r-- 1 root root 0 Nov 14 23:19 header_page
1668 drwxr-xr-x 25 root root 0 Nov 14 23:19 i915
1669 drwxr-xr-x 7 root root 0 Nov 14 23:19 irq
1670 drwxr-xr-x 12 root root 0 Nov 14 23:19 jbd
1671 drwxr-xr-x 14 root root 0 Nov 14 23:19 jbd2
1672 drwxr-xr-x 14 root root 0 Nov 14 23:19 kmem
1673 drwxr-xr-x 7 root root 0 Nov 14 23:19 module
1674 drwxr-xr-x 3 root root 0 Nov 14 23:19 napi
1675 drwxr-xr-x 6 root root 0 Nov 14 23:19 net
1676 drwxr-xr-x 3 root root 0 Nov 14 23:19 oom
1677 drwxr-xr-x 12 root root 0 Nov 14 23:19 power
1678 drwxr-xr-x 3 root root 0 Nov 14 23:19 printk
1679 drwxr-xr-x 8 root root 0 Nov 14 23:19 random
1680 drwxr-xr-x 4 root root 0 Nov 14 23:19 raw_syscalls
1681 drwxr-xr-x 3 root root 0 Nov 14 23:19 rcu
1682 drwxr-xr-x 6 root root 0 Nov 14 23:19 rpm
1683 drwxr-xr-x 20 root root 0 Nov 14 23:19 sched
1684 drwxr-xr-x 7 root root 0 Nov 14 23:19 scsi
1685 drwxr-xr-x 4 root root 0 Nov 14 23:19 signal
1686 drwxr-xr-x 5 root root 0 Nov 14 23:19 skb
1687 drwxr-xr-x 4 root root 0 Nov 14 23:19 sock
1688 drwxr-xr-x 10 root root 0 Nov 14 23:19 sunrpc
1689 drwxr-xr-x 538 root root 0 Nov 14 23:19 syscalls
1690 drwxr-xr-x 4 root root 0 Nov 14 23:19 task
1691 drwxr-xr-x 14 root root 0 Nov 14 23:19 timer
1692 drwxr-xr-x 3 root root 0 Nov 14 23:19 udp
1693 drwxr-xr-x 21 root root 0 Nov 14 23:19 vmscan
1694 drwxr-xr-x 3 root root 0 Nov 14 23:19 vsyscall
1695 drwxr-xr-x 6 root root 0 Nov 14 23:19 workqueue
1696 drwxr-xr-x 26 root root 0 Nov 14 23:19 writeback
1697 </literallayout>
1698 Each one of these subdirectories corresponds to a
1699 'subsystem' and contains yet again more subdirectories,
1700 each one of those finally corresponding to a tracepoint.
1701 For example, here are the contents of the 'kmem' subsystem:
1702 <literallayout class='monospaced'>
1703 root@sugarbay:/sys/kernel/debug/tracing/events# cd kmem
1704 root@sugarbay:/sys/kernel/debug/tracing/events/kmem# ls -al
1705 drwxr-xr-x 14 root root 0 Nov 14 23:19 .
1706 drwxr-xr-x 38 root root 0 Nov 14 23:19 ..
1707 -rw-r--r-- 1 root root 0 Nov 14 23:19 enable
1708 -rw-r--r-- 1 root root 0 Nov 14 23:19 filter
1709 drwxr-xr-x 2 root root 0 Nov 14 23:19 kfree
1710 drwxr-xr-x 2 root root 0 Nov 14 23:19 kmalloc
1711 drwxr-xr-x 2 root root 0 Nov 14 23:19 kmalloc_node
1712 drwxr-xr-x 2 root root 0 Nov 14 23:19 kmem_cache_alloc
1713 drwxr-xr-x 2 root root 0 Nov 14 23:19 kmem_cache_alloc_node
1714 drwxr-xr-x 2 root root 0 Nov 14 23:19 kmem_cache_free
1715 drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_alloc
1716 drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_alloc_extfrag
1717 drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_alloc_zone_locked
1718 drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_free
1719 drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_free_batched
1720 drwxr-xr-x 2 root root 0 Nov 14 23:19 mm_page_pcpu_drain
1721 </literallayout>
1722 Let's see what's inside the subdirectory for a specific
1723 tracepoint, in this case the one for kmalloc:
1724 <literallayout class='monospaced'>
1725 root@sugarbay:/sys/kernel/debug/tracing/events/kmem# cd kmalloc
1726 root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# ls -al
1727 drwxr-xr-x 2 root root 0 Nov 14 23:19 .
1728 drwxr-xr-x 14 root root 0 Nov 14 23:19 ..
1729 -rw-r--r-- 1 root root 0 Nov 14 23:19 enable
1730 -rw-r--r-- 1 root root 0 Nov 14 23:19 filter
1731 -r--r--r-- 1 root root 0 Nov 14 23:19 format
1732 -r--r--r-- 1 root root 0 Nov 14 23:19 id
1733 </literallayout>
1734 The 'format' file for the tracepoint describes the event
1735 in memory, which is used by the various tracing tools
1736 that now make use of these tracepoint to parse the event
1737 and make sense of it, along with a 'print fmt' field that
1738 allows tools like ftrace to display the event as text.
1739 Here's what the format of the kmalloc event looks like:
1740 <literallayout class='monospaced'>
1741 root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# cat format
1742 name: kmalloc
1743 ID: 313
1744 format:
1745 field:unsigned short common_type; offset:0; size:2; signed:0;
1746 field:unsigned char common_flags; offset:2; size:1; signed:0;
1747 field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
1748 field:int common_pid; offset:4; size:4; signed:1;
1749 field:int common_padding; offset:8; size:4; signed:1;
1750
1751 field:unsigned long call_site; offset:16; size:8; signed:0;
1752 field:const void * ptr; offset:24; size:8; signed:0;
1753 field:size_t bytes_req; offset:32; size:8; signed:0;
1754 field:size_t bytes_alloc; offset:40; size:8; signed:0;
1755 field:gfp_t gfp_flags; offset:48; size:4; signed:0;
1756
1757 print fmt: "call_site=%lx ptr=%p bytes_req=%zu bytes_alloc=%zu gfp_flags=%s", REC->call_site, REC->ptr, REC->bytes_req, REC->bytes_alloc,
1758 (REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {(unsigned long)(((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | ((
1759 gfp_t)0x20000u) | (( gfp_t)0x02u) | (( gfp_t)0x08u)) | (( gfp_t)0x4000u) | (( gfp_t)0x10000u) | (( gfp_t)0x1000u) | (( gfp_t)0x200u) | ((
1760 gfp_t)0x400000u)), "GFP_TRANSHUGE"}, {(unsigned long)((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | (( gfp_t)0x20000u) | ((
1761 gfp_t)0x02u) | (( gfp_t)0x08u)), "GFP_HIGHUSER_MOVABLE"}, {(unsigned long)((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | ((
1762 gfp_t)0x20000u) | (( gfp_t)0x02u)), "GFP_HIGHUSER"}, {(unsigned long)((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | ((
1763 gfp_t)0x20000u)), "GFP_USER"}, {(unsigned long)((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | (( gfp_t)0x80000u)), GFP_TEMPORARY"},
1764 {(unsigned long)((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u)), "GFP_KERNEL"}, {(unsigned long)((( gfp_t)0x10u) | (( gfp_t)0x40u)),
1765 "GFP_NOFS"}, {(unsigned long)((( gfp_t)0x20u)), "GFP_ATOMIC"}, {(unsigned long)((( gfp_t)0x10u)), "GFP_NOIO"}, {(unsigned long)((
1766 gfp_t)0x20u), "GFP_HIGH"}, {(unsigned long)(( gfp_t)0x10u), "GFP_WAIT"}, {(unsigned long)(( gfp_t)0x40u), "GFP_IO"}, {(unsigned long)((
1767 gfp_t)0x100u), "GFP_COLD"}, {(unsigned long)(( gfp_t)0x200u), "GFP_NOWARN"}, {(unsigned long)(( gfp_t)0x400u), "GFP_REPEAT"}, {(unsigned
1768 long)(( gfp_t)0x800u), "GFP_NOFAIL"}, {(unsigned long)(( gfp_t)0x1000u), "GFP_NORETRY"}, {(unsigned long)(( gfp_t)0x4000u), "GFP_COMP"},
1769 {(unsigned long)(( gfp_t)0x8000u), "GFP_ZERO"}, {(unsigned long)(( gfp_t)0x10000u), "GFP_NOMEMALLOC"}, {(unsigned long)(( gfp_t)0x20000u),
1770 "GFP_HARDWALL"}, {(unsigned long)(( gfp_t)0x40000u), "GFP_THISNODE"}, {(unsigned long)(( gfp_t)0x80000u), "GFP_RECLAIMABLE"}, {(unsigned
1771 long)(( gfp_t)0x08u), "GFP_MOVABLE"}, {(unsigned long)(( gfp_t)0), "GFP_NOTRACK"}, {(unsigned long)(( gfp_t)0x400000u), "GFP_NO_KSWAPD"},
1772 {(unsigned long)(( gfp_t)0x800000u), "GFP_OTHER_NODE"} ) : "GFP_NOWAIT"
1773 </literallayout>
1774 The 'enable' file in the tracepoint directory is what allows
1775 the user (or tools such as trace-cmd) to actually turn the
1776 tracepoint on and off. When enabled, the corresponding
1777 tracepoint will start appearing in the ftrace 'trace'
1778 file described previously. For example, this turns on the
1779 kmalloc tracepoint:
1780 <literallayout class='monospaced'>
1781 root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# echo 1 > enable
1782 </literallayout>
1783 At the moment, we're not interested in the function tracer or
1784 some other tracer that might be in effect, so we first turn
1785 it off, but if we do that, we still need to turn tracing on in
1786 order to see the events in the output buffer:
1787 <literallayout class='monospaced'>
1788 root@sugarbay:/sys/kernel/debug/tracing# echo nop > current_tracer
1789 root@sugarbay:/sys/kernel/debug/tracing# echo 1 > tracing_on
1790 </literallayout>
1791 Now, if we look at the the 'trace' file, we see nothing
1792 but the kmalloc events we just turned on:
1793 <literallayout class='monospaced'>
1794 root@sugarbay:/sys/kernel/debug/tracing# cat trace | less
1795 # tracer: nop
1796 #
1797 # entries-in-buffer/entries-written: 1897/1897 #P:8
1798 #
1799 # _-----=&gt; irqs-off
1800 # / _----=&gt; need-resched
1801 # | / _---=&gt; hardirq/softirq
1802 # || / _--=&gt; preempt-depth
1803 # ||| / delay
1804 # TASK-PID CPU# |||| TIMESTAMP FUNCTION
1805 # | | | |||| | |
1806 dropbear-1465 [000] ...1 18154.620753: kmalloc: call_site=ffffffff816650d4 ptr=ffff8800729c3000 bytes_req=2048 bytes_alloc=2048 gfp_flags=GFP_KERNEL
1807 &lt;idle&gt;-0 [000] ..s3 18154.621640: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1808 &lt;idle&gt;-0 [000] ..s3 18154.621656: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1809 matchbox-termin-1361 [001] ...1 18154.755472: kmalloc: call_site=ffffffff81614050 ptr=ffff88006d5f0e00 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_KERNEL|GFP_REPEAT
1810 Xorg-1264 [002] ...1 18154.755581: kmalloc: call_site=ffffffff8141abe8 ptr=ffff8800734f4cc0 bytes_req=168 bytes_alloc=192 gfp_flags=GFP_KERNEL|GFP_NOWARN|GFP_NORETRY
1811 Xorg-1264 [002] ...1 18154.755583: kmalloc: call_site=ffffffff814192a3 ptr=ffff88001f822520 bytes_req=24 bytes_alloc=32 gfp_flags=GFP_KERNEL|GFP_ZERO
1812 Xorg-1264 [002] ...1 18154.755589: kmalloc: call_site=ffffffff81419edb ptr=ffff8800721a2f00 bytes_req=64 bytes_alloc=64 gfp_flags=GFP_KERNEL|GFP_ZERO
1813 matchbox-termin-1361 [001] ...1 18155.354594: kmalloc: call_site=ffffffff81614050 ptr=ffff88006db35400 bytes_req=576 bytes_alloc=1024 gfp_flags=GFP_KERNEL|GFP_REPEAT
1814 Xorg-1264 [002] ...1 18155.354703: kmalloc: call_site=ffffffff8141abe8 ptr=ffff8800734f4cc0 bytes_req=168 bytes_alloc=192 gfp_flags=GFP_KERNEL|GFP_NOWARN|GFP_NORETRY
1815 Xorg-1264 [002] ...1 18155.354705: kmalloc: call_site=ffffffff814192a3 ptr=ffff88001f822520 bytes_req=24 bytes_alloc=32 gfp_flags=GFP_KERNEL|GFP_ZERO
1816 Xorg-1264 [002] ...1 18155.354711: kmalloc: call_site=ffffffff81419edb ptr=ffff8800721a2f00 bytes_req=64 bytes_alloc=64 gfp_flags=GFP_KERNEL|GFP_ZERO
1817 &lt;idle&gt;-0 [000] ..s3 18155.673319: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1818 dropbear-1465 [000] ...1 18155.673525: kmalloc: call_site=ffffffff816650d4 ptr=ffff8800729c3000 bytes_req=2048 bytes_alloc=2048 gfp_flags=GFP_KERNEL
1819 &lt;idle&gt;-0 [000] ..s3 18155.674821: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d554800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1820 &lt;idle&gt;-0 [000] ..s3 18155.793014: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d554800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1821 dropbear-1465 [000] ...1 18155.793219: kmalloc: call_site=ffffffff816650d4 ptr=ffff8800729c3000 bytes_req=2048 bytes_alloc=2048 gfp_flags=GFP_KERNEL
1822 &lt;idle&gt;-0 [000] ..s3 18155.794147: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1823 &lt;idle&gt;-0 [000] ..s3 18155.936705: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1824 dropbear-1465 [000] ...1 18155.936910: kmalloc: call_site=ffffffff816650d4 ptr=ffff8800729c3000 bytes_req=2048 bytes_alloc=2048 gfp_flags=GFP_KERNEL
1825 &lt;idle&gt;-0 [000] ..s3 18155.937869: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d554800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1826 matchbox-termin-1361 [001] ...1 18155.953667: kmalloc: call_site=ffffffff81614050 ptr=ffff88006d5f2000 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_KERNEL|GFP_REPEAT
1827 Xorg-1264 [002] ...1 18155.953775: kmalloc: call_site=ffffffff8141abe8 ptr=ffff8800734f4cc0 bytes_req=168 bytes_alloc=192 gfp_flags=GFP_KERNEL|GFP_NOWARN|GFP_NORETRY
1828 Xorg-1264 [002] ...1 18155.953777: kmalloc: call_site=ffffffff814192a3 ptr=ffff88001f822520 bytes_req=24 bytes_alloc=32 gfp_flags=GFP_KERNEL|GFP_ZERO
1829 Xorg-1264 [002] ...1 18155.953783: kmalloc: call_site=ffffffff81419edb ptr=ffff8800721a2f00 bytes_req=64 bytes_alloc=64 gfp_flags=GFP_KERNEL|GFP_ZERO
1830 &lt;idle&gt;-0 [000] ..s3 18156.176053: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d554800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1831 dropbear-1465 [000] ...1 18156.176257: kmalloc: call_site=ffffffff816650d4 ptr=ffff8800729c3000 bytes_req=2048 bytes_alloc=2048 gfp_flags=GFP_KERNEL
1832 &lt;idle&gt;-0 [000] ..s3 18156.177717: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1833 &lt;idle&gt;-0 [000] ..s3 18156.399229: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d555800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1834 dropbear-1465 [000] ...1 18156.399434: kmalloc: call_site=ffffffff816650d4 ptr=ffff8800729c3000 bytes_http://rostedt.homelinux.com/kernelshark/req=2048 bytes_alloc=2048 gfp_flags=GFP_KERNEL
1835 &lt;idle&gt;-0 [000] ..s3 18156.400660: kmalloc: call_site=ffffffff81619b36 ptr=ffff88006d554800 bytes_req=512 bytes_alloc=512 gfp_flags=GFP_ATOMIC
1836 matchbox-termin-1361 [001] ...1 18156.552800: kmalloc: call_site=ffffffff81614050 ptr=ffff88006db34800 bytes_req=576 bytes_alloc=1024 gfp_flags=GFP_KERNEL|GFP_REPEAT
1837 </literallayout>
1838 To again disable the kmalloc event, we need to send 0 to the
1839 enable file:
1840 <literallayout class='monospaced'>
1841 root@sugarbay:/sys/kernel/debug/tracing/events/kmem/kmalloc# echo 0 > enable
1842 </literallayout>
1843 You can enable any number of events or complete subsystems
1844 (by using the 'enable' file in the subsystem directory) and
1845 get am arbitrarily fine-grained idea of what's going on in the
1846 system by enabling as many of the appropriate tracepoints
1847 as applicable.
1848 </para>
1849
1850 <para>
1851 A number of the tools described in this HOWTO do just that,
1852 including trace-cmd and kernelshark in the next section.
1853 </para>
1854
1855 <informalexample>
1856 <emphasis>Tying it Together:</emphasis> These tracepoints and their representation
1857 are used not only by ftrace, but by many of the other tools
1858 covered in this document and they form a central point of
1859 integration for the various tracers available in Linux.
1860 They form a central part of the instrumentation for the
1861 following tools: perf, lttng, ftrace, blktrace and SystemTap
1862 </informalexample>
1863
1864 <informalexample>
1865 <emphasis>Tying it Together:</emphasis> Eventually all the special-purpose tracers
1866 currently available in /sys/kernel/debug/tracing will be
1867 removed and replaced with equivalent tracers based on the
1868 'trace events' subsystem.
1869 </informalexample>
1870 </section>
1871
1872 <section id='trace-cmd-kernelshark'>
1873 <title>trace-cmd/kernelshark</title>
1874
1875 <para>
1876 trace-cmd is essentially an extensive command-line 'wrapper'
1877 interface that hides the details of all the individual files
1878 in /sys/kernel/debug/tracing, allowing users to specify
1879 specific particular events within the
1880 /sys/kernel/debug/tracing/events/ subdirectory and to collect
1881 traces and avoiding having to deal with those details directly.
1882 </para>
1883
1884 <para>
1885 As yet another layer on top of that, kernelshark provides a GUI
1886 that allows users to start and stop traces and specify sets
1887 of events using an intuitive interface, and view the
1888 output as both trace events and as a per-cpu graphical
1889 display. It directly uses 'trace-cmd' as the plumbing
1890 that accomplishes all that underneath the covers (and
1891 actually displays the trace-cmd command it uses, as we'll see).
1892 </para>
1893
1894 <para>
1895 To start a trace using kernelshark, first start kernelshark:
1896 <literallayout class='monospaced'>
1897 root@sugarbay:~# kernelshark
1898 </literallayout>
1899 The bring up the 'Capture' dialog by choosing from the
1900 kernelshark menu:
1901 <literallayout class='monospaced'>
1902 Capture | Record
1903 </literallayout>
1904 That will display the following dialog, which allows you to
1905 choose on or more events (or even one or more complete
1906 subsystems) to trace:
1907 </para>
1908
1909 <para>
1910 <imagedata fileref="figures/kernelshark-choose-events.png" width="6in" depth="6in" align="center" scalefit="1" />
1911 </para>
1912
1913 <para>
1914 Note that these are exactly the same set of events described
1915 in the previous trace events subsystem section, and in fact
1916 is where trace-cmd gets them for kernelshark.
1917 </para>
1918
1919 <para>
1920 In the above screenshot, we've decided to explore the
1921 graphics subsystem a bit and so have chosen to trace all
1922 the tracepoints contained within the 'i915' and 'drm'
1923 subsystems.
1924 </para>
1925
1926 <para>
1927 After doing that, we can start and stop the trace using
1928 the 'Run' and 'Stop' button on the lower right corner of
1929 the dialog (the same button will turn into the 'Stop'
1930 button after the trace has started):
1931 </para>
1932
1933 <para>
1934 <imagedata fileref="figures/kernelshark-output-display.png" width="6in" depth="6in" align="center" scalefit="1" />
1935 </para>
1936
1937 <para>
1938 Notice that the right-hand pane shows the exact trace-cmd
1939 command-line that's used to run the trace, along with the
1940 results of the trace-cmd run.
1941 </para>
1942
1943 <para>
1944 Once the 'Stop' button is pressed, the graphical view magically
1945 fills up with a colorful per-cpu display of the trace data,
1946 along with the detailed event listing below that:
1947 </para>
1948
1949 <para>
1950 <imagedata fileref="figures/kernelshark-i915-display.png" width="6in" depth="7in" align="center" scalefit="1" />
1951 </para>
1952
1953 <para>
1954 Here's another example, this time a display resulting
1955 from tracing 'all events':
1956 </para>
1957
1958 <para>
1959 <imagedata fileref="figures/kernelshark-all.png" width="6in" depth="7in" align="center" scalefit="1" />
1960 </para>
1961
1962 <para>
1963 The tool is pretty self-explanatory, but for more detailed
1964 information on navigating through the data, see the
1965 <ulink url='http://rostedt.homelinux.com/kernelshark/'>kernelshark website</ulink>.
1966 </para>
1967 </section>
1968
1969 <section id='ftrace-documentation'>
1970 <title>Documentation</title>
1971
1972 <para>
1973 The documentation for ftrace can be found in the kernel
1974 Documentation directory:
1975 <literallayout class='monospaced'>
1976 Documentation/trace/ftrace.txt
1977 </literallayout>
1978 The documentation for the trace event subsystem can also
1979 be found in the kernel Documentation directory:
1980 <literallayout class='monospaced'>
1981 Documentation/trace/events.txt
1982 </literallayout>
1983 There are a nice series of articles on using
1984 ftrace and trace-cmd at LWN:
1985 <itemizedlist>
1986 <listitem><para><ulink url='http://lwn.net/Articles/365835/'>Debugging the kernel using Ftrace - part 1</ulink>
1987 </para></listitem>
1988 <listitem><para><ulink url='http://lwn.net/Articles/366796/'>Debugging the kernel using Ftrace - part 2</ulink>
1989 </para></listitem>
1990 <listitem><para><ulink url='https://lwn.net/Articles/410200/'>trace-cmd: A front-end for Ftrace</ulink>
1991 </para></listitem>
1992 </itemizedlist>
1993 </para>
1994
1995 <para>
1996 There's more detailed documentation kernelshark usage here:
1997 <ulink url='http://rostedt.homelinux.com/kernelshark/'>KernelShark</ulink>
1998 </para>
1999
2000 <para>
2001 An amusing yet useful README (a tracing mini-HOWTO) can be
2002 found in /sys/kernel/debug/tracing/README.
2003 </para>
2004 </section>
2005</section>
2006
2007<section id='profile-manual-systemtap'>
2008 <title>systemtap</title>
2009
2010 <para>
2011 SystemTap is a system-wide script-based tracing and profiling tool.
2012 </para>
2013
2014 <para>
2015 SystemTap scripts are C-like programs that are executed in the
2016 kernel to gather/print/aggregate data extracted from the context
2017 they end up being invoked under.
2018 </para>
2019
2020 <para>
2021 For example, this probe from the
2022 <ulink url='http://sourceware.org/systemtap/tutorial/'>SystemTap tutorial</ulink>
2023 simply prints a line every time any process on the system open()s
2024 a file. For each line, it prints the executable name of the
2025 program that opened the file, along with its pid, and the name
2026 of the file it opened (or tried to open), which it extracts
2027 from the open syscall's argstr.
2028 <literallayout class='monospaced'>
2029 probe syscall.open
2030 {
2031 printf ("%s(%d) open (%s)\n", execname(), pid(), argstr)
2032 }
2033
2034 probe timer.ms(4000) # after 4 seconds
2035 {
2036 exit ()
2037 }
2038 </literallayout>
2039 Normally, to execute this probe, you'd simply install
2040 systemtap on the system you want to probe, and directly run
2041 the probe on that system e.g. assuming the name of the file
2042 containing the above text is trace_open.stp:
2043 <literallayout class='monospaced'>
2044 # stap trace_open.stp
2045 </literallayout>
2046 What systemtap does under the covers to run this probe is 1)
2047 parse and convert the probe to an equivalent 'C' form, 2)
2048 compile the 'C' form into a kernel module, 3) insert the
2049 module into the kernel, which arms it, and 4) collect the data
2050 generated by the probe and display it to the user.
2051 </para>
2052
2053 <para>
2054 In order to accomplish steps 1 and 2, the 'stap' program needs
2055 access to the kernel build system that produced the kernel
2056 that the probed system is running. In the case of a typical
2057 embedded system (the 'target'), the kernel build system
2058 unfortunately isn't typically part of the image running on
2059 the target. It is normally available on the 'host' system
2060 that produced the target image however; in such cases,
2061 steps 1 and 2 are executed on the host system, and steps
2062 3 and 4 are executed on the target system, using only the
2063 systemtap 'runtime'.
2064 </para>
2065
2066 <para>
2067 The systemtap support in Yocto assumes that only steps
2068 3 and 4 are run on the target; it is possible to do
2069 everything on the target, but this section assumes only
2070 the typical embedded use-case.
2071 </para>
2072
2073 <para>
2074 So basically what you need to do in order to run a systemtap
2075 script on the target is to 1) on the host system, compile the
2076 probe into a kernel module that makes sense to the target, 2)
2077 copy the module onto the target system and 3) insert the
2078 module into the target kernel, which arms it, and 4) collect
2079 the data generated by the probe and display it to the user.
2080 </para>
2081
2082 <section id='systemtap-setup'>
2083 <title>Setup</title>
2084
2085 <para>
2086 Those are a lot of steps and a lot of details, but
2087 fortunately Yocto includes a script called 'crosstap'
2088 that will take care of those details, allowing you to
2089 simply execute a systemtap script on the remote target,
2090 with arguments if necessary.
2091 </para>
2092
2093 <para>
2094 In order to do this from a remote host, however, you
2095 need to have access to the build for the image you
2096 booted. The 'crosstap' script provides details on how
2097 to do this if you run the script on the host without having
2098 done a build:
2099 <note>
2100 SystemTap, which uses 'crosstap', assumes you can establish an
2101 ssh connection to the remote target.
2102 Please refer to crosstap wiki page for details on verifying
2103 ssh connections at
2104 <ulink url='https://wiki.yoctoproject.org/wiki/Tracing_and_Profiling#systemtap'></ulink>.
2105 Also, the ability to ssh into the target system is not enabled
2106 by default in -minimal images.
2107 </note>
2108 <literallayout class='monospaced'>
2109 $ crosstap root@192.168.1.88 trace_open.stp
2110
2111 Error: No target kernel build found.
2112 Did you forget to create a local build of your image?
2113
2114 'crosstap' requires a local sdk build of the target system
2115 (or a build that includes 'tools-profile') in order to build
2116 kernel modules that can probe the target system.
2117
2118 Practically speaking, that means you need to do the following:
2119 - If you're running a pre-built image, download the release
2120 and/or BSP tarballs used to build the image.
2121 - If you're working from git sources, just clone the metadata
2122 and BSP layers needed to build the image you'll be booting.
2123 - Make sure you're properly set up to build a new image (see
2124 the BSP README and/or the widely available basic documentation
2125 that discusses how to build images).
2126 - Build an -sdk version of the image e.g.:
2127 $ bitbake core-image-sato-sdk
2128 OR
2129 - Build a non-sdk image but include the profiling tools:
2130 [ edit local.conf and add 'tools-profile' to the end of
2131 the EXTRA_IMAGE_FEATURES variable ]
2132 $ bitbake core-image-sato
2133
2134 Once you've build the image on the host system, you're ready to
2135 boot it (or the equivalent pre-built image) and use 'crosstap'
2136 to probe it (you need to source the environment as usual first):
2137
2138 $ source oe-init-build-env
2139 $ cd ~/my/systemtap/scripts
2140 $ crosstap root@192.168.1.xxx myscript.stp
2141 </literallayout>
2142 So essentially what you need to do is build an SDK image or
2143 image with 'tools-profile' as detailed in the
2144 "<link linkend='profile-manual-general-setup'>General Setup</link>"
2145 section of this manual, and boot the resulting target image.
2146 </para>
2147
2148 <note>
2149 If you have a build directory containing multiple machines,
2150 you need to have the MACHINE you're connecting to selected
2151 in local.conf, and the kernel in that machine's build
2152 directory must match the kernel on the booted system exactly,
2153 or you'll get the above 'crosstap' message when you try to
2154 invoke a script.
2155 </note>
2156 </section>
2157
2158 <section id='running-a-script-on-a-target'>
2159 <title>Running a Script on a Target</title>
2160
2161 <para>
2162 Once you've done that, you should be able to run a systemtap
2163 script on the target:
2164 <literallayout class='monospaced'>
2165 $ cd /path/to/yocto
2166 $ source oe-init-build-env
2167
2168 ### Shell environment set up for builds. ###
2169
2170 You can now run 'bitbake &lt;target&gt;'
2171
2172 Common targets are:
2173 core-image-minimal
2174 core-image-sato
2175 meta-toolchain
2176 meta-toolchain-sdk
2177 adt-installer
2178 meta-ide-support
2179
2180 You can also run generated qemu images with a command like 'runqemu qemux86'
2181 </literallayout>
2182 Once you've done that, you can cd to whatever directory
2183 contains your scripts and use 'crosstap' to run the script:
2184 <literallayout class='monospaced'>
2185 $ cd /path/to/my/systemap/script
2186 $ crosstap root@192.168.7.2 trace_open.stp
2187 </literallayout>
2188 If you get an error connecting to the target e.g.:
2189 <literallayout class='monospaced'>
2190 $ crosstap root@192.168.7.2 trace_open.stp
2191 error establishing ssh connection on remote 'root@192.168.7.2'
2192 </literallayout>
2193 Try ssh'ing to the target and see what happens:
2194 <literallayout class='monospaced'>
2195 $ ssh root@192.168.7.2
2196 </literallayout>
2197 A lot of the time, connection problems are due specifying a
2198 wrong IP address or having a 'host key verification error'.
2199 </para>
2200
2201 <para>
2202 If everything worked as planned, you should see something
2203 like this (enter the password when prompted, or press enter
2204 if its set up to use no password):
2205 <literallayout class='monospaced'>
2206 $ crosstap root@192.168.7.2 trace_open.stp
2207 root@192.168.7.2's password:
2208 matchbox-termin(1036) open ("/tmp/vte3FS2LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600)
2209 matchbox-termin(1036) open ("/tmp/vteJMC7LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600)
2210 </literallayout>
2211 </para>
2212 </section>
2213
2214 <section id='systemtap-documentation'>
2215 <title>Documentation</title>
2216
2217 <para>
2218 The SystemTap language reference can be found here:
2219 <ulink url='http://sourceware.org/systemtap/langref/'>SystemTap Language Reference</ulink>
2220 </para>
2221
2222 <para>
2223 Links to other SystemTap documents, tutorials, and examples can be
2224 found here:
2225 <ulink url='http://sourceware.org/systemtap/documentation.html'>SystemTap documentation page</ulink>
2226 </para>
2227 </section>
2228</section>
2229
2230<section id='profile-manual-oprofile'>
2231 <title>oprofile</title>
2232
2233 <para>
2234 oprofile itself is a command-line application that runs on the
2235 target system.
2236 </para>
2237
2238 <section id='oprofile-setup'>
2239 <title>Setup</title>
2240
2241 <para>
2242 For this section, we'll assume you've already performed the
2243 basic setup outlined in the
2244 "<link linkend='profile-manual-general-setup'>General Setup</link>"
2245 section.
2246 </para>
2247
2248 <para>
2249 For the the section that deals with oprofile from the command-line,
2250 we assume you've ssh'ed to the host and will be running
2251 oprofile on the target.
2252 </para>
2253
2254 <para>
2255 oprofileui (oprofile-viewer) is a GUI-based program that runs
2256 on the host and interacts remotely with the target.
2257 See the oprofileui section for the exact steps needed to
2258 install oprofileui on the host.
2259 </para>
2260 </section>
2261
2262 <section id='oprofile-basic-usage'>
2263 <title>Basic Usage</title>
2264
2265 <para>
2266 Oprofile as configured in Yocto is a system-wide profiler
2267 (i.e. the version in Yocto doesn't yet make use of the
2268 perf_events interface which would allow it to profile
2269 specific processes and workloads). It's relies on hardware
2270 counter support in the hardware (but can fall back to a
2271 timer-based mode), which means that it doesn't take
2272 advantage of tracepoints or other event sources for example.
2273 </para>
2274
2275 <para>
2276 It consists of a kernel module that collects samples and a
2277 userspace daemon that writes the sample data to disk.
2278 </para>
2279
2280 <para>
2281 The 'opcontrol' shell script is used for transparently
2282 managing these components and starting and stopping
2283 profiles, and the 'opreport' command is used to
2284 display the results.
2285 </para>
2286
2287 <para>
2288 The oprofile daemon should already be running, but before
2289 you start profiling, you may need to change some settings
2290 and some of these settings may require the daemon not
2291 be running. One of these settings is the path the the
2292 vmlinux file, which you'll want to set using the --vmlinux
2293 option if you want the kernel profiled:
2294 <literallayout class='monospaced'>
2295 root@crownbay:~# opcontrol --vmlinux=/boot/vmlinux-`uname -r`
2296 The profiling daemon is currently active, so changes to the configuration
2297 will be used the next time you restart oprofile after a --shutdown or --deinit.
2298 </literallayout>
2299 You can check if vmlinux file: is set using opcontrol --status:
2300 <literallayout class='monospaced'>
2301 root@crownbay:~# opcontrol --status
2302 Daemon paused: pid 1334
2303 Separate options: library
2304 vmlinux file: none
2305 Image filter: none
2306 Call-graph depth: 6
2307 </literallayout>
2308 If it's not, you need to shutdown the daemon, add the setting
2309 and restart the daemon:
2310 <literallayout class='monospaced'>
2311 root@crownbay:~# opcontrol --shutdown
2312 Killing daemon.
2313
2314 root@crownbay:~# opcontrol --vmlinux=/boot/vmlinux-`uname -r`
2315 root@crownbay:~# opcontrol --start-daemon
2316 Using default event: CPU_CLK_UNHALTED:100000:0:1:1
2317 Using 2.6+ OProfile kernel interface.
2318 Reading module info.
2319 Using log file /var/lib/oprofile/samples/oprofiled.log
2320 Daemon started.
2321 </literallayout>
2322 If we get the status again we now see our updated settings:
2323 <literallayout class='monospaced'>
2324 root@crownbay:~# opcontrol --status
2325 Daemon paused: pid 1649
2326 Separate options: library
2327 vmlinux file: /boot/vmlinux-3.4.11-yocto-standard
2328 Image filter: none
2329 Call-graph depth: 6
2330 </literallayout>
2331 We're now in a position to run a profile. For that we used
2332 'opcontrol --start':
2333 <literallayout class='monospaced'>
2334 root@crownbay:~# opcontrol --start
2335 Profiler running.
2336 </literallayout>
2337 In another window, run our wget workload:
2338 <literallayout class='monospaced'>
2339 root@crownbay:~# rm linux-2.6.19.2.tar.bz2; wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>; sync
2340 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
2341 linux-2.6.19.2.tar.b 100% |*******************************| 41727k 0:00:00 ETA
2342 </literallayout>
2343 To stop the profile we use 'opcontrol --shudown', which not
2344 only stops the profile but shuts down the daemon as well:
2345 <literallayout class='monospaced'>
2346 root@crownbay:~# opcontrol --start
2347 Stopping profiling.
2348 Killing daemon.
2349 </literallayout>
2350 Oprofile writes sample data to /var/lib/oprofile/samples,
2351 which you can look at if you're interested in seeing how the
2352 samples are structured. This is also interesting because
2353 it's related to how you dive down to get further details
2354 about specific executables in OProfile.
2355 </para>
2356
2357 <para>
2358 To see the default display output for a profile, simply type
2359 'opreport', which will show the results using the data in
2360 /var/lib/oprofile/samples:
2361 <literallayout class='monospaced'>
2362 root@crownbay:~# opreport
2363
2364 WARNING! The OProfile kernel driver reports sample buffer overflows.
2365 Such overflows can result in incorrect sample attribution, invalid sample
2366 files and other symptoms. See the oprofiled.log for details.
2367 You should adjust your sampling frequency to eliminate (or at least minimize)
2368 these overflows.
2369 CPU: Intel Architectural Perfmon, speed 1.3e+06 MHz (estimated)
2370 Counted CPU_CLK_UNHALTED events (Clock cycles when not halted) with a unit mask of 0x00 (No unit mask) count 100000
2371 CPU_CLK_UNHALT...|
2372 samples| %|
2373 ------------------
2374 464365 79.8156 vmlinux-3.4.11-yocto-standard
2375 65108 11.1908 oprofiled
2376 CPU_CLK_UNHALT...|
2377 samples| %|
2378 ------------------
2379 64416 98.9372 oprofiled
2380 692 1.0628 libc-2.16.so
2381 36959 6.3526 no-vmlinux
2382 4378 0.7525 busybox
2383 CPU_CLK_UNHALT...|
2384 samples| %|
2385 ------------------
2386 2844 64.9612 libc-2.16.so
2387 1337 30.5391 busybox
2388 193 4.4084 ld-2.16.so
2389 2 0.0457 libnss_compat-2.16.so
2390 1 0.0228 libnsl-2.16.so
2391 1 0.0228 libnss_files-2.16.so
2392 4344 0.7467 bash
2393 CPU_CLK_UNHALT...|
2394 samples| %|
2395 ------------------
2396 2657 61.1648 bash
2397 1665 38.3287 libc-2.16.so
2398 18 0.4144 ld-2.16.so
2399 3 0.0691 libtinfo.so.5.9
2400 1 0.0230 libdl-2.16.so
2401 3118 0.5359 nf_conntrack
2402 686 0.1179 matchbox-terminal
2403 CPU_CLK_UNHALT...|
2404 samples| %|
2405 ------------------
2406 214 31.1953 libglib-2.0.so.0.3200.4
2407 114 16.6181 libc-2.16.so
2408 79 11.5160 libcairo.so.2.11200.2
2409 78 11.3703 libgdk-x11-2.0.so.0.2400.8
2410 51 7.4344 libpthread-2.16.so
2411 45 6.5598 libgobject-2.0.so.0.3200.4
2412 29 4.2274 libvte.so.9.2800.2
2413 25 3.6443 libX11.so.6.3.0
2414 19 2.7697 libxcb.so.1.1.0
2415 17 2.4781 libgtk-x11-2.0.so.0.2400.8
2416 12 1.7493 librt-2.16.so
2417 3 0.4373 libXrender.so.1.3.0
2418 671 0.1153 emgd
2419 411 0.0706 nf_conntrack_ipv4
2420 391 0.0672 iptable_nat
2421 378 0.0650 nf_nat
2422 263 0.0452 Xorg
2423 CPU_CLK_UNHALT...|
2424 samples| %|
2425 ------------------
2426 106 40.3042 Xorg
2427 53 20.1521 libc-2.16.so
2428 31 11.7871 libpixman-1.so.0.27.2
2429 26 9.8859 emgd_drv.so
2430 16 6.0837 libemgdsrv_um.so.1.5.15.3226
2431 11 4.1825 libEMGD2d.so.1.5.15.3226
2432 9 3.4221 libfb.so
2433 7 2.6616 libpthread-2.16.so
2434 1 0.3802 libudev.so.0.9.3
2435 1 0.3802 libdrm.so.2.4.0
2436 1 0.3802 libextmod.so
2437 1 0.3802 mouse_drv.so
2438 .
2439 .
2440 .
2441 9 0.0015 connmand
2442 CPU_CLK_UNHALT...|
2443 samples| %|
2444 ------------------
2445 4 44.4444 libglib-2.0.so.0.3200.4
2446 2 22.2222 libpthread-2.16.so
2447 1 11.1111 connmand
2448 1 11.1111 libc-2.16.so
2449 1 11.1111 librt-2.16.so
2450 6 0.0010 oprofile-server
2451 CPU_CLK_UNHALT...|
2452 samples| %|
2453 ------------------
2454 3 50.0000 libc-2.16.so
2455 1 16.6667 oprofile-server
2456 1 16.6667 libpthread-2.16.so
2457 1 16.6667 libglib-2.0.so.0.3200.4
2458 5 8.6e-04 gconfd-2
2459 CPU_CLK_UNHALT...|
2460 samples| %|
2461 ------------------
2462 2 40.0000 libdbus-1.so.3.7.2
2463 2 40.0000 libglib-2.0.so.0.3200.4
2464 1 20.0000 libc-2.16.so
2465 </literallayout>
2466 The output above shows the breakdown or samples by both
2467 number of samples and percentage for each executable.
2468 Within an executable, the sample counts are broken down
2469 further into executable and shared libraries (DSOs) used
2470 by the executable.
2471 </para>
2472
2473 <para>
2474 To get even more detailed breakdowns by function, we need to
2475 have the full paths to the DSOs, which we can get by
2476 using -f with opreport:
2477 <literallayout class='monospaced'>
2478 root@crownbay:~# opreport -f
2479
2480 CPU: Intel Architectural Perfmon, speed 1.3e+06 MHz (estimated)
2481 Counted CPU_CLK_UNHALTED events (Clock cycles when not halted) with a unit mask of 0x00 (No unit mask) count 100000
2482 CPU_CLK_UNHALT...|
2483 samples| %|
2484
2485 464365 79.8156 /boot/vmlinux-3.4.11-yocto-standard
2486 65108 11.1908 /usr/bin/oprofiled
2487 CPU_CLK_UNHALT...|
2488 samples| %|
2489 ------------------
2490 64416 98.9372 /usr/bin/oprofiled
2491 692 1.0628 /lib/libc-2.16.so
2492 36959 6.3526 /no-vmlinux
2493 4378 0.7525 /bin/busybox
2494 CPU_CLK_UNHALT...|
2495 samples| %|
2496 ------------------
2497 2844 64.9612 /lib/libc-2.16.so
2498 1337 30.5391 /bin/busybox
2499 193 4.4084 /lib/ld-2.16.so
2500 2 0.0457 /lib/libnss_compat-2.16.so
2501 1 0.0228 /lib/libnsl-2.16.so
2502 1 0.0228 /lib/libnss_files-2.16.so
2503 4344 0.7467 /bin/bash
2504 CPU_CLK_UNHALT...|
2505 samples| %|
2506 ------------------
2507 2657 61.1648 /bin/bash
2508 1665 38.3287 /lib/libc-2.16.so
2509 18 0.4144 /lib/ld-2.16.so
2510 3 0.0691 /lib/libtinfo.so.5.9
2511 1 0.0230 /lib/libdl-2.16.so
2512 .
2513 .
2514 .
2515 </literallayout>
2516 Using the paths shown in the above output and the -l option to
2517 opreport, we can see all the functions that have hits in the
2518 profile and their sample counts and percentages. Here's a
2519 portion of what we get for the kernel:
2520 <literallayout class='monospaced'>
2521 root@crownbay:~# opreport -l /boot/vmlinux-3.4.11-yocto-standard
2522
2523 CPU: Intel Architectural Perfmon, speed 1.3e+06 MHz (estimated)
2524 Counted CPU_CLK_UNHALTED events (Clock cycles when not halted) with a unit mask of 0x00 (No unit mask) count 100000
2525 samples % symbol name
2526 233981 50.3873 intel_idle
2527 15437 3.3243 rb_get_reader_page
2528 14503 3.1232 ring_buffer_consume
2529 14092 3.0347 mutex_spin_on_owner
2530 13024 2.8047 read_hpet
2531 8039 1.7312 sub_preempt_count
2532 7096 1.5281 ioread32
2533 6997 1.5068 add_preempt_count
2534 3985 0.8582 rb_advance_reader
2535 3488 0.7511 add_event_entry
2536 3303 0.7113 get_parent_ip
2537 3104 0.6684 rb_buffer_peek
2538 2960 0.6374 op_cpu_buffer_read_entry
2539 2614 0.5629 sync_buffer
2540 2545 0.5481 debug_smp_processor_id
2541 2456 0.5289 ohci_irq
2542 2397 0.5162 memset
2543 2349 0.5059 __copy_to_user_ll
2544 2185 0.4705 ring_buffer_event_length
2545 1918 0.4130 in_lock_functions
2546 1850 0.3984 __schedule
2547 1767 0.3805 __copy_from_user_ll_nozero
2548 1575 0.3392 rb_event_data_length
2549 1256 0.2705 memcpy
2550 1233 0.2655 system_call
2551 1213 0.2612 menu_select
2552 </literallayout>
2553 Notice that above we see an entry for the __copy_to_user_ll()
2554 function that we've looked at with other profilers as well.
2555 </para>
2556
2557 <para>
2558 Here's what we get when we do the same thing for the
2559 busybox executable:
2560 <literallayout class='monospaced'>
2561 CPU: Intel Architectural Perfmon, speed 1.3e+06 MHz (estimated)
2562 Counted CPU_CLK_UNHALTED events (Clock cycles when not halted) with a unit mask of 0x00 (No unit mask) count 100000
2563 samples % image name symbol name
2564 349 8.4198 busybox retrieve_file_data
2565 308 7.4306 libc-2.16.so _IO_file_xsgetn
2566 283 6.8275 libc-2.16.so __read_nocancel
2567 235 5.6695 libc-2.16.so syscall
2568 233 5.6212 libc-2.16.so clearerr
2569 215 5.1870 libc-2.16.so fread
2570 181 4.3667 libc-2.16.so __write_nocancel
2571 158 3.8118 libc-2.16.so __underflow
2572 151 3.6429 libc-2.16.so _dl_addr
2573 150 3.6188 busybox progress_meter
2574 150 3.6188 libc-2.16.so __poll_nocancel
2575 148 3.5706 libc-2.16.so _IO_file_underflow@@GLIBC_2.1
2576 137 3.3052 busybox safe_poll
2577 125 3.0157 busybox bb_progress_update
2578 122 2.9433 libc-2.16.so __x86.get_pc_thunk.bx
2579 95 2.2919 busybox full_write
2580 81 1.9542 busybox safe_write
2581 77 1.8577 busybox xwrite
2582 72 1.7370 libc-2.16.so _IO_file_read
2583 71 1.7129 libc-2.16.so _IO_sgetn
2584 67 1.6164 libc-2.16.so poll
2585 52 1.2545 libc-2.16.so _IO_switch_to_get_mode
2586 45 1.0856 libc-2.16.so read
2587 34 0.8203 libc-2.16.so write
2588 32 0.7720 busybox monotonic_sec
2589 25 0.6031 libc-2.16.so vfprintf
2590 22 0.5308 busybox get_mono
2591 14 0.3378 ld-2.16.so strcmp
2592 14 0.3378 libc-2.16.so __x86.get_pc_thunk.cx
2593 .
2594 .
2595 .
2596 </literallayout>
2597 Since we recorded the profile with a callchain depth of 6, we
2598 should be able to see our __copy_to_user_ll() callchains in
2599 the output, and indeed we can if we search around a bit in
2600 the 'opreport --callgraph' output:
2601 <literallayout class='monospaced'>
2602 root@crownbay:~# opreport --callgraph /boot/vmlinux-3.4.11-yocto-standard
2603
2604 392 6.9639 vmlinux-3.4.11-yocto-standard sock_aio_read
2605 736 13.0751 vmlinux-3.4.11-yocto-standard __generic_file_aio_write
2606 3255 57.8255 vmlinux-3.4.11-yocto-standard inet_recvmsg
2607 785 0.1690 vmlinux-3.4.11-yocto-standard tcp_recvmsg
2608 1790 31.7940 vmlinux-3.4.11-yocto-standard local_bh_enable
2609 1238 21.9893 vmlinux-3.4.11-yocto-standard __kfree_skb
2610 992 17.6199 vmlinux-3.4.11-yocto-standard lock_sock_nested
2611 785 13.9432 vmlinux-3.4.11-yocto-standard tcp_recvmsg [self]
2612 525 9.3250 vmlinux-3.4.11-yocto-standard release_sock
2613 112 1.9893 vmlinux-3.4.11-yocto-standard tcp_cleanup_rbuf
2614 72 1.2789 vmlinux-3.4.11-yocto-standard skb_copy_datagram_iovec
2615
2616 170 0.0366 vmlinux-3.4.11-yocto-standard skb_copy_datagram_iovec
2617 1491 73.3038 vmlinux-3.4.11-yocto-standard memcpy_toiovec
2618 327 16.0767 vmlinux-3.4.11-yocto-standard skb_copy_datagram_iovec
2619 170 8.3579 vmlinux-3.4.11-yocto-standard skb_copy_datagram_iovec [self]
2620 20 0.9833 vmlinux-3.4.11-yocto-standard copy_to_user
2621
2622 2588 98.2909 vmlinux-3.4.11-yocto-standard copy_to_user
2623 2349 0.5059 vmlinux-3.4.11-yocto-standard __copy_to_user_ll
2624 2349 89.2138 vmlinux-3.4.11-yocto-standard __copy_to_user_ll [self]
2625 166 6.3046 vmlinux-3.4.11-yocto-standard do_page_fault
2626 </literallayout>
2627 Remember that by default OProfile sessions are cumulative
2628 i.e. if you start and stop a profiling session, then start a
2629 new one, the new one will not erase the previous run(s) but
2630 will build on it. If you want to restart a profile from scratch,
2631 you need to reset:
2632 <literallayout class='monospaced'>
2633 root@crownbay:~# opcontrol --reset
2634 </literallayout>
2635 </para>
2636 </section>
2637
2638 <section id='oprofileui-a-gui-for-oprofile'>
2639 <title>OProfileUI - A GUI for OProfile</title>
2640
2641 <para>
2642 Yocto also supports a graphical UI for controlling and viewing
2643 OProfile traces, called OProfileUI. To use it, you first need
2644 to clone the oprofileui git repo, then configure, build, and
2645 install it:
2646 <literallayout class='monospaced'>
2647 [trz@empanada tmp]$ git clone git://git.yoctoproject.org/oprofileui
2648 [trz@empanada tmp]$ cd oprofileui
2649 [trz@empanada oprofileui]$ ./autogen.sh
2650 [trz@empanada oprofileui]$ sudo make install
2651 </literallayout>
2652 OprofileUI replaces the 'opreport' functionality with a GUI,
2653 and normally doesn't require the user to use 'opcontrol' either.
2654 If you want to profile the kernel, however, you need to either
2655 use the UI to specify a vmlinux or use 'opcontrol' to specify
2656 it on the target:
2657 </para>
2658
2659 <para>
2660 First, on the target, check if vmlinux file: is set:
2661 <literallayout class='monospaced'>
2662 root@crownbay:~# opcontrol --status
2663 </literallayout>
2664 If not:
2665 <literallayout class='monospaced'>
2666 root@crownbay:~# opcontrol --shutdown
2667 root@crownbay:~# opcontrol --vmlinux=/boot/vmlinux-`uname -r`
2668 root@crownbay:~# opcontrol --start-daemon
2669 </literallayout>
2670 Now, start the oprofile UI on the host system:
2671 <literallayout class='monospaced'>
2672 [trz@empanada oprofileui]$ oprofile-viewer
2673 </literallayout>
2674 To run a profile on the remote system, first connect to the
2675 remote system by pressing the 'Connect' button and supplying
2676 the IP address and port of the remote system (the default
2677 port is 4224).
2678 </para>
2679
2680 <para>
2681 The oprofile server should automatically be started already.
2682 If not, the connection will fail and you either typed in the
2683 wrong IP address and port (see below), or you need to start
2684 the server yourself:
2685 <literallayout class='monospaced'>
2686 root@crownbay:~# oprofile-server
2687 </literallayout>
2688 Or, to specify a specific port:
2689 <literallayout class='monospaced'>
2690 root@crownbay:~# oprofile-server --port 8888
2691 </literallayout>
2692 Once connected, press the 'Start' button and then run the
2693 wget workload on the remote system:
2694 <literallayout class='monospaced'>
2695 root@crownbay:~# rm linux-2.6.19.2.tar.bz2; wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>; sync
2696 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
2697 linux-2.6.19.2.tar.b 100% |*******************************| 41727k 0:00:00 ETA
2698 </literallayout>
2699 Once the workload completes, press the 'Stop' button. At that
2700 point the OProfile viewer will download the profile files it's
2701 collected (this may take some time, especially if the kernel
2702 was profiled). While it downloads the files, you should see
2703 something like the following:
2704 </para>
2705
2706 <para>
2707 <imagedata fileref="figures/oprofileui-downloading.png" width="6in" depth="7in" align="center" scalefit="1" />
2708 </para>
2709
2710 <para>
2711 Once the profile files have been retrieved, you should see a
2712 list of the processes that were profiled:
2713 </para>
2714
2715 <para>
2716 <imagedata fileref="figures/oprofileui-processes.png" width="6in" depth="7in" align="center" scalefit="1" />
2717 </para>
2718
2719 <para>
2720 If you select one of them, you should see all the symbols that
2721 were hit during the profile. Selecting one of them will show a
2722 list of callers and callees of the chosen function in two
2723 panes below the top pane. For example, here's what we see
2724 when we select __copy_to_user_ll():
2725 </para>
2726
2727 <para>
2728 <imagedata fileref="figures/oprofileui-copy-to-user.png" width="6in" depth="7in" align="center" scalefit="1" />
2729 </para>
2730
2731 <para>
2732 As another example, we can look at the busybox process and see
2733 that the progress meter made a system call:
2734 </para>
2735
2736 <para>
2737 <imagedata fileref="figures/oprofileui-busybox.png" width="6in" depth="7in" align="center" scalefit="1" />
2738 </para>
2739 </section>
2740
2741 <section id='oprofile-documentation'>
2742 <title>Documentation</title>
2743
2744 <para>
2745 Yocto already has some information on setting up and using
2746 OProfile and oprofileui. As this document doesn't cover
2747 everything in detail, it may be worth taking a look at the
2748 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-oprofile'>Profiling with OProfile</ulink>"
2749 section in the Yocto Project Development Manual
2750 </para>
2751
2752 <para>
2753 The OProfile manual can be found here:
2754 <ulink url='http://oprofile.sourceforge.net/doc/index.html'>OProfile manual</ulink>
2755 </para>
2756
2757 <para>
2758 The OProfile website contains links to the above manual and
2759 bunch of other items including an extensive set of examples:
2760 <ulink url='http://oprofile.sourceforge.net/about/'>About OProfile</ulink>
2761 </para>
2762 </section>
2763</section>
2764
2765<section id='profile-manual-sysprof'>
2766 <title>Sysprof</title>
2767
2768 <para>
2769 Sysprof is a very easy to use system-wide profiler that consists
2770 of a single window with three panes and a few buttons which allow
2771 you to start, stop, and view the profile from one place.
2772 </para>
2773
2774 <section id='sysprof-setup'>
2775 <title>Setup</title>
2776
2777 <para>
2778 For this section, we'll assume you've already performed the
2779 basic setup outlined in the General Setup section.
2780 </para>
2781
2782 <para>
2783 Sysprof is a GUI-based application that runs on the target
2784 system. For the rest of this document we assume you've
2785 ssh'ed to the host and will be running Sysprof on the
2786 target (you can use the '-X' option to ssh and have the
2787 Sysprof GUI run on the target but display remotely on the
2788 host if you want).
2789 </para>
2790 </section>
2791
2792 <section id='sysprof-basic-usage'>
2793 <title>Basic Usage</title>
2794
2795 <para>
2796 To start profiling the system, you simply press the 'Start'
2797 button. To stop profiling and to start viewing the profile data
2798 in one easy step, press the 'Profile' button.
2799 </para>
2800
2801 <para>
2802 Once you've pressed the profile button, the three panes will
2803 fill up with profiling data:
2804 </para>
2805
2806 <para>
2807 <imagedata fileref="figures/sysprof-copy-to-user.png" width="6in" depth="4in" align="center" scalefit="1" />
2808 </para>
2809
2810 <para>
2811 The left pane shows a list of functions and processes.
2812 Selecting one of those expands that function in the right
2813 pane, showing all its callees. Note that this caller-oriented
2814 display is essentially the inverse of perf's default
2815 callee-oriented callchain display.
2816 </para>
2817
2818 <para>
2819 In the screenshot above, we're focusing on __copy_to_user_ll()
2820 and looking up the callchain we can see that one of the callers
2821 of __copy_to_user_ll is sys_read() and the complete callpath
2822 between them. Notice that this is essentially a portion of the
2823 same information we saw in the perf display shown in the perf
2824 section of this page.
2825 </para>
2826
2827 <para>
2828 <imagedata fileref="figures/sysprof-copy-from-user.png" width="6in" depth="4in" align="center" scalefit="1" />
2829 </para>
2830
2831 <para>
2832 Similarly, the above is a snapshot of the Sysprof display of a
2833 copy-from-user callchain.
2834 </para>
2835
2836 <para>
2837 Finally, looking at the third Sysprof pane in the lower left,
2838 we can see a list of all the callers of a particular function
2839 selected in the top left pane. In this case, the lower pane is
2840 showing all the callers of __mark_inode_dirty:
2841 </para>
2842
2843 <para>
2844 <imagedata fileref="figures/sysprof-callers.png" width="6in" depth="4in" align="center" scalefit="1" />
2845 </para>
2846
2847 <para>
2848 Double-clicking on one of those functions will in turn change the
2849 focus to the selected function, and so on.
2850 </para>
2851
2852 <informalexample>
2853 <emphasis>Tying it Together:</emphasis> If you like sysprof's 'caller-oriented'
2854 display, you may be able to approximate it in other tools as
2855 well. For example, 'perf report' has the -g (--call-graph)
2856 option that you can experiment with; one of the options is
2857 'caller' for an inverted caller-based callgraph display.
2858 </informalexample>
2859 </section>
2860
2861 <section id='sysprof-documentation'>
2862 <title>Documentation</title>
2863
2864 <para>
2865 There doesn't seem to be any documentation for Sysprof, but
2866 maybe that's because it's pretty self-explanatory.
2867 The Sysprof website, however, is here:
2868 <ulink url='http://sysprof.com/'>Sysprof, System-wide Performance Profiler for Linux</ulink>
2869 </para>
2870 </section>
2871</section>
2872
2873<section id='lttng-linux-trace-toolkit-next-generation'>
2874 <title>LTTng (Linux Trace Toolkit, next generation)</title>
2875
2876 <section id='lttng-setup'>
2877 <title>Setup</title>
2878
2879 <para>
2880 For this section, we'll assume you've already performed the
2881 basic setup outlined in the General Setup section.
2882 </para>
2883
2884 <para>
2885 LTTng is run on the target system by ssh'ing to it.
2886 However, if you want to see the traces graphically,
2887 install Eclipse as described in section
2888 "<link linkend='manually-copying-a-trace-to-the-host-and-viewing-it-in-eclipse'>Manually copying a trace to the host and viewing it in Eclipse (i.e. using Eclipse without network support)</link>"
2889 and follow the directions to manually copy traces to the host and
2890 view them in Eclipse (i.e. using Eclipse without network support).
2891 </para>
2892
2893 <note>
2894 Be sure to download and install/run the 'SR1' or later Juno release
2895 of eclipse e.g.:
2896 <ulink url='http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/juno/SR1/eclipse-cpp-juno-SR1-linux-gtk-x86_64.tar.gz'>http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/juno/SR1/eclipse-cpp-juno-SR1-linux-gtk-x86_64.tar.gz</ulink>
2897 </note>
2898 </section>
2899
2900 <section id='collecting-and-viewing-traces'>
2901 <title>Collecting and Viewing Traces</title>
2902
2903 <para>
2904 Once you've applied the above commits and built and booted your
2905 image (you need to build the core-image-sato-sdk image or the
2906 other methods described in the General Setup section), you're
2907 ready to start tracing.
2908 </para>
2909
2910 <section id='collecting-and-viewing-a-trace-on-the-target-inside-a-shell'>
2911 <title>Collecting and viewing a trace on the target (inside a shell)</title>
2912
2913 <para>
2914 First, from the target, ssh to the target:
2915 <literallayout class='monospaced'>
2916 $ ssh -l root 192.168.1.47
2917 The authenticity of host '192.168.1.47 (192.168.1.47)' can't be established.
2918 RSA key fingerprint is 23:bd:c8:b1:a8:71:52:00:ee:00:4f:64:9e:10:b9:7e.
2919 Are you sure you want to continue connecting (yes/no)? yes
2920 Warning: Permanently added '192.168.1.47' (RSA) to the list of known hosts.
2921 root@192.168.1.47's password:
2922 </literallayout>
2923 Once on the target, use these steps to create a trace:
2924 <literallayout class='monospaced'>
2925 root@crownbay:~# lttng create
2926 Spawning a session daemon
2927 Session auto-20121015-232120 created.
2928 Traces will be written in /home/root/lttng-traces/auto-20121015-232120
2929 </literallayout>
2930 Enable the events you want to trace (in this case all
2931 kernel events):
2932 <literallayout class='monospaced'>
2933 root@crownbay:~# lttng enable-event --kernel --all
2934 All kernel events are enabled in channel channel0
2935 </literallayout>
2936 Start the trace:
2937 <literallayout class='monospaced'>
2938 root@crownbay:~# lttng start
2939 Tracing started for session auto-20121015-232120
2940 </literallayout>
2941 And then stop the trace after awhile or after running
2942 a particular workload that you want to trace:
2943 <literallayout class='monospaced'>
2944 root@crownbay:~# lttng stop
2945 Tracing stopped for session auto-20121015-232120
2946 </literallayout>
2947 You can now view the trace in text form on the target:
2948 <literallayout class='monospaced'>
2949 root@crownbay:~# lttng view
2950 [23:21:56.989270399] (+?.?????????) sys_geteuid: { 1 }, { }
2951 [23:21:56.989278081] (+0.000007682) exit_syscall: { 1 }, { ret = 0 }
2952 [23:21:56.989286043] (+0.000007962) sys_pipe: { 1 }, { fildes = 0xB77B9E8C }
2953 [23:21:56.989321802] (+0.000035759) exit_syscall: { 1 }, { ret = 0 }
2954 [23:21:56.989329345] (+0.000007543) sys_mmap_pgoff: { 1 }, { addr = 0x0, len = 10485760, prot = 3, flags = 131362, fd = 4294967295, pgoff = 0 }
2955 [23:21:56.989351694] (+0.000022349) exit_syscall: { 1 }, { ret = -1247805440 }
2956 [23:21:56.989432989] (+0.000081295) sys_clone: { 1 }, { clone_flags = 0x411, newsp = 0xB5EFFFE4, parent_tid = 0xFFFFFFFF, child_tid = 0x0 }
2957 [23:21:56.989477129] (+0.000044140) sched_stat_runtime: { 1 }, { comm = "lttng-consumerd", tid = 1193, runtime = 681660, vruntime = 43367983388 }
2958 [23:21:56.989486697] (+0.000009568) sched_migrate_task: { 1 }, { comm = "lttng-consumerd", tid = 1193, prio = 20, orig_cpu = 1, dest_cpu = 1 }
2959 [23:21:56.989508418] (+0.000021721) hrtimer_init: { 1 }, { hrtimer = 3970832076, clockid = 1, mode = 1 }
2960 [23:21:56.989770462] (+0.000262044) hrtimer_cancel: { 1 }, { hrtimer = 3993865440 }
2961 [23:21:56.989771580] (+0.000001118) hrtimer_cancel: { 0 }, { hrtimer = 3993812192 }
2962 [23:21:56.989776957] (+0.000005377) hrtimer_expire_entry: { 1 }, { hrtimer = 3993865440, now = 79815980007057, function = 3238465232 }
2963 [23:21:56.989778145] (+0.000001188) hrtimer_expire_entry: { 0 }, { hrtimer = 3993812192, now = 79815980008174, function = 3238465232 }
2964 [23:21:56.989791695] (+0.000013550) softirq_raise: { 1 }, { vec = 1 }
2965 [23:21:56.989795396] (+0.000003701) softirq_raise: { 0 }, { vec = 1 }
2966 [23:21:56.989800635] (+0.000005239) softirq_raise: { 0 }, { vec = 9 }
2967 [23:21:56.989807130] (+0.000006495) sched_stat_runtime: { 1 }, { comm = "lttng-consumerd", tid = 1193, runtime = 330710, vruntime = 43368314098 }
2968 [23:21:56.989809993] (+0.000002863) sched_stat_runtime: { 0 }, { comm = "lttng-sessiond", tid = 1181, runtime = 1015313, vruntime = 36976733240 }
2969 [23:21:56.989818514] (+0.000008521) hrtimer_expire_exit: { 0 }, { hrtimer = 3993812192 }
2970 [23:21:56.989819631] (+0.000001117) hrtimer_expire_exit: { 1 }, { hrtimer = 3993865440 }
2971 [23:21:56.989821866] (+0.000002235) hrtimer_start: { 0 }, { hrtimer = 3993812192, function = 3238465232, expires = 79815981000000, softexpires = 79815981000000 }
2972 [23:21:56.989822984] (+0.000001118) hrtimer_start: { 1 }, { hrtimer = 3993865440, function = 3238465232, expires = 79815981000000, softexpires = 79815981000000 }
2973 [23:21:56.989832762] (+0.000009778) softirq_entry: { 1 }, { vec = 1 }
2974 [23:21:56.989833879] (+0.000001117) softirq_entry: { 0 }, { vec = 1 }
2975 [23:21:56.989838069] (+0.000004190) timer_cancel: { 1 }, { timer = 3993871956 }
2976 [23:21:56.989839187] (+0.000001118) timer_cancel: { 0 }, { timer = 3993818708 }
2977 [23:21:56.989841492] (+0.000002305) timer_expire_entry: { 1 }, { timer = 3993871956, now = 79515980, function = 3238277552 }
2978 [23:21:56.989842819] (+0.000001327) timer_expire_entry: { 0 }, { timer = 3993818708, now = 79515980, function = 3238277552 }
2979 [23:21:56.989854831] (+0.000012012) sched_stat_runtime: { 1 }, { comm = "lttng-consumerd", tid = 1193, runtime = 49237, vruntime = 43368363335 }
2980 [23:21:56.989855949] (+0.000001118) sched_stat_runtime: { 0 }, { comm = "lttng-sessiond", tid = 1181, runtime = 45121, vruntime = 36976778361 }
2981 [23:21:56.989861257] (+0.000005308) sched_stat_sleep: { 1 }, { comm = "kworker/1:1", tid = 21, delay = 9451318 }
2982 [23:21:56.989862374] (+0.000001117) sched_stat_sleep: { 0 }, { comm = "kworker/0:0", tid = 4, delay = 9958820 }
2983 [23:21:56.989868241] (+0.000005867) sched_wakeup: { 0 }, { comm = "kworker/0:0", tid = 4, prio = 120, success = 1, target_cpu = 0 }
2984 [23:21:56.989869358] (+0.000001117) sched_wakeup: { 1 }, { comm = "kworker/1:1", tid = 21, prio = 120, success = 1, target_cpu = 1 }
2985 [23:21:56.989877460] (+0.000008102) timer_expire_exit: { 1 }, { timer = 3993871956 }
2986 [23:21:56.989878577] (+0.000001117) timer_expire_exit: { 0 }, { timer = 3993818708 }
2987 .
2988 .
2989 .
2990 </literallayout>
2991 You can now safely destroy the trace session (note that
2992 this doesn't delete the trace - it's still there
2993 in ~/lttng-traces):
2994 <literallayout class='monospaced'>
2995 root@crownbay:~# lttng destroy
2996 Session auto-20121015-232120 destroyed at /home/root
2997 </literallayout>
2998 Note that the trace is saved in a directory of the same
2999 name as returned by 'lttng create', under the ~/lttng-traces
3000 directory (note that you can change this by supplying your
3001 own name to 'lttng create'):
3002 <literallayout class='monospaced'>
3003 root@crownbay:~# ls -al ~/lttng-traces
3004 drwxrwx--- 3 root root 1024 Oct 15 23:21 .
3005 drwxr-xr-x 5 root root 1024 Oct 15 23:57 ..
3006 drwxrwx--- 3 root root 1024 Oct 15 23:21 auto-20121015-232120
3007 </literallayout>
3008 </para>
3009 </section>
3010
3011 <section id='collecting-and-viewing-a-userspace-trace-on-the-target-inside-a-shell'>
3012 <title>Collecting and viewing a userspace trace on the target (inside a shell)</title>
3013
3014 <para>
3015 For lttng userspace tracing, you need to have a properly
3016 instrumented userspace program. For this example, we'll use
3017 the 'hello' test program generated by the lttng-ust build.
3018 </para>
3019
3020 <para>
3021 The 'hello' test program isn't installed on the rootfs by
3022 the lttng-ust build, so we need to copy it over manually.
3023 First cd into the build directory that contains the hello
3024 executable:
3025 <literallayout class='monospaced'>
3026 $ cd build/tmp/work/core2-poky-linux/lttng-ust/2.0.5-r0/git/tests/hello/.libs
3027 </literallayout>
3028 Copy that over to the target machine:
3029 <literallayout class='monospaced'>
3030 $ scp hello root@192.168.1.20:
3031 </literallayout>
3032 You now have the instrumented lttng 'hello world' test
3033 program on the target, ready to test.
3034 </para>
3035
3036 <para>
3037 First, from the target, ssh to the target:
3038 <literallayout class='monospaced'>
3039 $ ssh -l root 192.168.1.47
3040 The authenticity of host '192.168.1.47 (192.168.1.47)' can't be established.
3041 RSA key fingerprint is 23:bd:c8:b1:a8:71:52:00:ee:00:4f:64:9e:10:b9:7e.
3042 Are you sure you want to continue connecting (yes/no)? yes
3043 Warning: Permanently added '192.168.1.47' (RSA) to the list of known hosts.
3044 root@192.168.1.47's password:
3045 </literallayout>
3046 Once on the target, use these steps to create a trace:
3047 <literallayout class='monospaced'>
3048 root@crownbay:~# lttng create
3049 Session auto-20190303-021943 created.
3050 Traces will be written in /home/root/lttng-traces/auto-20190303-021943
3051 </literallayout>
3052 Enable the events you want to trace (in this case all
3053 userspace events):
3054 <literallayout class='monospaced'>
3055 root@crownbay:~# lttng enable-event --userspace --all
3056 All UST events are enabled in channel channel0
3057 </literallayout>
3058 Start the trace:
3059 <literallayout class='monospaced'>
3060 root@crownbay:~# lttng start
3061 Tracing started for session auto-20190303-021943
3062 </literallayout>
3063 Run the instrumented hello world program:
3064 <literallayout class='monospaced'>
3065 root@crownbay:~# ./hello
3066 Hello, World!
3067 Tracing... done.
3068 </literallayout>
3069 And then stop the trace after awhile or after running a
3070 particular workload that you want to trace:
3071 <literallayout class='monospaced'>
3072 root@crownbay:~# lttng stop
3073 Tracing stopped for session auto-20190303-021943
3074 </literallayout>
3075 You can now view the trace in text form on the target:
3076 <literallayout class='monospaced'>
3077 root@crownbay:~# lttng view
3078 [02:31:14.906146544] (+?.?????????) hello:1424 ust_tests_hello:tptest: { cpu_id = 1 }, { intfield = 0, intfield2 = 0x0, longfield = 0, netintfield = 0, netintfieldhex = 0x0, arrfield1 = [ [0] = 1, [1] = 2, [2] = 3 ], arrfield2 = "test", _seqfield1_length = 4, seqfield1 = [ [0] = 116, [1] = 101, [2] = 115, [3] = 116 ], _seqfield2_length = 4, seqfield2 = "test", stringfield = "test", floatfield = 2222, doublefield = 2, boolfield = 1 }
3079 [02:31:14.906170360] (+0.000023816) hello:1424 ust_tests_hello:tptest: { cpu_id = 1 }, { intfield = 1, intfield2 = 0x1, longfield = 1, netintfield = 1, netintfieldhex = 0x1, arrfield1 = [ [0] = 1, [1] = 2, [2] = 3 ], arrfield2 = "test", _seqfield1_length = 4, seqfield1 = [ [0] = 116, [1] = 101, [2] = 115, [3] = 116 ], _seqfield2_length = 4, seqfield2 = "test", stringfield = "test", floatfield = 2222, doublefield = 2, boolfield = 1 }
3080 [02:31:14.906183140] (+0.000012780) hello:1424 ust_tests_hello:tptest: { cpu_id = 1 }, { intfield = 2, intfield2 = 0x2, longfield = 2, netintfield = 2, netintfieldhex = 0x2, arrfield1 = [ [0] = 1, [1] = 2, [2] = 3 ], arrfield2 = "test", _seqfield1_length = 4, seqfield1 = [ [0] = 116, [1] = 101, [2] = 115, [3] = 116 ], _seqfield2_length = 4, seqfield2 = "test", stringfield = "test", floatfield = 2222, doublefield = 2, boolfield = 1 }
3081 [02:31:14.906194385] (+0.000011245) hello:1424 ust_tests_hello:tptest: { cpu_id = 1 }, { intfield = 3, intfield2 = 0x3, longfield = 3, netintfield = 3, netintfieldhex = 0x3, arrfield1 = [ [0] = 1, [1] = 2, [2] = 3 ], arrfield2 = "test", _seqfield1_length = 4, seqfield1 = [ [0] = 116, [1] = 101, [2] = 115, [3] = 116 ], _seqfield2_length = 4, seqfield2 = "test", stringfield = "test", floatfield = 2222, doublefield = 2, boolfield = 1 }
3082 .
3083 .
3084 .
3085 </literallayout>
3086 You can now safely destroy the trace session (note that
3087 this doesn't delete the trace - it's still
3088 there in ~/lttng-traces):
3089 <literallayout class='monospaced'>
3090 root@crownbay:~# lttng destroy
3091 Session auto-20190303-021943 destroyed at /home/root
3092 </literallayout>
3093 </para>
3094 </section>
3095
3096 <section id='manually-copying-a-trace-to-the-host-and-viewing-it-in-eclipse'>
3097 <title>Manually copying a trace to the host and viewing it in Eclipse (i.e. using Eclipse without network support)</title>
3098
3099 <para>
3100 If you already have an LTTng trace on a remote target and
3101 would like to view it in Eclipse on the host, you can easily
3102 copy it from the target to the host and import it into
3103 Eclipse to view it using the LTTng Eclipse plug-in already
3104 bundled in the Eclipse (Juno SR1 or greater).
3105 </para>
3106
3107 <para>
3108 Using the trace we created in the previous section, archive
3109 it and copy it to your host system:
3110 <literallayout class='monospaced'>
3111 root@crownbay:~/lttng-traces# tar zcvf auto-20121015-232120.tar.gz auto-20121015-232120
3112 auto-20121015-232120/
3113 auto-20121015-232120/kernel/
3114 auto-20121015-232120/kernel/metadata
3115 auto-20121015-232120/kernel/channel0_1
3116 auto-20121015-232120/kernel/channel0_0
3117
3118 $ scp root@192.168.1.47:lttng-traces/auto-20121015-232120.tar.gz .
3119 root@192.168.1.47's password:
3120 auto-20121015-232120.tar.gz 100% 1566KB 1.5MB/s 00:01
3121 </literallayout>
3122 Unarchive it on the host:
3123 <literallayout class='monospaced'>
3124 $ gunzip -c auto-20121015-232120.tar.gz | tar xvf -
3125 auto-20121015-232120/
3126 auto-20121015-232120/kernel/
3127 auto-20121015-232120/kernel/metadata
3128 auto-20121015-232120/kernel/channel0_1
3129 auto-20121015-232120/kernel/channel0_0
3130 </literallayout>
3131 We can now import the trace into Eclipse and view it:
3132 <orderedlist>
3133 <listitem><para>First, start eclipse and open the
3134 'LTTng Kernel' perspective by selecting the following
3135 menu item:
3136 <literallayout class='monospaced'>
3137 Window | Open Perspective | Other...
3138 </literallayout></para></listitem>
3139 <listitem><para>In the dialog box that opens, select
3140 'LTTng Kernel' from the list.</para></listitem>
3141 <listitem><para>Back at the main menu, select the
3142 following menu item:
3143 <literallayout class='monospaced'>
3144 File | New | Project...
3145 </literallayout></para></listitem>
3146 <listitem><para>In the dialog box that opens, select
3147 the 'Tracing | Tracing Project' wizard and press
3148 'Next>'.</para></listitem>
3149 <listitem><para>Give the project a name and press
3150 'Finish'.</para></listitem>
3151 <listitem><para>In the 'Project Explorer' pane under
3152 the project you created, right click on the
3153 'Traces' item.</para></listitem>
3154 <listitem><para>Select 'Import..." and in the dialog
3155 that's displayed:</para></listitem>
3156 <listitem><para>Browse the filesystem and find the
3157 select the 'kernel' directory containing the trace
3158 you copied from the target
3159 e.g. auto-20121015-232120/kernel</para></listitem>
3160 <listitem><para>'Checkmark' the directory in the tree
3161 that's displayed for the trace</para></listitem>
3162 <listitem><para>Below that, select 'Common Trace Format:
3163 Kernel Trace' for the 'Trace Type'</para></listitem>
3164 <listitem><para>Press 'Finish' to close the dialog
3165 </para></listitem>
3166 <listitem><para>Back in the 'Project Explorer' pane,
3167 double-click on the 'kernel' item for the
3168 trace you just imported under 'Traces'
3169 </para></listitem>
3170 </orderedlist>
3171 You should now see your trace data displayed graphically
3172 in several different views in Eclipse:
3173 </para>
3174
3175 <para>
3176 <imagedata fileref="figures/lttngmain0.png" width="6in" depth="6in" align="center" scalefit="1" />
3177 </para>
3178
3179 <para>
3180 You can access extensive help information on how to use
3181 the LTTng plug-in to search and analyze captured traces via
3182 the Eclipse help system:
3183 <literallayout class='monospaced'>
3184 Help | Help Contents | LTTng Plug-in User Guide
3185 </literallayout>
3186 </para>
3187 </section>
3188
3189 <section id='collecting-and-viewing-a-trace-in-eclipse'>
3190 <title>Collecting and viewing a trace in Eclipse</title>
3191
3192 <note>
3193 This section on collecting traces remotely doesn't currently
3194 work because of Eclipse 'RSE' connectivity problems. Manually
3195 tracing on the target, copying the trace files to the host,
3196 and viewing the trace in Eclipse on the host as outlined in
3197 previous steps does work however - please use the manual
3198 steps outlined above to view traces in Eclipse.
3199 </note>
3200
3201 <para>
3202 In order to trace a remote target, you also need to add
3203 a 'tracing' group on the target and connect as a user
3204 who's part of that group e.g:
3205 <literallayout class='monospaced'>
3206 # adduser tomz
3207 # groupadd -r tracing
3208 # usermod -a -G tracing tomz
3209 </literallayout>
3210 <orderedlist>
3211 <listitem><para>First, start eclipse and open the
3212 'LTTng Kernel' perspective by selecting the following
3213 menu item:
3214 <literallayout class='monospaced'>
3215 Window | Open Perspective | Other...
3216 </literallayout></para></listitem>
3217 <listitem><para>In the dialog box that opens, select
3218 'LTTng Kernel' from the list.</para></listitem>
3219 <listitem><para>Back at the main menu, select the
3220 following menu item:
3221 <literallayout class='monospaced'>
3222 File | New | Project...
3223 </literallayout></para></listitem>
3224 <listitem><para>In the dialog box that opens, select
3225 the 'Tracing | Tracing Project' wizard and
3226 press 'Next>'.</para></listitem>
3227 <listitem><para>Give the project a name and press
3228 'Finish'. That should result in an entry in the
3229 'Project' subwindow.</para></listitem>
3230 <listitem><para>In the 'Control' subwindow just below
3231 it, press 'New Connection'.</para></listitem>
3232 <listitem><para>Add a new connection, giving it the
3233 hostname or IP address of the target system.
3234 </para></listitem>
3235 <listitem><para>Provide the username and password
3236 of a qualified user (a member of the 'tracing' group)
3237 or root account on the target system.
3238 </para></listitem>
3239 <listitem><para>Provide appropriate answers to whatever
3240 else is asked for e.g. 'secure storage password'
3241 can be anything you want.
3242 If you get an 'RSE Error' it may be due to proxies.
3243 It may be possible to get around the problem by
3244 changing the following setting:
3245 <literallayout class='monospaced'>
3246 Window | Preferences | Network Connections
3247 </literallayout>
3248 Switch 'Active Provider' to 'Direct'
3249 </para></listitem>
3250 </orderedlist>
3251 </para>
3252 </section>
3253 </section>
3254
3255 <section id='lltng-documentation'>
3256 <title>Documentation</title>
3257
3258 <para>
3259 There doesn't seem to be any current documentation covering
3260 LTTng 2.0, but maybe that's because the project is in transition.
3261 The LTTng 2.0 website, however, is here:
3262 <ulink url='http://lttng.org/lttng2.0'>LTTng Project</ulink>
3263 </para>
3264
3265 <para>
3266 You can access extensive help information on how to use the
3267 LTTng plug-in to search and analyze captured traces via the
3268 Eclipse help system:
3269 <literallayout class='monospaced'>
3270 Help | Help Contents | LTTng Plug-in User Guide
3271 </literallayout>
3272 </para>
3273 </section>
3274</section>
3275
3276<section id='profile-manual-blktrace'>
3277 <title>blktrace</title>
3278
3279 <para>
3280 blktrace is a tool for tracing and reporting low-level disk I/O.
3281 blktrace provides the tracing half of the equation; its output can
3282 be piped into the blkparse program, which renders the data in a
3283 human-readable form and does some basic analysis:
3284 </para>
3285
3286 <section id='blktrace-setup'>
3287 <title>Setup</title>
3288
3289 <para>
3290 For this section, we'll assume you've already performed the
3291 basic setup outlined in the
3292 "<link linkend='profile-manual-general-setup'>General Setup</link>"
3293 section.
3294 </para>
3295
3296 <para>
3297 blktrace is an application that runs on the target system.
3298 You can run the entire blktrace and blkparse pipeline on the
3299 target, or you can run blktrace in 'listen' mode on the target
3300 and have blktrace and blkparse collect and analyze the data on
3301 the host (see the
3302 "<link linkend='using-blktrace-remotely'>Using blktrace Remotely</link>"
3303 section below).
3304 For the rest of this section we assume you've ssh'ed to the
3305 host and will be running blkrace on the target.
3306 </para>
3307 </section>
3308
3309 <section id='blktrace-basic-usage'>
3310 <title>Basic Usage</title>
3311
3312 <para>
3313 To record a trace, simply run the 'blktrace' command, giving it
3314 the name of the block device you want to trace activity on:
3315 <literallayout class='monospaced'>
3316 root@crownbay:~# blktrace /dev/sdc
3317 </literallayout>
3318 In another shell, execute a workload you want to trace.
3319 <literallayout class='monospaced'>
3320 root@crownbay:/media/sdc# rm linux-2.6.19.2.tar.bz2; wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>; sync
3321 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
3322 linux-2.6.19.2.tar.b 100% |*******************************| 41727k 0:00:00 ETA
3323 </literallayout>
3324 Press Ctrl-C in the blktrace shell to stop the trace. It will
3325 display how many events were logged, along with the per-cpu file
3326 sizes (blktrace records traces in per-cpu kernel buffers and
3327 simply dumps them to userspace for blkparse to merge and sort
3328 later).
3329 <literallayout class='monospaced'>
3330 ^C=== sdc ===
3331 CPU 0: 7082 events, 332 KiB data
3332 CPU 1: 1578 events, 74 KiB data
3333 Total: 8660 events (dropped 0), 406 KiB data
3334 </literallayout>
3335 If you examine the files saved to disk, you see multiple files,
3336 one per CPU and with the device name as the first part of the
3337 filename:
3338 <literallayout class='monospaced'>
3339 root@crownbay:~# ls -al
3340 drwxr-xr-x 6 root root 1024 Oct 27 22:39 .
3341 drwxr-sr-x 4 root root 1024 Oct 26 18:24 ..
3342 -rw-r--r-- 1 root root 339938 Oct 27 22:40 sdc.blktrace.0
3343 -rw-r--r-- 1 root root 75753 Oct 27 22:40 sdc.blktrace.1
3344 </literallayout>
3345 To view the trace events, simply invoke 'blkparse' in the
3346 directory containing the trace files, giving it the device name
3347 that forms the first part of the filenames:
3348 <literallayout class='monospaced'>
3349 root@crownbay:~# blkparse sdc
3350
3351 8,32 1 1 0.000000000 1225 Q WS 3417048 + 8 [jbd2/sdc-8]
3352 8,32 1 2 0.000025213 1225 G WS 3417048 + 8 [jbd2/sdc-8]
3353 8,32 1 3 0.000033384 1225 P N [jbd2/sdc-8]
3354 8,32 1 4 0.000043301 1225 I WS 3417048 + 8 [jbd2/sdc-8]
3355 8,32 1 0 0.000057270 0 m N cfq1225 insert_request
3356 8,32 1 0 0.000064813 0 m N cfq1225 add_to_rr
3357 8,32 1 5 0.000076336 1225 U N [jbd2/sdc-8] 1
3358 8,32 1 0 0.000088559 0 m N cfq workload slice:150
3359 8,32 1 0 0.000097359 0 m N cfq1225 set_active wl_prio:0 wl_type:1
3360 8,32 1 0 0.000104063 0 m N cfq1225 Not idling. st->count:1
3361 8,32 1 0 0.000112584 0 m N cfq1225 fifo= (null)
3362 8,32 1 0 0.000118730 0 m N cfq1225 dispatch_insert
3363 8,32 1 0 0.000127390 0 m N cfq1225 dispatched a request
3364 8,32 1 0 0.000133536 0 m N cfq1225 activate rq, drv=1
3365 8,32 1 6 0.000136889 1225 D WS 3417048 + 8 [jbd2/sdc-8]
3366 8,32 1 7 0.000360381 1225 Q WS 3417056 + 8 [jbd2/sdc-8]
3367 8,32 1 8 0.000377422 1225 G WS 3417056 + 8 [jbd2/sdc-8]
3368 8,32 1 9 0.000388876 1225 P N [jbd2/sdc-8]
3369 8,32 1 10 0.000397886 1225 Q WS 3417064 + 8 [jbd2/sdc-8]
3370 8,32 1 11 0.000404800 1225 M WS 3417064 + 8 [jbd2/sdc-8]
3371 8,32 1 12 0.000412343 1225 Q WS 3417072 + 8 [jbd2/sdc-8]
3372 8,32 1 13 0.000416533 1225 M WS 3417072 + 8 [jbd2/sdc-8]
3373 8,32 1 14 0.000422121 1225 Q WS 3417080 + 8 [jbd2/sdc-8]
3374 8,32 1 15 0.000425194 1225 M WS 3417080 + 8 [jbd2/sdc-8]
3375 8,32 1 16 0.000431968 1225 Q WS 3417088 + 8 [jbd2/sdc-8]
3376 8,32 1 17 0.000435251 1225 M WS 3417088 + 8 [jbd2/sdc-8]
3377 8,32 1 18 0.000440279 1225 Q WS 3417096 + 8 [jbd2/sdc-8]
3378 8,32 1 19 0.000443911 1225 M WS 3417096 + 8 [jbd2/sdc-8]
3379 8,32 1 20 0.000450336 1225 Q WS 3417104 + 8 [jbd2/sdc-8]
3380 8,32 1 21 0.000454038 1225 M WS 3417104 + 8 [jbd2/sdc-8]
3381 8,32 1 22 0.000462070 1225 Q WS 3417112 + 8 [jbd2/sdc-8]
3382 8,32 1 23 0.000465422 1225 M WS 3417112 + 8 [jbd2/sdc-8]
3383 8,32 1 24 0.000474222 1225 I WS 3417056 + 64 [jbd2/sdc-8]
3384 8,32 1 0 0.000483022 0 m N cfq1225 insert_request
3385 8,32 1 25 0.000489727 1225 U N [jbd2/sdc-8] 1
3386 8,32 1 0 0.000498457 0 m N cfq1225 Not idling. st->count:1
3387 8,32 1 0 0.000503765 0 m N cfq1225 dispatch_insert
3388 8,32 1 0 0.000512914 0 m N cfq1225 dispatched a request
3389 8,32 1 0 0.000518851 0 m N cfq1225 activate rq, drv=2
3390 .
3391 .
3392 .
3393 8,32 0 0 58.515006138 0 m N cfq3551 complete rqnoidle 1
3394 8,32 0 2024 58.516603269 3 C WS 3156992 + 16 [0]
3395 8,32 0 0 58.516626736 0 m N cfq3551 complete rqnoidle 1
3396 8,32 0 0 58.516634558 0 m N cfq3551 arm_idle: 8 group_idle: 0
3397 8,32 0 0 58.516636933 0 m N cfq schedule dispatch
3398 8,32 1 0 58.516971613 0 m N cfq3551 slice expired t=0
3399 8,32 1 0 58.516982089 0 m N cfq3551 sl_used=13 disp=6 charge=13 iops=0 sect=80
3400 8,32 1 0 58.516985511 0 m N cfq3551 del_from_rr
3401 8,32 1 0 58.516990819 0 m N cfq3551 put_queue
3402
3403 CPU0 (sdc):
3404 Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB
3405 Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB
3406 Reads Requeued: 0 Writes Requeued: 0
3407 Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB
3408 Read Merges: 0, 0KiB Write Merges: 13, 160KiB
3409 Read depth: 0 Write depth: 2
3410 IO unplugs: 23 Timer unplugs: 0
3411 CPU1 (sdc):
3412 Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB
3413 Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB
3414 Reads Requeued: 0 Writes Requeued: 0
3415 Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB
3416 Read Merges: 0, 0KiB Write Merges: 40, 276KiB
3417 Read depth: 0 Write depth: 2
3418 IO unplugs: 30 Timer unplugs: 1
3419
3420 Total (sdc):
3421 Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB
3422 Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB
3423 Reads Requeued: 0 Writes Requeued: 0
3424 Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB
3425 Read Merges: 0, 0KiB Write Merges: 53, 436KiB
3426 IO unplugs: 53 Timer unplugs: 1
3427
3428 Throughput (R/W): 0KiB/s / 719KiB/s
3429 Events (sdc): 6,592 entries
3430 Skips: 0 forward (0 - 0.0%)
3431 Input file sdc.blktrace.0 added
3432 Input file sdc.blktrace.1 added
3433 </literallayout>
3434 The report shows each event that was found in the blktrace data,
3435 along with a summary of the overall block I/O traffic during
3436 the run. You can look at the
3437 <ulink url='http://linux.die.net/man/1/blkparse'>blkparse</ulink>
3438 manpage to learn the
3439 meaning of each field displayed in the trace listing.
3440 </para>
3441
3442 <section id='blktrace-live-mode'>
3443 <title>Live Mode</title>
3444
3445 <para>
3446 blktrace and blkparse are designed from the ground up to
3447 be able to operate together in a 'pipe mode' where the
3448 stdout of blktrace can be fed directly into the stdin of
3449 blkparse:
3450 <literallayout class='monospaced'>
3451 root@crownbay:~# blktrace /dev/sdc -o - | blkparse -i -
3452 </literallayout>
3453 This enables long-lived tracing sessions to run without
3454 writing anything to disk, and allows the user to look for
3455 certain conditions in the trace data in 'real-time' by
3456 viewing the trace output as it scrolls by on the screen or
3457 by passing it along to yet another program in the pipeline
3458 such as grep which can be used to identify and capture
3459 conditions of interest.
3460 </para>
3461
3462 <para>
3463 There's actually another blktrace command that implements
3464 the above pipeline as a single command, so the user doesn't
3465 have to bother typing in the above command sequence:
3466 <literallayout class='monospaced'>
3467 root@crownbay:~# btrace /dev/sdc
3468 </literallayout>
3469 </para>
3470 </section>
3471
3472 <section id='using-blktrace-remotely'>
3473 <title>Using blktrace Remotely</title>
3474
3475 <para>
3476 Because blktrace traces block I/O and at the same time
3477 normally writes its trace data to a block device, and
3478 in general because it's not really a great idea to make
3479 the device being traced the same as the device the tracer
3480 writes to, blktrace provides a way to trace without
3481 perturbing the traced device at all by providing native
3482 support for sending all trace data over the network.
3483 </para>
3484
3485 <para>
3486 To have blktrace operate in this mode, start blktrace on
3487 the target system being traced with the -l option, along with
3488 the device to trace:
3489 <literallayout class='monospaced'>
3490 root@crownbay:~# blktrace -l /dev/sdc
3491 server: waiting for connections...
3492 </literallayout>
3493 On the host system, use the -h option to connect to the
3494 target system, also passing it the device to trace:
3495 <literallayout class='monospaced'>
3496 $ blktrace -d /dev/sdc -h 192.168.1.43
3497 blktrace: connecting to 192.168.1.43
3498 blktrace: connected!
3499 </literallayout>
3500 On the target system, you should see this:
3501 <literallayout class='monospaced'>
3502 server: connection from 192.168.1.43
3503 </literallayout>
3504 In another shell, execute a workload you want to trace.
3505 <literallayout class='monospaced'>
3506 root@crownbay:/media/sdc# rm linux-2.6.19.2.tar.bz2; wget <ulink url='http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2'>http://downloads.yoctoproject.org/mirror/sources/linux-2.6.19.2.tar.bz2</ulink>; sync
3507 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
3508 linux-2.6.19.2.tar.b 100% |*******************************| 41727k 0:00:00 ETA
3509 </literallayout>
3510 When it's done, do a Ctrl-C on the host system to
3511 stop the trace:
3512 <literallayout class='monospaced'>
3513 ^C=== sdc ===
3514 CPU 0: 7691 events, 361 KiB data
3515 CPU 1: 4109 events, 193 KiB data
3516 Total: 11800 events (dropped 0), 554 KiB data
3517 </literallayout>
3518 On the target system, you should also see a trace
3519 summary for the trace just ended:
3520 <literallayout class='monospaced'>
3521 server: end of run for 192.168.1.43:sdc
3522 === sdc ===
3523 CPU 0: 7691 events, 361 KiB data
3524 CPU 1: 4109 events, 193 KiB data
3525 Total: 11800 events (dropped 0), 554 KiB data
3526 </literallayout>
3527 The blktrace instance on the host will save the target
3528 output inside a hostname-timestamp directory:
3529 <literallayout class='monospaced'>
3530 $ ls -al
3531 drwxr-xr-x 10 root root 1024 Oct 28 02:40 .
3532 drwxr-sr-x 4 root root 1024 Oct 26 18:24 ..
3533 drwxr-xr-x 2 root root 1024 Oct 28 02:40 192.168.1.43-2012-10-28-02:40:56
3534 </literallayout>
3535 cd into that directory to see the output files:
3536 <literallayout class='monospaced'>
3537 $ ls -l
3538 -rw-r--r-- 1 root root 369193 Oct 28 02:44 sdc.blktrace.0
3539 -rw-r--r-- 1 root root 197278 Oct 28 02:44 sdc.blktrace.1
3540 </literallayout>
3541 And run blkparse on the host system using the device name:
3542 <literallayout class='monospaced'>
3543 $ blkparse sdc
3544
3545 8,32 1 1 0.000000000 1263 Q RM 6016 + 8 [ls]
3546 8,32 1 0 0.000036038 0 m N cfq1263 alloced
3547 8,32 1 2 0.000039390 1263 G RM 6016 + 8 [ls]
3548 8,32 1 3 0.000049168 1263 I RM 6016 + 8 [ls]
3549 8,32 1 0 0.000056152 0 m N cfq1263 insert_request
3550 8,32 1 0 0.000061600 0 m N cfq1263 add_to_rr
3551 8,32 1 0 0.000075498 0 m N cfq workload slice:300
3552 .
3553 .
3554 .
3555 8,32 0 0 177.266385696 0 m N cfq1267 arm_idle: 8 group_idle: 0
3556 8,32 0 0 177.266388140 0 m N cfq schedule dispatch
3557 8,32 1 0 177.266679239 0 m N cfq1267 slice expired t=0
3558 8,32 1 0 177.266689297 0 m N cfq1267 sl_used=9 disp=6 charge=9 iops=0 sect=56
3559 8,32 1 0 177.266692649 0 m N cfq1267 del_from_rr
3560 8,32 1 0 177.266696560 0 m N cfq1267 put_queue
3561
3562 CPU0 (sdc):
3563 Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB
3564 Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB
3565 Reads Requeued: 0 Writes Requeued: 0
3566 Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB
3567 Read Merges: 0, 0KiB Write Merges: 9, 344KiB
3568 Read depth: 2 Write depth: 2
3569 IO unplugs: 20 Timer unplugs: 1
3570 CPU1 (sdc):
3571 Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB
3572 Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB
3573 Reads Requeued: 0 Writes Requeued: 0
3574 Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB
3575 Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB
3576 Read depth: 2 Write depth: 2
3577 IO unplugs: 52 Timer unplugs: 0
3578
3579 Total (sdc):
3580 Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB
3581 Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB
3582 Reads Requeued: 0 Writes Requeued: 0
3583 Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB
3584 Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB
3585 IO unplugs: 72 Timer unplugs: 1
3586
3587 Throughput (R/W): 15KiB/s / 238KiB/s
3588 Events (sdc): 9,301 entries
3589 Skips: 0 forward (0 - 0.0%)
3590 </literallayout>
3591 You should see the trace events and summary just as
3592 you would have if you'd run the same command on the target.
3593 </para>
3594 </section>
3595
3596 <section id='tracing-block-io-via-ftrace'>
3597 <title>Tracing Block I/O via 'ftrace'</title>
3598
3599 <para>
3600 It's also possible to trace block I/O using only
3601 <link linkend='the-trace-events-subsystem'>trace events subsystem</link>,
3602 which can be useful for casual tracing
3603 if you don't want bother dealing with the userspace tools.
3604 </para>
3605
3606 <para>
3607 To enable tracing for a given device, use
3608 /sys/block/xxx/trace/enable, where xxx is the device name.
3609 This for example enables tracing for /dev/sdc:
3610 <literallayout class='monospaced'>
3611 root@crownbay:/sys/kernel/debug/tracing# echo 1 > /sys/block/sdc/trace/enable
3612 </literallayout>
3613 Once you've selected the device(s) you want to trace,
3614 selecting the 'blk' tracer will turn the blk tracer on:
3615 <literallayout class='monospaced'>
3616 root@crownbay:/sys/kernel/debug/tracing# cat available_tracers
3617 blk function_graph function nop
3618
3619 root@crownbay:/sys/kernel/debug/tracing# echo blk > current_tracer
3620 </literallayout>
3621 Execute the workload you're interested in:
3622 <literallayout class='monospaced'>
3623 root@crownbay:/sys/kernel/debug/tracing# cat /media/sdc/testfile.txt
3624 </literallayout>
3625 And look at the output (note here that we're using
3626 'trace_pipe' instead of trace to capture this trace -
3627 this allows us to wait around on the pipe for data to
3628 appear):
3629 <literallayout class='monospaced'>
3630 root@crownbay:/sys/kernel/debug/tracing# cat trace_pipe
3631 cat-3587 [001] d..1 3023.276361: 8,32 Q R 1699848 + 8 [cat]
3632 cat-3587 [001] d..1 3023.276410: 8,32 m N cfq3587 alloced
3633 cat-3587 [001] d..1 3023.276415: 8,32 G R 1699848 + 8 [cat]
3634 cat-3587 [001] d..1 3023.276424: 8,32 P N [cat]
3635 cat-3587 [001] d..2 3023.276432: 8,32 I R 1699848 + 8 [cat]
3636 cat-3587 [001] d..1 3023.276439: 8,32 m N cfq3587 insert_request
3637 cat-3587 [001] d..1 3023.276445: 8,32 m N cfq3587 add_to_rr
3638 cat-3587 [001] d..2 3023.276454: 8,32 U N [cat] 1
3639 cat-3587 [001] d..1 3023.276464: 8,32 m N cfq workload slice:150
3640 cat-3587 [001] d..1 3023.276471: 8,32 m N cfq3587 set_active wl_prio:0 wl_type:2
3641 cat-3587 [001] d..1 3023.276478: 8,32 m N cfq3587 fifo= (null)
3642 cat-3587 [001] d..1 3023.276483: 8,32 m N cfq3587 dispatch_insert
3643 cat-3587 [001] d..1 3023.276490: 8,32 m N cfq3587 dispatched a request
3644 cat-3587 [001] d..1 3023.276497: 8,32 m N cfq3587 activate rq, drv=1
3645 cat-3587 [001] d..2 3023.276500: 8,32 D R 1699848 + 8 [cat]
3646 </literallayout>
3647 And this turns off tracing for the specified device:
3648 <literallayout class='monospaced'>
3649 root@crownbay:/sys/kernel/debug/tracing# echo 0 > /sys/block/sdc/trace/enable
3650 </literallayout>
3651 </para>
3652 </section>
3653 </section>
3654
3655 <section id='blktrace-documentation'>
3656 <title>Documentation</title>
3657
3658 <para>
3659 Online versions of the man pages for the commands discussed
3660 in this section can be found here:
3661 <itemizedlist>
3662 <listitem><para><ulink url='http://linux.die.net/man/8/blktrace'>http://linux.die.net/man/8/blktrace</ulink>
3663 </para></listitem>
3664 <listitem><para><ulink url='http://linux.die.net/man/1/blkparse'>http://linux.die.net/man/1/blkparse</ulink>
3665 </para></listitem>
3666 <listitem><para><ulink url='http://linux.die.net/man/8/btrace'>http://linux.die.net/man/8/btrace</ulink>
3667 </para></listitem>
3668 </itemizedlist>
3669 </para>
3670
3671 <para>
3672 The above manpages, along with manpages for the other
3673 blktrace utilities (btt, blkiomon, etc) can be found in the
3674 /doc directory of the blktrace tools git repo:
3675 <literallayout class='monospaced'>
3676 $ git clone git://git.kernel.dk/blktrace.git
3677 </literallayout>
3678 </para>
3679 </section>
3680</section>
3681</chapter>
3682<!--
3683vim: expandtab tw=80 ts=4
3684-->
diff --git a/documentation/profile-manual/profile-manual.xml b/documentation/profile-manual/profile-manual.xml
new file mode 100644
index 0000000000..bafecff7e2
--- /dev/null
+++ b/documentation/profile-manual/profile-manual.xml
@@ -0,0 +1,85 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='profile-manual' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/profile-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Profiling and Tracing Manual
21 </title>
22
23 <authorgroup>
24 <author>
25 <firstname>Tom</firstname> <surname>Zanussi</surname>
26 <affiliation>
27 <orgname>Intel Corporation</orgname>
28 </affiliation>
29 <email>tom.zanussi@intel.com</email>
30 </author>
31 </authorgroup>
32
33 <revhistory>
34 <revision>
35 <revnumber>1.4</revnumber>
36 <date>April 2013</date>
37 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
38 </revision>
39 <revision>
40 <revnumber>1.5</revnumber>
41 <date>October 2013</date>
42 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
43 </revision>
44 <revision>
45 <revnumber>1.5.1</revnumber>
46 <date>Sometime in 2013</date>
47 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
48 </revision>
49 </revhistory>
50
51 <copyright>
52 <year>&COPYRIGHT_YEAR;</year>
53 <holder>Linux Foundation</holder>
54 </copyright>
55
56 <legalnotice>
57 <para>
58 Permission is granted to copy, distribute and/or modify this document under
59 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">
60 Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by
61 Creative Commons.
62 </para>
63
64 <note>
65 For the latest version of this manual associated with this
66 Yocto Project release, see the
67 <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>
68 from the Yocto Project website.
69 </note>
70 </legalnotice>
71
72 </bookinfo>
73
74 <xi:include href="profile-manual-intro.xml"/>
75
76 <xi:include href="profile-manual-arch.xml"/>
77
78 <xi:include href="profile-manual-usage.xml"/>
79
80 <xi:include href="profile-manual-examples.xml"/>
81
82</book>
83<!--
84vim: expandtab tw=80 ts=4
85-->
diff --git a/documentation/ref-manual/TODO b/documentation/ref-manual/TODO
new file mode 100644
index 0000000000..ee0db977cc
--- /dev/null
+++ b/documentation/ref-manual/TODO
@@ -0,0 +1,11 @@
1Handbook Todo List:
2
3 * Document adding a new IMAGE_FEATURE to the customising images section
4 * Add instructions about using zaurus/openmoko emulation
5 * Add component overview/block diagrams
6 * Software Deevelopment intro should mention its software development for
7 intended target and could be a different arch etc and thus special case.
8 * Expand insane.bbclass documentation to cover tests
9 * Document remaining classes (see list in ref-classes)
10 * Document formfactor
11
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
new file mode 100644
index 0000000000..25c03e0a52
--- /dev/null
+++ b/documentation/ref-manual/closer-look.xml
@@ -0,0 +1,1224 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='closer-look'>
6<title>A Closer Look at the Yocto Project Development Environment</title>
7
8 <para>
9 This chapter takes a more detailed look at the Yocto Project
10 development environment.
11 The following diagram represents the development environment at a
12 high level.
13 The remainder of this chapter expands on the fundamental input, output,
14 process, and
15 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>) blocks
16 in the Yocto Project development environment.
17 </para>
18
19 <para id='general-yocto-environment-figure'>
20 <imagedata fileref="figures/yocto-environment-ref.png" align="center" width="8in" depth="4.25in" />
21 </para>
22
23 <para>
24 The generalized Yocto Project Development Environment consists of
25 several functional areas:
26 <itemizedlist>
27 <listitem><para><emphasis>User Configuration:</emphasis>
28 Metadata you can use to control the build process.
29 </para></listitem>
30 <listitem><para><emphasis>Metadata Layers:</emphasis>
31 Various layers that provide software, machine, and
32 distro Metadata.</para></listitem>
33 <listitem><para><emphasis>Source Files:</emphasis>
34 Upstream releases, local projects, and SCMs.</para></listitem>
35 <listitem><para><emphasis>Build System:</emphasis>
36 Processes under the control of BitBake.
37 This block expands on how BitBake fetches source, applies
38 patches, completes compilation, analyzes output for package
39 generation, creates and tests packages, generates images, and
40 generates cross-development tools.</para></listitem>
41 <listitem><para><emphasis>Package Feeds:</emphasis>
42 Directories containing output packages (rpm, deb or ipk),
43 which are subsequently used in the construction of an image or
44 SDK, produced by the build system.
45 These feeds can also be copied and shared using a web server or
46 other means to facilitate extending or updating existing
47 images on devices at runtime if runtime package management is
48 enabled.</para></listitem>
49 <listitem><para><emphasis>Images:</emphasis>
50 Images produced by the development process.
51 Where do they go?
52 Can you mess with them (i.e. freely delete them or move them?).
53 </para></listitem>
54 <listitem><para><emphasis>Application Development SDK:</emphasis>
55 Cross-development tools that are produced along with an image
56 or separately with BitBake.</para></listitem>
57 </itemizedlist>
58 </para>
59
60 <section id="user-configuration">
61 <title>User Configuration</title>
62
63 <para>
64 User configuration helps define the build.
65 Through user configuration, you can tell BitBake the
66 target architecture for which you are building the image,
67 where to store downloaded source, and other build properties.
68 </para>
69
70 <para>
71 The following figure shows an expanded representation of the
72 "User Configuration" box of the
73 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>:
74 </para>
75
76 <para>
77 <imagedata fileref="figures/user-configuration.png" align="center" width="5.5in" depth="3.5in" />
78 </para>
79
80 <para>
81 BitBake needs some basic configuration files in order to complete
82 a build.
83 These files are <filename>*.conf</filename> files.
84 The minimally necessary ones reside as example files in the
85 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
86 For simplicity, this section refers to the Source Directory as
87 the "Poky Directory."
88 </para>
89
90 <para>
91 When you clone the <filename>poky</filename> Git repository or you
92 download and unpack a Yocto Project release, you can set up the
93 Source Directory to be named anything you want.
94 For this discussion, the cloned repository uses the default
95 name <filename>poky</filename>.
96 <note>
97 The Poky repository is primarily an aggregation of existing
98 repositories.
99 It is not a canonical upstream source.
100 </note>
101 </para>
102
103 <para>
104 The <filename>meta-yocto</filename> layer inside Poky contains
105 a <filename>conf</filename> directory that has example
106 configuration files.
107 These example files are used as a basis for creating actual
108 configuration files when you source the build environment
109 script
110 (i.e.
111 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
112 or
113 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
114 </para>
115
116 <para>
117 Sourcing the build environment script creates a
118 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
119 if one does not already exist.
120 BitBake uses the Build Directory for all its work during builds.
121 The Build Directory has a <filename>conf</filename> directory that
122 contains default versions of your <filename>local.conf</filename>
123 and <filename>bblayers.conf</filename> configuration files.
124 These default configuration files are created only if versions
125 do not already exist in the Build Directory at the time you
126 source the build environment setup script.
127 </para>
128
129 <para>
130 Because the Poky repository is fundamentally an aggregation of
131 existing repositories, some users might be familiar with running
132 the <filename>&OE_INIT_FILE;</filename> or
133 <filename>oe-init-build-env-memres</filename> script in the context
134 of separate OpenEmbedded-Core and BitBake repositories rather than a
135 single Poky repository.
136 This discussion assumes the script is executed from within a cloned
137 or unpacked version of Poky.
138 </para>
139
140 <para>
141 Depending on where the script is sourced, different sub-scripts
142 are called to set up the Build Directory (Yocto or OpenEmbedded).
143 Specifically, the script
144 <filename>scripts/oe-setup-builddir</filename> inside the
145 poky directory sets up the Build Directory and seeds the directory
146 (if necessary) with configuration files appropriate for the
147 Yocto Project development environment.
148 <note>
149 The <filename>scripts/oe-setup-builddir</filename> script
150 uses the <filename>$TEMPLATECONF</filename> variable to
151 determine which sample configuration files to locate.
152 </note>
153 </para>
154
155 <para>
156 The <filename>local.conf</filename> file provides many
157 basic variables that define a build environment.
158 Here is a list of a few.
159 To see the default configurations in a <filename>local.conf</filename>
160 file created by the build environment script, see the
161 <filename>local.conf.sample</filename> in the
162 <filename>meta-yocto</filename> layer:
163 <itemizedlist>
164 <listitem><para><emphasis>Parallelism Options:</emphasis>
165 Controlled by the
166 <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
167 and
168 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>
169 variables.</para></listitem>
170 <listitem><para><emphasis>Target Machine Selection:</emphasis>
171 Controlled by the
172 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
173 variable.</para></listitem>
174 <listitem><para><emphasis>Download Directory:</emphasis>
175 Controlled by the
176 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
177 variable.</para></listitem>
178 <listitem><para><emphasis>Shared State Directory:</emphasis>
179 Controlled by the
180 <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>
181 variable.</para></listitem>
182 <listitem><para><emphasis>Build Output:</emphasis>
183 Controlled by the
184 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
185 variable.</para></listitem>
186 </itemizedlist>
187 <note>
188 Configurations set in the <filename>conf/local.conf</filename>
189 file can also be set in the
190 <filename>conf/site.conf</filename> and
191 <filename>conf/auto.conf</filename> configuration files.
192 </note>
193 </para>
194
195 <para>
196 The <filename>bblayers.conf</filename> file tells BitBake what
197 layers you want considered during the build.
198 By default, the layers listed in this file include layers
199 minimally needed by the build system.
200 However, you must manually add any custom layers you have created.
201 You can find more information on working with the
202 <filename>bblayers.conf</filename> file in the
203 "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-your-layer'>Enabling Your Layer</ulink>"
204 section in the Yocto Project Development Manual.
205 </para>
206
207 <para>
208 The files <filename>site.conf</filename> and
209 <filename>auto.conf</filename> are not created by the environment
210 initialization script.
211 If you want these configuration files, you must create them
212 yourself:
213 <itemizedlist>
214 <listitem><para><emphasis><filename>site.conf</filename>:</emphasis>
215 You can use the <filename>conf/site.conf</filename>
216 configuration file to configure multiple build directories.
217 For example, suppose you had several build environments and
218 they shared some common features.
219 You can set these default build properties here.
220 A good example is perhaps the level of parallelism you want
221 to use through the
222 <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
223 and
224 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>
225 variables.</para>
226 <para>One useful scenario for using the
227 <filename>conf/site.conf</filename> file is to extend your
228 <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
229 variable to include the path to a
230 <filename>conf/site.conf</filename>.
231 Then, when BitBake looks for Metadata using
232 <filename>BBPATH</filename>, it finds the
233 <filename>conf/site.conf</filename> file and applies your
234 common configurations found in the file.
235 To override configurations in a particular build directory,
236 alter the similar configurations within that build
237 directory's <filename>conf/local.conf</filename> file.
238 </para></listitem>
239 <listitem><para><emphasis><filename>auto.conf</filename>:</emphasis>
240 This file is not hand-created.
241 Rather, the file is usually created and written to by
242 an autobuilder.
243 The settings put into the file are typically the same as
244 you would find in the <filename>conf/local.conf</filename>
245 or the <filename>conf/site.conf</filename> files.
246 </para></listitem>
247 </itemizedlist>
248 </para>
249
250 <para>
251 You can edit all configuration files to further define
252 any particular build environment.
253 This process is represented by the "User Configuration Edits"
254 box in the figure.
255 </para>
256
257 <para>
258 When you launch your build with the
259 <filename>bitbake &lt;target&gt;</filename> command, BitBake
260 sorts out the configurations to ultimately define your build
261 environment.
262 </para>
263 </section>
264
265 <section id="metadata-machine-configuration-and-policy-configuration">
266 <title>Metadata, Machine Configuration, and Policy Configuration</title>
267
268 <para>
269 The previous section described the user configurations that
270 define the BitBake's global behavior.
271 This section takes a closer look at the layers the build system
272 uses to further control the build.
273 These layers provide Metadata for the software, machine, and
274 policy.
275 </para>
276
277 <para>
278 In general, three types of layer input exist:
279 <itemizedlist>
280 <listitem><para><emphasis>Policy Configuration:</emphasis>
281 Distribution Layers provide top-level or general
282 policies for the image or SDK being built.
283 For example, this layer would dictate whether BitBake
284 produces RPM or IPK packages.</para></listitem>
285 <listitem><para><emphasis>Machine Configuration:</emphasis>
286 Board Support Package (BSP) layers provide machine
287 configurations.
288 This type of information is specific to a particular
289 target architecture.</para></listitem>
290 <listitem><para><emphasis>Metadata:</emphasis>
291 Software layers contain user-supplied recipe files,
292 patches, and append files.
293 </para></listitem>
294 </itemizedlist>
295 </para>
296
297 <para>
298 The following figure shows an expanded representation of the
299 Metadata, Machine Configuration, and Policy Configuration input
300 (layers) boxes of the
301 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>:
302 </para>
303
304 <para>
305 <imagedata fileref="figures/layer-input.png" align="center" width="8in" depth="7.5in" />
306 </para>
307
308 <para>
309 In general, all layers have a similar structure.
310 They all contain a licensing file
311 (e.g. <filename>COPYING</filename>) if the layer is to be
312 distributed, a <filename>README</filename> file as good practice
313 and especially if the layer is to be distributed, a
314 configuration directory, and recipe directories.
315 </para>
316
317 <para>
318 The Yocto Project has many layers that can be used.
319 You can see a web-interface listing of them on the
320 <ulink url="http://git.yoctoproject.org/">Source Repositories</ulink>
321 page.
322 The layers are shown at the bottom categorized under
323 "Yocto Metadata Layers."
324 These layers are fundamentally a subset of the
325 <ulink url="http://layers.openembedded.org/layerindex/layers/">OpenEmbedded Metadata Index</ulink>,
326 which lists all layers provided by the OpenEmbedded community.
327 <note>
328 Layers exist in the Yocto Project Source Repositories that
329 cannot be found in the OpenEmbedded Metadata Index.
330 These layers are either deprecated or experimental in nature.
331 </note>
332 </para>
333
334 <para>
335 BitBake uses the <filename>conf/bblayers.conf</filename> file,
336 which is part of the user configuration, to find what layers it
337 should be using as part of the build.
338 </para>
339
340 <para>
341 For more information on layers, see the
342 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
343 section in the Yocto Project Development Manual.
344 </para>
345
346 <section id="distro-layer">
347 <title>Distro Layer</title>
348
349 <para>
350 The distribution layer provides policy configurations for your
351 distribution.
352 Best practices dictate that you isolate these types of
353 configurations into their own layer.
354 Settings you provide in
355 <filename>conf/&lt;distro&gt;.conf</filename> override similar
356 settings that BitBake finds in your
357 <filename>conf/local.conf</filename> file in the Build
358 Directory.
359 </para>
360
361 <para>
362 The following list provides some explanation and references
363 for what you typically find in the distribution layer:
364 <itemizedlist>
365 <listitem><para><emphasis>classes:</emphasis>
366 Class files (<filename>.bbclass</filename>) holds
367 common functionality that can be shared among
368 recipes in the distribution.
369 When your recipes inherit a class, they take on the
370 settings and functions for that class.
371 You can read more about class files in the
372 "<link linkend='ref-classes'>Classes</link>" section.
373 </para></listitem>
374 <listitem><para><emphasis>conf:</emphasis>
375 This area holds configuration files for the
376 layer (<filename>conf/layer.conf</filename>),
377 the distribution
378 (<filename>conf/distro/&lt;distro&gt;.conf</filename>),
379 and any distribution-wide include files.
380 </para></listitem>
381 <listitem><para><emphasis>recipes-*:</emphasis>
382 Recipes and append files that affect common
383 functionality across the distribution.
384 This area could include recipes and append files to
385 to add distribution-specific configuration,
386 initialization scripts, custom image recipes,
387 and so forth.</para></listitem>
388 </itemizedlist>
389 </para>
390 </section>
391
392 <section id="bsp-layer">
393 <title>BSP Layer</title>
394
395 <para>
396 The BSP Layer provides machine configurations.
397 Everything in this layer is specific to the machine for which
398 you are building the image or the SDK.
399 A common structure or form is defined for BSP layers.
400 You can learn more about this structure in the
401 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
402 <note>
403 In order for a BSP layer to be considered compliant with the
404 Yocto Project, it must meet some structural requirements.
405 </note>
406 </para>
407
408 <para>
409 The BSP Layer's configuration directory contains
410 configuration files for the machine
411 (<filename>conf/machine/&lt;machine&gt;.conf</filename>) and,
412 of course, the layer (<filename>conf/layer.conf</filename>).
413 </para>
414
415 <para>
416 The remainder of the layer is dedicated to specific recipes
417 by function: <filename>recipes-bsp</filename>,
418 <filename>recipes-core</filename>,
419 <filename>recipes-graphics</filename>, and
420 <filename>recipes-kernel</filename>.
421 Metadata can exist for multiple formfactors, graphics
422 support systems, and so forth.
423 <note>
424 While the figure shows several <filename>recipe-*</filename>
425 directories, not all these directories appear in all
426 BSP layers.
427 </note>
428 </para>
429 </section>
430
431 <section id="software-layer">
432 <title>Software Layer</title>
433
434 <para>
435 The software layer provides the Metadata for additional
436 software packages used during the build.
437 This layer does not include Metadata that is specific to the
438 distribution or the machine, which are found in their
439 respective layers.
440 </para>
441
442 <para>
443 This layer contains any new recipes that your project needs
444 in the form of recipe files.
445 </para>
446 </section>
447 </section>
448
449 <section id="sources-dev-environment">
450 <title>Sources</title>
451
452 <para>
453 In order for the OpenEmbedded build system to create an image or
454 any target, it must be able to access source files.
455 The
456 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>
457 represents source files using the "Upstream Project Releases",
458 "Local Projects", and "SCMs (optional)" boxes.
459 The figure represents mirrors, which also play a role in locating
460 source files, with the "Source Mirror(s)" box.
461 </para>
462
463 <para>
464 The method by which source files are ultimately organized is
465 a function of the project.
466 For example, for released software, projects tend to use tarballs
467 or other archived files that can capture the state of a release
468 guaranteeing that it is statically represented.
469 On the other hand, for a project that is more dynamic or
470 experimental in nature, a project might keep source files in a
471 repository controlled by a Source Control Manager (SCM) such as
472 Git.
473 Pulling source from a repository allows you to control
474 the point in the repository (the revision) from which you want to
475 build software.
476 Finally, a combination of the two might exist, which would give the
477 consumer a choice when deciding where to get source files.
478 </para>
479
480 <para>
481 BitBake uses the
482 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
483 variable to point to source files regardless of their location.
484 Each recipe must have a <filename>SRC_URI</filename> variable
485 that points to the source.
486 </para>
487
488 <para>
489 Another area that plays a significant role in where source files
490 comes from is pointed to by the
491 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
492 variable.
493 This area is a cache that can hold previously downloaded source.
494 You can also instruct the OpenEmbedded build system to create
495 tarballs from Git repositories, which is not the default behavior,
496 and store them in the <filename>DL_DIR</filename> by using the
497 <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link>
498 variable.
499 </para>
500
501 <para>
502 Judicious use of a <filename>DL_DIR</filename> directory can
503 save the build system a trip across the Internet when looking
504 for files.
505 A good method for using a download directory is to have
506 <filename>DL_DIR</filename> point to an area outside of your
507 Build Directory.
508 Doing so allows you to safely delete the Build Directory
509 if needed without fear of removing any downloaded source file.
510 </para>
511
512 <para>
513 The remainder of this section provides a deeper look into the
514 source files and the mirrors.
515 Here is a more detailed look at the source file area of the
516 base figure:
517 <imagedata fileref="figures/source-input.png" align="center" width="7in" depth="7.5in" />
518 </para>
519
520 <section id='upstream-project-releases'>
521 <title>Upstream Project Releases</title>
522
523 <para>
524 Upstream project releases exist anywhere in the form of an
525 archived file (e.g. tarball or zip file).
526 These files correspond to individual recipes.
527 For example, the figure uses specific releases each for
528 BusyBox, Qt, and Dbus.
529 An archive file can be for any released product that can be
530 built using a recipe.
531 </para>
532 </section>
533
534 <section id='local-projects'>
535 <title>Local Projects</title>
536
537 <para>
538 Local projects are custom bits of software the user provides.
539 These bits reside somewhere local to a project - perhaps
540 a directory into which the user checks in items (e.g.
541 a local directory containing a development source tree
542 used by the group).
543 </para>
544
545 <para>
546 The canonical method through which to include a local project
547 is to use the
548 <link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>
549 class to include local project.
550 You use either the <filename>local.conf</filename> or a
551 recipe's append file to override or set the
552 recipe to point to the local directory on your disk to pull
553 in the whole source tree.
554 </para>
555
556 <para>
557 For information on how to use the
558 <filename>externalsrc.bbclass</filename>, see the
559 "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>"
560 section.
561 </para>
562 </section>
563
564 <section id='scms'>
565 <title>Source Control Managers (Optional)</title>
566
567 <para>
568 Another place the build system can get source files from is
569 through an SCM such as Git or Subversion.
570 In this case, a repository is cloned or checked out.
571 The <filename>do_fetch</filename> task inside BitBake uses
572 the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
573 variable and the argument's prefix to determine the correct
574 fetcher module.
575 </para>
576
577 <note>
578 For information on how to have the OpenEmbedded build system
579 generate tarballs for Git repositories and place them in the
580 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
581 directory, see the
582 <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link>
583 variable.
584 </note>
585
586 <para>
587 When fetching a repository, BitBake uses the
588 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
589 variable to determine the specific revision from which to
590 build.
591 </para>
592 </section>
593
594 <section id='source-mirrors'>
595 <title>Source Mirror(s)</title>
596
597 <para>
598 Two kinds of mirrors exist: pre-mirrors and regular mirrors.
599 The <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
600 and
601 <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
602 variables point to these, respectively.
603 BitBake checks pre-mirrors before looking upstream for any
604 source files.
605 Pre-mirrors are appropriate when you have a shared directory
606 that is not a directory defined by the
607 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
608 variable.
609 A Pre-mirror typically points to a shared directory that is
610 local to your organization.
611 </para>
612
613 <para>
614 Regular mirrors can be any site across the Internet that is
615 used as an alternative location for source code should the
616 primary site not be functioning for some reason or another.
617 </para>
618 </section>
619 </section>
620
621 <section id="package-feeds-dev-environment">
622 <title>Package Feeds</title>
623
624 <para>
625 When the OpenEmbedded build system generates an image or an SDK,
626 it gets the packages from a package feed area located in the
627 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
628 The
629 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>
630 shows this package feeds area in the upper-right corner.
631 </para>
632
633 <para>
634 This section looks a little closer into the package feeds area used
635 by the build system.
636 Here is a more detailed look at the area:
637 <imagedata fileref="figures/package-feeds.png" align="center" width="7in" depth="6in" />
638 </para>
639
640 <para>
641 Package feeds are an intermediary step in the build process.
642 BitBake generates packages whose type is defined by the
643 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
644 variable.
645 Before placing the packages into package feeds,
646 the build process validates them with generated output quality
647 assurance checks through the
648 <link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>
649 class.
650 </para>
651
652 <para>
653 The package feed area resides in
654 <filename>tmp/deploy</filename> of the Build Directory.
655 Folders are created that correspond to the package type
656 (IPK, DEB, or RPM) created.
657 Further organization is derived through the value of the
658 <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link>
659 variable for each package.
660 For example, packages can exist for the i586 or qemux86
661 architectures.
662 The package files themselves reside within the appropriate
663 architecture folder.
664 </para>
665
666 <para>
667 BitBake uses the <filename>do_package_write_*</filename> task to
668 place generated packages into the package holding area (e.g.
669 <filename>do_package_write_ipk</filename> for IPK packages).
670 </para>
671 </section>
672
673 <section id='bitbake-dev-environment'>
674 <title>BitBake</title>
675
676 <para>
677 The OpenEmbedded build system uses BitBake to produce images.
678 You can see from the
679 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>,
680 the BitBake area consists of several functional areas.
681 This section takes a closer look at each of those areas.
682 </para>
683
684 <section id='source-fetching-dev-environment'>
685 <title>Source Fetching</title>
686
687 <para>
688 The first stages of building a recipe are to fetch and unpack
689 the source code:
690 <imagedata fileref="figures/source-fetching.png" align="center" width="6.5in" depth="5in" />
691 </para>
692
693 <para>
694 The <filename>do_fetch</filename> and
695 <filename>do_unpack</filename> tasks fetch the source files
696 and unpack them into a working directory.
697 By default, everything is accomplished in the
698 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
699 which has a defined structure.
700 For additional general information on the Build Directory,
701 see the
702 "<link linkend='structure-core-build'><filename>build/</filename></link>"
703 section.
704 </para>
705
706 <para>
707 Unpacked source source files are pointed to by the
708 <link linkend='var-S'><filename>S</filename></link> variable.
709 Each recipe has an area in the Build Directory where the
710 unpacked source code resides.
711 The name of directory for any given recipe is defined from
712 several different variables.
713 You can see the variables that define these directories
714 by looking at the figure:
715 <itemizedlist>
716 <listitem><para><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
717 </para></listitem>
718 <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link>
719 </para></listitem>
720 <listitem><para><link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>
721 </para></listitem>
722 <listitem><para><link linkend='var-PN'><filename>PN</filename></link>
723 </para></listitem>
724 <listitem><para><link linkend='var-PV'><filename>PV</filename></link>
725 </para></listitem>
726 <listitem><para><link linkend='var-PR'><filename>PR</filename></link>
727 </para></listitem>
728 <listitem><para><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
729 </para></listitem>
730 <listitem><para><link linkend='var-S'><filename>S</filename></link>
731 </para></listitem>
732 </itemizedlist>
733 </para>
734
735 <para>
736 Briefly, the <filename>S</filename> directory contains the
737 unpacked source files for a recipe.
738 The <filename>WORKDIR</filename> directory is where all the
739 building goes on for a given recipe.
740 </para>
741 </section>
742
743 <section id='patching-dev-environment'>
744 <title>Patching</title>
745
746 <para>
747 Once source code is fetched and unpacked, BitBake locates
748 patch files and applies them to the source files:
749 <imagedata fileref="figures/patching.png" align="center" width="6in" depth="5in" />
750 </para>
751
752 <para>
753 The <filename>do_patch</filename> task processes recipes by
754 using the
755 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
756 variable to locate applicable patch files, which by default
757 are <filename>*.patch</filename> or
758 <filename>*.diff</filename> files, or any file if
759 "apply=yes" is specified for the file in
760 <filename>SRC_URI</filename>.
761 </para>
762
763 <para>
764 BitBake finds and applies multiple patches for a single recipe
765 in the order in which it finds the patches.
766 Patches are applied to the recipe's source files located in the
767 <link linkend='var-S'><filename>S</filename></link> directory.
768 </para>
769
770 <para>
771 For more information on how the source directories are
772 created, see the
773 "<link linkend='source-fetching-dev-environment'>Source Fetching</link>"
774 section.
775 </para>
776 </section>
777
778 <section id='configuration-and-compilation-dev-environment'>
779 <title>Configuration and Compilation</title>
780
781 <para>
782 After source code is patched, BitBake executes tasks that
783 configure and compile the source code:
784 <imagedata fileref="figures/configuration-compile-autoreconf.png" align="center" width="7in" depth="5in" />
785 </para>
786
787 <para>
788 This step in the build process consists of three tasks:
789 <itemizedlist>
790 <listitem><para><emphasis><filename>do_configure</filename>:</emphasis>
791 This task configures the source by enabling and
792 disabling any build-time and configuration options for
793 the software being built.
794 Configurations can come from the recipe itself as well
795 as from an inherited class.
796 Additionally, the software itself might configure itself
797 depending on the target for which it is being built.
798 </para>
799
800 <para>The configurations handled by the
801 <filename>do_configure</filename> task are specific
802 to source code configuration for the source code
803 being built by the recipe.</para>
804
805 <para>If you are using
806 <link linkend='ref-classes-autotools'><filename>autotools.bbclass</filename></link>,
807 you can add additional configuration options by using
808 the <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>
809 variable.
810 For information on how this variable works within
811 that class, see the
812 <filename>meta/classes/autotools.bbclass</filename>.
813 </para></listitem>
814 <listitem><para><emphasis><filename>do_compile</filename>:</emphasis>
815 Once a configuration task has been satisfied, BitBake
816 compiles the source using the
817 <filename>do_compile</filename> task.
818 Compilation occurs in the directory pointed to by the
819 <link linkend='var-B'><filename>B</filename></link>
820 variable.
821 Realize that the <filename>B</filename> directory, by
822 default, is the same as the
823 <link linkend='var-S'><filename>S</filename></link>
824 directory.</para></listitem>
825 <listitem><para><emphasis><filename>do_install</filename>:</emphasis>
826 Once compilation is done, BitBake executes the
827 <filename>do_install</filename> task.
828 This task copies files from the <filename>B</filename>
829 directory and places them in a holding area pointed to
830 by the
831 <link linkend='var-D'><filename>D</filename></link>
832 variable.</para></listitem>
833 </itemizedlist>
834 </para>
835 </section>
836
837 <section id='package-splitting-dev-environment'>
838 <title>Package Splitting</title>
839
840 <para>
841 After source code is configured and compiled, the
842 OpenEmbedded build system analyzes
843 the results and splits the output into packages:
844 <imagedata fileref="figures/analysis-for-package-splitting.png" align="center" width="7in" depth="7in" />
845 </para>
846
847 <para>
848 The <filename>do_package</filename> and
849 <filename>do_packagedata</filename> tasks combine to analyze
850 the files found in the
851 <link linkend='var-D'><filename>D</filename></link> directory
852 and split them into subsets based on available packages and
853 files.
854 The analyzing process involves the following as well as other
855 items: splitting out debugging symbols,
856 looking at shared library dependencies between packages,
857 and looking at package relationships.
858 The <filename>do_packagedata</filename> task creates package
859 metadata based on the analysis such that the
860 OpenEmbedded build system can generate the final packages.
861 Working, staged, and intermediate results of the analysis
862 and package splitting process use these areas:
863 <itemizedlist>
864 <listitem><para><link linkend='var-PKGD'><filename>PKGD</filename></link>
865 </para></listitem>
866 <listitem><para><link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>
867 </para></listitem>
868 <listitem><para><link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link>
869 </para></listitem>
870 <listitem><para><link linkend='var-PKGDEST'><filename>PKGDEST</filename></link>
871 </para></listitem>
872 </itemizedlist>
873 The <link linkend='var-FILES'><filename>FILES</filename></link>
874 variable defines the files that go into each package in
875 <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>.
876 If you want details on how this is accomplished, you can
877 look at
878 <link linkend='ref-classes-package'><filename>package.bbclass</filename></link>.
879 </para>
880
881 <para>
882 Depending on the type of packages being created (RPM, DEB, or
883 IPK), the <filename>do_package_write_*</filename> task
884 creates the actual packages and places them in the
885 Package Feed area, which is
886 <filename>${TMPDIR}/deploy</filename>.
887 You can see the
888 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
889 section for more detail on that part of the build process.
890 <note>
891 Support for creating feeds directly from the
892 <filename>deploy/*</filename> directories does not exist.
893 Creating such feeds usually requires some kind of feed
894 maintenance mechanism that would upload the new packages
895 into an official package feed (e.g. the
896 Ångström distribution).
897 This functionality is highly distribution-specific
898 and thus is not provided out of the box.
899 </note>
900 </para>
901 </section>
902
903 <section id='image-generation-dev-environment'>
904 <title>Image Generation</title>
905
906 <para>
907 Once packages are split and stored in the Package Feeds area,
908 the OpenEmbedded build system uses BitBake to generate the
909 root filesystem image:
910 <imagedata fileref="figures/image-generation.png" align="center" width="6in" depth="7in" />
911 </para>
912
913 <para>
914 The image generation process consists of several stages and
915 depends on many variables.
916 The <filename>do_rootfs</filename> task uses these key variables
917 to help create the list of packages to actually install:
918 <itemizedlist>
919 <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>:
920 Lists out the base set of packages to install from
921 the Package Feeds area.</para></listitem>
922 <listitem><para><link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>:
923 Specifies packages that should not be installed.
924 </para></listitem>
925 <listitem><para><link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>:
926 Specifies features to include in the image.
927 Most of these features map to additional packages for
928 installation.</para></listitem>
929 <listitem><para><link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>:
930 Specifies the package backend to use and consequently
931 helps determine where to locate packages within the
932 Package Feeds area.</para></listitem>
933 <listitem><para><link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link>:
934 Determines the language(s) for which additional
935 language support packages are installed.
936 </para></listitem>
937 </itemizedlist>
938 </para>
939
940 <para>
941 Package installation is under control of the package manager
942 (e.g. smart/rpm, opkg, or apt/dpkg) regardless of whether or
943 not package management is enabled for the target.
944 At the end of the process, if package management is not
945 enabled for the target, the package manager's data files
946 are deleted from the root filesystem.
947 </para>
948
949 <para>
950 During image generation, the build system attempts to run
951 all post installation scripts.
952 Any that fail to run on the build host are run on the
953 target when the target system is first booted.
954 If you are using a
955 <ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>read-only root filesystem</ulink>,
956 all the post installation scripts must succeed during the
957 package installation phase since the root filesystem cannot be
958 written into.
959 </para>
960
961 <para>
962 During Optimization, optimizing processes are run across
963 the image.
964 These processes include <filename>mklibs</filename> and
965 <filename>prelink</filename>.
966 The <filename>mklibs</filename> process optimizes the size
967 of the libraries.
968 A <filename>prelink</filename> process optimizes the dynamic
969 linking of shared libraries to reduce start up time of
970 executables.
971 </para>
972
973 <para>
974 Part of the image generation process includes compressing the
975 root filesystem image.
976 Compression is accomplished through several optimization
977 routines designed to reduce the overall size of the image.
978 </para>
979
980 <para>
981 After the root filesystem has been constructed, the image
982 generation process turns everything into an image file or
983 a set of image files.
984 The formats used for the root filesystem depend on the
985 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
986 variable.
987 </para>
988
989 <note>
990 The entire image generation process is run under Pseudo.
991 Running under Pseudo ensures that the files in the root
992 filesystem have correct ownership.
993 </note>
994 </section>
995
996 <section id='sdk-generation-dev-environment'>
997 <title>SDK Generation</title>
998
999 <para>
1000 The OpenEmbedded build system uses BitBake to generate the
1001 Software Development Kit (SDK) installer script:
1002 <imagedata fileref="figures/sdk-generation.png" align="center" width="6in" depth="7in" />
1003 </para>
1004
1005 <note>
1006 For more information on the cross-development toolchain
1007 generation, see the
1008 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
1009 section.
1010 </note>
1011
1012 <para>
1013 Like image generation, the SDK script process consists of
1014 several stages and depends on many variables.
1015 The <filename>do_populate_sdk</filename> task uses these
1016 key variables to help create the list of packages to actually
1017 install.
1018 For information on the variables listed in the figure, see the
1019 "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
1020 section.
1021 </para>
1022
1023 <para>
1024 The <filename>do_populate_sdk</filename> task handles two
1025 parts: a target part and a host part.
1026 The target part is the part built for the target hardware and
1027 includes libraries and headers.
1028 The host part is the part of the SDK that runs on the
1029 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
1030 </para>
1031
1032 <para>
1033 Once both parts are constructed, the
1034 <filename>do_populate_sdk</filename> task performs some cleanup
1035 on both parts.
1036 After the cleanup, the task creates a cross-development
1037 environment setup script and any configuration files that
1038 might be needed.
1039 </para>
1040
1041 <para>
1042 The final output of the task is the Cross-development
1043 toolchain installation script (<filename>.sh</filename> file),
1044 which includes the environment setup script.
1045 </para>
1046 </section>
1047 </section>
1048
1049 <section id='images-dev-environment'>
1050 <title>Images</title>
1051
1052 <para>
1053 The images produced by the OpenEmbedded build system
1054 are compressed forms of the
1055 root filesystems that are ready to boot on a target device.
1056 You can see from the
1057 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>
1058 that BitBake output in part consists of images.
1059 This section is going to look more closely at this output:
1060 <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" />
1061 </para>
1062
1063 <para>
1064 For a list of example images that the Yocto Project provides,
1065 the
1066 "<link linkend='ref-images'>Images</link>" chapter.
1067 </para>
1068
1069 <para>
1070 Images are written out to the
1071 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1072 inside the <filename>deploy/images/&lt;machine&gt;/</filename>
1073 folder as shown in the figure.
1074 This folder contains any files expected to be loaded on the
1075 target device.
1076 The
1077 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>
1078 variable points to the <filename>deploy</filename> directory,
1079 while the
1080 <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
1081 variable points to the appropriate directory containing images for
1082 the current configuration.
1083 <itemizedlist>
1084 <listitem><para><filename>&lt;kernel-image&gt;</filename>:
1085 A kernel binary file.
1086 The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>
1087 variable setting determines the naming scheme for the
1088 kernel image file.
1089 Depending on that variable, the file could begin with
1090 a variety of naming strings.
1091 The <filename>deploy/images/&lt;machine&gt;</filename>
1092 directory can contain multiple image files for the
1093 machine.</para></listitem>
1094 <listitem><para><filename>&lt;root-filesystem-image&gt;</filename>:
1095 Root filesystems for the target device (e.g.
1096 <filename>*.ext3</filename> or <filename>*.bz2</filename>
1097 files).
1098 The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
1099 variable setting determines the root filesystem image
1100 type.
1101 The <filename>deploy/images/&lt;machine&gt;</filename>
1102 directory can contain multiple root filesystems for the
1103 machine.</para></listitem>
1104 <listitem><para><filename>&lt;kernel-modules&gt;</filename>:
1105 Tarballs that contain all the modules built for the kernel.
1106 Kernel module tarballs exist for legacy purposes and
1107 can be suppressed by setting the
1108 <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link>
1109 variable to "0".
1110 The <filename>deploy/images/&lt;machine&gt;</filename>
1111 directory can contain multiple kernel module tarballs
1112 for the machine.</para></listitem>
1113 <listitem><para><filename>&lt;bootloaders&gt;</filename>:
1114 Bootloaders supporting the image, if applicable to the
1115 target machine.
1116 The <filename>deploy/images/&lt;machine&gt;</filename>
1117 directory can contain multiple bootloaders for the
1118 machine.</para></listitem>
1119 <listitem><para><filename>&lt;symlinks&gt;</filename>:
1120 The <filename>deploy/images/&lt;machine&gt;</filename>
1121 folder contains
1122 a symbolic link that points to the most recently built file
1123 for each machine.
1124 These links might be useful for external scripts that
1125 need to obtain the latest version of each file.
1126 </para></listitem>
1127 </itemizedlist>
1128 </para>
1129 </section>
1130
1131 <section id='sdk-dev-environment'>
1132 <title>Application Development SDK</title>
1133
1134 <para>
1135 In the
1136 <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>,
1137 the output labeled "Application Development SDK" represents an
1138 SDK.
1139 This section is going to take a closer look at this output:
1140 <imagedata fileref="figures/sdk.png" align="center" width="5in" depth="4in" />
1141 </para>
1142
1143 <para>
1144 The specific form of this output is a self-extracting
1145 SDK installer (<filename>*.sh</filename>) that, when run,
1146 installs the SDK, which consists of a cross-development
1147 toolchain, a set of libraries and headers, and an SDK
1148 environment setup script.
1149 Running this installer essentially sets up your
1150 cross-development environment.
1151 You can think of the cross-toolchain as the "host"
1152 part because it runs on the SDK machine.
1153 You can think of the libraries and headers as the "target"
1154 part because they are built for the target hardware.
1155 The setup script is added so that you can initialize the
1156 environment before using the tools.
1157 </para>
1158
1159 <note>
1160 <para>
1161 The Yocto Project supports several methods by which you can
1162 set up this cross-development environment.
1163 These methods include downloading pre-built SDK installers,
1164 building and installing your own SDK installer, or running
1165 an Application Development Toolkit (ADT) installer to
1166 install not just cross-development toolchains
1167 but also additional tools to help in this type of
1168 development.
1169 </para>
1170
1171 <para>
1172 For background information on cross-development toolchains
1173 in the Yocto Project development environment, see the
1174 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
1175 section.
1176 For information on setting up a cross-development
1177 environment, see the
1178 "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>"
1179 section in the Yocto Project Application Developer's Guide.
1180 </para>
1181 </note>
1182
1183 <para>
1184 Once built, the SDK installers are written out to the
1185 <filename>deploy/sdk</filename> folder inside the
1186 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1187 as shown in the figure at the beginning of this section.
1188 Several variables exist that help configure these files:
1189 <itemizedlist>
1190 <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
1191 Points to the <filename>deploy</filename>
1192 directory.</para></listitem>
1193 <listitem><para><link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>:
1194 Specifies the architecture of the machine
1195 on which the cross-development tools are run to
1196 create packages for the target hardware.
1197 </para></listitem>
1198 <listitem><para><link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>:
1199 Lists the features to include in the "target" part
1200 of the SDK.
1201 </para></listitem>
1202 <listitem><para><link linkend='var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></link>:
1203 Lists packages that make up the host
1204 part of the SDK (i.e. the part that runs on
1205 the <filename>SDKMACHINE</filename>).
1206 When you use
1207 <filename>bitbake -c populate_sdk &lt;imagename&gt;</filename>
1208 to create the SDK, a set of default packages
1209 apply.
1210 This variable allows you to add more packages.
1211 </para></listitem>
1212 <listitem><para><link linkend='var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></link>:
1213 Lists packages that make up the target part
1214 of the SDK (i.e. the part built for the
1215 target hardware).
1216 </para></listitem>
1217 </itemizedlist>
1218 </para>
1219 </section>
1220
1221</chapter>
1222<!--
1223vim: expandtab tw=80 ts=4
1224-->
diff --git a/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb b/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb
new file mode 100644
index 0000000000..5dfb0b30cf
--- /dev/null
+++ b/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb
@@ -0,0 +1,8 @@
1DESCRIPTION = "GNU Helloworld application"
2SECTION = "examples"
3LICENSE = "GPLv3"
4LIC_FILES_CHKSUM = "file://COPYING;md5=adefda309052235aa5d1e99ce7557010"
5
6SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.bz2"
7
8inherit autotools
diff --git a/documentation/ref-manual/examples/hello-single/files/helloworld.c b/documentation/ref-manual/examples/hello-single/files/helloworld.c
new file mode 100644
index 0000000000..fc7169b7b8
--- /dev/null
+++ b/documentation/ref-manual/examples/hello-single/files/helloworld.c
@@ -0,0 +1,8 @@
1#include <stdio.h>
2
3int main(void)
4{
5 printf("Hello world!\n");
6
7 return 0;
8}
diff --git a/documentation/ref-manual/examples/hello-single/hello.bb b/documentation/ref-manual/examples/hello-single/hello.bb
new file mode 100644
index 0000000000..0812743e39
--- /dev/null
+++ b/documentation/ref-manual/examples/hello-single/hello.bb
@@ -0,0 +1,17 @@
1DESCRIPTION = "Simple helloworld application"
2SECTION = "examples"
3LICENSE = "MIT"
4LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
5
6SRC_URI = "file://helloworld.c"
7
8S = "${WORKDIR}"
9
10do_compile() {
11 ${CC} helloworld.c -o helloworld
12}
13
14do_install() {
15 install -d ${D}${bindir}
16 install -m 0755 helloworld ${D}${bindir}
17}
diff --git a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb b/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
new file mode 100644
index 0000000000..b58d4d7bd1
--- /dev/null
+++ b/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb
@@ -0,0 +1,14 @@
1require xorg-lib-common.inc
2
3DESCRIPTION = "X11 Pixmap library"
4LICENSE = "X-BSD"
5LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5"
6DEPENDS += "libxext"
7PR = "r2"
8PE = "1"
9
10XORG_PN = "libXpm"
11
12PACKAGES =+ "sxpm cxpm"
13FILES_cxpm = "${bindir}/cxpm"
14FILES_sxpm = "${bindir}/sxpm"
diff --git a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
new file mode 100644
index 0000000000..5d05a437a4
--- /dev/null
+++ b/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb
@@ -0,0 +1,15 @@
1DESCRIPTION = "Tools for managing memory technology devices."
2SECTION = "base"
3DEPENDS = "zlib"
4HOMEPAGE = "http://www.linux-mtd.infradead.org/"
5LICENSE = "GPLv2"
6LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \
7 file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c"
8
9SRC_URI = "ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-${PV}.tar.gz"
10
11CFLAGS_prepend = "-I ${S}/include "
12
13do_install() {
14 oe_runmake install DESTDIR=${D}
15}
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml
new file mode 100644
index 0000000000..69b679bbf7
--- /dev/null
+++ b/documentation/ref-manual/faq.xml
@@ -0,0 +1,710 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='faq'>
6<title>FAQ</title>
7<qandaset>
8 <qandaentry>
9 <question>
10 <para>
11 How does Poky differ from <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>?
12 </para>
13 </question>
14 <answer>
15 <para>
16 The term "<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>"
17 refers to the specific reference build system that
18 the Yocto Project provides.
19 Poky is based on <ulink url='&YOCTO_DOCS_DEV_URL;#oe-core'>OE-Core</ulink>
20 and <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>.
21 Thus, the generic term used here for the build system is
22 the "OpenEmbedded build system."
23 Development in the Yocto Project using Poky is closely tied to OpenEmbedded, with
24 changes always being merged to OE-Core or BitBake first before being pulled back
25 into Poky.
26 This practice benefits both projects immediately.
27 </para>
28 </answer>
29 </qandaentry>
30
31 <qandaentry>
32 <question>
33 <para>
34 I only have Python 2.4 or 2.5 but BitBake requires Python 2.6 or 2.7.
35 Can I still use the Yocto Project?
36 </para>
37 </question>
38 <answer>
39 <para>
40 You can use a stand-alone tarball to provide Python 2.6.
41 You can find pre-built 32 and 64-bit versions of Python 2.6 at the following locations:
42 <itemizedlist>
43 <listitem><para><ulink url='&YOCTO_PYTHON-i686_DL_URL;'>32-bit tarball</ulink></para></listitem>
44 <listitem><para><ulink url='&YOCTO_PYTHON-x86_64_DL_URL;'>64-bit tarball</ulink></para></listitem>
45 </itemizedlist>
46 </para>
47 <para>
48 These tarballs are self-contained with all required libraries and should work
49 on most Linux systems.
50 To use the tarballs extract them into the root
51 directory and run the appropriate command:
52 <literallayout class='monospaced'>
53 $ export PATH=/opt/poky/sysroots/i586-pokysdk-linux/usr/bin/:$PATH
54 $ export PATH=/opt/poky/sysroots/x86_64-pokysdk-linux/usr/bin/:$PATH
55 </literallayout>
56 </para>
57 <para>
58 Once you run the command, BitBake uses Python 2.6.
59 </para>
60 </answer>
61 </qandaentry>
62
63 <qandaentry>
64 <question>
65 <para>
66 How can you claim Poky / OpenEmbedded-Core is stable?
67 </para>
68 </question>
69 <answer>
70 <para>
71 There are three areas that help with stability;
72 <itemizedlist>
73 <listitem><para>The Yocto Project team keeps
74 <ulink url='&YOCTO_DOCS_DEV_URL;#oe-core'>OE-Core</ulink> small
75 and focused, containing around 830 recipes as opposed to the thousands
76 available in other OpenEmbedded community layers.
77 Keeping it small makes it easy to test and maintain.</para></listitem>
78 <listitem><para>The Yocto Project team runs manual and automated tests
79 using a small, fixed set of reference hardware as well as emulated
80 targets.</para></listitem>
81 <listitem><para>The Yocto Project uses an autobuilder,
82 which provides continuous build and integration tests.</para></listitem>
83 </itemizedlist>
84 </para>
85 </answer>
86 </qandaentry>
87
88 <qandaentry>
89 <question>
90 <para>
91 How do I get support for my board added to the Yocto Project?
92 </para>
93 </question>
94 <answer>
95 <para>
96 Support for an additional board is added by creating a
97 Board Support Package (BSP) layer for it.
98 For more information on how to create a BSP layer, see the
99 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
100 section in the Yocto Project Development Manual and the
101 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
102 </para>
103 <para>
104 Usually, if the board is not completely exotic, adding support in
105 the Yocto Project is fairly straightforward.
106 </para>
107 </answer>
108 </qandaentry>
109
110 <qandaentry>
111 <question>
112 <para>
113 Are there any products built using the OpenEmbedded build system?
114 </para>
115 </question>
116 <answer>
117 <para>
118 The software running on the <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink>
119 is built using the OpenEmbedded build system.
120 See the <ulink url='http://www.vernier.com/products/interfaces/labq/'>Vernier LabQuest</ulink>
121 website for more information.
122 There are a number of pre-production devices using the OpenEmbedded build system
123 and the Yocto Project team
124 announces them as soon as they are released.
125 </para>
126 </answer>
127 </qandaentry>
128
129 <qandaentry>
130 <question>
131 <para>
132 What does the OpenEmbedded build system produce as output?
133 </para>
134 </question>
135 <answer>
136 <para>
137 Because you can use the same set of recipes to create output of
138 various formats, the output of an OpenEmbedded build depends on
139 how you start it.
140 Usually, the output is a flashable image ready for the target
141 device.
142 </para>
143 </answer>
144 </qandaentry>
145
146 <qandaentry>
147 <question>
148 <para>
149 How do I add my package to the Yocto Project?
150 </para>
151 </question>
152 <answer>
153 <para>
154 To add a package, you need to create a BitBake recipe.
155 For information on how to add a package, see the section
156 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-addpkg'>Writing a Recipe to Add a Package to Your Image</ulink>"
157 in the Yocto Project Development Manual.
158 </para>
159 </answer>
160 </qandaentry>
161
162 <qandaentry>
163 <question>
164 <para>
165 Do I have to reflash my entire board with a new Yocto Project image when recompiling
166 a package?
167 </para>
168 </question>
169 <answer>
170 <para>
171 The OpenEmbedded build system can build packages in various
172 formats such as IPK for OPKG, Debian package
173 (<filename>.deb</filename>), or RPM.
174 You can then upgrade the packages using the package tools on
175 the device, much like on a desktop distribution such as
176 Ubuntu or Fedora.
177 However, package management on the target is entirely optional.
178 </para>
179 </answer>
180 </qandaentry>
181
182 <qandaentry>
183 <question>
184 <para>
185 What is GNOME Mobile and what is the difference between GNOME Mobile and GNOME?
186 </para>
187 </question>
188 <answer>
189 <para>
190 GNOME Mobile is a subset of the <ulink url='http://www.gnome.org'>GNOME</ulink>
191 platform targeted at mobile and embedded devices.
192 The main difference between GNOME Mobile and standard GNOME is that
193 desktop-orientated libraries have been removed, along with deprecated libraries,
194 creating a much smaller footprint.
195 </para>
196 </answer>
197 </qandaentry>
198
199 <qandaentry>
200 <question>
201 <para>
202 I see the error '<filename>chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x</filename>'.
203 What is wrong?
204 </para>
205 </question>
206 <answer>
207 <para>
208 You are probably running the build on an NTFS filesystem.
209 Use <filename>ext2</filename>, <filename>ext3</filename>, or <filename>ext4</filename> instead.
210 </para>
211 </answer>
212 </qandaentry>
213
214 <qandaentry>
215 <question>
216 <para>
217 How do I make the Yocto Project work in RHEL/CentOS?
218 </para>
219 </question>
220 <answer>
221 <para>
222 To get the Yocto Project working under RHEL/CentOS 5.1 you need to first
223 install some required packages.
224 The standard CentOS packages needed are:
225 <itemizedlist>
226 <listitem><para>"Development tools" (selected during installation)</para></listitem>
227 <listitem><para><filename>texi2html</filename></para></listitem>
228 <listitem><para><filename>compat-gcc-34</filename></para></listitem>
229 </itemizedlist>
230 On top of these, you need the following external packages:
231 <itemizedlist>
232 <listitem><para><filename>python-sqlite2</filename> from
233 <ulink url='http://dag.wieers.com/rpm/packages/python-sqlite2/'>DAG repository</ulink>
234 </para></listitem>
235 <listitem><para><filename>help2man</filename> from
236 <ulink url='http://centos.karan.org/el4/extras/stable/x86_64/RPMS/repodata/repoview/help2man-0-1.33.1-2.html'>Karan repository</ulink></para></listitem>
237 </itemizedlist>
238 </para>
239
240 <para>
241 Once these packages are installed, the OpenEmbedded build system will be able
242 to build standard images.
243 However, there might be a problem with the QEMU emulator segfaulting.
244 You can either disable the generation of binary locales by setting
245 <filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link>
246 </filename> to "0" or by removing the <filename>linux-2.6-execshield.patch</filename>
247 from the kernel and rebuilding it since that is the patch that causes the problems with QEMU.
248 </para>
249
250 <note>
251 <para>For information on distributions that the Yocto Project
252 uses during validation, see the
253 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>
254 Wiki page.</para>
255 <para>For notes about using the Yocto Project on a RHEL 4-based
256 host, see the
257 <ulink url='&YOCTO_WIKI_URL;/wiki/BuildingOnRHEL4'>Building on RHEL4</ulink>
258 Wiki page.</para>
259 </note>
260 </answer>
261 </qandaentry>
262
263 <qandaentry>
264 <question>
265 <para>
266 I see lots of 404 responses for files on
267 <filename>&YOCTO_HOME_URL;/sources/*</filename>. Is something wrong?
268 </para>
269 </question>
270 <answer>
271 <para>
272 Nothing is wrong.
273 The OpenEmbedded build system checks any configured source mirrors before downloading
274 from the upstream sources.
275 The build system does this searching for both source archives and
276 pre-checked out versions of SCM-managed software.
277 These checks help in large installations because it can reduce load on the SCM servers
278 themselves.
279 The address above is one of the default mirrors configured into the
280 build system.
281 Consequently, if an upstream source disappears, the team
282 can place sources there so builds continue to work.
283 </para>
284 </answer>
285 </qandaentry>
286
287 <qandaentry>
288 <question>
289 <para>
290 I have machine-specific data in a package for one machine only but the package is
291 being marked as machine-specific in all cases, how do I prevent this?
292 </para>
293 </question>
294 <answer>
295 <para>
296 Set <filename><link linkend='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'>SRC_URI_OVERRIDES_PACKAGE_ARCH</link>
297 </filename> = "0" in the <filename>.bb</filename> file but make sure the package is
298 manually marked as
299 machine-specific for the case that needs it.
300 The code that handles
301 <filename>SRC_URI_OVERRIDES_PACKAGE_ARCH</filename> is in
302 the <filename>meta/classes/base.bbclass</filename> file.
303 </para>
304 </answer>
305 </qandaentry>
306
307 <qandaentry>
308 <question>
309 <para>
310 I'm behind a firewall and need to use a proxy server. How do I do that?
311 </para>
312 </question>
313 <answer>
314 <para>
315 Most source fetching by the OpenEmbedded build system is done by <filename>wget</filename>
316 and you therefore need to specify the proxy settings in a
317 <filename>.wgetrc</filename> file in your home directory.
318 Here are some example settings:
319 <literallayout class='monospaced'>
320 http_proxy = http://proxy.yoyodyne.com:18023/
321 ftp_proxy = http://proxy.yoyodyne.com:18023/
322 </literallayout>
323 The Yocto Project also includes a
324 <filename>site.conf.sample</filename> file that shows how to
325 configure CVS and Git proxy servers if needed.
326 </para>
327 </answer>
328 </qandaentry>
329
330 <qandaentry>
331 <question>
332 <para>
333 What’s the difference between <filename>foo</filename> and <filename>foo-native</filename>?
334 </para>
335 </question>
336 <answer>
337 <para>
338 The <filename>*-native</filename> targets are designed to run on the system
339 being used for the build.
340 These are usually tools that are needed to assist the build in some way such as
341 <filename>quilt-native</filename>, which is used to apply patches.
342 The non-native version is the one that runs on the target device.
343 </para>
344 </answer>
345 </qandaentry>
346
347 <qandaentry>
348 <question>
349 <para>
350 I'm seeing random build failures. Help?!
351 </para>
352 </question>
353 <answer>
354 <para>
355 If the same build is failing in totally different and random
356 ways, the most likely explanation is:
357 <itemizedlist>
358 <listitem><para>The hardware you are running the build on
359 has some problem.</para></listitem>
360 <listitem><para>You are running the build under
361 virtualization, in which case the virtualization
362 probably has bugs.</para></listitem>
363 </itemizedlist>
364 The OpenEmbedded build system processes a massive amount of
365 data that causes lots of network, disk and CPU activity and
366 is sensitive to even single-bit failures in any of these areas.
367 True random failures have always been traced back to hardware
368 or virtualization issues.
369 </para>
370 </answer>
371 </qandaentry>
372
373 <qandaentry>
374 <question>
375 <para>
376 What do we need to ship for license compliance?
377 </para>
378 </question>
379 <answer>
380 <para>
381 This is a difficult question and you need to consult your lawyer
382 for the answer for your specific case.
383 It is worth bearing in mind that for GPL compliance, there needs
384 to be enough information shipped to allow someone else to
385 rebuild and produce the same end result you are shipping.
386 This means sharing the source code, any patches applied to it,
387 and also any configuration information about how that package
388 was configured and built.
389 </para>
390
391 <para>
392 You can find more information on licensing in the
393 "<ulink url='&YOCTO_DOCS_DEV_URL;#licensing'>Licensing</ulink>"
394 and "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
395 sections, both of which are in the Yocto Project Development
396 Manual.
397 </para>
398 </answer>
399 </qandaentry>
400
401 <qandaentry>
402 <question>
403 <para>
404 How do I disable the cursor on my touchscreen device?
405 </para>
406 </question>
407 <answer>
408 <para>
409 You need to create a form factor file as described in the
410 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-misc-recipes'>Miscellaneous BSP-Specific Recipe Files</ulink>"
411 section in the Yocto Project Board Support Packages (BSP)
412 Developer's Guide.
413 Set the <filename>HAVE_TOUCHSCREEN</filename> variable equal to
414 one as follows:
415 <literallayout class='monospaced'>
416 HAVE_TOUCHSCREEN=1
417 </literallayout>
418 </para>
419 </answer>
420 </qandaentry>
421
422 <qandaentry>
423 <question>
424 <para>
425 How do I make sure connected network interfaces are brought up by default?
426 </para>
427 </question>
428 <answer>
429 <para>
430 The default interfaces file provided by the netbase recipe does not
431 automatically bring up network interfaces.
432 Therefore, you will need to add a BSP-specific netbase that includes an interfaces
433 file.
434 See the "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-misc-recipes'>Miscellaneous BSP-Specific Recipe Files</ulink>"
435 section in the Yocto Project Board Support Packages (BSP)
436 Developer's Guide for information on creating these types of
437 miscellaneous recipe files.
438 </para>
439 <para>
440 For example, add the following files to your layer:
441 <literallayout class='monospaced'>
442 meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces
443 meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend
444 </literallayout>
445 </para>
446 </answer>
447 </qandaentry>
448
449 <qandaentry>
450 <question>
451 <para>
452 How do I create images with more free space?
453 </para>
454 </question>
455 <answer>
456 <para>
457 By default, the OpenEmbedded build system creates images
458 that are 1.3 times the size of the populated root filesystem.
459 To affect the image size, you need to set various
460 configurations:
461 <itemizedlist>
462 <listitem><para><emphasis>Image Size:</emphasis>
463 The OpenEmbedded build system uses the
464 <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link>
465 variable to define the size of the image in Kbytes.
466 The build system determines the size by taking into
467 account the initial root filesystem size before any
468 modifications such as requested size for the image and
469 any requested additional free disk space to be
470 added to the image.</para></listitem>
471 <listitem><para><emphasis>Overhead:</emphasis>
472 Use the
473 <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link>
474 variable to define the multiplier that the build system
475 applies to the initial image size, which is 1.3 by
476 default.</para></listitem>
477 <listitem><para><emphasis>Additional Free Space:</emphasis>
478 Use the
479 <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link>
480 variable to add additional free space to the image.
481 The build system adds this space to the image after
482 it determines its
483 <filename>IMAGE_ROOTFS_SIZE</filename>.
484 </para></listitem>
485 </itemizedlist>
486 </para>
487 </answer>
488 </qandaentry>
489
490 <qandaentry>
491 <question>
492 <para>
493 Why don't you support directories with spaces in the pathnames?
494 </para>
495 </question>
496 <answer>
497 <para>
498 The Yocto Project team has tried to do this before but too
499 many of the tools the OpenEmbedded build system depends on,
500 such as <filename>autoconf</filename>, break when they find
501 spaces in pathnames.
502 Until that situation changes, the team will not support spaces
503 in pathnames.
504 </para>
505 </answer>
506 </qandaentry>
507
508 <qandaentry>
509 <question>
510 <para>
511 How do I use an external toolchain?
512 </para>
513 </question>
514 <answer>
515 <para>
516 The toolchain configuration is very flexible and customizable.
517 It is primarily controlled with the
518 <filename><link linkend='var-TCMODE'>TCMODE</link></filename>
519 variable.
520 This variable controls which <filename>tcmode-*.inc</filename>
521 file to include from the
522 <filename>meta/conf/distro/include</filename> directory within
523 the
524 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
525 </para>
526
527 <para>
528 The default value of <filename>TCMODE</filename> is "default"
529 (i.e. <filename>tcmode-default.inc</filename>).
530 However, other patterns are accepted.
531 In particular, "external-*" refers to external toolchains of
532 which there are some basic examples included in the
533 OpenEmbedded Core (<filename>meta</filename>).
534 You can use your own custom toolchain definition in your own
535 layer (or as defined in the <filename>local.conf</filename>
536 file) at the location
537 <filename>conf/distro/include/tcmode-*.inc</filename>.
538 </para>
539
540 <para>
541 In addition to the toolchain configuration, you also need a
542 corresponding toolchain recipe file.
543 This recipe file needs to package up any pre-built objects in
544 the toolchain such as <filename>libgcc</filename>,
545 <filename>libstdcc++</filename>, any locales, and
546 <filename>libc</filename>.
547 An example is the
548 <filename>external-sourcery-toolchain.bb</filename>, which is
549 located in <filename>meta/recipes-core/meta/</filename> within
550 the Source Directory.
551 </para>
552
553 <para>
554 For information on installing and using cross-development
555 toolchains, see the
556 "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>"
557 section in the Yocto Project Application Developer's Guide.
558 For general information on cross-development toolchains, see
559 the
560 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
561 section.
562 </para>
563 </answer>
564 </qandaentry>
565
566 <qandaentry>
567 <question>
568 <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>
569 How does the OpenEmbedded build system obtain source code and
570 will it work behind my firewall or proxy server?
571 </para>
572 </question>
573 <answer>
574 <para>
575 The way the build system obtains source code is highly
576 configurable.
577 You can setup the build system to get source code in most
578 environments if HTTP transport is available.
579 </para>
580 <para>
581 When the build system searches for source code, it first
582 tries the local download directory.
583 If that location fails, Poky tries
584 <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>,
585 the upstream source, and then
586 <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
587 in that order.
588 </para>
589 <para>
590 Assuming your distribution is "poky", the OpenEmbedded build
591 system uses the Yocto Project source
592 <filename>PREMIRRORS</filename> by default for SCM-based
593 sources, upstreams for normal tarballs, and then falls back
594 to a number of other mirrors including the Yocto Project
595 source mirror if those fail.
596 </para>
597 <para>
598 As an example, you could add a specific server for the
599 build system to attempt before any others by adding something
600 like the following to the <filename>local.conf</filename>
601 configuration file:
602 <literallayout class='monospaced'>
603 PREMIRRORS_prepend = "\
604 git://.*/.* http://www.yoctoproject.org/sources/ \n \
605 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
606 http://.*/.* http://www.yoctoproject.org/sources/ \n \
607 https://.*/.* http://www.yoctoproject.org/sources/ \n"
608 </literallayout>
609 </para>
610 <para>
611 These changes cause the build system to intercept Git, FTP,
612 HTTP, and HTTPS requests and direct them to the
613 <filename>http://</filename> sources mirror.
614 You can use <filename>file://</filename> URLs to point to
615 local directories or network shares as well.
616 </para>
617 <para>
618 Aside from the previous technique, these options also exist:
619 <literallayout class='monospaced'>
620 BB_NO_NETWORK = "1"
621 </literallayout>
622 This statement tells BitBake to issue an error instead of
623 trying to access the Internet.
624 This technique is useful if you want to ensure code builds
625 only from local sources.
626 </para>
627 <para>
628 Here is another technique:
629 <literallayout class='monospaced'>
630 BB_FETCH_PREMIRRORONLY = "1"
631 </literallayout>
632 This statement limits the build system to pulling source
633 from the <filename>PREMIRRORS</filename> only.
634 Again, this technique is useful for reproducing builds.
635 </para>
636 <para>
637 Here is another technique:
638 <literallayout class='monospaced'>
639 BB_GENERATE_MIRROR_TARBALLS = "1"
640 </literallayout>
641 This statement tells the build system to generate mirror
642 tarballs.
643 This technique is useful if you want to create a mirror server.
644 If not, however, the technique can simply waste time during
645 the build.
646 </para>
647 <para>
648 Finally, consider an example where you are behind an
649 HTTP-only firewall.
650 You could make the following changes to the
651 <filename>local.conf</filename> configuration file as long as
652 the <filename>PREMIRRORS</filename> server is current:
653 <literallayout class='monospaced'>
654 PREMIRRORS_prepend = "\
655 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
656 http://.*/.* http://www.yoctoproject.org/sources/ \n \
657 https://.*/.* http://www.yoctoproject.org/sources/ \n"
658 BB_FETCH_PREMIRRORONLY = "1"
659 </literallayout>
660 These changes would cause the build system to successfully
661 fetch source over HTTP and any network accesses to anything
662 other than the <filename>PREMIRRORS</filename> would fail.
663 </para>
664 <para>
665 The build system also honors the standard shell environment
666 variables <filename>http_proxy</filename>,
667 <filename>ftp_proxy</filename>,
668 <filename>https_proxy</filename>, and
669 <filename>all_proxy</filename> to redirect requests through
670 proxy servers.
671 </para>
672 </answer>
673 </qandaentry>
674
675 <qandaentry>
676 <question>
677 <para>
678 Can I get rid of build output so I can start over?
679 </para>
680 </question>
681 <answer>
682 <para>
683 Yes - you can easily do this.
684 When you use BitBake to build an image, all the build output
685 goes into the directory created when you run the
686 build environment setup script (i.e.
687 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
688 or
689 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
690 By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
691 is named <filename>build</filename> but can be named
692 anything you want.
693 </para>
694
695 <para>
696 Within the Build Directory, is the <filename>tmp</filename>
697 directory.
698 To remove all the build output yet preserve any source code or
699 downloaded files from previous builds, simply remove the
700 <filename>tmp</filename> directory.
701 </para>
702 </answer>
703 </qandaentry>
704
705
706</qandaset>
707</chapter>
708<!--
709vim: expandtab tw=80 ts=4
710-->
diff --git a/documentation/ref-manual/figures/analysis-for-package-splitting.png b/documentation/ref-manual/figures/analysis-for-package-splitting.png
new file mode 100644
index 0000000000..04f2794ea9
--- /dev/null
+++ b/documentation/ref-manual/figures/analysis-for-package-splitting.png
Binary files differ
diff --git a/documentation/ref-manual/figures/buildhistory-web.png b/documentation/ref-manual/figures/buildhistory-web.png
new file mode 100644
index 0000000000..f6db86c977
--- /dev/null
+++ b/documentation/ref-manual/figures/buildhistory-web.png
Binary files differ
diff --git a/documentation/ref-manual/figures/buildhistory.png b/documentation/ref-manual/figures/buildhistory.png
new file mode 100644
index 0000000000..edf98d95cf
--- /dev/null
+++ b/documentation/ref-manual/figures/buildhistory.png
Binary files differ
diff --git a/documentation/ref-manual/figures/configuration-compile-autoreconf.png b/documentation/ref-manual/figures/configuration-compile-autoreconf.png
new file mode 100644
index 0000000000..a07464f04c
--- /dev/null
+++ b/documentation/ref-manual/figures/configuration-compile-autoreconf.png
Binary files differ
diff --git a/documentation/ref-manual/figures/cross-development-toolchains.png b/documentation/ref-manual/figures/cross-development-toolchains.png
new file mode 100644
index 0000000000..d36670a198
--- /dev/null
+++ b/documentation/ref-manual/figures/cross-development-toolchains.png
Binary files differ
diff --git a/documentation/ref-manual/figures/image-generation.png b/documentation/ref-manual/figures/image-generation.png
new file mode 100644
index 0000000000..5594658200
--- /dev/null
+++ b/documentation/ref-manual/figures/image-generation.png
Binary files differ
diff --git a/documentation/ref-manual/figures/images.png b/documentation/ref-manual/figures/images.png
new file mode 100644
index 0000000000..d99eac1fbf
--- /dev/null
+++ b/documentation/ref-manual/figures/images.png
Binary files differ
diff --git a/documentation/ref-manual/figures/layer-input.png b/documentation/ref-manual/figures/layer-input.png
new file mode 100644
index 0000000000..0a4f2e74f3
--- /dev/null
+++ b/documentation/ref-manual/figures/layer-input.png
Binary files differ
diff --git a/documentation/ref-manual/figures/package-feeds.png b/documentation/ref-manual/figures/package-feeds.png
new file mode 100644
index 0000000000..4bc311f3d6
--- /dev/null
+++ b/documentation/ref-manual/figures/package-feeds.png
Binary files differ
diff --git a/documentation/ref-manual/figures/patching.png b/documentation/ref-manual/figures/patching.png
new file mode 100644
index 0000000000..8ecd018502
--- /dev/null
+++ b/documentation/ref-manual/figures/patching.png
Binary files differ
diff --git a/documentation/ref-manual/figures/poky-title.png b/documentation/ref-manual/figures/poky-title.png
new file mode 100644
index 0000000000..2893d84620
--- /dev/null
+++ b/documentation/ref-manual/figures/poky-title.png
Binary files differ
diff --git a/documentation/ref-manual/figures/sdk-generation.png b/documentation/ref-manual/figures/sdk-generation.png
new file mode 100644
index 0000000000..c37e2748ca
--- /dev/null
+++ b/documentation/ref-manual/figures/sdk-generation.png
Binary files differ
diff --git a/documentation/ref-manual/figures/sdk.png b/documentation/ref-manual/figures/sdk.png
new file mode 100644
index 0000000000..a539cc52f0
--- /dev/null
+++ b/documentation/ref-manual/figures/sdk.png
Binary files differ
diff --git a/documentation/ref-manual/figures/source-fetching.png b/documentation/ref-manual/figures/source-fetching.png
new file mode 100644
index 0000000000..26aefb50c2
--- /dev/null
+++ b/documentation/ref-manual/figures/source-fetching.png
Binary files differ
diff --git a/documentation/ref-manual/figures/source-input.png b/documentation/ref-manual/figures/source-input.png
new file mode 100644
index 0000000000..f7515058ef
--- /dev/null
+++ b/documentation/ref-manual/figures/source-input.png
Binary files differ
diff --git a/documentation/ref-manual/figures/user-configuration.png b/documentation/ref-manual/figures/user-configuration.png
new file mode 100644
index 0000000000..f2b3f8e7fe
--- /dev/null
+++ b/documentation/ref-manual/figures/user-configuration.png
Binary files differ
diff --git a/documentation/ref-manual/figures/yocto-environment-ref.png b/documentation/ref-manual/figures/yocto-environment-ref.png
new file mode 100644
index 0000000000..650c6c8030
--- /dev/null
+++ b/documentation/ref-manual/figures/yocto-environment-ref.png
Binary files differ
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
new file mode 100644
index 0000000000..b1a5c0e175
--- /dev/null
+++ b/documentation/ref-manual/introduction.xml
@@ -0,0 +1,444 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='intro'>
6<title>Introduction</title>
7
8<section id='intro-welcome'>
9 <title>Introduction</title>
10
11 <para>
12 This manual provides reference information for the current release of the Yocto Project.
13 The Yocto Project is an open-source collaboration project focused on embedded Linux
14 developers.
15 Amongst other things, the Yocto Project uses the OpenEmbedded build system, which
16 is based on the Poky project, to construct complete Linux images.
17 You can find complete introductory and getting started information on the Yocto Project
18 by reading the
19 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
20 For task-based information using the Yocto Project, see the
21 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>
22 and the <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>.
23 For Board Support Package (BSP) structure information, see the
24 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
25 You can also find lots of Yocto Project information on the
26 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
27 </para>
28</section>
29
30<section id='intro-manualoverview'>
31 <title>Documentation Overview</title>
32 <para>
33 This reference manual consists of the following:
34 <itemizedlist>
35 <listitem><para><emphasis>
36 <link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis>
37 Provides an overview of the components that make up the Yocto Project
38 followed by information about debugging images created in the Yocto Project.
39 </para></listitem>
40 <listitem><para><emphasis>
41 <link linkend='technical-details'>Technical Details</link>:</emphasis>
42 Describes fundamental Yocto Project components as well as an explanation
43 behind how the Yocto Project uses shared state (sstate) cache to speed build time.
44 </para></listitem>
45 <listitem><para><emphasis>
46 <link linkend='ref-structure'>Directory Structure</link>:</emphasis>
47 Describes the
48 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> created
49 either by unpacking a released Yocto Project tarball on your host development system,
50 or by cloning the upstream
51 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
52 </para></listitem>
53 <listitem><para><emphasis>
54 <link linkend='ref-bitbake'>BitBake</link>:</emphasis>
55 Provides an overview of the BitBake tool and its role within
56 the Yocto Project.</para></listitem>
57 <listitem><para><emphasis>
58 <link linkend='ref-classes'>Classes</link>:</emphasis>
59 Describes the classes used in the Yocto Project.</para></listitem>
60 <listitem><para><emphasis>
61 <link linkend='ref-images'>Images</link>:</emphasis>
62 Describes the standard images that the Yocto Project supports.
63 </para></listitem>
64 <listitem><para><emphasis>
65 <link linkend='ref-features'>Features</link>:</emphasis>
66 Describes mechanisms for creating distribution, machine, and image
67 features during the build process using the OpenEmbedded build system.</para></listitem>
68 <listitem><para><emphasis>
69 <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis>
70 Presents most variables used by the OpenEmbedded build system, which
71 uses BitBake.
72 Entries describe the function of the variable and how to apply them.
73 </para></listitem>
74 <listitem><para><emphasis>
75 <link linkend='ref-varlocality'>Variable Context</link>:</emphasis>
76 Provides variable locality or context.</para></listitem>
77 <listitem><para><emphasis>
78 <link linkend='faq'>FAQ</link>:</emphasis>
79 Provides answers for commonly asked questions in the Yocto Project
80 development environment.</para></listitem>
81 <listitem><para><emphasis>
82 <link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis>
83 Provides guidance on how you can contribute back to the Yocto
84 Project.</para></listitem>
85 </itemizedlist>
86 </para>
87</section>
88
89
90<section id='intro-requirements'>
91<title>System Requirements</title>
92 <para>
93 For general Yocto Project system requirements, see the
94 "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" section
95 in the Yocto Project Quick Start.
96 The remainder of this section provides details on system requirements
97 not covered in the Yocto Project Quick Start.
98 </para>
99
100 <section id='detailed-supported-distros'>
101 <title>Supported Linux Distributions</title>
102
103 <para>
104 Currently, the Yocto Project is supported on the following
105 distributions:
106 <note>
107 <para>
108 Yocto Project releases are tested against the stable Linux
109 distributions in the following list.
110 The Yocto Project should work on other distributions but
111 validation is not performed against them.
112 </para>
113
114 <para>
115 In particular, the Yocto Project does not support
116 and currently has no plans to support
117 rolling-releases or development distributions due to their
118 constantly changing nature.
119 We welcome patches and bug reports, but keep in mind that
120 our priority is on the supported platforms listed below.
121 </para>
122
123 <para>
124 Refer to
125 <ulink url='&OE_HOME_URL;/index.php?title=OEandYourDistro'>OE and Your Distro</ulink> and
126 <ulink url='&OE_HOME_URL;/index.php?title=Required_software'>Required Software</ulink>
127 for information for information about dependencies and
128 requirements.
129 If you encounter problems, please go to
130 <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink>
131 and submit a bug.
132 We are interested in hearing about your experience.
133 </para>
134 </note>
135 <itemizedlist>
136<!-- <listitem><para>Ubuntu 10.04</para></listitem>
137 <listitem><para>Ubuntu 11.10</para></listitem> -->
138 <listitem><para>Ubuntu 12.04 (LTS)</para></listitem>
139 <listitem><para>Ubuntu 12.10</para></listitem>
140 <listitem><para>Ubuntu 13.04</para></listitem>
141<!-- <listitem><para>Fedora 16 (Verne)</para></listitem>
142 <listitem><para>Fedora 17 (Spherical)</para></listitem> -->
143 <listitem><para>Fedora release 18 (Spherical Cow)</para></listitem>
144 <listitem><para>Fedora release 19 (Schrödinger's Cat)</para></listitem>
145<!-- <listitem><para>CentOS release 5.6 (Final)</para></listitem>
146 <listitem><para>CentOS release 5.7 (Final)</para></listitem>
147 <listitem><para>CentOS release 5.8 (Final)</para></listitem>
148 <listitem><para>CentOS release 6.3 (Final)</para></listitem> -->
149 <listitem><para>CentOS release 6.4</para></listitem>
150<!-- <listitem><para>Debian GNU/Linux 6.0 (Squeeze)</para></listitem> -->
151 <listitem><para>Debian GNU/Linux 6.0.7 (Squeeze)</para></listitem>
152 <listitem><para>Debian GNU/Linux 7.0 (Wheezy)</para></listitem>
153 <listitem><para>Debian GNU/Linux 7.1 (Wheezy)</para></listitem>
154<!-- <listitem><para>openSUSE 11.4</para></listitem>
155 <listitem><para>openSUSE 12.1</para></listitem> -->
156 <listitem><para>openSUSE 12.2</para></listitem>
157 <listitem><para>openSUSE 12.3</para></listitem>
158 </itemizedlist>
159 </para>
160
161 <note>
162 While the Yocto Project Team attempts to ensure all Yocto Project
163 releases are one hundred percent compatible with each officially
164 supported Linux distribution, instances might exist where you
165 encounter a problem while using the Yocto Project on a specific
166 distribution.
167 For example, the CentOS 6.4 distribution does not include the
168 Gtk+ 2.20.0 and PyGtk 2.21.0 (or higher) packages, which are
169 required to run
170 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>.
171 </note>
172 </section>
173
174 <section id='required-packages-for-the-host-development-system'>
175 <title>Required Packages for the Host Development System</title>
176
177 <para>
178 The list of packages you need on the host development system can
179 be large when covering all build scenarios using the Yocto Project.
180 This section provides required packages according to
181 Linux distribution and function.
182 </para>
183
184 <section id='ubuntu-packages'>
185 <title>Ubuntu and Debian</title>
186
187 <para>
188 The following list shows the required packages by function
189 given a supported Ubuntu or Debian Linux distribution:
190 <itemizedlist>
191 <listitem><para><emphasis>Essentials:</emphasis>
192 Packages needed to build an image on a headless
193 system:
194 <literallayout class='monospaced'>
195 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
196 </literallayout></para></listitem>
197 <listitem><para><emphasis>Graphical Extras:</emphasis>
198 Packages recommended if the host system has graphics support:
199 <literallayout class='monospaced'>
200 $ sudo apt-get install libsdl1.2-dev xterm
201 </literallayout></para></listitem>
202 <listitem><para><emphasis>Documentation:</emphasis>
203 Packages needed if you are going to build out the
204 Yocto Project documentation manuals:
205 <literallayout class='monospaced'>
206 $ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto
207 </literallayout></para></listitem>
208 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
209 Packages needed if you are going to be using the
210 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
211 <literallayout class='monospaced'>
212 $ sudo apt-get install autoconf automake libtool libglib2.0-dev
213 </literallayout></para></listitem>
214 </itemizedlist>
215 </para>
216 </section>
217
218 <section id='fedora-packages'>
219 <title>Fedora Packages</title>
220
221 <para>
222 The following list shows the required packages by function
223 given a supported Fedora Linux distribution:
224 <itemizedlist>
225 <listitem><para><emphasis>Essentials:</emphasis>
226 Packages needed to build an image for a headless
227 system:
228 <literallayout class='monospaced'>
229 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL;
230 </literallayout></para></listitem>
231 <listitem><para><emphasis>Graphical Extras:</emphasis>
232 Packages recommended if the host system has graphics support:
233 <literallayout class='monospaced'>
234 $ sudo yum install SDL-devel xterm
235 </literallayout></para></listitem>
236 <listitem><para><emphasis>Documentation:</emphasis>
237 Packages needed if you are going to build out the
238 Yocto Project documentation manuals:
239 <literallayout class='monospaced'>
240 $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
241 docbook-dtds docbook-utils fop libxslt dblatex xmlto
242 </literallayout></para></listitem>
243 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
244 Packages needed if you are going to be using the
245 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
246 <literallayout class='monospaced'>
247 $ sudo yum install autoconf automake libtool glib2-devel
248 </literallayout></para></listitem>
249 </itemizedlist>
250 </para>
251 </section>
252
253 <section id='opensuse-packages'>
254 <title>OpenSUSE Packages</title>
255
256 <para>
257 The following list shows the required packages by function
258 given a supported OpenSUSE Linux distribution:
259 <itemizedlist>
260 <listitem><para><emphasis>Essentials:</emphasis>
261 Packages needed to build an image for a headless
262 system:
263 <literallayout class='monospaced'>
264 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
265 </literallayout></para></listitem>
266 <listitem><para><emphasis>Graphical Extras:</emphasis>
267 Packages recommended if the host system has graphics support:
268 <literallayout class='monospaced'>
269 $ sudo zypper install libSDL-devel xterm
270 </literallayout></para></listitem>
271 <listitem><para><emphasis>Documentation:</emphasis>
272 Packages needed if you are going to build out the
273 Yocto Project documentation manuals:
274 <literallayout class='monospaced'>
275 $ sudo zypper install make fop xsltproc dblatex xmlto
276 </literallayout></para></listitem>
277 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
278 Packages needed if you are going to be using the
279 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
280 <literallayout class='monospaced'>
281 $ sudo zypper install autoconf automake libtool glib2-devel
282 </literallayout></para></listitem>
283 </itemizedlist>
284 </para>
285 </section>
286
287 <section id='centos-packages'>
288 <title>CentOS Packages</title>
289
290 <para>
291 The following list shows the required packages by function
292 given a supported CentOS Linux distribution:
293 <note>Depending on the CentOS version you are using, other requirements
294 and dependencies might exist.
295 For details, you should look at the CentOS sections on the
296 <ulink url='https://wiki.yoctoproject.org/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink>
297 wiki page.
298 </note>
299 <itemizedlist>
300 <listitem><para><emphasis>Essentials:</emphasis>
301 Packages needed to build an image for a headless
302 system:
303 <literallayout class='monospaced'>
304 $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL;
305 </literallayout></para></listitem>
306 <listitem><para><emphasis>Graphical Extras:</emphasis>
307 Packages recommended if the host system has graphics support:
308 <literallayout class='monospaced'>
309 $ sudo yum install SDL-devel xterm
310 </literallayout></para></listitem>
311 <listitem><para><emphasis>Documentation:</emphasis>
312 Packages needed if you are going to build out the
313 Yocto Project documentation manuals:
314 <literallayout class='monospaced'>
315 $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
316 docbook-dtds docbook-utils fop libxslt dblatex xmlto
317 </literallayout></para></listitem>
318 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
319 Packages needed if you are going to be using the
320 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
321 <literallayout class='monospaced'>
322 $ sudo yum install autoconf automake libtool glib2-devel
323 </literallayout></para></listitem>
324 </itemizedlist>
325 </para>
326 </section>
327 </section>
328
329 <section id='required-git-tar-and-python-versions'>
330 <title>Required Git, tar, and Python Versions</title>
331
332 <para>
333 In order to use the build system, your host development system
334 must meet the following version requirements for Git, tar, and
335 Python:
336 <itemizedlist>
337 <listitem><para>Git 1.7.5 or greater</para></listitem>
338 <listitem><para>tar 1.24 or greater</para></listitem>
339 <listitem><para>Python 2.7.3 or greater not including
340 Python 3.x, which is not supported.</para></listitem>
341 </itemizedlist>
342 </para>
343
344 <para>
345 If your host development system does not meet all these requirements,
346 you can resolve this by either downloading a pre-built tarball
347 containing these tools, or building such a tarball on another
348 system.
349 Regardless of the method, once you have the tarball you simply
350 install it somewhere on you system, such as a directory in your
351 home directory, and then source the environment script provided,
352 which adds the tools into <filename>PATH</filename> and sets
353 any other environment variables required to run the tools.
354 Doing so gives you working versions of Git, tar, Python and
355 <filename>chrpath</filename>.
356 </para>
357
358 <para>
359 If downloading a pre-built tarball, locate the
360 <filename>*.sh</filename> at
361 <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-1.5/buildtools/'></ulink>.
362 </para>
363
364 <para>
365 If building your own tarball, do so using this command:
366 <literallayout class='monospaced'>
367 $ bitbake buildtools-tarball
368 </literallayout>
369 <note>
370 The <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>
371 variable determines whether you build tools for a 32-bit
372 or 64-bit system.
373 </note>
374 Once the build completes, you can find the file that installs the
375 the tools in the <filename>tmp/deploy/sdk</filename> subdirectory
376 of the
377 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
378 The file used to install the tarball has the string "buildtools"
379 in the name.
380 </para>
381
382 <para>
383 After you have either built the tarball or downloaded it, you need
384 to install it.
385 Install the tools by executing the <filename>*.sh</filename> file.
386 During execution, a prompt appears that allows you to choose the
387 installation directory.
388 For example, you could choose the following:
389 <literallayout class='monospaced'>
390 /home/your-username/sdk
391 </literallayout>
392 </para>
393
394 <para>
395 The final step before you can actually use the tools is to source
396 the tools environment with a command like the following:
397 <literallayout class='monospaced'>
398 $ source /home/your-username/sdk/environment-setup-i586-poky-linux
399 </literallayout>
400 Of course, you need to supply your installation directory and be
401 sure to use the right file (i.e. i585 or x86-64).
402 </para>
403 </section>
404</section>
405
406<section id='intro-getit'>
407 <title>Obtaining the Yocto Project</title>
408 <para>
409 The Yocto Project development team makes the Yocto Project available through a number
410 of methods:
411 <itemizedlist>
412 <listitem><para><emphasis>Releases:</emphasis> Stable, tested releases are available through
413 <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem>
414 <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at
415 <ulink url='http://autobuilder.yoctoproject.org/nightly'/>.
416 These builds include Yocto Project releases, meta-toolchain tarball installation scripts, and
417 experimental builds.</para></listitem>
418 <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases
419 of the Yocto Project and supported BSPs at the
420 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>.
421 Along with these downloads, you can find lots of other information at this site.
422 </para></listitem>
423 </itemizedlist>
424 </para>
425</section>
426
427<section id='intro-getit-dev'>
428 <title>Development Checkouts</title>
429 <para>
430 Development using the Yocto Project requires a local
431 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
432 You can set up the Source Directory by downloading a Yocto Project release tarball and unpacking it,
433 or by cloning a copy of the upstream
434 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
435 For information on both these methods, see the
436 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
437 section in the Yocto Project Development Manual.
438 </para>
439</section>
440
441</chapter>
442<!--
443vim: expandtab tw=80 ts=4
444-->
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
new file mode 100644
index 0000000000..bb6203998b
--- /dev/null
+++ b/documentation/ref-manual/migration.xml
@@ -0,0 +1,1089 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='migration'>
6<title>Migrating to a Newer Yocto Project Release</title>
7
8 <para>
9 This chapter provides information you can use to migrate work to a
10 newer Yocto Project release. You can find the same information in the
11 release notes for a given release.
12 </para>
13
14<section id='moving-to-the-yocto-project-1.3-release'>
15 <title>Moving to the Yocto Project 1.3 Release</title>
16
17 <para>
18 This section provides migration information for moving to the
19 Yocto Project 1.3 Release from the prior release.
20 </para>
21
22 <section id='1.3-local-configuration'>
23 <title>Local Configuration</title>
24
25 <para>
26 Differences include changes for
27 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
28 and <filename>bblayers.conf</filename>.
29 </para>
30
31 <section id='migration-1.3-sstate-mirrors'>
32 <title>SSTATE_MIRRORS</title>
33
34 <para>
35 The shared state cache (sstate-cache), as pointed to by
36 <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, by default
37 now has two-character subdirectories to prevent issues rising
38 from too many files in the same directory.
39 Also, native sstate-cache packages will go into a subdirectory named using
40 the distro ID string.
41 If you copy the newly structured sstate-cache to a mirror location
42 (either local or remote) and then point to it in
43 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>,
44 you need to append "PATH" to the end of the mirror URL so that
45 the path used by BitBake before the mirror substitution is
46 appended to the path used to access the mirror.
47 Here is an example:
48 <literallayout class='monospaced'>
49 SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH"
50 </literallayout>
51 </para>
52 </section>
53
54 <section id='migration-1.3-bblayers-conf'>
55 <title>bblayers.conf</title>
56
57 <para>
58 The <filename>meta-yocto</filename> layer consists of two parts
59 that correspond to the Poky reference distribution and the
60 reference hardware Board Support Packages (BSPs), respectively:
61 <filename>meta-yocto</filename> and
62 <filename>meta-yocto-bsp</filename>.
63 When running BitBake or Hob for the first time after upgrading,
64 your <filename>conf/bblayers.conf</filename> file will be
65 updated to handle this change and you will be asked to
66 re-run or restart for the changes to take effect.
67 </para>
68 </section>
69 </section>
70
71 <section id='1.3-recipes'>
72 <title>Recipes</title>
73
74 <para>
75 Differences include changes for the following:
76 <itemizedlist>
77 <listitem><para>Python function whitespace</para></listitem>
78 <listitem><para><filename>proto=</filename> in <filename>SRC_URI</filename></para></listitem>
79 <listitem><para><filename>nativesdk</filename></para></listitem>
80 <listitem><para>Task recipes</para></listitem>
81 <listitem><para><filename>IMAGE_FEATURES</filename></para></listitem>
82 <listitem><para>Removed recipes</para></listitem>
83 </itemizedlist>
84 </para>
85
86 <section id='migration-1.3-python-function-whitespace'>
87 <title>Python Function Whitespace</title>
88
89 <para>
90 All Python functions must now use four spaces for indentation.
91 Previously, an inconsistent mix of spaces and tabs existed,
92 which made extending these functions using
93 <filename>_append</filename> or <filename>_prepend</filename>
94 complicated given that Python treats whitespace as
95 syntactically significant.
96 If you are defining or extending any Python functions (e.g.
97 <filename>populate_packages</filename>, <filename>do_unpack</filename>,
98 <filename>do_patch</filename> and so forth) in custom recipes
99 or classes, you need to ensure you are using consistent
100 four-space indentation.
101 </para>
102 </section>
103
104 <section id='migration-1.3-proto=-in-src-uri'>
105 <title>proto= in SRC_URI</title>
106
107 <para>
108 Any use of <filename>proto=</filename> in
109 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
110 needs to be changed to <filename>protocol=</filename>.
111 In particular, this applies to the following URIs:
112 <itemizedlist>
113 <listitem><para><filename>svn://</filename></para></listitem>
114 <listitem><para><filename>bzr://</filename></para></listitem>
115 <listitem><para><filename>hg://</filename></para></listitem>
116 <listitem><para><filename>osc://</filename></para></listitem>
117 </itemizedlist>
118 Other URIs were already using <filename>protocol=</filename>.
119 This change improves consistency.
120 </para>
121 </section>
122
123 <section id='migration-1.3-nativesdk'>
124 <title>nativesdk</title>
125
126 <para>
127 The suffix <filename>nativesdk</filename> is now implemented
128 as a prefix, which simplifies a lot of the packaging code for
129 <filename>nativesdk</filename> recipes.
130 All custom <filename>nativesdk</filename> recipes and any
131 references need to be updated to use
132 <filename>nativesdk-*</filename> instead of
133 <filename>*-nativesdk</filename>.
134 </para>
135 </section>
136
137 <section id='migration-1.3-task-recipes'>
138 <title>Task Recipes</title>
139
140 <para>
141 "Task" recipes are now known as "Package groups" and have
142 been renamed from <filename>task-*.bb</filename> to
143 <filename>packagegroup-*.bb</filename>.
144 Existing references to the previous <filename>task-*</filename>
145 names should work in most cases as there is an automatic
146 upgrade path for most packages.
147 However, you should update references in your own recipes and
148 configurations as they could be removed in future releases.
149 You should also rename any custom <filename>task-*</filename>
150 recipes to <filename>packagegroup-*</filename>, and change
151 them to inherit <filename>packagegroup</filename> instead of
152 <filename>task</filename>, as well as taking the opportunity
153 to remove anything now handled by
154 <filename>packagegroup.bbclass</filename>, such as providing
155 <filename>-dev</filename> and <filename>-dbg</filename>
156 packages, setting
157 <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>,
158 and so forth.
159 See the
160 "<link linkend='ref-classes-packagegroup'>Package Groups - packagegroup.bbclass</link>"
161 section for further details.
162 </para>
163 </section>
164
165 <section id='migration-1.3-image-features'>
166 <title>IMAGE_FEATURES</title>
167
168 <para>
169 Image recipes that previously included "apps-console-core"
170 in <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
171 should now include "splash" instead to enable the boot-up
172 splash screen.
173 Retaining "apps-console-core" will still include the splash
174 screen but generates a warning.
175 The "apps-x11-core" and "apps-x11-games"
176 <filename>IMAGE_FEATURES</filename> features have been removed.
177 </para>
178 </section>
179
180 <section id='migration-1.3-removed-recipes'>
181 <title>Removed Recipes</title>
182
183 <para>
184 The following recipes have been removed.
185 For most of them, it is unlikely that you would have any
186 references to them in your own
187 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>.
188 However, you should check your metadata against this list to be sure:
189 <itemizedlist>
190 <listitem><para><emphasis><filename>libx11-trim</filename></emphasis>:
191 Replaced by <filename>libx11</filename>, which has a negligible
192 size difference with modern Xorg.</para></listitem>
193 <listitem><para><emphasis><filename>xserver-xorg-lite</filename></emphasis>:
194 Use <filename>xserver-xorg</filename>, which has a negligible
195 size difference when DRI and GLX modules are not installed.</para></listitem>
196 <listitem><para><emphasis><filename>xserver-kdrive</filename></emphasis>:
197 Effectively unmaintained for many years.</para></listitem>
198 <listitem><para><emphasis><filename>mesa-xlib</filename></emphasis>:
199 No longer serves any purpose.</para></listitem>
200 <listitem><para><emphasis><filename>galago</filename></emphasis>:
201 Replaced by telepathy.</para></listitem>
202 <listitem><para><emphasis><filename>gail</filename></emphasis>:
203 Functionality was integrated into GTK+ 2.13.</para></listitem>
204 <listitem><para><emphasis><filename>eggdbus</filename></emphasis>:
205 No longer needed.</para></listitem>
206 <listitem><para><emphasis><filename>gcc-*-intermediate</filename></emphasis>:
207 The build has been restructured to avoid the need for
208 this step.</para></listitem>
209 <listitem><para><emphasis><filename>libgsmd</filename></emphasis>:
210 Unmaintained for many years.
211 Functionality now provided by
212 <filename>ofono</filename> instead.</para></listitem>
213 <listitem><para><emphasis>contacts, dates, tasks, eds-tools</emphasis>:
214 Largely unmaintained PIM application suite.
215 It has been moved to <filename>meta-gnome</filename>
216 in <filename>meta-openembedded</filename>.</para></listitem>
217 </itemizedlist>
218 In addition to the previously listed changes, the
219 <filename>meta-demoapps</filename> directory has also been removed
220 because the recipes in it were not being maintained and many
221 had become obsolete or broken.
222 Additionally, these recipes were not parsed in the default configuration.
223 Many of these recipes are already provided in an updated and
224 maintained form within the OpenEmbedded community layers such as
225 <filename>meta-oe</filename> and <filename>meta-gnome</filename>.
226 For the remainder, you can now find them in the
227 <filename>meta-extras</filename> repository, which is in the
228 Yocto Project
229 <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink>.
230 </para>
231 </section>
232 </section>
233
234 <section id='1.3-linux-kernel-naming'>
235 <title>Linux Kernel Naming</title>
236
237 <para>
238 The naming scheme for kernel output binaries has been changed to
239 now include
240 <link linkend='var-PE'><filename>PE</filename></link> as part of the
241 filename:
242 <literallayout class='monospaced'>
243 KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}"
244 </literallayout>
245 </para>
246
247 <para>
248 Because the <filename>PE</filename> variable is not set by default,
249 these binary files could result with names that include two dash
250 characters.
251 Here is an example:
252 <literallayout class='monospaced'>
253 bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin
254 </literallayout>
255 </para>
256 </section>
257</section>
258
259<section id='moving-to-the-yocto-project-1.4-release'>
260 <title>Moving to the Yocto Project 1.4 Release</title>
261
262 <para>
263 This section provides migration information for moving to the
264 Yocto Project 1.4 Release from the prior release.
265 </para>
266
267 <section id='migration-1.4-bitbake'>
268 <title>BitBake</title>
269
270 <para>
271 Differences include the following:
272 <itemizedlist>
273 <listitem><para><emphasis>Comment Continuation:</emphasis>
274 If a comment ends with a line continuation (\) character,
275 then the next line must also be a comment.
276 Any instance where this is not the case, now triggers
277 a warning.
278 You must either remove the continuation character, or be
279 sure the next line is a comment.
280 </para></listitem>
281 <listitem><para><emphasis>Package Name Overrides:</emphasis>
282 The runtime package specific variables
283 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>,
284 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
285 <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>,
286 <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>,
287 <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>,
288 <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>,
289 <link linkend='var-FILES'><filename>FILES</filename></link>,
290 <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>,
291 and the pre, post, install, and uninstall script functions
292 <filename>pkg_preinst</filename>,
293 <filename>pkg_postinst</filename>,
294 <filename>pkg_prerm</filename>, and
295 <filename>pkg_postrm</filename> should always have a
296 package name override.
297 For example, use <filename>RDEPENDS_${PN}</filename> for
298 the main package instead of <filename>RDEPENDS</filename>.
299 BitBake uses more strict checks when it parses recipes.
300 </para></listitem>
301 </itemizedlist>
302 </para>
303 </section>
304
305 <section id='migration-1.4-build-behavior'>
306 <title>Build Behavior</title>
307
308 <para>
309 Differences include the following:
310 <itemizedlist>
311 <listitem><para><emphasis>Shared State Code:</emphasis>
312 The shared state code has been optimized to avoid running
313 unnecessary tasks.
314 For example,
315 <filename>bitbake -c rootfs some-image</filename> from
316 shared state no longer populates the target sysroot
317 since that is not necessary.
318 Instead, the system just needs to extract the output
319 package contents, re-create the packages, and construct
320 the root filesystem.
321 This change is unlikely to cause any problems unless
322 you have missing declared dependencies.
323 </para></listitem>
324 <listitem><para><emphasis>Scanning Directory Names:</emphasis>
325 When scanning for files in
326 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>,
327 the build system now uses
328 <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link>
329 instead of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
330 for the directory names.
331 In general, the values previously in
332 <filename>OVERRIDES</filename> are now in
333 <filename>FILESOVERRIDES</filename> as well.
334 However, if you relied upon an additional value
335 you previously added to <filename>OVERRIDES</filename>,
336 you might now need to add it to
337 <filename>FILESOVERRIDES</filename> unless you are already
338 adding it through the
339 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>
340 or <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link>
341 variables, as appropriate.
342 For more related changes, see the
343 "<link linkend='migration-1.4-variables'>Variables</link>"
344 section.
345 </para></listitem>
346 </itemizedlist>
347 </para>
348 </section>
349
350
351 <section id='migration-1.4-proxies-and-fetching-source'>
352 <title>Proxies and Fetching Source</title>
353
354 <para>
355 A new <filename>oe-git-proxy</filename> script has been added to
356 replace previous methods of handling proxies and fetching source
357 from Git.
358 See the <filename>meta-yocto/conf/site.conf.sample</filename> file
359 for information on how to use this script.
360 </para>
361 </section>
362
363 <section id='migration-1.4-custom-interfaces-file-netbase-change'>
364 <title>Custom Interfaces File (netbase change)</title>
365
366 <para>
367 If you have created your own custom
368 <filename>etc/network/interfaces</filename> file by creating
369 an append file for the <filename>netbase</filename> recipe,
370 you now need to create an append file for the
371 <filename>init-ifupdown</filename> recipe instead, which you can
372 find in the
373 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
374 at <filename>meta/recipes-core/init-ifupdown</filename>.
375 For information on how to use append files, see the
376 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>"
377 in the Yocto Project Development Manual.
378 </para>
379 </section>
380
381 <section id='migration-1.4-remote-debugging'>
382 <title>Remote Debugging</title>
383
384 <para>
385 Support for remote debugging with the Eclipse IDE is now
386 separated into an image feature
387 (<filename>eclipse-debug</filename>) that corresponds to the
388 <filename>packagegroup-core-eclipse-debug</filename> package group.
389 Previously, the debugging feature was included through the
390 <filename>tools-debug</filename> image feature, which corresponds
391 to the <filename>packagegroup-core-tools-debug</filename>
392 package group.
393 </para>
394 </section>
395
396 <section id='migration-1.4-variables'>
397 <title>Variables</title>
398
399 <para>
400 The following variables have changed:
401 <itemizedlist>
402 <listitem><para><emphasis><filename>SANITY_TESTED_DISTROS</filename>:</emphasis>
403 This variable now uses a distribution ID, which is composed
404 of the host distributor ID followed by the release.
405 Previously,
406 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
407 was composed of the description field.
408 For example, "Ubuntu 12.10" becomes "Ubuntu-12.10".
409 You do not need to worry about this change if you are not
410 specifically setting this variable, or if you are
411 specifically setting it to "".
412 </para></listitem>
413 <listitem><para><emphasis><filename>SRC_URI</filename>:</emphasis>
414 The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>,
415 <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>,
416 <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>,
417 and <filename>FILE_DIRNAME</filename> directories have been
418 dropped from the default value of the
419 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
420 variable, which is used as the search path for finding files
421 referred to in
422 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>.
423 If you have a recipe that relied upon these directories,
424 which would be unusual, then you will need to add the
425 appropriate paths within the recipe or, alternatively,
426 rearrange the files.
427 The most common locations are still covered by
428 <filename>${BP}</filename>, <filename>${BPN}</filename>,
429 and "files", which all remain in the default value of
430 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
431 </para></listitem>
432 </itemizedlist>
433 </para>
434 </section>
435
436 <section id='migration-target-package-management-with-rpm'>
437 <title>Target Package Management with RPM</title>
438
439 <para>
440 If runtime package management is enabled and the RPM backend
441 is selected, Smart is now installed for package download, dependency
442 resolution, and upgrades instead of Zypper.
443 For more information on how to use Smart, run the following command
444 on the target:
445 <literallayout class='monospaced'>
446 smart --help
447 </literallayout>
448 </para>
449 </section>
450
451 <section id='migration-1.4-recipes-moved'>
452 <title>Recipes Moved</title>
453
454 <para>
455 The following recipes were moved from their previous locations
456 because they are no longer used by anything in
457 the OpenEmbedded-Core:
458 <itemizedlist>
459 <listitem><para><emphasis><filename>clutter-box2d</filename>:</emphasis>
460 Now resides in the <filename>meta-oe</filename> layer.
461 </para></listitem>
462 <listitem><para><emphasis><filename>evolution-data-server</filename>:</emphasis>
463 Now resides in the <filename>meta-gnome</filename> layer.
464 </para></listitem>
465 <listitem><para><emphasis><filename>gthumb</filename>:</emphasis>
466 Now resides in the <filename>meta-gnome</filename> layer.
467 </para></listitem>
468 <listitem><para><emphasis><filename>gtkhtml2</filename>:</emphasis>
469 Now resides in the <filename>meta-oe</filename> layer.
470 </para></listitem>
471 <listitem><para><emphasis><filename>gupnp</filename>:</emphasis>
472 Now resides in the <filename>meta-multimedia</filename> layer.
473 </para></listitem>
474 <listitem><para><emphasis><filename>gypsy</filename>:</emphasis>
475 Now resides in the <filename>meta-oe</filename> layer.
476 </para></listitem>
477 <listitem><para><emphasis><filename>libcanberra</filename>:</emphasis>
478 Now resides in the <filename>meta-gnome</filename> layer.
479 </para></listitem>
480 <listitem><para><emphasis><filename>libgdata</filename>:</emphasis>
481 Now resides in the <filename>meta-gnome</filename> layer.
482 </para></listitem>
483 <listitem><para><emphasis><filename>libmusicbrainz</filename>:</emphasis>
484 Now resides in the <filename>meta-multimedia</filename> layer.
485 </para></listitem>
486 <listitem><para><emphasis><filename>metacity</filename>:</emphasis>
487 Now resides in the <filename>meta-gnome</filename> layer.
488 </para></listitem>
489 <listitem><para><emphasis><filename>polkit</filename>:</emphasis>
490 Now resides in the <filename>meta-oe</filename> layer.
491 </para></listitem>
492 <listitem><para><emphasis><filename>zeroconf</filename>:</emphasis>
493 Now resides in the <filename>meta-networking</filename> layer.
494 </para></listitem>
495 </itemizedlist>
496 </para>
497 </section>
498
499 <section id='migration-1.4-removals-and-renames'>
500 <title>Removals and Renames</title>
501
502 <para>
503 The following list shows what has been removed or renamed:
504 <itemizedlist>
505 <listitem><para><emphasis><filename>evieext</filename>:</emphasis>
506 Removed because it has been removed from
507 <filename>xserver</filename> since 2008.
508 </para></listitem>
509 <listitem><para><emphasis>Gtk+ DirectFB:</emphasis>
510 Removed support because upstream Gtk+ no longer supports it
511 as of version 2.18.
512 </para></listitem>
513 <listitem><para><emphasis><filename>libxfontcache / xfontcacheproto</filename>:</emphasis>
514 Removed because they were removed from the Xorg server in 2008.
515 </para></listitem>
516 <listitem><para><emphasis><filename>libxp / libxprintapputil / libxprintutil / printproto</filename>:</emphasis>
517 Removed because the XPrint server was removed from
518 Xorg in 2008.
519 </para></listitem>
520 <listitem><para><emphasis><filename>libxtrap / xtrapproto</filename>:</emphasis>
521 Removed because their functionality was broken upstream.
522 </para></listitem>
523 <listitem><para><emphasis>linux-yocto 3.0 kernel:</emphasis>
524 Removed with linux-yocto 3.8 kernel being added.
525 The linux-yocto 3.2 and linux-yocto 3.4 kernels remain
526 as part of the release.
527 </para></listitem>
528 <listitem><para><emphasis><filename>lsbsetup</filename>:</emphasis>
529 Removed with functionality now provided by
530 <filename>lsbtest</filename>.
531 </para></listitem>
532 <listitem><para><emphasis><filename>matchbox-stroke</filename>:</emphasis>
533 Removed because it was never more than a proof-of-concept.
534 </para></listitem>
535 <listitem><para><emphasis><filename>matchbox-wm-2 / matchbox-theme-sato-2</filename>:</emphasis>
536 Removed because they are not maintained.
537 However, <filename>matchbox-wm</filename> and
538 <filename>matchbox-theme-sato</filename> are still
539 provided.
540 </para></listitem>
541 <listitem><para><emphasis><filename>mesa-dri</filename>:</emphasis>
542 Renamed to <filename>mesa</filename>.
543 </para></listitem>
544 <listitem><para><emphasis><filename>mesa-xlib</filename>:</emphasis>
545 Removed because it was no longer useful.
546 </para></listitem>
547 <listitem><para><emphasis><filename>mutter</filename>:</emphasis>
548 Removed because nothing ever uses it and the recipe is
549 very old.
550 </para></listitem>
551 <listitem><para><emphasis><filename>orinoco-conf</filename>:</emphasis>
552 Removed because it has become obsolete.
553 </para></listitem>
554 <listitem><para><emphasis><filename>update-modules</filename>:</emphasis>
555 Removed because it is no longer used.
556 The kernel module <filename>postinstall</filename> and
557 <filename>postrm</filename> scripts can now do the same
558 task without the use of this script.
559 </para></listitem>
560 <listitem><para><emphasis><filename>web</filename>:</emphasis>
561 Removed because it is not maintained. Superseded by
562 <filename>web-webkit</filename>.
563 </para></listitem>
564 <listitem><para><emphasis><filename>xf86bigfontproto</filename>:</emphasis>
565 Removed because upstream it has been disabled by default
566 since 2007.
567 Nothing uses <filename>xf86bigfontproto</filename>.
568 </para></listitem>
569 <listitem><para><emphasis><filename>xf86rushproto</filename>:</emphasis>
570 Removed because its dependency in
571 <filename>xserver</filename> was spurious and it was
572 removed in 2005.
573 </para></listitem>
574 <listitem><para><emphasis><filename>zypper / libzypp / sat-solver</filename>:</emphasis>
575 Removed and been functionally replaced with Smart
576 (<filename>python-smartpm</filename>) when RPM packaging
577 is used and package management is enabled on the target.
578 </para></listitem>
579 </itemizedlist>
580 </para>
581 </section>
582</section>
583
584<section id='moving-to-the-yocto-project-1.5-release'>
585 <title>Moving to the Yocto Project 1.5 Release</title>
586
587 <para>
588 This section provides migration information for moving to the
589 Yocto Project 1.5 Release from the prior release.
590 </para>
591
592 <section id='migration-1.5-host-dependency-changes'>
593 <title>Host Dependency Changes</title>
594
595 <para>
596 The OpenEmbedded build system now has some additional requirements
597 on the host system:
598 <itemizedlist>
599 <listitem><para>Python 2.7.3+</para></listitem>
600 <listitem><para>Tar 1.24+</para></listitem>
601 <listitem><para>Git 1.7.5+</para></listitem>
602 <listitem><para>Patched version of Make if you are using
603 3.82.
604 Most distributions that provide Make 3.82 use the patched
605 version.</para></listitem>
606 </itemizedlist>
607 If the Linux distribution you are using on your build host
608 does not provide packages for these, you can install and use
609 the Buildtools tarball, which provides an SDK-like environment
610 containing them.
611 </para>
612
613 <para>
614 For more information on this requirement, see the
615 "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>"
616 section.
617 </para>
618 </section>
619
620 <section id='migration-1.5-atom-pc-bsp'>
621 <title><filename>atom-pc</filename> Board Support Package (BSP)</title>
622
623 <para>
624 The <filename>atom-pc</filename> hardware reference BSP has been
625 replaced by a <filename>genericx86</filename> BSP.
626 This BSP is not necessarily guaranteed to work on all x86
627 hardware, but it will run on a wider range of systems than the
628 <filename>atom-pc</filename> did.
629 <note>
630 Additionally, a <filename>genericx86-64</filename> BSP has been
631 added for 64-bit systems.
632 </note>
633 </para>
634 </section>
635
636 <section id='migration-1.5-bitbake'>
637 <title>BitBake</title>
638
639 <para>
640 The following changes have been made that relate to BitBake:
641 <itemizedlist>
642 <listitem><para>
643 BitBake now supports a <filename>_remove</filename>
644 operator.
645 The addition of this operator means you will have to
646 rename any items in recipe space (functions, variables)
647 whose names currently contain
648 <filename>_remove_</filename> or end with
649 <filename>_remove</filename> to avoid unexpected behavior.
650 </para></listitem>
651 <listitem><para>
652 BitBake's global method pool has been removed.
653 This method is not particularly useful and led to clashes
654 between recipes containing functions that had the
655 same name.</para></listitem>
656 <listitem><para>
657 The "none" server backend has been removed.
658 The "process" server backend has been serving well as the
659 default for a long time now.</para></listitem>
660 <listitem><para>
661 The <filename>bitbake-runtask</filename> script has been
662 removed.</para></listitem>
663 <listitem><para>
664 <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>
665 and
666 <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>
667 are no longer added to
668 <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
669 by default in <filename>bitbake.conf</filename>.
670 These version-specific <filename>PROVIDES</filename>
671 items were seldom used.
672 Attempting to use them could result in two versions being
673 built simultaneously rather than just one version due to
674 the way BitBake resolves dependencies.</para></listitem>
675 </itemizedlist>
676 </para>
677 </section>
678
679 <section id='migration-1.5-qa-warnings'>
680 <title>QA Warnings</title>
681
682 <para>
683 The following changes have been made to the package QA checks:
684 <itemizedlist>
685 <listitem><para>
686 If you have customized
687 <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link>
688 or <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link>
689 values in your configuration, check that they contain all of
690 the issues that you wish to be reported.
691 Previous Yocto Project versions contained a bug that meant
692 that any item not mentioned in <filename>ERROR_QA</filename>
693 or <filename>WARN_QA</filename> would be treated as a
694 warning.
695 Consequently, several important items were not already in
696 the default value of <filename>WARN_QA</filename>.
697 All of the possible QA checks are now documented in the
698 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
699 section.</para></listitem>
700 <listitem><para>
701 An additional QA check has been added to check if
702 <filename>/usr/share/info/dir</filename> is being installed.
703 Your recipe should delete this file within
704 <filename>do_install</filename> if "make install" is
705 installing it.</para></listitem>
706 <listitem><para>
707 If you are using the buildhistory class, the check for the
708 package version going backwards is now controlled using a
709 standard QA check.
710 Thus, if you have customized your
711 <filename>ERROR_QA</filename> or
712 <filename>WARN_QA</filename> values and still wish to have
713 this check performed, you should add
714 "version-going-backwards" to your value for one or the
715 other variables depending on how you wish it to be handled.
716 See the documented QA checks in the
717 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
718 section.
719 </para></listitem>
720 </itemizedlist>
721 </para>
722 </section>
723
724 <section id='migration-1.5-directory-layout-changes'>
725 <title>Directory Layout Changes</title>
726
727 <para>
728 The following directory changes exist:
729 <itemizedlist>
730 <listitem><para>
731 Output SDK installer files are now named to include the
732 image name and tuning architecture through the
733 <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link>
734 variable.</para></listitem>
735 <listitem><para>
736 Images and related files are now installed into a directory
737 that is specific to the machine, instead of a parent
738 directory containing output files for multiple machines.
739 The
740 <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
741 variable continues to point to the directory containing
742 images for the current
743 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
744 and should be used anywhere there is a need to refer to
745 this directory.
746 The <filename>runqemu</filename> script now uses this
747 variable to find images and kernel binaries and will use
748 BitBake to determine the directory.
749 Alternatively, you can set the
750 <filename>DEPLOY_DIR_IMAGE</filename> variable in the
751 external environment.</para></listitem>
752 <listitem><para>
753 When buildhistory is enabled, its output is now written
754 under the
755 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
756 rather than
757 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>.
758 Doing so makes it a easier to delete
759 <filename>TMPDIR</filename> and preserve the build history.
760 Additionally, data for produced SDKs is now split by
761 <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>.
762 </para></listitem>
763 <listitem><para>
764 The <filename>pkgdata</filename> directory produced as
765 part of the packaging process has been collapsed into a
766 single machine-specific directory.
767 This directory is located under
768 <filename>sysroots</filename> and uses a machine-specific
769 name (i.e.
770 <filename>tmp/sysroots/&lt;machine&gt;/pkgdata</filename>).
771 </para></listitem>
772 </itemizedlist>
773 </para>
774 </section>
775
776 <section id='migration-1.5-shortened-git-srcrev-values'>
777 <title>Shortened Git <filename>SRCREV</filename> Values</title>
778
779 <para>
780 BitBake will now shorten revisions from Git repositories from the
781 normal 40 characters down to 10 characters within
782 <link linkend='var-SRCPV'><filename>SRCPV</filename></link>
783 for improved usability in path and file names.
784 This change should be safe within contexts where these revisions
785 are used because the chances of spatially close collisions
786 is very low.
787 Distant collisions are not a major issue in the way
788 the values are used.
789 </para>
790 </section>
791
792 <section id='migration-1.5-image-features'>
793 <title><filename>IMAGE_FEATURES</filename></title>
794
795 <para>
796 The following changes have been made that relate to
797 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>:
798 <itemizedlist>
799 <listitem><para>
800 The value of
801 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
802 is now validated to ensure invalid feature items are not
803 added.
804 Some users mistakenly add package names to this variable
805 instead of using
806 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
807 in order to have the package added to the image, which does
808 not work.
809 This change is intended to catch those kinds of situations.
810 Valid <filename>IMAGE_FEATURES</filename> are drawn from
811 <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link>
812 definitions,
813 <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link>
814 and a new "validitems" varflag on
815 <filename>IMAGE_FEATURES</filename>.
816 The "validitems" varflag change allows additional features
817 to be added if they are not provided using the previous
818 two mechanisms.
819 </para></listitem>
820 <listitem><para>
821 The previously deprecated "apps-console-core"
822 <filename>IMAGE_FEATURES</filename> item is no longer
823 supported.
824 Add "splash" to <filename>IMAGE_FEATURES</filename> if you
825 wish to have the splash screen enabled, since this is
826 all that apps-console-core was doing.</para></listitem>
827 </itemizedlist>
828 </para>
829 </section>
830
831 <section id='migration-1.5-run'>
832 <title><filename>/run</filename></title>
833
834 <para>
835 The <filename>/run</filename> directory from the Filesystem
836 Hierarchy Standard 3.0 has been introduced.
837 You can find some of the implications for this change
838 <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>.
839 The change also means that recipes that install files to
840 <filename>/var/run</filename> must be changed.
841 You can find a guide on how to make these changes
842 <ulink url='http://permalink.gmane.org/gmane.comp.handhelds.openembedded/58530'>here</ulink>.
843 </para>
844 </section>
845
846 <section id='migration-1.5-removal-of-package-manager-database-within-image-recipes'>
847 <title>Removal of Package Manager Database Within Image Recipes</title>
848
849 <para>
850 The image <filename>core-image-minimal</filename> no longer adds
851 <filename>remove_packaging_data_files</filename> to
852 <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link>.
853 This addition is now handled automatically when "package-management"
854 is not in
855 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
856 If you have custom image recipes that make this addition,
857 you should remove the lines, as they are not needed and might
858 interfere with correct operation of postinstall scripts.
859 </para>
860 </section>
861
862 <section id='migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time'>
863 <title>Images Now Rebuild Only on Changes Instead of Every Time</title>
864
865 <para>
866 The <filename>do_rootfs</filename> and other related image
867 construction tasks are no longer marked as "nostamp".
868 Consequently, they will only be re-executed when their inputs have
869 changed.
870 Previous versions of the OpenEmbedded build system always rebuilt
871 the image when requested rather when necessary.
872 </para>
873 </section>
874
875 <section id='migration-1.5-task-recipes'>
876 <title>Task Recipes</title>
877
878 <para>
879 The previously deprecated <filename>task.bbclass</filename> has
880 now been dropped.
881 For recipes that previously inherited from this task, you should
882 rename them from <filename>task-*</filename> to
883 <filename>packagegroup-*</filename> and inherit packagegroup
884 instead.
885 </para>
886
887 <para>
888 For more information, see the
889 "<link linkend='ref-classes-packagegroup'>Package Groups - <filename>packagegroup.bbclass</filename></link>"
890 section.
891 </para>
892 </section>
893
894 <section id='migration-1.5-busybox'>
895 <title>BusyBox</title>
896
897 <para>
898 By default, we now split BusyBox into two binaries:
899 one that is suid root for those components that need it, and
900 another for the rest of the components.
901 Splitting BusyBox allows for optimization that eliminates the
902 <filename>tinylogin</filename> recipe as recommended by upstream.
903 You can disable this split by setting
904 <link linkend='var-BUSYBOX_SPLIT_SUID'><filename>BUSYBOX_SPLIT_SUID</filename></link>
905 to "0".
906 </para>
907 </section>
908
909 <section id='migration-1.5-automated-image-testing'>
910 <title>Automated Image Testing</title>
911
912 <para>
913 A new automated image testing framework has been added
914 through the
915 <link linkend='ref-classes-testimage'><filename>testimage*.bbclass</filename></link>
916 class.
917 This framework replaces the older
918 <filename>imagetest-qemu</filename> framework.
919 </para>
920
921 <para>
922 You can learn more about performing automated image tests in the
923 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
924 section.
925 </para>
926 </section>
927
928 <section id='migration-1.5-build-history'>
929 <title>Build History</title>
930
931 <para>
932 Following are changes to Build History:
933 <itemizedlist>
934 <listitem><para>
935 Installed package sizes:
936 <filename>installed-package-sizes.txt</filename> for an
937 image now records the size of the files installed by each
938 package instead of the size of each compressed package
939 archive file.</para></listitem>
940 <listitem><para>
941 The dependency graphs (<filename>depends*.dot</filename>)
942 now use the actual package names instead of replacing
943 dashes, dots and plus signs with underscores.
944 </para></listitem>
945 <listitem><para>
946 The <filename>buildhistory-diff</filename> and
947 <filename>buildhistory-collect-srcrevs</filename>
948 utilities have improved command-line handling.
949 Use the <filename>&dash;&dash;help</filename> option for
950 each utility for more information on the new syntax.
951 </para></listitem>
952 </itemizedlist>
953 For more information on Build History, see the
954 "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
955 section.
956 </para>
957 </section>
958
959 <section id='migration-1.5-udev'>
960 <title><filename>udev</filename></title>
961
962 <para>
963 Following are changes to <filename>udev</filename>:
964 <itemizedlist>
965 <listitem><para>
966 <filename>udev</filename> no longer brings in
967 <filename>udev-extraconf</filename> automatically
968 through
969 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
970 since this was originally intended to be optional.
971 If you need the extra rules, then add
972 <filename>udev-extraconf</filename> to your image.
973 </para></listitem>
974 <listitem><para>
975 <filename>udev</filename> no longer brings in
976 <filename>pciutils-ids</filename> or
977 <filename>usbutils-ids</filename> through
978 <filename>RRECOMMENDS</filename>.
979 These are not needed by <filename>udev</filename> itself
980 and removing them saves around 350KB.
981 </para></listitem>
982 </itemizedlist>
983 </para>
984 </section>
985
986 <section id='removed-renamed-recipes'>
987 <title>Removed and Renamed Recipes</title>
988
989 <itemizedlist>
990 <listitem><para>
991 The <filename>linux-yocto</filename> 3.2 kernel has been
992 removed.</para></listitem>
993 <listitem><para>
994 <filename>libtool-nativesdk</filename> has been renamed to
995 <filename>nativesdk-libtool</filename>.</para></listitem>
996 <listitem><para>
997 <filename>tinylogin</filename> has been removed.
998 It has been replaced by a suid portion of Busybox.
999 See the
1000 "<link linkend='migration-1.5-busybox'>BusyBox</link>" section
1001 for more information.</para></listitem>
1002 <listitem><para>
1003 <filename>external-python-tarball</filename> has been renamed
1004 to <filename>buildtools-tarball</filename>.
1005 </para></listitem>
1006 <listitem><para>
1007 <filename>web-webkit</filename> has been removed.
1008 It has been functionally replaced by
1009 <filename>midori</filename>.</para></listitem>
1010 <listitem><para>
1011 <filename>imake</filename> has been removed.
1012 It is no longer needed by any other recipe.
1013 </para></listitem>
1014 <listitem><para>
1015 <filename>transfig-native</filename> has been removed.
1016 It is no longer needed by any other recipe.
1017 </para></listitem>
1018 <listitem><para>
1019 <filename>anjuta-remote-run</filename> has been removed.
1020 Anjuta IDE integration has not been officially supported for
1021 several releases.</para></listitem>
1022 </itemizedlist>
1023 </section>
1024
1025 <section id='migration-1.5-other-changes'>
1026 <title>Other Changes</title>
1027
1028 <para>
1029 Following is a list of short entries describing other changes:
1030 <itemizedlist>
1031 <listitem><para>
1032 <filename>run-postinsts</filename>: Make this generic.
1033 </para></listitem>
1034 <listitem><para>
1035 <filename>base-files</filename>: Remove the unnecessary
1036 <filename>/media/xxx</filename> directories.
1037 </para></listitem>
1038 <listitem><para>
1039 <filename>alsa-state</filename>: Provide an empty
1040 <filename>asound.conf</filename> by default.
1041 </para></listitem>
1042 <listitem><para>
1043 <filename>classes/image</filename>: Ensure
1044 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
1045 supports pre-renamed package names.</para></listitem>
1046 <listitem><para>
1047 <filename>classes/rootfs_rpm</filename>: Implement
1048 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
1049 for RPM.</para></listitem>
1050 <listitem><para>
1051 <filename>systemd</filename>: Remove
1052 <filename>systemd_unitdir</filename> if
1053 <filename>systemd</filename> is not in
1054 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
1055 </para></listitem>
1056 <listitem><para>
1057 <filename>systemd</filename>: Remove
1058 <filename>init.d</filename> dir if
1059 <filename>systemd</filename> unit file is present and
1060 <filename>sysvinit</filename> is not a distro feature.
1061 </para></listitem>
1062 <listitem><para>
1063 <filename>libpam</filename>: Deny all services for the
1064 <filename>OTHER</filename> entries.
1065 </para></listitem>
1066 <listitem><para>
1067 <filename>image.bbclass</filename>: Move
1068 <filename>runtime_mapping_rename</filename> to avoid
1069 conflict with <filename>multilib</filename>.
1070 See
1071 <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993'><filename>YOCTO #4993</filename></ulink>
1072 in Bugzilla for more information.
1073 </para></listitem>
1074 <listitem><para>
1075 <filename>linux-dtb</filename>: Use kernel build system
1076 to generate the <filename>dtb</filename> files.
1077 </para></listitem>
1078 <listitem><para>
1079 <filename>kern-tools</filename>: Switch from guilt to
1080 new <filename>kgit-s2q</filename> tool.
1081 </para></listitem>
1082 </itemizedlist>
1083 </para>
1084 </section>
1085</section>
1086</chapter>
1087<!--
1088vim: expandtab tw=80 ts=4
1089-->
diff --git a/documentation/ref-manual/ref-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml
new file mode 100644
index 0000000000..b587d46caa
--- /dev/null
+++ b/documentation/ref-manual/ref-bitbake.xml
@@ -0,0 +1,432 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-bitbake'>
6
7 <title>BitBake</title>
8
9 <para>
10 BitBake is a program written in Python that interprets the
11 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> used by
12 the OpenEmbedded build system.
13 At some point, developers wonder what actually happens when you enter:
14 <literallayout class='monospaced'>
15 $ bitbake core-image-sato
16 </literallayout>
17 </para>
18
19 <para>
20 This chapter provides an overview of what happens behind the scenes from BitBake's perspective.
21 </para>
22
23 <note>
24 BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships.
25 As such, it has no real knowledge of what the tasks being executed actually do.
26 BitBake just considers a list of tasks with dependencies and handles
27 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
28 consisting of variables in a certain format that get passed to the tasks.
29 </note>
30
31 <section id='ref-bitbake-parsing'>
32 <title>Parsing</title>
33
34 <para>
35 BitBake parses configuration files, classes, and <filename>.bb</filename> files.
36 </para>
37
38 <para>
39 The first thing BitBake does is look for the <filename>bitbake.conf</filename> file.
40 This file resides in the
41 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
42 within the <filename>meta/conf/</filename> directory.
43 BitBake finds it by examining its
44 <link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment
45 variable and looking for the <filename>meta/conf/</filename>
46 directory.
47 </para>
48
49 <para>
50 The <filename>bitbake.conf</filename> file lists other configuration
51 files to include from a <filename>conf/</filename>
52 directory below the directories listed in <filename>BBPATH</filename>.
53 In general, the most important configuration file from a user's perspective
54 is <filename>local.conf</filename>, which contains a user's customized
55 settings for the OpenEmbedded build environment.
56 Other notable configuration files are the distribution
57 configuration file (set by the
58 <filename><link linkend='var-DISTRO'>DISTRO</link></filename> variable)
59 and the machine configuration file
60 (set by the
61 <filename><link linkend='var-MACHINE'>MACHINE</link></filename> variable).
62 The <filename>DISTRO</filename> and <filename>MACHINE</filename> BitBake environment
63 variables are both usually set in
64 the <filename>local.conf</filename> file.
65 Valid distribution
66 configuration files are available in the <filename>meta/conf/distro/</filename> directory
67 and valid machine configuration
68 files in the <filename>meta/conf/machine/</filename> directory.
69 Within the <filename>meta/conf/machine/include/</filename>
70 directory are various <filename>tune-*.inc</filename> configuration files that provide common
71 "tuning" settings specific to and shared between particular architectures and machines.
72 </para>
73
74 <para>
75 After the parsing of the configuration files, some standard classes are included.
76 The <filename>base.bbclass</filename> file is always included.
77 Other classes that are specified in the configuration using the
78 <filename><link linkend='var-INHERIT'>INHERIT</link></filename>
79 variable are also included.
80 Class files are searched for in a <filename>classes</filename> subdirectory
81 under the paths in <filename>BBPATH</filename> in the same way as
82 configuration files.
83 </para>
84
85 <para>
86 After classes are included, the variable
87 <filename><link linkend='var-BBFILES'>BBFILES</link></filename>
88 is set, usually in
89 <filename>local.conf</filename>, and defines the list of places to search for
90 <filename>.bb</filename> files.
91 By default, the <filename>BBFILES</filename> variable specifies the
92 <filename>meta/recipes-*/</filename> directory within Poky.
93 Adding extra content to <filename>BBFILES</filename> is best achieved through the use of
94 BitBake layers as described in the
95 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and
96 Creating Layers</ulink>" section of the Yocto Project Development Manual.
97 </para>
98
99 <para>
100 BitBake parses each <filename>.bb</filename> file in <filename>BBFILES</filename> and
101 stores the values of various variables.
102 In summary, for each <filename>.bb</filename>
103 file the configuration plus the base class of variables are set, followed
104 by the data in the <filename>.bb</filename> file
105 itself, followed by any inherit commands that
106 <filename>.bb</filename> file might contain.
107 </para>
108
109 <para>
110 Because parsing <filename>.bb</filename> files is a time
111 consuming process, a cache is kept to speed up subsequent parsing.
112 This cache is invalid if the timestamp of the <filename>.bb</filename>
113 file itself changes, or if the timestamps of any of the include,
114 configuration files or class files on which the
115 <filename>.bb</filename> file depends change.
116 </para>
117 </section>
118
119 <section id='ref-bitbake-providers'>
120 <title>Preferences and Providers</title>
121
122 <para>
123 Once all the <filename>.bb</filename> files have been
124 parsed, BitBake starts to build the target (<filename>core-image-sato</filename>
125 in the previous section's example) and looks for providers of that target.
126 Once a provider is selected, BitBake resolves all the dependencies for
127 the target.
128 In the case of <filename>core-image-sato</filename>, it would lead to
129 <filename>packagegroup-core-x11-sato</filename>,
130 which in turn leads to recipes like <filename>matchbox-terminal</filename>,
131 <filename>pcmanfm</filename> and <filename>gthumb</filename>.
132 These recipes in turn depend on <filename>eglibc</filename> and the toolchain.
133 </para>
134
135 <para>
136 Sometimes a target might have multiple providers.
137 A common example is "virtual/kernel", which is provided by each kernel package.
138 Each machine often selects the best kernel provider by using a line similar to the
139 following in the machine configuration file:
140 </para>
141
142 <literallayout class='monospaced'>
143 PREFERRED_PROVIDER_virtual/kernel = "linux-yocto"
144 </literallayout>
145
146 <para>
147 The default <filename><link linkend='var-PREFERRED_PROVIDER'>PREFERRED_PROVIDER</link></filename>
148 is the provider with the same name as the target.
149 </para>
150
151 <para>
152 Understanding how providers are chosen is made complicated by the fact
153 that multiple versions might exist.
154 BitBake defaults to the highest version of a provider.
155 Version comparisons are made using the same method as Debian.
156 You can use the
157 <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename>
158 variable to specify a particular version (usually in the distro configuration).
159 You can influence the order by using the
160 <filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE</link></filename>
161 variable.
162 By default, files have a preference of "0".
163 Setting the <filename>DEFAULT_PREFERENCE</filename> to "-1" makes the
164 package unlikely to be used unless it is explicitly referenced.
165 Setting the <filename>DEFAULT_PREFERENCE</filename> to "1" makes it likely the package is used.
166 <filename>PREFERRED_VERSION</filename> overrides any <filename>DEFAULT_PREFERENCE</filename> setting.
167 <filename>DEFAULT_PREFERENCE</filename> is often used to mark newer and more experimental package
168 versions until they have undergone sufficient testing to be considered stable.
169 </para>
170
171 <para>
172 In summary, BitBake has created a list of providers, which is prioritized, for each target.
173 </para>
174 </section>
175
176 <section id='ref-bitbake-dependencies'>
177 <title>Dependencies</title>
178
179 <para>
180 Each target BitBake builds consists of multiple tasks such as
181 <filename>fetch</filename>, <filename>unpack</filename>,
182 <filename>patch</filename>, <filename>configure</filename>,
183 and <filename>compile</filename>.
184 For best performance on multi-core systems, BitBake considers each task as an independent
185 entity with its own set of dependencies.
186 </para>
187
188 <para>
189 Dependencies are defined through several variables.
190 You can find information about variables BitBake uses in the BitBake documentation,
191 which is found in the <filename>bitbake/doc/manual</filename> directory within the
192 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
193 At a basic level, it is sufficient to know that BitBake uses the
194 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename> and
195 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when
196 calculating dependencies.
197 </para>
198 </section>
199
200 <section id='ref-bitbake-tasklist'>
201 <title>The Task List</title>
202
203 <para>
204 Based on the generated list of providers and the dependency information,
205 BitBake can now calculate exactly what tasks it needs to run and in what
206 order it needs to run them.
207 The build now starts with BitBake forking off threads up to the limit set in the
208 <filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link></filename> variable.
209 BitBake continues to fork threads as long as there are tasks ready to run,
210 those tasks have all their dependencies met, and the thread threshold has not been
211 exceeded.
212 </para>
213
214 <para>
215 It is worth noting that you can greatly speed up the build time by properly setting
216 the <filename>BB_NUMBER_THREADS</filename> variable.
217 See the
218 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
219 section in the Yocto Project Quick Start for more information.
220 </para>
221
222 <para>
223 As each task completes, a timestamp is written to the directory specified by the
224 <filename><link linkend='var-STAMP'>STAMP</link></filename> variable.
225 On subsequent runs, BitBake looks within the <filename>/build/tmp/stamps</filename>
226 directory and does not rerun
227 tasks that are already completed unless a timestamp is found to be invalid.
228 Currently, invalid timestamps are only considered on a per
229 <filename>.bb</filename> file basis.
230 So, for example, if the configure stamp has a timestamp greater than the
231 compile timestamp for a given target, then the compile task would rerun.
232 Running the compile task again, however, has no effect on other providers
233 that depend on that target.
234 This behavior could change or become configurable in future versions of BitBake.
235 </para>
236
237 <note>
238 Some tasks are marked as "nostamp" tasks.
239 No timestamp file is created when these tasks are run.
240 Consequently, "nostamp" tasks are always rerun.
241 </note>
242 </section>
243
244 <section id='ref-bitbake-runtask'>
245 <title>Running a Task</title>
246
247 <para>
248 Tasks can either be a shell task or a Python task.
249 For shell tasks, BitBake writes a shell script to
250 <filename>${WORKDIR}/temp/run.do_taskname.pid</filename> and then executes the script.
251 The generated shell script contains all the exported variables, and the shell functions
252 with all variables expanded.
253 Output from the shell script goes to the file <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>.
254 Looking at the expanded shell functions in the run file and the output in the log files
255 is a useful debugging technique.
256 </para>
257
258 <para>
259 For Python tasks, BitBake executes the task internally and logs information to the
260 controlling terminal.
261 Future versions of BitBake will write the functions to files similar to the way
262 shell tasks are handled.
263 Logging will be handled in a way similar to shell tasks as well.
264 </para>
265
266 <para>
267 Once all the tasks have been completed BitBake exits.
268 </para>
269
270 <para>
271 When running a task, BitBake tightly controls the execution environment
272 of the build tasks to make sure unwanted contamination from the build machine
273 cannot influence the build.
274 Consequently, if you do want something to get passed into the build
275 task's environment, you must take a few steps:
276 <orderedlist>
277 <listitem><para>Tell BitBake to load what you want from the environment
278 into the data store.
279 You can do so through the <filename>BB_ENV_EXTRAWHITE</filename>
280 variable.
281 For example, assume you want to prevent the build system from
282 accessing your <filename>$HOME/.ccache</filename> directory.
283 The following command tells BitBake to load
284 <filename>CCACHE_DIR</filename> from the environment into the data
285 store:
286 <literallayout class='monospaced'>
287 export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR"
288 </literallayout></para></listitem>
289 <listitem><para>Tell BitBake to export what you have loaded into the
290 environment store to the task environment of every running task.
291 Loading something from the environment into the data store
292 (previous step) only makes it available in the datastore.
293 To export it to the task environment of every running task,
294 use a command similar to the following in your
295 <filename>local.conf</filename> or distro configuration file:
296 <literallayout class='monospaced'>
297 export CCACHE_DIR
298 </literallayout></para></listitem>
299 </orderedlist>
300 </para>
301
302 <note>
303 A side effect of the previous steps is that BitBake records the variable
304 as a dependency of the build process in things like the shared state
305 checksums.
306 If doing so results in unnecessary rebuilds of tasks, you can whitelist the
307 variable so that the shared state code ignores the dependency when it creates
308 checksums.
309 For information on this process, see the <filename>BB_HASHBASE_WHITELIST</filename>
310 example in the "<link linkend='checksums'>Checksums (Signatures)</link>" section.
311 </note>
312 </section>
313
314 <section id='ref-bitbake-commandline'>
315 <title>BitBake Command Line</title>
316
317 <para>
318 Following is the BitBake help output:
319 </para>
320
321 <screen>
322$ bitbake --help
323Usage: bitbake [options] [recipename/target ...]
324
325 Executes the specified task (default is 'build') for a given set of target recipes (.bb files).
326 It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which
327 will provide the layer, BBFILES and other configuration information.
328
329Options:
330 --version show program's version number and exit
331 -h, --help show this help message and exit
332 -b BUILDFILE, --buildfile=BUILDFILE
333 Execute tasks from a specific .bb recipe directly.
334 WARNING: Does not handle any dependencies from other
335 recipes.
336 -k, --continue Continue as much as possible after an error. While the
337 target that failed and anything depending on it cannot
338 be built, as much as possible will be built before
339 stopping.
340 -a, --tryaltconfigs Continue with builds by trying to use alternative
341 providers where possible.
342 -f, --force Force the specified targets/task to run (invalidating
343 any existing stamp file).
344 -c CMD, --cmd=CMD Specify the task to execute. The exact options
345 available depend on the metadata. Some examples might
346 be 'compile' or 'populate_sysroot' or 'listtasks' may
347 give a list of the tasks available.
348 -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP
349 Invalidate the stamp for the specified task such as
350 'compile' and then run the default task for the
351 specified target(s).
352 -r PREFILE, --read=PREFILE
353 Read the specified file before bitbake.conf.
354 -R POSTFILE, --postread=POSTFILE
355 Read the specified file after bitbake.conf.
356 -v, --verbose Output more log message data to the terminal.
357 -D, --debug Increase the debug level. You can specify this more
358 than once.
359 -n, --dry-run Don't execute, just go through the motions.
360 -S, --dump-signatures
361 Don't execute, just dump out the signature
362 construction information.
363 -p, --parse-only Quit after parsing the BB recipes.
364 -s, --show-versions Show current and preferred versions of all recipes.
365 -e, --environment Show the global or per-package environment complete
366 with information about where variables were
367 set/changed.
368 -g, --graphviz Save dependency tree information for the specified
369 targets in the dot syntax.
370 -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED
371 Assume these dependencies don't exist and are already
372 provided (equivalent to ASSUME_PROVIDED). Useful to
373 make dependency graphs more appealing
374 -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS
375 Show debug logging for the specified logging domains
376 -P, --profile Profile the command and save reports.
377 -u UI, --ui=UI The user interface to use (e.g. knotty, hob, depexp).
378 -t SERVERTYPE, --servertype=SERVERTYPE
379 Choose which server to use, process or xmlrpc.
380 --revisions-changed Set the exit code depending on whether upstream
381 floating revisions have changed or not.
382 --server-only Run bitbake without a UI, only starting a server
383 (cooker) process.
384 -B BIND, --bind=BIND The name/address for the bitbake server to bind to.
385 --no-setscene Do not run any setscene tasks. sstate will be ignored
386 and everything needed, built.
387 --remote-server=REMOTE_SERVER
388 Connect to the specified server.
389 -m, --kill-server Terminate the remote server.
390 --observe-only Connect to a server as an observing-only client.
391 </screen>
392 </section>
393
394 <section id='ref-bitbake-fetchers'>
395 <title>Fetchers</title>
396
397 <para>
398 BitBake also contains a set of "fetcher" modules that allow
399 retrieval of source code from various types of sources.
400 For example, BitBake can get source code from a disk with the metadata, from websites,
401 from remote shell accounts, or from Source Code Management (SCM) systems
402 like <filename>cvs/subversion/git</filename>.
403 </para>
404
405 <para>
406 Fetchers are usually triggered by entries in
407 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>.
408 You can find information about the options and formats of entries for specific
409 fetchers in the BitBake manual located in the
410 <filename>bitbake/doc/manual</filename> directory of the
411 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
412 </para>
413
414 <para>
415 One useful feature for certain Source Code Manager (SCM) fetchers is the ability to
416 "auto-update" when the upstream SCM changes version.
417 Since this ability requires certain functionality from the SCM, not all
418 systems support it.
419 Currently Subversion, Bazaar and to a limited extent, Git support the ability to "auto-update".
420 This feature works using the <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
421 variable.
422 See the
423 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-srcrev'>Using an External SCM</ulink>" section
424 in the Yocto Project Development Manual for more information.
425 </para>
426
427 </section>
428
429</chapter>
430<!--
431vim: expandtab tw=80 ts=4 spell spelllang=en_gb
432-->
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
new file mode 100644
index 0000000000..27edfde33d
--- /dev/null
+++ b/documentation/ref-manual/ref-classes.xml
@@ -0,0 +1,1104 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-classes'>
6<title>Classes</title>
7
8<para>
9 Class files are used to abstract common functionality and share it amongst multiple
10 <filename>.bb</filename> files.
11 Any <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> usually
12 found in a <filename>.bb</filename> file can also be placed in a class
13 file.
14 Class files are identified by the extension <filename>.bbclass</filename> and are usually placed
15 in a <filename>classes/</filename> directory beneath the
16 <filename>meta*/</filename> directory found in the
17 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
18 Class files can also be pointed to by
19 <link linkend='var-BUILDDIR'><filename>BUILDDIR</filename></link>
20 (e.g. <filename>build/</filename>) in the same way as
21 <filename>.conf</filename> files in the <filename>conf</filename> directory.
22 Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
23 using the same method by which <filename>.conf</filename> files are searched.
24</para>
25
26<para>
27 In most cases inheriting the class is enough to enable its features, although
28 for some classes you might need to set variables or override some of the
29 default behavior.
30</para>
31
32<para>
33 This chapter discusses only the most useful and important classes.
34 Other classes do exist within the <filename>meta/classes</filename>
35 directory in the
36 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
37 You can reference the <filename>.bbclass</filename> files directly
38 for more information.
39</para>
40
41<section id='ref-classes-base'>
42 <title>The base Class - <filename>base.bbclass</filename></title>
43
44 <para>
45 The base class is special in that every <filename>.bb</filename>
46 file inherits it automatically.
47 This class contains definitions for standard basic
48 tasks such as fetching, unpacking, configuring (empty by default), compiling
49 (runs any <filename>Makefile</filename> present), installing (empty by default) and packaging
50 (empty by default).
51 These classes are often overridden or extended by other classes
52 such as <filename>autotools.bbclass</filename> or <filename>package.bbclass</filename>.
53 The class also contains some commonly used functions such as <filename>oe_runmake</filename>.
54 </para>
55</section>
56
57<section id='ref-classes-autotools'>
58 <title>Autotooled Packages - <filename>autotools.bbclass</filename></title>
59
60 <para>
61 Autotools (<filename>autoconf</filename>, <filename>automake</filename>,
62 and <filename>libtool</filename>) bring standardization.
63 This class defines a set of tasks (configure, compile etc.) that
64 work for all Autotooled packages.
65 It should usually be enough to define a few standard variables
66 and then simply <filename>inherit autotools</filename>.
67 This class can also work with software that emulates Autotools.
68 For more information, see the
69 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-addpkg-autotools'>Autotooled Package</ulink>"
70 section in the Yocto Project Development Manual.
71 </para>
72
73 <para>
74 It's useful to have some idea of how the tasks defined by this class work
75 and what they do behind the scenes.
76 <itemizedlist>
77 <listitem><para><filename>do_configure</filename> &dash; Regenerates the
78 configure script (using <filename>autoreconf</filename>) and then launches it
79 with a standard set of arguments used during cross-compilation.
80 You can pass additional parameters to <filename>configure</filename> through the
81 <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> variable.
82 </para></listitem>
83 <listitem><para><filename>do_compile</filename> &dash; Runs <filename>make</filename> with
84 arguments that specify the compiler and linker.
85 You can pass additional arguments through
86 the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable.
87 </para></listitem>
88 <listitem><para><filename>do_install</filename> &dash; Runs <filename>make install</filename>
89 and passes in
90 <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>
91 as <filename>DESTDIR</filename>.
92 </para></listitem>
93 </itemizedlist>
94 </para>
95</section>
96
97<section id='ref-classes-update-alternatives'>
98 <title>Alternatives - <filename>update-alternatives.bbclass</filename></title>
99
100 <para>
101 This class helps the alternatives system when multiple sources provide
102 the same command.
103 This situation occurs when several programs that have the same or
104 similar function are installed with the same name.
105 For example, the <filename>ar</filename> command is available from the
106 <filename>busybox</filename>, <filename>binutils</filename> and
107 <filename>elfutils</filename> packages.
108 The <filename>update-alternatives.bbclass</filename> class handles
109 renaming the binaries so that multiple packages can be installed
110 without conflicts.
111 The <filename>ar</filename> command still works regardless of which
112 packages are installed or subsequently removed.
113 The class renames the conflicting binary in each package and symlinks
114 the highest priority binary during installation or removal of packages.
115 </para>
116
117 <para>
118 To use this class, you need to define a number of variables:
119 <itemizedlist>
120 <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link>
121 </para></listitem>
122 <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link>
123 </para></listitem>
124 <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link>
125 </para></listitem>
126 <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link>
127 </para></listitem>
128 </itemizedlist>
129 These variables list alternative commands needed by a package,
130 provide pathnames for links, default links for targets, and
131 so forth.
132 For details on how to use this class, see the comments in the
133 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>.
134 </para>
135
136 <note>
137 You can use the <filename>update-alternatives</filename> command
138 directly in your recipes.
139 However, this class simplifies things in most cases.
140 </note>
141</section>
142
143<section id='ref-classes-update-rc.d'>
144 <title>Initscripts - <filename>update-rc.d.bbclass</filename></title>
145
146 <para>
147 This class uses <filename>update-rc.d</filename> to safely install an
148 initialization script on behalf of the package.
149 The OpenEmbedded build system takes care of details such as making sure the script is stopped before
150 a package is removed and started when the package is installed.
151 Three variables control this class:
152 <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>,
153 <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and
154 <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>.
155 See the variable links for details.
156 </para>
157</section>
158
159<section id='ref-classes-binconfig'>
160 <title><filename>binconfig.bbclass</filename></title>
161
162 <para>
163 This class helps to correct paths in shell scripts.
164 </para>
165
166 <para>
167 Before <filename>pkg-config</filename> had become widespread, libraries
168 shipped shell scripts to give information about the libraries and
169 include paths needed to build software (usually named
170 <filename>LIBNAME-config</filename>).
171 This class assists any recipe using such scripts.
172 </para>
173
174 <para>
175 During staging, the OpenEmbedded build system installs such scripts
176 into the <filename>sysroots/</filename> directory.
177 Inheriting this class results in all paths in these scripts being
178 changed to point into the <filename>sysroots/</filename> directory so
179 that all builds that use the script use the correct directories
180 for the cross compiling layout.
181 See the
182 <link linkend='var-BINCONFIG_GLOB'><filename>BINCONFIG_GLOB</filename></link>
183 variable for more information.
184 </para>
185</section>
186
187<section id='ref-classes-debian'>
188 <title>Debian Renaming - <filename>debian.bbclass</filename></title>
189
190 <para>
191 This class renames packages so that they follow the Debian naming
192 policy (i.e. <filename>eglibc</filename> becomes <filename>libc6</filename>
193 and <filename>eglibc-devel</filename> becomes <filename>libc6-dev</filename>.)
194 </para>
195</section>
196
197<section id='ref-classes-pkgconfig'>
198 <title>Pkg-config - <filename>pkgconfig.bbclass</filename></title>
199
200 <para>
201 <filename>pkg-config</filename> provides a standard way to get
202 header and library information.
203 This class aims to smooth integration of
204 <filename>pkg-config</filename> into libraries that use it.
205 </para>
206
207 <para>
208 During staging, BitBake installs <filename>pkg-config</filename> data into the
209 <filename>sysroots/</filename> directory.
210 By making use of sysroot functionality within <filename>pkg-config</filename>,
211 this class no longer has to manipulate the files.
212 </para>
213</section>
214
215<section id='ref-classes-archiver'>
216 <title>Archiving Sources - <filename>archive*.bbclass</filename></title>
217
218 <para>
219 Many software licenses require that source code and other materials be
220 released with the binaries.
221 To help with that task, the following classes are provided:
222 <itemizedlist>
223 <listitem><filename>archive-original-sources.bbclass</filename></listitem>
224 <listitem><filename>archive-patched-sources.bbclass</filename></listitem>
225 <listitem><filename>archive-configured-sources.bbclass</filename></listitem>
226 <listitem><filename>archiver.bbclass</filename></listitem>
227 </itemizedlist>
228 </para>
229
230 <para>
231 For more details on the source archiver, see the
232 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
233 section in the Yocto Project Development Manual.
234 </para>
235</section>
236
237<section id='ref-classes-perl'>
238 <title>Perl Modules - <filename>cpan.bbclass</filename></title>
239
240 <para>
241 Recipes for Perl modules are simple.
242 These recipes usually only need to point to the source's archive and then inherit the
243 proper <filename>.bbclass</filename> file.
244 Building is split into two methods depending on which method the module authors used.
245 <itemizedlist>
246 <listitem><para>Modules that use old
247 <filename>Makefile.PL</filename>-based build system require
248 <filename>cpan.bbclass</filename> in their recipes.
249 </para></listitem>
250 <listitem><para>Modules that use
251 <filename>Build.PL</filename>-based build system require
252 using <filename>cpan_build.bbclass</filename> in their recipes.
253 </para></listitem>
254 </itemizedlist>
255 </para>
256</section>
257
258<section id='ref-classes-distutils'>
259 <title>Python Extensions - <filename>distutils.bbclass</filename></title>
260
261 <para>
262 Recipes for Python extensions are simple.
263 These recipes usually only need to point to the source's archive and then inherit
264 the proper <filename>.bbclass</filename> file.
265 Building is split into two methods depending on which method the module authors used.
266 <itemizedlist>
267 <listitem><para>Extensions that use an Autotools-based build system
268 require Autotools and
269 <filename>distutils</filename>-based
270 <filename>.bbclasse</filename> files in their recipes.
271 </para></listitem>
272 <listitem><para>Extensions that use
273 <filename>distutils</filename>-based build systems require
274 <filename>distutils.bbclass</filename> in their recipes.
275 </para></listitem>
276 </itemizedlist>
277 </para>
278</section>
279
280<section id='ref-classes-devshell'>
281 <title>Developer Shell - <filename>devshell.bbclass</filename></title>
282
283 <para>
284 This class adds the <filename>devshell</filename> task.
285 Distribution policy dictates whether to include this class.
286 See the
287 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section
288 in the Yocto Project Development Manual for more information about using <filename>devshell</filename>.
289 </para>
290</section>
291
292<section id='ref-classes-packagegroup'>
293 <title>Package Groups - <filename>packagegroup.bbclass</filename></title>
294
295 <para>
296 This class sets default values appropriate for package group recipes (e.g.
297 <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>,
298 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>,
299 <filename><link linkend='var-ALLOW_EMPTY'>ALLOW_EMPTY</link></filename>,
300 and so forth).
301 It is highly recommended that all package group recipes inherit this class.
302 </para>
303 <para>
304 For information on how to use this class, see the
305 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>"
306 section in the Yocto Project Development Manual.
307 </para>
308 <para>
309 Previously, this class was named <filename>task.bbclass</filename>.
310 </para>
311</section>
312
313
314<section id='ref-classes-package'>
315 <title>Packaging - <filename>package*.bbclass</filename></title>
316
317 <para>
318 The packaging classes add support for generating packages from a build's
319 output.
320 The core generic functionality is in <filename>package.bbclass</filename>.
321 The code specific to particular package types is contained in various sub-classes such as
322 <filename>package_deb.bbclass</filename>, <filename>package_ipk.bbclass</filename>,
323 and <filename>package_rpm.bbclass</filename>.
324 Most users will want one or more of these classes.
325 </para>
326
327 <para>
328 You can control the list of resulting package formats by using the
329 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
330 variable defined in the <filename>local.conf</filename> configuration file,
331 which is located in the <filename>conf</filename> folder of the
332 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
333 When defining the variable, you can specify one or more package types.
334 Since images are generated from packages, a packaging class is
335 needed to enable image generation.
336 The first class listed in this variable is used for image generation.
337 </para>
338
339 <para>
340 If you take the optional step to set up a repository (package feed)
341 on the development host that can be used by Smart, you can
342 install packages from the feed while you are running the image
343 on the target (i.e. runtime installation of packages).
344 For more information, see the
345 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>"
346 section in the Yocto Project Development Manual.
347 </para>
348
349 <para>
350 The package class you choose can affect build-time performance and has space
351 ramifications.
352 In general, building a package with IPK takes about thirty percent less
353 time as compared to using RPM to build the same or similar package.
354 This comparison takes into account a complete build of the package with
355 all dependencies previously built.
356 The reason for this discrepancy is because the RPM package manager
357 creates and processes more
358 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> than the
359 IPK package manager.
360 Consequently, you might consider setting <filename>PACKAGE_CLASSES</filename>
361 to "package_ipk" if you are building smaller systems.
362 </para>
363
364 <para>
365 Before making your decision on package manager, however, you should
366 consider some further things about using RPM:
367 <itemizedlist>
368 <listitem><para>
369 RPM starts to provide more abilities than IPK due to
370 the fact that it processes more metadata.
371 For example, this information includes individual file types,
372 file checksum generation and evaluation on install, sparse file
373 support, conflict detection and resolution for Multilib systems,
374 ACID style upgrade, and repackaging abilities for rollbacks.
375 </para></listitem>
376 <listitem><para>
377 For smaller systems, the extra space used for the Berkley
378 Database and the amount of metadata when using RPM can affect
379 your ability to perform on-device upgrades.
380 </para></listitem>
381 </itemizedlist>
382 </para>
383
384 <para>
385 You can find additional information on the effects of the package
386 class at these two Yocto Project mailing list links:
387 <itemizedlist>
388 <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006362.html'>
389 https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html</ulink></para></listitem>
390 <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006363.html'>
391 https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html</ulink></para></listitem>
392 </itemizedlist>
393 </para>
394</section>
395
396<section id='ref-classes-kernel'>
397 <title>Building Kernels - <filename>kernel.bbclass</filename></title>
398
399 <para>
400 This class handles building Linux kernels.
401 The class contains code to build all kernel trees.
402 All needed headers are staged into the
403 <filename><link linkend='var-STAGING_KERNEL_DIR'>STAGING_KERNEL_DIR</link></filename>
404 directory to allow out-of-tree module builds using <filename>module.bbclass</filename>.
405 </para>
406
407 <para>
408 This means that each built kernel module is packaged separately and inter-module
409 dependencies are created by parsing the <filename>modinfo</filename> output.
410 If all modules are required, then installing the <filename>kernel-modules</filename>
411 package installs all packages with modules and various other kernel packages
412 such as <filename>kernel-vmlinux</filename>.
413 </para>
414
415 <para>
416 Various other classes are used by the kernel and module classes internally including
417 <filename>kernel-arch.bbclass</filename>, <filename>module_strip.bbclass</filename>,
418 <filename>module-base.bbclass</filename>, and <filename>linux-kernel-base.bbclass</filename>.
419 </para>
420</section>
421
422<section id='ref-classes-image'>
423 <title>Creating Images - <filename>image.bbclass</filename> and <filename>rootfs*.bbclass</filename></title>
424
425 <para>
426 These classes add support for creating images in several formats.
427 First, the root filesystem is created from packages using
428 one of the <filename>rootfs_*.bbclass</filename>
429 files (depending on the package format used) and then the image is created.
430 <itemizedlist>
431 <listitem><para>The
432 <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename>
433 variable controls the types of images to generate.
434 </para></listitem>
435 <listitem><para>The
436 <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename>
437 variable controls the list of packages to install into the
438 image.</para></listitem>
439 </itemizedlist>
440 </para>
441</section>
442
443<section id='ref-classes-sanity'>
444 <title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title>
445
446 <para>
447 This class checks to see if prerequisite software is present on the host system
448 so that users can be notified of potential problems that might affect their build.
449 The class also performs basic user configuration checks from
450 the <filename>local.conf</filename> configuration file to
451 prevent common mistakes that cause build failures.
452 Distribution policy usually determines whether to include this class.
453 </para>
454</section>
455
456<section id='ref-classes-insane'>
457<title><filename>insane.bbclass</filename></title>
458
459 <para>
460 This class adds a step to the package generation process so that
461 output quality assurance checks are generated by the OpenEmbedded
462 build system.
463 A range of checks are performed that check the build's output
464 for common problems that show up during runtime.
465 Distribution policy usually dictates whether to include this class.
466 </para>
467
468 <para>
469 You can configure the sanity checks so that specific test failures
470 either raise a warning or an error message.
471 Typically, failures for new tests generate a warning.
472 Subsequent failures for the same test would then generate an error
473 message once the metadata is in a known and good condition.
474 </para>
475
476 <para>
477 Use the
478 <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and
479 <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link>
480 variables to control the behavior of
481 these checks at the global level (i.e. in your custom distro
482 configuration).
483 However, to skip one or more checks in recipes, you should use
484 <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>.
485 For example, to skip the check for symbolic link
486 <filename>.so</filename> files in the main package of a recipe,
487 add the following to the recipe.
488 You need to realize that the package name override, in this example
489 <filename>${PN}</filename>, must be used:
490 <literallayout class='monospaced'>
491 INSANE_SKIP_${PN} += "dev-so"
492 </literallayout>
493 Please keep in mind that the QA checks exist in order to detect real
494 or potential problems in the packaged output.
495 So exercise caution when disabling these checks.
496 </para>
497
498 <para>
499 The following list shows the tests you can list with the
500 <filename>WARN_QA</filename> and <filename>ERROR_QA</filename>
501 variables:
502 <itemizedlist>
503 <listitem><para><emphasis><filename>ldflags:</filename></emphasis>
504 Ensures that the binaries were linked with the
505 <filename>LDFLAGS</filename> options provided by the build system.
506 If this test fails, check that the <filename>LDFLAGS</filename> variable
507 is being passed to the linker command.</para></listitem>
508 <listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis>
509 Checks for dynamic library load paths (rpaths) in the binaries that
510 by default on a standard system are searched by the linker (e.g.
511 <filename>/lib</filename> and <filename>/usr/lib</filename>).
512 While these paths will not cause any breakage, they do waste space and
513 are unnecessary.</para></listitem>
514 <listitem><para><emphasis><filename>rpaths:</filename></emphasis>
515 Checks for rpaths in the binaries that contain build system paths such
516 as <filename>TMPDIR</filename>.
517 If this test fails, bad <filename>-rpath</filename> options are being
518 passed to the linker commands and your binaries have potential security
519 issues.</para></listitem>
520 <listitem><para><emphasis><filename>dev-so:</filename></emphasis>
521 Checks that the <filename>.so</filename> symbolic links are in the
522 <filename>-dev</filename> package and not in any of the other packages.
523 In general, these symlinks are only useful for development purposes.
524 Thus, the <filename>-dev</filename> package is the correct location for
525 them.
526 Some very rare cases do exist for dynamically loaded modules where
527 these symlinks are needed instead in the main package.
528 </para></listitem>
529 <listitem><para><emphasis><filename>debug-files:</filename></emphasis>
530 Checks for <filename>.debug</filename> directories in anything but the
531 <filename>-dbg</filename> package.
532 The debug files should all be in the <filename>-dbg</filename> package.
533 Thus, anything packaged elsewhere is incorrect packaging.</para></listitem>
534 <listitem><para><emphasis><filename>arch:</filename></emphasis>
535 Checks the Executable and Linkable Format (ELF) type, bit size, and endianness
536 of any binaries to ensure they match the target architecture.
537 This test fails if any binaries don't match the type since there would be an
538 incompatibility.
539 Sometimes software, like bootloaders, might need to bypass this check.
540 </para></listitem>
541 <listitem><para><emphasis><filename>debug-deps:</filename></emphasis>
542 Checks that <filename>-dbg</filename> packages only depend on other
543 <filename>-dbg</filename> packages and not on any other types of packages,
544 which would cause a packaging bug.</para></listitem>
545 <listitem><para><emphasis><filename>dev-deps:</filename></emphasis>
546 Checks that <filename>-dev</filename> packages only depend on other
547 <filename>-dev</filename> packages and not on any other types of packages,
548 which would be a packaging bug.</para></listitem>
549 <listitem><para><emphasis><filename>pkgconfig:</filename></emphasis>
550 Checks <filename>.pc</filename> files for any
551 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>/<link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
552 paths.
553 Any <filename>.pc</filename> file containing these paths is incorrect
554 since <filename>pkg-config</filename> itself adds the correct sysroot prefix
555 when the files are accessed.</para></listitem>
556 <listitem><para><emphasis><filename>textrel:</filename></emphasis>
557 Checks for ELF binaries that contain relocations in their
558 <filename>.text</filename> sections, which can result in a
559 performance impact at runtime.</para></listitem>
560 <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis>
561 Checks through the variables
562 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>,
563 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
564 <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>,
565 <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>,
566 <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>,
567 <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>,
568 <link linkend='var-FILES'><filename>FILES</filename></link>,
569 <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>,
570 <filename>pkg_preinst</filename>,
571 <filename>pkg_postinst</filename>,
572 <filename>pkg_prerm</filename>
573 and <filename>pkg_postrm</filename>, and reports if there are
574 variable sets that are not package-specific.
575 Using these variables without a package suffix is bad practice,
576 and might unnecessarily complicate dependencies of other packages
577 within the same recipe or have other unintended consequences.
578 </para></listitem>
579 <listitem><para><emphasis><filename>xorg-driver-abi:</filename></emphasis>
580 Checks that all packages containing Xorg drivers have ABI
581 dependencies.
582 The <filename>xserver-xorg</filename> recipe provides driver
583 ABI names.
584 All drivers should depend on the ABI versions that they have
585 been built against.
586 Driver recipes that include
587 <filename>xorg-driver-input.inc</filename>
588 or <filename>xorg-driver-video.inc</filename> will
589 automatically get these versions.
590 Consequently, you should only need to explicitly add
591 dependencies to binary driver recipes.
592 </para></listitem>
593 <listitem><para><emphasis><filename>libexec:</filename></emphasis>
594 Checks if a package contains files in
595 <filename>/usr/libexec</filename>.
596 This check is not performed if the
597 <filename>libexecdir</filename> variable has been set
598 explicitly to <filename>/usr/libexec</filename>.
599 </para></listitem>
600 <listitem><para><emphasis><filename>staticdev:</filename></emphasis>
601 Checks for static library files (<filename>*.a</filename>) in
602 non-<filename>staticdev</filename> packages.
603 </para></listitem>
604 <listitem><para><emphasis><filename>la:</filename></emphasis>
605 Checks <filename>.la</filename> files for any <filename>TMPDIR</filename>
606 paths.
607 Any <filename>.la</filename> file containing these paths is incorrect since
608 <filename>libtool</filename> adds the correct sysroot prefix when using the
609 files automatically itself.</para></listitem>
610 <listitem><para><emphasis><filename>desktop:</filename></emphasis>
611 Runs the <filename>desktop-file-validate</filename> program
612 against any <filename>.desktop</filename> files to validate
613 their contents against the specification for
614 <filename>.desktop</filename> files.</para></listitem>
615 <listitem><para><emphasis><filename>already-stripped:</filename></emphasis>
616 Checks that produced binaries have not already been
617 stripped prior to the build system extracting debug symbols.
618 It is common for upstream software projects to default to
619 stripping debug symbols for output binaries.
620 In order for debugging to work on the target using
621 <filename>-dbg</filename> packages, this stripping must be
622 disabled.
623 </para></listitem>
624 <listitem><para><emphasis><filename>split-strip:</filename></emphasis>
625 Reports that splitting or stripping debug symbols from binaries
626 has failed.
627 </para></listitem>
628 <listitem><para><emphasis><filename>arch:</filename></emphasis>
629 Checks to ensure the architecture, bit size, and endianness
630 of all output binaries matches that of the target.
631 This test can detect when the wrong compiler or compiler options
632 have been used.
633 </para></listitem>
634 <listitem><para><emphasis><filename>installed-vs-shipped:</filename></emphasis>
635 Reports when files have been installed within
636 <filename>do_install</filename> but have not been included in
637 any package by way of the
638 <link linkend='var-FILES'><filename>FILES</filename></link>
639 variable.
640 Files that do not appear in any package cannot be present in
641 an image later on in the build process.
642 Ideally, all installed files should be packaged or not
643 installed at all.
644 These files can be deleted at the end of
645 <filename>do_install</filename> if the files are not
646 needed in any package.
647 </para></listitem>
648 <listitem><para><emphasis><filename>dep-cmp:</filename></emphasis>
649 Checks for invalid version comparison statements in runtime
650 dependency relationships between packages (i.e. in
651 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>,
652 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
653 <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>,
654 <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>,
655 <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>,
656 and
657 <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>
658 variable values).
659 Any invalid comparisons might trigger failures or undesirable
660 behavior when passed to the package manager.
661 </para></listitem>
662 <listitem><para><emphasis><filename>files-invalid:</filename></emphasis>
663 Checks for
664 <link linkend='var-FILES'><filename>FILES</filename></link>
665 variable values that contain "//", which is invalid.
666 </para></listitem>
667 <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis>
668 Report when packages are excluded from being created due to
669 being marked with a license that is in
670 <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>.
671 </para></listitem>
672 <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis>
673 Checks the <filename>do_compile</filename> log for indications
674 that paths to locations on the build host were used.
675 Using such paths might result in host contamination of the
676 build output.
677 </para></listitem>
678 <listitem><para><emphasis><filename>install-host-path:</filename></emphasis>
679 Checks the <filename>do_install</filename> log for indications
680 that paths to locations on the build host were used.
681 Using such paths might result in host contamination of the
682 build output.
683 </para></listitem>
684 <listitem><para><emphasis><filename>libdir:</filename></emphasis>
685 Checks for libraries being installed into incorrect
686 (possibly hardcoded) installation paths.
687 For example, this test will catch recipes that install
688 <filename>/lib/bar.so</filename> when
689 <filename>${base_libdir}</filename> is "lib32".
690 Another example is when recipes install
691 <filename>/usr/lib64/foo.so</filename> when
692 <filename>${libdir}</filename> is "/usr/lib".
693 </para></listitem>
694 <listitem><para><emphasis><filename>packages-list:</filename></emphasis>
695 Checks for the same package being listed multiple times through
696 the <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
697 variable value.
698 Installing the package in this manner can cause errors during
699 packaging.
700 </para></listitem>
701 <listitem><para><emphasis><filename>perm-config:</filename></emphasis>
702 Reports lines in <filename>fs-perms.txt</filename> that have
703 an invalid format.
704 </para></listitem>
705 <listitem><para><emphasis><filename>perm-line:</filename></emphasis>
706 Reports lines in <filename>fs-perms.txt</filename> that have
707 an invalid format.
708 </para></listitem>
709 <listitem><para><emphasis><filename>perm-link:</filename></emphasis>
710 Reports lines in <filename>fs-perms.txt</filename> that
711 specify 'link' where the specified target already exists.
712 </para></listitem>
713 <listitem><para><emphasis><filename>pkgname:</filename></emphasis>
714 Checks that all packages in
715 <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
716 have names that do not contain invalid characters (i.e.
717 characters other than 0-9, a-z, ., +, and -).
718 </para></listitem>
719 <listitem><para><emphasis><filename>pn-overrides:</filename></emphasis>
720 Checks that a recipe does not have a name
721 (<link linkend='var-PN'><filename>PN</filename></link>) value
722 that appears in
723 <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>.
724 If a recipe is named such that its <filename>PN</filename>
725 value matches something already in
726 <filename>OVERRIDES</filename> (e.g. <filename>PN</filename>
727 happens to be the same as
728 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
729 or
730 <link linkend='var-DISTRO'><filename>DISTRO</filename></link>),
731 it can have unexpected consequences.
732 For example, assignments such as
733 <filename>FILES_${PN} = "xyz"</filename> effectively turn into
734 <filename>FILES = "xyz"</filename>.
735 </para></listitem>
736 <listitem><para><emphasis><filename>unsafe-references-in-binaries:</filename></emphasis>
737 Reports when a binary installed in
738 <filename>${base_libdir}</filename>,
739 <filename>${base_bindir}</filename>, or
740 <filename>${base_sbindir}</filename>, depends on another
741 binary installed under <filename>${exec_prefix}</filename>.
742 This dependency is a concern if you want the system to remain
743 basically operable if <filename>/usr</filename> is mounted
744 separately and is not mounted.
745 <note>
746 Defaults for binaries installed in
747 <filename>${base_libdir}</filename>,
748 <filename>${base_bindir}</filename>, and
749 <filename>${base_sbindir}</filename> are
750 <filename>/lib</filename>, <filename>/bin</filename>, and
751 <filename>/sbin</filename>, respectively.
752 The default for a binary installed
753 under <filename>${exec_prefix}</filename> is
754 <filename>/usr</filename>.
755 </note>
756 </para></listitem>
757 <listitem><para><emphasis><filename>unsafe-references-in-scripts:</filename></emphasis>
758 Reports when a script file installed in
759 <filename>${base_libdir}</filename>,
760 <filename>${base_bindir}</filename>, or
761 <filename>${base_sbindir}</filename>, depends on files
762 installed under <filename>${exec_prefix}</filename>.
763 This dependency is a concern if you want the system to remain
764 basically operable if <filename>/usr</filename> is mounted
765 separately and is not mounted.
766 <note>
767 Defaults for binaries installed in
768 <filename>${base_libdir}</filename>,
769 <filename>${base_bindir}</filename>, and
770 <filename>${base_sbindir}</filename> are
771 <filename>/lib</filename>, <filename>/bin</filename>, and
772 <filename>/sbin</filename>, respectively.
773 The default for a binary installed
774 under <filename>${exec_prefix}</filename> is
775 <filename>/usr</filename>.
776 </note>
777 </para></listitem>
778 <listitem><para><emphasis><filename>var-undefined:</filename></emphasis>
779 Reports when variables fundamental to packaging (i.e.
780 <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>,
781 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>,
782 <link linkend='var-D'><filename>D</filename></link>,
783 <link linkend='var-PN'><filename>PN</filename></link>, and
784 <link linkend='var-PKGD'><filename>PKGD</filename></link>) are
785 undefined during <filename>do_package</filename>.
786 </para></listitem>
787 <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis>
788 Checks to see if the <filename>PKGV</filename> variable
789 is undefined during <filename>do_package</filename>.
790 </para></listitem>
791 <listitem><para><emphasis><filename>buildpaths:</filename></emphasis>
792 Checks for paths to locations on the build host inside the
793 output files.
794 Currently, this test triggers too many false positives and
795 thus is not normally enabled.
796 </para></listitem>
797 <listitem><para><emphasis><filename>perms:</filename></emphasis>
798 Currently, this check is unused but reserved.
799 </para></listitem>
800 <listitem><para><emphasis><filename>version-going-backwards:</filename></emphasis>
801 If Build History is enabled, reports when a package
802 being written out has a lower version than the previously
803 written package under the same name.
804 If you are placing output packages into a feed and
805 upgrading packages on a target system using that feed, the
806 version of a package going backwards can result in the target
807 system not correctly upgrading to the "new" version of the
808 package.
809 <note>
810 If you are not using runtime package management on your
811 target system, then you do not need to worry about
812 this situation.
813 </note>
814 </para></listitem>
815 </itemizedlist>
816 </para>
817</section>
818
819<section id='ref-classes-rm-work'>
820 <title>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></title>
821
822 <para>
823 The OpenEmbedded build system can use a substantial amount of disk
824 space during the build process.
825 A portion of this space is the work files under the
826 <filename>${TMPDIR}/work</filename> directory for each recipe.
827 Once the build system generates the packages for a recipe, the work
828 files for that recipe are no longer needed.
829 However, by default, the build system preserves these files
830 for inspection and possible debugging purposes.
831 If you would rather have these files deleted to save disk space
832 as the build progresses, you can enable <filename>rm_work</filename>
833 by adding the following to your <filename>local.conf</filename> file,
834 which is found in the
835 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
836 <literallayout class='monospaced'>
837 INHERIT += "rm_work"
838 </literallayout>
839 If you are modifying and building source code out of the work directory
840 for a recipe, enabling <filename>rm_work</filename> will potentially
841 result in your changes to the source being lost.
842 To exclude some recipes from having their work directories deleted by
843 <filename>rm_work</filename>, you can add the names of the recipe or
844 recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename>
845 variable, which can also be set in your <filename>local.conf</filename>
846 file.
847 Here is an example:
848 <literallayout class='monospaced'>
849 RM_WORK_EXCLUDE += "busybox eglibc"
850 </literallayout>
851 </para>
852</section>
853
854
855<section id='ref-classes-siteinfo'>
856 <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title>
857
858 <para>
859 Autotools can require tests that must execute on the target hardware.
860 Since this is not possible in general when cross compiling, site information is
861 used to provide cached test results so these tests can be skipped over but
862 still make the correct values available.
863 The <filename><link linkend='structure-meta-site'>meta/site directory</link></filename>
864 contains test results sorted into different categories such as architecture, endianness, and
865 the <filename>libc</filename> used.
866 Site information provides a list of files containing data relevant to
867 the current build in the
868 <filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable
869 that Autotools automatically picks up.
870 </para>
871
872 <para>
873 The class also provides variables like
874 <filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename>
875 and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename>
876 that can be used elsewhere in the metadata.
877 </para>
878
879 <para>
880 Because this class is included from <filename>base.bbclass</filename>, it is always active.
881 </para>
882</section>
883
884<section id='ref-classes-useradd'>
885 <title>Adding Users - <filename>useradd.bbclass</filename></title>
886
887 <para>
888 If you have packages that install files that are owned by custom users or groups,
889 you can use this class to specify those packages and associate the users and groups
890 with those packages.
891 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename>
892 recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
893 provides a simple example that shows how to add three
894 users and groups to two packages.
895 See the <filename>useradd-example.bb</filename> for more information on how to
896 use this class.
897 </para>
898</section>
899
900<section id='ref-classes-externalsrc'>
901 <title><filename>externalsrc.bbclass</filename></title>
902
903 <para>
904 You can use this class to build software from source code that is
905 external to the OpenEmbedded build system.
906 Building software from an external source tree means that the build
907 system's normal fetch, unpack, and patch process is not used.
908 </para>
909
910 <para>
911 By default, the OpenEmbedded build system uses the
912 <link linkend='var-S'><filename>S</filename></link> and
913 <link linkend='var-B'><filename>B</filename></link> variables to
914 locate unpacked recipe source code and to build it, respectively.
915 When your recipe inherits <filename>externalsrc.bbclass</filename>,
916 you use the
917 <link linkend='var-EXTERNALSRC'><filename>EXTERNALSRC</filename></link>
918 and
919 <link linkend='var-EXTERNALSRC_BUILD'><filename>EXTERNALSRC_BUILD</filename></link>
920 variables to ultimately define <filename>S</filename> and
921 <filename>B</filename>.
922 </para>
923
924 <para>
925 By default, this class expects the source code to support recipe builds
926 that use the <link linkend='var-B'><filename>B</filename></link>
927 variable to point to the directory in which the OpenEmbedded build
928 system places the generated objects built from the recipes.
929 By default, the <filename>B</filename> directory is set to the
930 following, which is separate from the source directory
931 (<filename>S</filename>):
932 <literallayout class='monospaced'>
933 ${WORKDIR}/${BPN}/{PV}/
934 </literallayout>
935 See the glossary entries for the
936 <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>,
937 <link linkend='var-BPN'><filename>BPN</filename></link>,
938 <link linkend='var-PV'><filename>PV</filename></link>,
939 </para>
940
941 <para>
942 For more information on
943 <filename>externalsrc.bbclass</filename>, see the comments in
944 <filename>meta/classes/externalsrc.bbclass</filename> in the
945 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
946 For information on how to use <filename>externalsrc.bbclass</filename>,
947 see the
948 "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
949 section in the Yocto Project Development Manual.
950 </para>
951</section>
952
953<section id='ref-classes-testimage'>
954 <title><filename>testimage.bbclass</filename></title>
955
956 <para>
957 You can use this class to enable running a series of automated tests
958 for images.
959 The class handles loading the tests and starting the image.
960 <note>
961 Currently, there is only support for running these tests
962 under QEMU.
963 </note>
964 </para>
965
966 <para>
967 To use the class, you need to perform steps to set up the
968 environment.
969 The tests are commands that run on the target system over
970 <filename>ssh</filename>.
971 they are written in Python and make use of the
972 <filename>unittest</filename> module.
973 </para>
974
975 <para>
976 For information on how to enable, run, and create new tests, see the
977 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
978 section.
979 </para>
980</section>
981
982<section id='ref-classes-others'>
983 <title>Other Classes</title>
984
985 <para>
986 Thus far, this chapter has discussed only the most useful and important
987 classes.
988 However, other classes exist within the <filename>meta/classes</filename> directory
989 in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
990 You can examine the <filename>.bbclass</filename> files directly for more
991 information.
992 </para>
993</section>
994
995<!-- Undocumented classes are:
996 allarch.bbclass
997 archive*.bbclass
998 binconfig.bbclass
999 bin_package.bbclass
1000 blacklist.bbclass
1001 bootimg.bbclass
1002 boot-directdisk.bbclass
1003 bugzilla.bbclass
1004 buildhistory.bbclass
1005 buildstats.bbclass
1006 ccache.bbclass
1007 chrpath.bbclass
1008 clutter.bbclass
1009 cmake.bbclass
1010 cml1.bbclass
1011 copyleft_compliance.bbclass
1012 core-image.bbclass
1013 cross.bbclass
1014 cross-canadian.bbclass
1015 crosssdk.bbclass
1016 deploy.bbclass
1017 distrodata.bbclass
1018 distro_features_check.bbclass
1019 dummy.bbclass
1020 extrausers.bbclass
1021 fontcache.bbclass
1022 gconf.bbclass
1023 gettext.bbclass
1024 gnomebase.bbclass
1025 gnome.bbclass
1026 grub-efi.bbclass
1027 gsettings.bbclass
1028 gtk-doc.bbclass
1029 gtk-icon-cache.bbclass
1030 gtk-immodules-cache.bbclass
1031 gzipnative.bbclass
1032 icecc.bbclass
1033 image-empty.bbclass
1034 image-live.bbclass
1035 image-vmdk.bbclass
1036 image-mklibs.bbclass
1037 image-prelink.bbclass
1038 image-swab.bbclass
1039 image_types.bbclass
1040 image_types_uboot.bbclass
1041 insserv.bbclass
1042 kernel-arch.bbclass
1043 kernel-module-split.bbclass
1044 kernel-yocto.bbclass
1045 lib_package.bbclass
1046 linux-kernel-base.bbclass
1047 license.bbclass
1048 logging.bbclass
1049 meta.bbclass
1050 metadata_scm.bbclass
1051 migrate_localcount.bbclass
1052 mime.bbclass
1053 mirrors.bbclass
1054 multilib*.bbclass
1055 native.bbclass
1056 nativesdk.bbclass
1057 oelint.bbclass
1058 own-mirrors.bbclass
1059 packagedata.bbclass
1060 packageinfo.bbclass
1061 patch.bbclass
1062 perlnative.bbclass
1063 pixbufcache.bbclass
1064 pkg_distribute.bbclass
1065 pkg_metainfo.bbclass
1066 populate_sdk*.bbclass
1067 prexport.bbclass
1068 primport.bbclass
1069 prserv.bbclass
1070 ptest.bbclass
1071 python-dir.bbclass
1072 pythonnative.bbclass
1073 qemu.bbclass
1074 qmake*.bbclass
1075 qt4*.bbclass
1076 recipe_sanity.bbclass
1077 relocatable.bbclass
1078 scons.bbclass
1079 sdl.bbclass
1080 setuptools.bbclass
1081 sip.bbclass
1082 siteconfig.bbclass
1083 sourcepkg.bbclass
1084 spdx.bbclass
1085 sstate.bbclass
1086 staging.bbclass
1087 syslinux.bbclass
1088 systemd.bbclass
1089 terminal.bbclass
1090 tinderclient.bbclass
1091 toolchain-scripts.bbclass
1092 typecheck.bbclass
1093 uboot-config.bbclass
1094 utility-tasks.bbclass
1095 utils.bbclass
1096 vala.bbclass
1097 waf.bbclass
1098-->
1099
1100
1101</chapter>
1102<!--
1103vim: expandtab tw=80 ts=4
1104-->
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml
new file mode 100644
index 0000000000..3f216e3a64
--- /dev/null
+++ b/documentation/ref-manual/ref-features.xml
@@ -0,0 +1,334 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-features'>
6 <title>Reference: Features</title>
7
8 <para>
9 This chapter provides a reference of shipped machine and distro features
10 you can include as part of the image, a reference on image types you can
11 build, and a reference on feature backfilling.
12 </para>
13
14 <para>
15 Features provide a mechanism for working out which packages
16 should be included in the generated images.
17 Distributions can select which features they want to support through the
18 <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>
19 variable, which is set in the <filename>poky.conf</filename> distribution configuration file.
20 Machine features are set in the
21 <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>
22 variable, which is set in the machine configuration file and
23 specifies the hardware features for a given machine.
24 </para>
25
26 <para>
27 These two variables combine to work out which kernel modules,
28 utilities, and other packages to include.
29 A given distribution can support a selected subset of features so some machine features might not
30 be included if the distribution itself does not support them.
31 </para>
32
33 <para>
34 One method you can use to determine which recipes are checking to see if a
35 particular feature is contained or not is to <filename>grep</filename> through
36 the <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
37 for the feature.
38 Here is an example that discovers the recipes whose build is potentially
39 changed based on a given feature:
40 <literallayout class='monospaced'>
41 $ cd $HOME/poky
42 $ git grep 'contains.*MACHINE_FEATURES.*&lt;feature&gt;'
43 </literallayout>
44 </para>
45
46 <section id='ref-features-distro'>
47 <title>Distro</title>
48
49 <para>
50 The items below are features you can use with
51 <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
52 Features do not have a one-to-one correspondence to packages, and they can
53 go beyond simply controlling the installation of a package or packages.
54 Sometimes a feature can influence how certain recipes are built.
55 For example, a feature might determine whether a particular configure option
56 is specified within <filename>do_configure</filename> for a particular
57 recipe.
58 </para>
59
60 <para>
61 This list only represents features as shipped with the Yocto Project metadata:
62 <itemizedlist>
63 <listitem><para><emphasis>alsa:</emphasis> Include ALSA support
64 (OSS compatibility kernel modules installed if available).
65 </para></listitem>
66 <listitem><para><emphasis>bluetooth:</emphasis> Include
67 bluetooth support (integrated BT only).</para></listitem>
68 <listitem><para><emphasis>cramfs:</emphasis> Include CramFS
69 support.</para></listitem>
70 <listitem><para><emphasis>ext2:</emphasis> Include tools for
71 supporting for devices with internal HDD/Microdrive for
72 storing files (instead of Flash only devices).
73 </para></listitem>
74 <listitem><para><emphasis>ipsec:</emphasis> Include IPSec
75 support.</para></listitem>
76 <listitem><para><emphasis>ipv6:</emphasis> Include IPv6 support.
77 </para></listitem>
78 <listitem><para><emphasis>irda:</emphasis> Include Irda support.
79 </para></listitem>
80 <listitem><para><emphasis>keyboard:</emphasis> Include keyboard
81 support (e.g. keymaps will be loaded during boot).
82 </para></listitem>
83 <listitem><para><emphasis>nfs:</emphasis> Include NFS client
84 support (for mounting NFS exports on device).
85 </para></listitem>
86 <listitem><para><emphasis>opengl:</emphasis>
87 Include the Open Graphics Library, which is a
88 cross-language, multi-platform application programming
89 interface used for rendering two and three-dimensional
90 graphics.</para></listitem>
91 <listitem><para><emphasis>pci:</emphasis> Include PCI bus
92 support.</para></listitem>
93 <listitem><para><emphasis>pcmcia:</emphasis> Include
94 PCMCIA/CompactFlash support.</para></listitem>
95 <listitem><para><emphasis>ppp:</emphasis> Include PPP dialup
96 support.</para></listitem>
97 <listitem><para><emphasis>smbfs:</emphasis> Include SMB networks
98 client support (for mounting Samba/Microsoft Windows shares
99 on device).</para></listitem>
100 <listitem><para><emphasis>systemd:</emphasis> Include support
101 for this <filename>init</filename> manager, which is a full
102 replacement of for <filename>init</filename> with parallel
103 starting of services, reduced shell overhead, and other
104 features.
105 This <filename>init</filename> manager is used by many
106 distributions.</para></listitem>
107 <listitem><para><emphasis>usbgadget:</emphasis> Include USB
108 Gadget Device support (for USB networking/serial/storage).
109 </para></listitem>
110 <listitem><para><emphasis>usbhost:</emphasis> Include USB Host
111 support (allows to connect external keyboard, mouse,
112 storage, network etc).</para></listitem>
113 <listitem><para><emphasis>wayland:</emphasis> Include the
114 Wayland display server protocol and the library that
115 supports it.</para></listitem>
116 <listitem><para><emphasis>wifi:</emphasis> Include WiFi support
117 (integrated only).</para></listitem>
118 <listitem><para><emphasis>sdk-pms:</emphasis> Include Package
119 Management Tools in the
120 <filename>nativesdk</filename> toolchain tarball.
121 Including these tools allows for easy sandbox use when
122 creating the root filesystem while using the SDK tarball.
123 </para></listitem>
124 </itemizedlist>
125 </para>
126 </section>
127
128 <section id='ref-features-machine'>
129 <title>Machine</title>
130
131 <para>
132 The items below are features you can use with
133 <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>.
134 Features do not have a one-to-one correspondence to packages, and they can
135 go beyond simply controlling the installation of a package or packages.
136 Sometimes a feature can influence how certain recipes are built.
137 For example, a feature might determine whether a particular configure option
138 is specified within <filename>do_configure</filename> for a particular
139 recipe.
140 </para>
141
142 <para>
143 This feature list only represents features as shipped with the Yocto Project metadata:
144 <itemizedlist>
145 <listitem><para><emphasis>acpi:</emphasis> Hardware has ACPI (x86/x86_64 only)
146 </para></listitem>
147 <listitem><para><emphasis>alsa:</emphasis> Hardware has ALSA audio drivers
148 </para></listitem>
149 <listitem><para><emphasis>apm:</emphasis> Hardware uses APM (or APM emulation)
150 </para></listitem>
151 <listitem><para><emphasis>bluetooth:</emphasis> Hardware has integrated BT
152 </para></listitem>
153 <listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive
154 </para></listitem>
155 <listitem><para><emphasis>irda:</emphasis> Hardware has Irda support
156 </para></listitem>
157 <listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard
158 </para></listitem>
159 <listitem><para><emphasis>pci:</emphasis> Hardware has a PCI bus
160 </para></listitem>
161 <listitem><para><emphasis>pcmcia:</emphasis> Hardware has PCMCIA or CompactFlash sockets
162 </para></listitem>
163 <listitem><para><emphasis>screen:</emphasis> Hardware has a screen
164 </para></listitem>
165 <listitem><para><emphasis>serial:</emphasis> Hardware has serial support (usually RS232)
166 </para></listitem>
167 <listitem><para><emphasis>touchscreen:</emphasis> Hardware has a touchscreen
168 </para></listitem>
169 <listitem><para><emphasis>usbgadget:</emphasis> Hardware is USB gadget device capable
170 </para></listitem>
171 <listitem><para><emphasis>usbhost:</emphasis> Hardware is USB Host capable
172 </para></listitem>
173 <listitem><para><emphasis>wifi:</emphasis> Hardware has integrated WiFi
174 </para></listitem>
175 </itemizedlist>
176 </para>
177 </section>
178
179 <section id='ref-features-image'>
180 <title>Images</title>
181
182 <para>
183 The contents of images generated by the OpenEmbedded build system can be controlled by the
184 <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
185 and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename>
186 variables that you typically configure in your image recipes.
187 Through these variables, you can add several different
188 predefined packages such as development utilities or packages with debug
189 information needed to investigate application problems or profile applications.
190 </para>
191
192 <para>
193 Current list of
194 <filename>IMAGE_FEATURES</filename> contains the following:
195 <itemizedlist>
196 <listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages
197 installed in a given image.</para></listitem>
198 <listitem><para><emphasis>dev-pkgs:</emphasis> Installs development packages (headers and
199 extra library links) for all packages installed in a given image.</para></listitem>
200 <listitem><para><emphasis>doc-pkgs:</emphasis> Installs documentation packages for all packages
201 installed in a given image.</para></listitem>
202 <listitem><para><emphasis>nfs-server:</emphasis> Installs an NFS server.</para></listitem>
203 <listitem><para><emphasis>read-only-rootfs:</emphasis> Creates
204 an image whose root filesystem is read-only.
205 See the
206 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
207 section in the Yocto Project Development Manual for more
208 information.</para></listitem>
209 <listitem><para><emphasis>splash:</emphasis> Enables showing a splash screen during boot.
210 By default, this screen is provided by <filename>psplash</filename>, which does
211 allow customization.
212 If you prefer to use an alternative splash screen package, you can do so by
213 setting the <filename>SPLASH</filename> variable
214 to a different package name (or names) within the image recipe or at the distro
215 configuration level.</para></listitem>
216 <listitem><para><emphasis>ssh-server-dropbear:</emphasis> Installs the Dropbear minimal
217 SSH server.
218 </para></listitem>
219 <listitem><para><emphasis>ssh-server-openssh:</emphasis> Installs the OpenSSH SSH server,
220 which is more full-featured than Dropbear.
221 Note that if both the OpenSSH SSH server and the Dropbear minimal SSH server
222 are present in <filename>IMAGE_FEATURES</filename>, then OpenSSH will take
223 precedence and Dropbear will not be installed.</para></listitem>
224 <listitem><para><emphasis>staticdev-pkgs:</emphasis> Installs static development
225 packages (i.e. static libraries containing <filename>*.a</filename> files) for all
226 packages installed in a given image.</para></listitem>
227 <listitem><para><emphasis>tools-debug:</emphasis> Installs debugging tools such as
228 <filename>strace</filename> and <filename>gdb</filename>.
229 For information on GDB, see the
230 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
231 section in the Yocto Project Development Manual.
232 For information on tracing and profiling, see the
233 <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>.
234 </para></listitem>
235 <listitem><para><emphasis>tools-profile:</emphasis> Installs profiling tools such as
236 <filename>oprofile</filename>, <filename>exmap</filename>, and
237 <filename>LTTng</filename>.
238 For general information on user-space tools, see the
239 "<ulink url='&YOCTO_DOCS_ADT_URL;#user-space-tools'>User-Space Tools</ulink>"
240 section in the Yocto Project Application Developer's Guide.</para></listitem>
241 <listitem><para><emphasis>tools-sdk:</emphasis> Installs a full SDK that runs on the device.
242 </para></listitem>
243 <listitem><para><emphasis>tools-testapps:</emphasis> Installs device testing tools (e.g.
244 touchscreen debugging).</para></listitem>
245 <listitem><para><emphasis>x11:</emphasis> Installs the X server</para></listitem>
246 <listitem><para><emphasis>x11-base:</emphasis> Installs the X server with a
247 minimal environment.</para></listitem>
248 <listitem><para><emphasis>x11-sato:</emphasis> Installs the OpenedHand Sato environment.
249 </para></listitem>
250 </itemizedlist>
251 </para>
252 </section>
253
254 <section id='ref-features-backfill'>
255 <title>Feature Backfilling</title>
256
257 <para>
258 Sometimes it is necessary in the OpenEmbedded build system to extend
259 <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
260 or <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>
261 to control functionality that was previously enabled and not able
262 to be disabled.
263 For these cases, we need to add an
264 additional feature item to appear in one of these variables,
265 but we do not want to force developers who have existing values
266 of the variables in their configuration to add the new feature
267 in order to retain the same overall level of functionality.
268 Thus, the OpenEmbedded build system has a mechanism to
269 automatically "backfill" these added features into existing
270 distro or machine configurations.
271 You can see the list of features for which this is done by
272 finding the
273 <link linkend='var-DISTRO_FEATURES_BACKFILL'><filename>DISTRO_FEATURES_BACKFILL</filename></link>
274 and <link linkend='var-MACHINE_FEATURES_BACKFILL'><filename>MACHINE_FEATURES_BACKFILL</filename></link>
275 variables in the <filename>meta/conf/bitbake.conf</filename> file.
276 </para>
277
278 <para>
279 Because such features are backfilled by default into all
280 configurations as described in the previous paragraph, developers
281 who wish to disable the new features need to be able to selectively
282 prevent the backfilling from occurring.
283 They can do this by adding the undesired feature or features to the
284 <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link>
285 or <link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename></link>
286 variables for distro features and machine features respectively.
287 </para>
288
289 <para>
290 Here are two examples to help illustrate feature backfilling:
291 <itemizedlist>
292 <listitem><para><emphasis>The "pulseaudio" distro feature option</emphasis>:
293 Previously, PulseAudio support was enabled within the Qt and
294 GStreamer frameworks.
295 Because of this, the feature is backfilled and thus
296 enabled for all distros through the
297 <filename>DISTRO_FEATURES_BACKFILL</filename>
298 variable in the <filename>meta/conf/bitbake.conf</filename> file.
299 However, your distro needs to disable the feature.
300 You can disable the feature without affecting
301 other existing distro configurations that need PulseAudio support
302 by adding "pulseaudio" to
303 <filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename>
304 in your distro's <filename>.conf</filename> file.
305 Adding the feature to this variable when it also
306 exists in the <filename>DISTRO_FEATURES_BACKFILL</filename>
307 variable prevents the build system from adding the feature to
308 your configuration's <filename>DISTRO_FEATURES</filename>, effectively disabling
309 the feature for that particular distro.</para></listitem>
310 <listitem><para><emphasis>The "rtc" machine feature option</emphasis>:
311 Previously, real time clock (RTC) support was enabled for all
312 target devices.
313 Because of this, the feature is backfilled and thus enabled
314 for all machines through the <filename>MACHINE_FEATURES_BACKFILL</filename>
315 variable in the <filename>meta/conf/bitbake.conf</filename> file.
316 However, your target device does not have this capability.
317 You can disable RTC support for your device without
318 affecting other machines that need RTC support
319 by adding the feature to your machine's
320 <filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename>
321 list in the machine's <filename>.conf</filename> file.
322 Adding the feature to this variable when it also
323 exists in the <filename>MACHINE_FEATURES_BACKFILL</filename>
324 variable prevents the build system from adding the feature to
325 your configuration's <filename>MACHINE_FEATURES</filename>, effectively
326 disabling RTC support for that particular machine.</para></listitem>
327 </itemizedlist>
328 </para>
329 </section>
330</chapter>
331
332<!--
333vim: expandtab tw=80 ts=4 spell spelllang=en_gb
334-->
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml
new file mode 100644
index 0000000000..37c8051a26
--- /dev/null
+++ b/documentation/ref-manual/ref-images.xml
@@ -0,0 +1,150 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-images'>
6 <title>Images</title>
7
8 <para>
9 The OpenEmbedded build system provides several example
10 images to satisfy different needs.
11 When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe
12 that essentially begins the build for the type of image you want.
13 </para>
14
15 <note>
16 Building an image without GNU General Public License Version 3 (GPLv3) components
17 is only supported for minimal and base images.
18 Furthermore, if you are going to build an image using non-GPLv3 components,
19 you must make the following changes in the <filename>local.conf</filename> file
20 before using the BitBake command to build the minimal or base image:
21 <literallayout class='monospaced'>
22 1. Comment out the EXTRA_IMAGE_FEATURES line
23 2. Set INCOMPATIBLE_LICENSE = "GPLv3"
24 </literallayout>
25 </note>
26
27 <para>
28 From within the <filename>poky</filename> Git repository, use the following command to list
29 the supported images:
30 <literallayout class='monospaced'>
31 $ ls meta*/recipes*/images/*.bb
32 </literallayout>
33 These recipes reside in the <filename>meta/recipes-core/images</filename>,
34 <filename>meta/recipes-extended/images</filename>,
35 <filename>meta/recipes-graphics/images</filename>,
36 <filename>meta/recipes-qt/images</filename>,
37 <filename>meta/recipes-rt/images</filename>,
38 <filename>meta/recipes-sato/images</filename>, and
39 <filename>meta-skeleton/recipes-multilib/images</filename> directories
40 within the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
41 Although the recipe names are somewhat explanatory, here is a list that describes them:
42 </para>
43
44 <itemizedlist>
45 <listitem><para><emphasis><filename>build-appliance-image</filename>:</emphasis>
46 An example virtual machine that contains all the pieces required to
47 run builds using the build system as well as the build system itself.
48 You can boot and run the image using either the
49 <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink>
50 or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>.
51 For more information on this image, see the
52 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on
53 the Yocto Project website.</para></listitem>
54 <listitem><para><emphasis><filename>core-image-base</filename>:</emphasis>
55 A console-only image that fully supports the target device hardware.</para></listitem>
56 <listitem><para><emphasis><filename>core-image-minimal</filename>:</emphasis>
57 A small image just capable of allowing a device to boot.</para></listitem>
58 <listitem><para><emphasis><filename>core-image-minimal-dev</filename>:</emphasis>
59 A <filename>core-image-minimal</filename> image suitable for development work
60 using the host.
61 The image includes headers and libraries you can use in a host development
62 environment.
63 </para></listitem>
64 <listitem><para><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
65 A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
66 Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel,
67 which allows the system to find the first “init” program more efficiently.
68 </para></listitem>
69 <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
70 A <filename>core-image-minimal</filename> image that has support
71 for the Minimal MTD Utilities, which let the user interact with the
72 MTD subsystem in the kernel to perform operations on flash devices.
73 </para></listitem>
74 <listitem><para><emphasis><filename>core-image-basic</filename>:</emphasis>
75 A console-only image with more full-featured Linux system
76 functionality installed.</para></listitem>
77 <listitem><para><emphasis><filename>core-image-lsb</filename>:</emphasis>
78 An image that conforms to the Linux Standard Base (LSB) specification.
79 </para></listitem>
80 <listitem><para><emphasis><filename>core-image-lsb-dev</filename>:</emphasis>
81 A <filename>core-image-lsb</filename> image that is suitable for development work
82 using the host.
83 The image includes headers and libraries you can use in a host development
84 environment.
85 </para></listitem>
86 <listitem><para><emphasis><filename>core-image-lsb-sdk</filename>:</emphasis>
87 A <filename>core-image-lsb</filename> that includes everything in meta-toolchain
88 but also includes development headers and libraries to form a complete standalone SDK.
89 This image is suitable for development using the target.</para></listitem>
90 <listitem><para><emphasis><filename>core-image-clutter</filename>:</emphasis>
91 An image with support for the Open GL-based toolkit Clutter, which enables development of
92 rich and animated graphical user interfaces.</para></listitem>
93 <listitem><para><emphasis><filename>core-image-gtk-directfb</filename>:</emphasis>
94 An image that uses <filename>gtk+</filename> over <filename>directfb</filename>
95 instead of X11.
96 In order to build, this image requires specific distro configuration that enables
97 <filename>gtk</filename> over <filename>directfb</filename>.</para></listitem>
98 <listitem><para><emphasis><filename>core-image-x11</filename>:</emphasis>
99 A very basic X11 image with a terminal.
100 </para></listitem>
101 <listitem><para><emphasis><filename>qt4e-demo-image</filename>:</emphasis>
102 An image that launches into the demo application for the embedded
103 (not based on X11) version of Qt.</para></listitem>
104 <listitem><para><emphasis><filename>core-image-rt</filename>:</emphasis>
105 A <filename>core-image-minimal</filename> image plus a real-time test suite and
106 tools appropriate for real-time use.</para></listitem>
107 <listitem><para><emphasis><filename>core-image-rt-sdk</filename>:</emphasis>
108 A <filename>core-image-rt</filename> image that includes everything in
109 <filename>meta-toolchain</filename>.
110 The image also includes development headers and libraries to form a complete
111 stand-alone SDK and is suitable for development using the target.
112 </para></listitem>
113 <listitem><para><emphasis><filename>core-image-sato</filename>:</emphasis>
114 An image with Sato support, a mobile environment and visual style that works well
115 with mobile devices.
116 The image supports X11 with a Sato theme and applications such as
117 a terminal, editor, file manager, media player, and so forth.
118 </para></listitem>
119 <listitem><para><emphasis><filename>core-image-sato-dev</filename>:</emphasis>
120 A <filename>core-image-sato</filename> image suitable for development
121 using the host.
122 The image includes libraries needed to build applications on the device itself,
123 testing and profiling tools, and debug symbols.
124 This image was formerly <filename>core-image-sdk</filename>.
125 </para></listitem>
126 <listitem><para><emphasis><filename>core-image-sato-sdk</filename>:</emphasis>
127 A <filename>core-image-sato</filename> image that includes everything in meta-toolchain.
128 The image also includes development headers and libraries to form a complete standalone SDK
129 and is suitable for development using the target.</para></listitem>
130 <listitem><para><emphasis><filename>core-image-multilib-example</filename>:</emphasis>
131 An example image that includes a <filename>lib32</filename> version
132 of Bash into an otherwise standard <filename>sato</filename> image.
133 The image assumes a "lib32" multilib has been enabled in the your
134 configuration.</para></listitem>
135 </itemizedlist>
136
137 <tip>
138 From the Yocto Project release 1.1 onwards, <filename>-live</filename> and
139 <filename>-directdisk</filename> images have been replaced by a "live"
140 option in <filename>IMAGE_FSTYPES</filename> that will work with any image to produce an
141 image file that can be
142 copied directly to a CD or USB device and run as is.
143 To build a live image, simply add
144 "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename>
145 file or wherever appropriate and then build the desired image as normal.
146 </tip>
147</chapter>
148<!--
149vim: expandtab tw=80 ts=4
150-->
diff --git a/documentation/ref-manual/ref-manual-customization.xsl b/documentation/ref-manual/ref-manual-customization.xsl
new file mode 100644
index 0000000000..3ad3a315c0
--- /dev/null
+++ b/documentation/ref-manual/ref-manual-customization.xsl
@@ -0,0 +1,11 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5
6 <xsl:param name="html.stylesheet" select="'ref-style.css'" />
7 <xsl:param name="chapter.autolabel" select="1" />
8 <xsl:param name="appendix.autolabel" select="A" />
9 <xsl:param name="section.autolabel" select="1" />
10 <xsl:param name="section.label.includes.component.label" select="1" />
11</xsl:stylesheet>
diff --git a/documentation/ref-manual/ref-manual-eclipse-customization.xsl b/documentation/ref-manual/ref-manual-eclipse-customization.xsl
new file mode 100644
index 0000000000..4e6b7997b8
--- /dev/null
+++ b/documentation/ref-manual/ref-manual-eclipse-customization.xsl
@@ -0,0 +1,27 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10
11 <xsl:param name="chunker.output.indent" select="'yes'"/>
12 <xsl:param name="chunk.quietly" select="1"/>
13 <xsl:param name="chunk.first.sections" select="1"/>
14 <xsl:param name="chunk.section.depth" select="10"/>
15 <xsl:param name="use.id.as.filename" select="1"/>
16 <xsl:param name="ulink.target" select="'_self'" />
17 <xsl:param name="base.dir" select="'html/ref-manual/'"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="chapter.autolabel" select="1" />
24 <xsl:param name="appendix.autolabel">A</xsl:param>
25 <xsl:param name="section.autolabel" select="1" />
26 <xsl:param name="section.label.includes.component.label" select="1" />
27</xsl:stylesheet>
diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml
new file mode 100644
index 0000000000..7db880b404
--- /dev/null
+++ b/documentation/ref-manual/ref-manual.xml
@@ -0,0 +1,138 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<book id='ref-manual' lang='en'
6 xmlns:xi="http://www.w3.org/2003/XInclude"
7 xmlns="http://docbook.org/ns/docbook"
8 >
9 <bookinfo>
10
11 <mediaobject>
12 <imageobject>
13 <imagedata fileref='figures/poky-title.png'
14 format='SVG'
15 align='left' scalefit='1' width='100%'/>
16 </imageobject>
17 </mediaobject>
18
19 <title>
20 Yocto Project Reference Manual
21 </title>
22
23 <authorgroup>
24 <author>
25 <firstname>Richard</firstname> <surname>Purdie</surname>
26 <affiliation>
27 <orgname>Linux Foundation</orgname>
28 </affiliation>
29 <email>richard.purdie@linuxfoundation.org</email>
30 </author>
31
32 </authorgroup>
33
34 <revhistory>
35 <revision>
36 <revnumber>4.0+git</revnumber>
37 <date>24 November 2010</date>
38 <revremark>Released with the Yocto Project 0.9 Release</revremark>
39 </revision>
40 <revision>
41 <revnumber>1.0</revnumber>
42 <date>6 April 2011</date>
43 <revremark>Released with the Yocto Project 1.0 Release.</revremark>
44 </revision>
45 <revision>
46 <revnumber>1.0.1</revnumber>
47 <date>23 May 2011</date>
48 <revremark>Released with the Yocto Project 1.0.1 Release.</revremark>
49 </revision>
50 <revision>
51 <revnumber>1.1</revnumber>
52 <date>6 October 2011</date>
53 <revremark>Released with the Yocto Project 1.1 Release.</revremark>
54 </revision>
55 <revision>
56 <revnumber>1.2</revnumber>
57 <date>April 2012</date>
58 <revremark>Released with the Yocto Project 1.2 Release.</revremark>
59 </revision>
60 <revision>
61 <revnumber>1.3</revnumber>
62 <date>October 2012</date>
63 <revremark>Released with the Yocto Project 1.3 Release.</revremark>
64 </revision>
65 <revision>
66 <revnumber>1.4</revnumber>
67 <date>April 2013</date>
68 <revremark>Released with the Yocto Project 1.4 Release.</revremark>
69 </revision>
70 <revision>
71 <revnumber>1.5</revnumber>
72 <date>October 2013</date>
73 <revremark>Released with the Yocto Project 1.5 Release.</revremark>
74 </revision>
75 <revision>
76 <revnumber>1.5.1</revnumber>
77 <date>Sometime in 2013</date>
78 <revremark>Released with the Yocto Project 1.5.1 Release.</revremark>
79 </revision>
80 </revhistory>
81
82 <copyright>
83 <year>&COPYRIGHT_YEAR;</year>
84 <holder>Linux Foundation</holder>
85 </copyright>
86
87 <legalnotice>
88 <para>
89 Permission is granted to copy, distribute and/or modify this document under
90 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
91 </para>
92 <note>
93 For the latest version of this manual associated with this
94 Yocto Project release, see the
95 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>
96 from the Yocto Project website.
97 </note>
98 </legalnotice>
99
100 </bookinfo>
101
102 <xi:include href="introduction.xml"/>
103
104 <xi:include href="usingpoky.xml"/>
105
106 <xi:include href="closer-look.xml"/>
107
108 <xi:include href="technical-details.xml"/>
109
110 <xi:include href="migration.xml"/>
111
112 <xi:include href="ref-structure.xml"/>
113
114 <xi:include href="ref-bitbake.xml"/>
115
116 <xi:include href="ref-classes.xml"/>
117
118 <xi:include href="ref-images.xml"/>
119
120 <xi:include href="ref-features.xml"/>
121
122 <xi:include href="ref-variables.xml"/>
123
124 <xi:include href="ref-varlocality.xml"/>
125
126 <xi:include href="faq.xml"/>
127
128 <xi:include href="resources.xml"/>
129
130<!-- <index id='index'>
131 <title>Index</title>
132 </index>
133-->
134
135</book>
136<!--
137vim: expandtab tw=80 ts=4
138-->
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
new file mode 100644
index 0000000000..13803f5a41
--- /dev/null
+++ b/documentation/ref-manual/ref-structure.xml
@@ -0,0 +1,953 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-structure'>
6
7<title>Source Directory Structure</title>
8
9<para>
10 The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components.
11 Understanding them and knowing where they are located is key to using the Yocto Project well.
12 This chapter describes the Source Directory and gives information about the various
13 files and directories.
14</para>
15
16<para>
17 For information on how to establish a local Source Directory on your development system, see the
18 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
19 section in the Yocto Project Development Manual.
20</para>
21
22<note>
23 The OpenEmbedded build system does not support file or directory names that
24 contain spaces.
25 Be sure that the Source Directory you use does not contain these types
26 of names.
27</note>
28
29<section id='structure-core'>
30 <title>Top-Level Core Components</title>
31
32 <para>
33 This section describes the top-level components of the
34 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
35 </para>
36
37 <section id='structure-core-bitbake'>
38 <title><filename>bitbake/</filename></title>
39
40 <para>
41 This directory includes a copy of BitBake for ease of use.
42 The copy usually matches the current stable BitBake release from the BitBake project.
43 BitBake, a
44 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
45 interpreter, reads the Yocto Project metadata and runs the tasks
46 defined by that data.
47 Failures are usually from the metadata and not from BitBake itself.
48 Consequently, most users do not need to worry about BitBake.
49 </para>
50
51 <para>
52 When you run the <filename>bitbake</filename> command, the wrapper script in
53 <filename>scripts/</filename> is executed to run the main BitBake executable,
54 which resides in the <filename>bitbake/bin/</filename> directory.
55 Sourcing the <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>
56 script places the <filename>scripts</filename> and <filename>bitbake/bin</filename>
57 directories (in that order) into the shell's <filename>PATH</filename> environment
58 variable.
59 </para>
60
61 <para>
62 For more information on BitBake, see the BitBake documentation
63 included in the <filename>bitbake/doc/manual</filename> directory of the
64 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
65 </para>
66 </section>
67
68 <section id='structure-core-build'>
69 <title><filename>build/</filename></title>
70
71 <para>
72 This directory contains user configuration files and the output
73 generated by the OpenEmbedded build system in its standard configuration where
74 the source tree is combined with the output.
75 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
76 is created initially when you <filename>source</filename>
77 the OpenEmbedded build environment setup script
78 (i.e.
79 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
80 or
81 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
82 </para>
83
84 <para>
85 It is also possible to place output and configuration
86 files in a directory separate from the
87 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
88 by providing a directory name when you <filename>source</filename>
89 the setup script.
90 For information on separating output from your local
91 Source Directory files, see the
92 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
93 and
94 "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>"
95 sections.
96 </para>
97 </section>
98
99 <section id='handbook'>
100 <title><filename>documentation</filename></title>
101
102 <para>
103 This directory holds the source for the Yocto Project documentation
104 as well as templates and tools that allow you to generate PDF and HTML
105 versions of the manuals.
106 Each manual is contained in a sub-folder.
107 For example, the files for this manual reside in
108 <filename>ref-manual</filename>.
109 </para>
110 </section>
111
112 <section id='structure-core-meta'>
113 <title><filename>meta/</filename></title>
114
115 <para>
116 This directory contains the OpenEmbedded Core metadata.
117 The directory holds recipes, common classes, and machine
118 configuration for emulated targets (<filename>qemux86</filename>,
119 <filename>qemuarm</filename>, and so forth.)
120 </para>
121 </section>
122
123 <section id='structure-core-meta-yocto'>
124 <title><filename>meta-yocto/</filename></title>
125
126 <para>
127 This directory contains the configuration for the Poky
128 reference distribution.
129 </para>
130 </section>
131
132 <section id='structure-core-meta-yocto-bsp'>
133 <title><filename>meta-yocto-bsp/</filename></title>
134
135 <para>
136 This directory contains the Yocto Project reference
137 hardware Board Support Packages (BSPs).
138 For more information on BSPs, see the
139 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support
140 Package (BSP) Developer's Guide</ulink>.
141 </para>
142 </section>
143
144 <section id='structure-meta-hob'>
145 <title><filename>meta-hob/</filename></title>
146
147 <para>
148 This directory contains template recipes used by Hob,
149 which is a Yocto Project build user interface.
150 For more information on the Hob, see the
151 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob Project</ulink>
152 web page.
153 </para>
154 </section>
155
156 <section id='structure-meta-skeleton'>
157 <title><filename>meta-skeleton/</filename></title>
158
159 <para>
160 This directory contains template recipes for BSP and kernel development.
161 </para>
162 </section>
163
164 <section id='structure-core-scripts'>
165 <title><filename>scripts/</filename></title>
166
167 <para>
168 This directory contains various integration scripts that implement
169 extra functionality in the Yocto Project environment (e.g. QEMU scripts).
170 The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>
171 and
172 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
173 scripts append this directory to the shell's
174 <filename>PATH</filename> environment variable.
175 </para>
176
177 <para>
178 The <filename>scripts</filename> directory has useful scripts that assist contributing
179 back to the Yocto Project, such as <filename>create_pull_request</filename> and
180 <filename>send_pull_request</filename>.
181 </para>
182 </section>
183
184 <section id='structure-core-script'>
185 <title><filename>&OE_INIT_FILE;</filename></title>
186
187 <para>
188 This script is one of two scripts that set up the OpenEmbedded build
189 environment.
190 For information on the other script, see the
191 "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>"
192 section.
193 </para>
194
195 <para>
196 Running this script with the <filename>source</filename> command in
197 a shell makes changes to <filename>PATH</filename> and sets other
198 core BitBake variables based on the current working directory.
199 You need to run an environment setup script before running BitBake
200 commands.
201 The script uses other scripts within the
202 <filename>scripts</filename> directory to do the bulk of the work.
203 </para>
204
205 <para>
206 By default, running this script without a
207 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
208 argument creates the <filename>build</filename> directory.
209 If you provide a Build Directory argument when you
210 <filename>source</filename> the script, you direct the OpenEmbedded
211 build system to create a Build Directory of your choice.
212 For example, the following command creates a Build Directory named
213 <filename>mybuilds</filename> that is outside of the
214 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
215 <literallayout class='monospaced'>
216 $ source &OE_INIT_FILE; ~/mybuilds
217 </literallayout>
218 <note>
219 The OpenEmbedded build system does not support file or directory names that
220 contain spaces.
221 If you attempt to run the <filename>&OE_INIT_FILE;</filename> script
222 from a Source Directory that contains spaces in either the filenames
223 or directory names, the script returns an error indicating no such
224 file or directory.
225 Be sure to use a Source Directory free of names containing spaces.
226 </note>
227 </para>
228 </section>
229
230 <section id='structure-memres-core-script'>
231 <title><filename>oe-init-build-env-memres</filename></title>
232
233 <para>
234 This script is one of two scripts that set up the OpenEmbedded build
235 environment.
236 Setting up the environment with this script uses a
237 memory-resident BitBake.
238 For information on the other setup script, see the
239 "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>"
240 section.
241 </para>
242
243 <para>
244 Memory-resident BitBake resides in memory until you specifically
245 remove it using the following BitBake command:
246 <literallayout class='monospaced'>
247 $ bitbake -m
248 </literallayout>
249 </para>
250
251 <para>
252 Running this script with the <filename>source</filename> command in
253 a shell makes changes to <filename>PATH</filename> and sets other
254 core BitBake variables based on the current working directory.
255 One of these variables is the
256 <link linkend='var-BBSERVER'><filename>BBSERVER</filename></link>
257 variable, which allows the OpenEmbedded build system to locate
258 the server that is running BitBake.
259 </para>
260
261 <para>
262 You need to run an environment setup script before running BitBake
263 commands.
264 Following is the script syntax:
265 <literallayout class='monospaced'>
266 $ source oe-init-build-env-memres &lt;port_number&gt; &lt;build_dir&gt;
267 </literallayout>
268 The script uses other scripts within the
269 <filename>scripts</filename> directory to do the bulk of the work.
270 </para>
271
272 <para>
273 If you do not provide a port number with the script, the default
274 port "12345" is used.
275 </para>
276
277 <para>
278 By default, running this script without a
279 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
280 argument creates the <filename>build</filename> directory.
281 If you provide a Build Directory argument when you
282 <filename>source</filename> the script, you direct the OpenEmbedded
283 build system to create a Build Directory of your choice.
284 For example, the following command uses the default port number
285 "12345" and creates a Build Directory named
286 <filename>mybuilds</filename> that is outside of the
287 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
288 <literallayout class='monospaced'>
289 $ source oe-init-build-env-memres ~/mybuilds
290 </literallayout>
291 <note>
292 The OpenEmbedded build system does not support file or
293 directory names that contain spaces.
294 If you attempt to run the
295 <filename>oe-init-build-env-memres</filename> script
296 from a Source Directory that contains spaces in either the
297 filenames or directory names, the script returns an error
298 indicating no such file or directory.
299 Be sure to use a Source Directory free of names containing
300 spaces.
301 </note>
302 </para>
303 </section>
304
305 <section id='structure-basic-top-level'>
306 <title><filename>LICENSE, README, and README.hardware</filename></title>
307
308 <para>
309 These files are standard top-level files.
310 </para>
311 </section>
312</section>
313
314<section id='structure-build'>
315 <title>The Build Directory - <filename>build/</filename></title>
316
317 <para>
318 The OpenEmbedded build system creates the
319 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
320 during the build.
321 By default, this directory is named <filename>build</filename>.
322 </para>
323
324 <section id='structure-build-pseudodone'>
325 <title><filename>build/pseudodone</filename></title>
326
327 <para>
328 This tag file indicates that the initial pseudo binary was created.
329 The file is built the first time BitBake is invoked.
330 </para>
331 </section>
332
333 <section id='structure-build-conf-local.conf'>
334 <title><filename>build/conf/local.conf</filename></title>
335
336 <para>
337 This configuration file contains all the local user configurations
338 for your build environment.
339 The <filename>local.conf</filename> file contains documentation on
340 the various configuration options.
341 Any variable set here overrides any variable set elsewhere within
342 the environment unless that variable is hard-coded within a file
343 (e.g. by using '=' instead of '?=').
344 Some variables are hard-coded for various reasons but these
345 variables are relatively rare.
346 </para>
347
348 <para>
349 Edit this file to set the
350 <filename><link linkend='var-MACHINE'>MACHINE</link></filename>
351 for which you want to build, which package types you wish to use
352 (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>),
353 the location from which you want to downloaded files
354 (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>),
355 and how you want your host machine to use resources
356 (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>
357 and
358 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>).
359 </para>
360
361 <para>
362 If <filename>local.conf</filename> is not present when you
363 start the build, the OpenEmbedded build system creates it from
364 <filename>local.conf.sample</filename> when
365 you <filename>source</filename> the top-level build environment
366 setup script (i.e.
367 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
368 or
369 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
370 </para>
371
372 <para>
373 The source <filename>local.conf.sample</filename> file used
374 depends on the <filename>$TEMPLATECONF</filename> script variable,
375 which defaults to <filename>/meta-yocto/conf</filename>
376 when you are building from the Yocto Project development
377 environment and defaults to <filename>/meta/conf</filename> when
378 you are building from the OpenEmbedded Core environment.
379 Because the script variable points to the source of the
380 <filename>local.conf.sample</filename> file, this implies that
381 you can configure your build environment from any layer by setting
382 the variable in the top-level build environment setup script as
383 follows:
384 <literallayout class='monospaced'>
385 TEMPLATECONF=&lt;your_layer&gt;/conf
386 </literallayout>
387 Once the build process gets the sample file, it uses
388 <filename>sed</filename> to substitute final
389 <filename>${</filename><link linkend='var-OEROOT'><filename>OEROOT</filename></link><filename>}</filename>
390 values for all <filename>##OEROOT##</filename> values.
391 <note>
392 You can see how the <filename>TEMPLATECONF</filename> variable
393 is used by looking at the
394 <filename>/scripts/oe-setup-builddir</filename> script in the
395 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
396 You can find the Yocto Project version of the
397 <filename>local.conf.sample</filename> file in the
398 <filename>/meta-yocto/conf</filename> directory.
399 </note>
400 </para>
401 </section>
402
403 <section id='structure-build-conf-bblayers.conf'>
404 <title><filename>build/conf/bblayers.conf</filename></title>
405
406 <para>
407 This configuration file defines
408 <ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>layers</ulink>,
409 which are directory trees, traversed (or walked) by BitBake.
410 The <filename>bblayers.conf</filename> file uses the
411 <link linkend='var-BBLAYERS'><filename>BBLAYERS</filename></link>
412 variable to list the layers BitBake tries to find, and uses the
413 <link linkend='var-BBLAYERS_NON_REMOVABLE'><filename>BBLAYERS_NON_REMOVABLE</filename></link>
414 variable to list layers that must not be removed.
415 </para>
416
417 <para>
418 If <filename>bblayers.conf</filename> is not present when you
419 start the build, the OpenEmbedded build system creates it from
420 <filename>bblayers.conf.sample</filename> when
421 you <filename>source</filename> the top-level build environment
422 setup script (i.e.
423 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
424 or
425 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
426 </para>
427
428 <para>
429 The source <filename>bblayers.conf.sample</filename> file used
430 depends on the <filename>$TEMPLATECONF</filename> script variable,
431 which defaults to <filename>/meta-yocto/conf</filename>
432 when you are building from the Yocto Project development
433 environment and defaults to <filename>/meta/conf</filename> when
434 you are building from the OpenEmbedded Core environment.
435 Because the script variable points to the source of the
436 <filename>bblayers.conf.sample</filename> file, this implies that
437 you can base your build from any layer by setting the variable in
438 the top-level build environment setup script as follows:
439 <literallayout class='monospaced'>
440 TEMPLATECONF=&lt;your_layer&gt;/conf
441 </literallayout>
442 Once the build process gets the sample file, it uses
443 <filename>sed</filename> to substitute final
444 <filename>${</filename><link linkend='var-OEROOT'><filename>OEROOT</filename></link><filename>}</filename>
445 values for all <filename>##OEROOT##</filename> values.
446 <note>
447 You can see how the <filename>TEMPLATECONF</filename> variable
448 <filename>/scripts/oe-setup-builddir</filename> script in the
449 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
450 You can find the Yocto Project version of the
451 <filename>bblayers.conf.sample</filename> file in the
452 <filename>/meta-yocto/conf</filename> directory.
453 </note>
454 </para>
455 </section>
456
457 <section id='structure-build-conf-sanity_info'>
458 <title><filename>build/conf/sanity_info</filename></title>
459
460 <para>
461 This file indicates the state of the sanity checks and is created
462 during the build.
463 </para>
464 </section>
465
466 <section id='structure-build-downloads'>
467 <title><filename>build/downloads/</filename></title>
468
469 <para>
470 This directory contains downloaded upstream source tarballs.
471 You can reuse the directory for multiple builds or move
472 the directory to another location.
473 You can control the location of this directory through the
474 <filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable.
475 </para>
476 </section>
477
478 <section id='structure-build-sstate-cache'>
479 <title><filename>build/sstate-cache/</filename></title>
480
481 <para>
482 This directory contains the shared state cache.
483 You can reuse the directory for multiple builds or move
484 the directory to another location.
485 You can control the location of this directory through the
486 <filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable.
487 </para>
488 </section>
489
490 <section id='structure-build-tmp'>
491 <title><filename>build/tmp/</filename></title>
492
493 <para>
494 This directory receives all the OpenEmbedded build system's output.
495 BitBake creates this directory if it does not exist.
496 As a last resort, to clean up a build and start it from scratch (other than the downloads),
497 you can remove everything in the <filename>tmp</filename> directory or get rid of the
498 directory completely.
499 If you do, you should also completely remove the
500 <filename>build/sstate-cache</filename> directory.
501 </para>
502 </section>
503
504 <section id='structure-build-tmp-buildstats'>
505 <title><filename>build/tmp/buildstats/</filename></title>
506
507 <para>
508 This directory stores the build statistics.
509 </para>
510 </section>
511
512 <section id='structure-build-tmp-cache'>
513 <title><filename>build/tmp/cache/</filename></title>
514
515 <para>
516 When BitBake parses the metadata, it creates a cache file of the result that can
517 be used when subsequently running commands.
518 BitBake stores these results here on a per-machine basis.
519 </para>
520 </section>
521
522 <section id='structure-build-tmp-deploy'>
523 <title><filename>build/tmp/deploy/</filename></title>
524
525 <para>
526 This directory contains any "end result" output from the
527 OpenEmbedded build process.
528 The <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>
529 variable points to this directory.
530 For more detail on the contents of the <filename>deploy</filename>
531 directory, see the
532 "<link linkend='images-dev-environment'>Images</link>" and
533 "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
534 sections.
535 </para>
536 </section>
537
538 <section id='structure-build-tmp-deploy-deb'>
539 <title><filename>build/tmp/deploy/deb/</filename></title>
540
541 <para>
542 This directory receives any <filename>.deb</filename> packages produced by
543 the build process.
544 The packages are sorted into feeds for different architecture types.
545 </para>
546 </section>
547
548 <section id='structure-build-tmp-deploy-rpm'>
549 <title><filename>build/tmp/deploy/rpm/</filename></title>
550
551 <para>
552 This directory receives any <filename>.rpm</filename> packages produced by
553 the build process.
554 The packages are sorted into feeds for different architecture types.
555 </para>
556 </section>
557
558 <section id='structure-build-tmp-deploy-licenses'>
559 <title><filename>build/tmp/deploy/licenses/</filename></title>
560
561 <para>
562 This directory receives package licensing information.
563 For example, the directory contains sub-directories for <filename>bash</filename>,
564 <filename>busybox</filename>, and <filename>eglibc</filename> (among others) that in turn
565 contain appropriate <filename>COPYING</filename> license files with other licensing information.
566 For information on licensing, see the
567 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>"
568 section.
569 </para>
570 </section>
571
572 <section id='structure-build-tmp-deploy-images'>
573 <title><filename>build/tmp/deploy/images/</filename></title>
574
575 <para>
576 This directory receives complete filesystem images.
577 If you want to flash the resulting image from a build onto a device, look here for the image.
578 </para>
579
580 <para>
581 Be careful when deleting files in this directory.
582 You can safely delete old images from this directory (e.g.
583 <filename>core-image-*</filename>, <filename>hob-image-*</filename>,
584 etc.).
585 However, the kernel (<filename>*zImage*</filename>, <filename>*uImage*</filename>, etc.),
586 bootloader and other supplementary files might be deployed here prior to building an
587 image.
588 Because these files are not directly produced from the image, if you
589 delete them they will not be automatically re-created when you build the image again.
590 </para>
591
592 <para>
593 If you do accidentally delete files here, you will need to force them to be
594 re-created.
595 In order to do that, you will need to know the target that produced them.
596 For example, these commands rebuild and re-create the kernel files:
597 <literallayout class='monospaced'>
598 $ bitbake -c clean virtual/kernel
599 $ bitbake virtual/kernel
600 </literallayout>
601 </para>
602 </section>
603
604 <section id='structure-build-tmp-deploy-ipk'>
605 <title><filename>build/tmp/deploy/ipk/</filename></title>
606
607 <para>
608 This directory receives <filename>.ipk</filename> packages produced by
609 the build process.</para>
610 </section>
611
612 <section id='structure-build-tmp-sysroots'>
613 <title><filename>build/tmp/sysroots/</filename></title>
614
615 <para>
616 This directory contains shared header files and libraries as well as other shared
617 data.
618 Packages that need to share output with other packages do so within this directory.
619 The directory is subdivided by architecture so multiple builds can run within
620 the one Build Directory.
621 </para>
622 </section>
623
624 <section id='structure-build-tmp-stamps'>
625 <title><filename>build/tmp/stamps/</filename></title>
626
627 <para>
628 This directory holds information that BitBake uses for accounting purposes
629 to track what tasks have run and when they have run.
630 The directory is sub-divided by architecture, package name, and
631 version.
632 Following is an example:
633 <literallayout class='monospaced'>
634 stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do
635 </literallayout>
636 Although the files in the directory are empty of data,
637 BitBake uses the filenames and timestamps for tracking purposes.
638 </para>
639 </section>
640
641 <section id='structure-build-tmp-log'>
642 <title><filename>build/tmp/log/</filename></title>
643
644 <para>
645 This directory contains general logs that are not otherwise placed using the
646 package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>.
647 Examples of logs are the output from the <filename>check_pkg</filename> or
648 <filename>distro_check</filename> tasks.
649 Running a build does not necessarily mean this directory is created.
650 </para>
651 </section>
652
653 <section id='structure-build-tmp-pkgdata'>
654 <title><filename>build/tmp/pkgdata/</filename></title>
655
656 <para>
657 This directory contains intermediate packaging data that is used later in the packaging process.
658 For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section.
659 </para>
660 </section>
661
662 <section id='structure-build-tmp-work'>
663 <title><filename>build/tmp/work/</filename></title>
664
665 <para>
666 This directory contains architecture-specific work sub-directories
667 for packages built by BitBake.
668 All tasks execute from the appropriate work directory.
669 For example, the source for a particular package is unpacked,
670 patched, configured and compiled all within its own work directory.
671 Within the work directory, organization is based on the package group
672 and version for which the source is being compiled
673 as defined by the
674 <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
675 </para>
676
677 <para>
678 It is worth considering the structure of a typical work directory.
679 As an example, consider <filename>linux-yocto-kernel-3.0</filename>
680 on the machine <filename>qemux86</filename>
681 built within the Yocto Project.
682 For this package, a work directory of
683 <filename>tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+&lt;.....&gt;</filename>,
684 referred to as the
685 <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, is created.
686 Within this directory, the source is unpacked to
687 <filename>linux-qemux86-standard-build</filename> and then patched by Quilt.
688 (See the
689 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using a Quilt Flow</ulink>"
690 section in the Yocto Project Development Manual for more information.)
691 Within the <filename>linux-qemux86-standard-build</filename> directory,
692 standard Quilt directories <filename>linux-3.0/patches</filename>
693 and <filename>linux-3.0/.pc</filename> are created,
694 and standard Quilt commands can be used.
695 </para>
696
697 <para>
698 There are other directories generated within <filename>WORKDIR</filename>.
699 The most important directory is <filename>WORKDIR/temp/</filename>,
700 which has log files for each task (<filename>log.do_*.pid</filename>)
701 and contains the scripts BitBake runs for each task
702 (<filename>run.do_*.pid</filename>).
703 The <filename>WORKDIR/image/</filename> directory is where "make
704 install" places its output that is then split into sub-packages
705 within <filename>WORKDIR/packages-split/</filename>.
706 </para>
707 </section>
708</section>
709
710<section id='structure-meta'>
711 <title>The Metadata - <filename>meta/</filename></title>
712
713 <para>
714 As mentioned previously,
715 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> is the core
716 of the Yocto Project.
717 Metadata has several important subdivisions:
718 </para>
719
720 <section id='structure-meta-classes'>
721 <title><filename>meta/classes/</filename></title>
722
723 <para>
724 This directory contains the <filename>*.bbclass</filename> files.
725 Class files are used to abstract common code so it can be reused by multiple
726 packages.
727 Every package inherits the <filename>base.bbclass</filename> file.
728 Examples of other important classes are <filename>autotools.bbclass</filename>, which
729 in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort.
730 Another example is <filename>kernel.bbclass</filename> that contains common code and functions
731 for working with the Linux kernel.
732 Functions like image generation or packaging also have their specific class files
733 such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and
734 <filename>package*.bbclass</filename>.
735 </para>
736
737 <para>
738 For reference information on classes, see the
739 "<link linkend='ref-classes'>Classes</link>" chapter.
740 </para>
741 </section>
742
743 <section id='structure-meta-conf'>
744 <title><filename>meta/conf/</filename></title>
745
746 <para>
747 This directory contains the core set of configuration files that start from
748 <filename>bitbake.conf</filename> and from which all other configuration
749 files are included.
750 See the include statements at the end of the
751 <filename>bitbake.conf</filename> file and you will note that even
752 <filename>local.conf</filename> is loaded from there.
753 While <filename>bitbake.conf</filename> sets up the defaults, you can often override
754 these by using the (<filename>local.conf</filename>) file, machine file or
755 the distribution configuration file.
756 </para>
757 </section>
758
759 <section id='structure-meta-conf-machine'>
760 <title><filename>meta/conf/machine/</filename></title>
761
762 <para>
763 This directory contains all the machine configuration files.
764 If you set <filename>MACHINE = "qemux86"</filename>,
765 the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this
766 directory.
767 The <filename>include</filename> directory contains various data common to multiple machines.
768 If you want to add support for a new machine to the Yocto Project, look in this directory.
769 </para>
770 </section>
771
772 <section id='structure-meta-conf-distro'>
773 <title><filename>meta/conf/distro/</filename></title>
774
775 <para>
776 The contents of this directory controls any distribution-specific
777 configurations.
778 For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here.
779 This directory includes the versions and the
780 <filename>SRCDATE</filename> definitions for applications that are configured here.
781 An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>.
782 Although this file mainly inherits its configuration from Poky.
783 </para>
784 </section>
785
786 <section id='structure-meta-files'>
787 <title><filename>meta/files/</filename></title>
788
789 <para>
790 This directory contains common license files and several text files
791 used by the build system.
792 The text files contain minimal device information and
793 lists of files and directories with knows permissions.
794 </para>
795 </section>
796
797 <section id='structure-meta-lib'>
798 <title><filename>meta/lib/</filename></title>
799
800 <para>
801 This directory contains OpenEmbedded Python library code
802 used during the build process.
803 </para>
804 </section>
805
806 <section id='structure-meta-recipes-bsp'>
807 <title><filename>meta/recipes-bsp/</filename></title>
808
809 <para>
810 This directory contains anything linking to specific hardware or hardware
811 configuration information such as "u-boot" and "grub".
812 </para>
813 </section>
814
815 <section id='structure-meta-recipes-connectivity'>
816 <title><filename>meta/recipes-connectivity/</filename></title>
817
818 <para>
819 This directory contains libraries and applications related to communication with other devices.
820 </para>
821 </section>
822
823 <section id='structure-meta-recipes-core'>
824 <title><filename>meta/recipes-core/</filename></title>
825
826 <para>
827 This directory contains what is needed to build a basic working Linux image
828 including commonly used dependencies.
829 </para>
830 </section>
831
832 <section id='structure-meta-recipes-devtools'>
833 <title><filename>meta/recipes-devtools/</filename></title>
834
835 <para>
836 This directory contains tools that are primarily used by the build system.
837 The tools, however, can also be used on targets.
838 </para>
839 </section>
840
841 <section id='structure-meta-recipes-extended'>
842 <title><filename>meta/recipes-extended/</filename></title>
843
844 <para>
845 This directory contains non-essential applications that add features compared to the
846 alternatives in core.
847 You might need this directory for full tool functionality or for Linux Standard Base (LSB)
848 compliance.
849 </para>
850 </section>
851
852 <section id='structure-meta-recipes-gnome'>
853 <title><filename>meta/recipes-gnome/</filename></title>
854
855 <para>
856 This directory contains all things related to the GTK+ application framework.
857 </para>
858 </section>
859
860 <section id='structure-meta-recipes-graphics'>
861 <title><filename>meta/recipes-graphics/</filename></title>
862
863 <para>
864 This directory contains X and other graphically related system libraries
865 </para>
866 </section>
867
868 <section id='structure-meta-recipes-kernel'>
869 <title><filename>meta/recipes-kernel/</filename></title>
870
871 <para>
872 This directory contains the kernel and generic applications and libraries that
873 have strong kernel dependencies.
874 </para>
875 </section>
876
877 <section id='structure-meta-recipes-lsb4'>
878 <title><filename>meta/recipes-lsb4/</filename></title>
879
880 <para>
881 This directory contains recipes specifically added to support
882 the Linux Standard Base (LSB) version 4.x.
883 </para>
884 </section>
885
886 <section id='structure-meta-recipes-multimedia'>
887 <title><filename>meta/recipes-multimedia/</filename></title>
888
889 <para>
890 This directory contains codecs and support utilities for audio, images and video.
891 </para>
892 </section>
893
894 <section id='structure-meta-recipes-qt'>
895 <title><filename>meta/recipes-qt/</filename></title>
896
897 <para>
898 This directory contains all things related to the Qt application framework.
899 </para>
900 </section>
901
902 <section id='structure-meta-recipes-rt'>
903 <title><filename>meta/recipes-rt/</filename></title>
904
905 <para>
906 This directory contains package and image recipes for using and testing
907 the <filename>PREEMPT_RT</filename> kernel.
908 </para>
909 </section>
910
911 <section id='structure-meta-recipes-sato'>
912 <title><filename>meta/recipes-sato/</filename></title>
913
914 <para>
915 This directory contains the Sato demo/reference UI/UX and its associated applications
916 and configuration data.
917 </para>
918 </section>
919
920 <section id='structure-meta-recipes-support'>
921 <title><filename>meta/recipes-support/</filename></title>
922
923 <para>
924 This directory contains recipes used by other recipes, but that are
925 not directly included in images (i.e. dependencies of other
926 recipes).
927 </para>
928 </section>
929
930 <section id='structure-meta-site'>
931 <title><filename>meta/site/</filename></title>
932
933 <para>
934 This directory contains a list of cached results for various architectures.
935 Because certain "autoconf" test results cannot be determined when cross-compiling due to
936 the tests not able to run on a live system, the information in this directory is
937 passed to "autoconf" for the various architectures.
938 </para>
939 </section>
940
941 <section id='structure-meta-recipes-txt'>
942 <title><filename>meta/recipes.txt</filename></title>
943
944 <para>
945 This file is a description of the contents of <filename>recipes-*</filename>.
946 </para>
947 </section>
948</section>
949
950</chapter>
951<!--
952vim: expandtab tw=80 ts=4
953-->
diff --git a/documentation/ref-manual/ref-style.css b/documentation/ref-manual/ref-style.css
new file mode 100644
index 0000000000..e896a39d33
--- /dev/null
+++ b/documentation/ref-manual/ref-style.css
@@ -0,0 +1,979 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("figures/poky-title.png");
122 background-position: left top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 0px;
126 text-align: right;
127 width: 740px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/poky-title.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
979
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
new file mode 100644
index 0000000000..f3211f84ed
--- /dev/null
+++ b/documentation/ref-manual/ref-variables.xml
@@ -0,0 +1,5888 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<!-- Dummy chapter -->
6<chapter id='ref-variables-glos'>
7
8<title>Variables Glossary</title>
9
10<para>
11 This chapter lists common variables used in the OpenEmbedded build system and gives an overview
12 of their function and contents.
13</para>
14
15<glossary id='ref-variables-glossary'>
16
17
18 <para>
19 <link linkend='var-ALLOW_EMPTY'>A</link>
20 <link linkend='var-B'>B</link>
21 <link linkend='var-CFLAGS'>C</link>
22 <link linkend='var-D'>D</link>
23 <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link>
24 <link linkend='var-FILES'>F</link>
25<!-- <link linkend='var-glossary-g'>G</link> -->
26 <link linkend='var-HOMEPAGE'>H</link>
27 <link linkend='var-IMAGE_BASENAME'>I</link>
28<!-- <link linkend='var-glossary-j'>J</link> -->
29 <link linkend='var-KARCH'>K</link>
30 <link linkend='var-LAYERDEPENDS'>L</link>
31 <link linkend='var-MACHINE'>M</link>
32<!-- <link linkend='var-glossary-n'>N</link> -->
33 <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link>
34 <link linkend='var-P'>P</link>
35<!-- <link linkend='var-glossary-q'>Q</link> -->
36 <link linkend='var-RCONFLICTS'>R</link>
37 <link linkend='var-S'>S</link>
38 <link linkend='var-T'>T</link>
39 <link linkend='var-UBOOT_ENTRYPOINT'>U</link>
40<!-- <link linkend='var-glossary-v'>V</link> -->
41 <link linkend='var-WARN_QA'>W</link>
42<!-- <link linkend='var-glossary-x'>X</link> -->
43<!-- <link linkend='var-glossary-y'>Y</link> -->
44<!-- <link linkend='var-glossary-z'>Z</link>-->
45 </para>
46
47 <glossdiv id='var-glossary-a'><title>A</title>
48
49 <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm>
50 <glossdef>
51 <para>
52 Specifies if an output package should still be produced if it is empty.
53 By default, BitBake does not produce empty packages.
54 This default behavior can cause issues when there is an
55 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or
56 some other runtime hard-requirement on the existence of the package.
57 </para>
58
59 <para>
60 Like all package-controlling variables, you must always use them in
61 conjunction with a package name override.
62 Here is an example:
63 <literallayout class='monospaced'>
64 ALLOW_EMPTY_${PN} = "1"
65 </literallayout>
66 </para>
67 </glossdef>
68 </glossentry>
69
70 <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm>
71 <glossdef>
72 <para>
73 Lists commands in a package that need an alternative
74 binary naming scheme.
75 Sometimes the same command is provided in multiple packages.
76 When this occurs, the OpenEmbedded build system needs to
77 use the alternatives system to create a different binary
78 naming scheme so the commands can co-exist.
79 </para>
80
81 <para>
82 To use the variable, list out the package's commands
83 that also exist as part of another package.
84 For example, if the <filename>busybox</filename> package
85 has four commands that also exist as part of another
86 package, you identify them as follows:
87 <literallayout class='monospaced'>
88 ALTERNATIVE_busybox = "sh sed test bracket"
89 </literallayout>
90 For more information on the alternatives system, see the
91 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
92 section.
93 </para>
94 </glossdef>
95 </glossentry>
96
97 <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm>
98 <glossdef>
99 <para>
100 Used by the alternatives system to map duplicated commands
101 to actual locations.
102 For example, if the <filename>bracket</filename> command
103 provided by the <filename>busybox</filename> package is
104 duplicated through another package, you must use the
105 <filename>ALTERNATIVE_LINK_NAME</filename> variable to
106 specify the actual location:
107 <literallayout class='monospaced'>
108 ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/["
109 </literallayout>
110 In this example, the binary for the
111 <filename>bracket</filename> command (i.e.
112 <filename>[</filename>) from the
113 <filename>busybox</filename> package resides in
114 <filename>/usr/bin/</filename>.
115 <note>
116 If <filename>ALTERNATIVE_LINK_NAME</filename> is not
117 defined, it defaults to
118 <filename>${bindir}/&lt;name&gt;</filename>.
119 </note>
120 </para>
121
122 <para>
123 For more information on the alternatives system, see the
124 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
125 section.
126 </para>
127 </glossdef>
128 </glossentry>
129
130 <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm>
131 <glossdef>
132 <para>
133 Used by the alternatives system to create default
134 priorities for duplicated commands.
135 You can use the variable to create a single default
136 regardless of the command name or package, a default for
137 specific duplicated commands regardless of the package, or
138 a default for specific commands tied to particular packages.
139 Here are the available syntax forms:
140 <literallayout class='monospaced'>
141 ALTERNATIVE_PRIORITY = "&lt;priority&gt;"
142 ALTERNATIVE_PRIORITY[&lt;name&gt;] = "&lt;priority&gt;"
143 ALTERNATIVE_PRIORITY_&lt;pkg&gt;[&lt;name&gt;] = "&lt;priority&gt;"
144 </literallayout>
145 </para>
146
147 <para>
148 For more information on the alternatives system, see the
149 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
150 section.
151 </para>
152 </glossdef>
153 </glossentry>
154
155 <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm>
156 <glossdef>
157 <para>
158 Used by the alternatives system to create default link
159 locations for duplicated commands.
160 You can use the variable to create a single default
161 location for all duplicated commands regardless of the
162 command name or package, a default for
163 specific duplicated commands regardless of the package, or
164 a default for specific commands tied to particular packages.
165 Here are the available syntax forms:
166 <literallayout class='monospaced'>
167 ALTERNATIVE_TARGET = "&lt;target&gt;"
168 ALTERNATIVE_TARGET[&lt;name&gt;] = "&lt;target&gt;"
169 ALTERNATIVE_TARGET_&lt;pkg&gt;[&lt;name&gt;] = "&lt;target&gt;"
170 </literallayout>
171 <note>
172 <para>
173 If <filename>ALTERNATIVE_TARGET</filename> is not
174 defined, it inherits the value from the
175 <link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link>
176 variable.
177 </para>
178
179 <para>
180 If <filename>ALTERNATIVE_LINK_NAME</filename> and
181 <filename>ALTERNATIVE_TARGET</filename> are the
182 same, the target for
183 <filename>ALTERNATIVE_TARGET</filename>
184 has "<filename>.{BPN}</filename>" appended to it.
185 </para>
186
187 <para>
188 Finally, if the file referenced has not been
189 renamed, the alternatives system will rename it to
190 avoid the need to rename alternative files in the
191 <filename>do_install</filename> task while
192 retaining support for the command if necessary.
193 </para>
194 </note>
195 </para>
196
197 <para>
198 For more information on the alternatives system, see the
199 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
200 section.
201 </para>
202 </glossdef>
203 </glossentry>
204
205 <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
206 <glossdef>
207 <para>The email address used to contact the original author
208 or authors in order to send patches and forward bugs.</para>
209 </glossdef>
210 </glossentry>
211
212 <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
213 <glossdef>
214 <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
215 is set to the value of this variable, it specifies to use the latest
216 source revision in the repository.
217 Here is an example:
218 <literallayout class='monospaced'>
219 SRCREV = "${AUTOREV}"
220 </literallayout>
221 </para>
222 </glossdef>
223 </glossentry>
224
225 </glossdiv>
226
227 <glossdiv id='var-glossary-b'><title>B</title>
228
229 <glossentry id='var-B'><glossterm>B</glossterm>
230 <glossdef>
231 <para>
232 The directory within the
233 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
234 in which the OpenEmbedded build system places generated
235 objects during a recipe's build process.
236 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
237 directory:
238 <literallayout class='monospaced'>
239 B = "${WORKDIR}/${BPN}/{PV}/"
240 </literallayout>
241 You can separate the (<filename>S</filename>) directory
242 and the directory pointed to by the <filename>B</filename>
243 variable.
244 Most Autotools-based recipes support separating these
245 directories.
246 The build system defaults to using separate directories for
247 <filename>gcc</filename> and some kernel recipes.
248 </para>
249 </glossdef>
250 </glossentry>
251
252 <glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm>
253 <glossdef>
254 <para>
255 Lists "recommended-only" packages to not install.
256 Recommended-only packages are packages installed only
257 through the
258 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
259 variable.
260 You can prevent any of these "recommended" packages from
261 being installed by listing them with the
262 <filename>BAD_RECOMMENDATIONS</filename> variable:
263 <literallayout class='monospaced'>
264 BAD_RECOMMENDATIONS = "&lt;package_name&gt; &lt;package_name&gt; &lt;package_name&gt; ..."
265 </literallayout>
266 You can set this variable globally in your
267 <filename>local.conf</filename> file or you can attach it to
268 a specific image recipe by using the recipe name override:
269 <literallayout class='monospaced'>
270 BAD_RECOMMENDATIONS_pn-&lt;target_image&gt; = "&lt;package_name&gt;"
271 </literallayout>
272 </para>
273
274 <para>
275 It is important to realize that if you choose to not install
276 packages using this variable and some other packages are
277 dependent on them (i.e. listed in a recipe's
278 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
279 variable), the OpenEmbedded build system ignores your
280 request and will install the packages to avoid dependency
281 errors.
282 </para>
283
284 <para>
285 Support for this variable exists only when using the
286 IPK and RPM packaging backend.
287 Support does not exist for DEB.
288 </para>
289
290 <para>
291 See the
292 <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>
293 and the
294 <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
295 variables for related information.
296 </para>
297 </glossdef>
298 </glossentry>
299
300 <glossentry id='var-BB_DANGLINGAPPENDS_WARNONLY'><glossterm>BB_DANGLINGAPPENDS_WARNONLY</glossterm>
301 <glossdef>
302 <para>
303 Defines how BitBake handles situations where an append
304 file (<filename>.bbappend</filename>) has no
305 corresponding recipe file (<filename>.bb</filename>).
306 This condition often occurs when layers get out of sync
307 (e.g. <filename>oe-core</filename> bumps a
308 recipe version and the old recipe no longer exists and the
309 other layer has not been updated to the new version
310 of the recipe yet).
311 </para>
312
313 <para>
314 The default fatal behavior is safest because it is
315 the sane reaction given something is out of sync.
316 It is important to realize when your changes are no longer
317 being applied.
318 </para>
319
320 <para>
321 You can change the default behavior by setting this
322 variable to "1" in the <filename>local.conf</filename>
323 file in the
324 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
325 as follows:
326 <literallayout class='monospaced'>
327 BB_DANGLINGAPPENDS_WARNONLY = "1"
328 </literallayout>
329 </para>
330 </glossdef>
331 </glossentry>
332
333 <glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm>
334 <glossdef>
335 <para>
336 Monitors disk space and available inodes during the build
337 and allows you to control the build based on these
338 parameters.
339 </para>
340
341 <para>
342 Disk space monitoring is disabled by default.
343 To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename>
344 variable to your <filename>conf/local.conf</filename> file found in the
345 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
346 Use the following form:
347 <literallayout class='monospaced'>
348 BB_DISKMON_DIRS = "&lt;action&gt;,&lt;dir&gt;,&lt;threshold&gt; [...]"
349
350 where:
351
352 &lt;action&gt; is:
353 ABORT: Immediately abort the build when
354 a threshold is broken.
355 STOPTASKS: Stop the build after the currently
356 executing tasks have finished when
357 a threshold is broken.
358 WARN: Issue a warning but continue the
359 build when a threshold is broken.
360 Subsequent warnings are issued as
361 defined by the
362 <link linkend='var-BB_DISKMON_WARNINTERVAL'>BB_DISKMON_WARNINTERVAL</link> variable,
363 which must be defined in the
364 conf/local.conf file.
365
366 &lt;dir&gt; is:
367 Any directory you choose. You can specify one or
368 more directories to monitor by separating the
369 groupings with a space. If two directories are
370 on the same device, only the first directory
371 is monitored.
372
373 &lt;threshold&gt; is:
374 Either the minimum available disk space,
375 the minimum number of free inodes, or
376 both. You must specify at least one. To
377 omit one or the other, simply omit the value.
378 Specify the threshold using G, M, K for Gbytes,
379 Mbytes, and Kbytes, respectively. If you do
380 not specify G, M, or K, Kbytes is assumed by
381 default. Do not use GB, MB, or KB.
382 </literallayout>
383 </para>
384
385 <para>
386 Here are some examples:
387 <literallayout class='monospaced'>
388 BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K"
389 BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G"
390 BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
391 </literallayout>
392 The first example works only if you also provide
393 the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable
394 in the <filename>conf/local.conf</filename>.
395 This example causes the build system to immediately
396 abort when either the disk space in <filename>${TMPDIR}</filename> drops
397 below 1 Gbyte or the available free inodes drops below
398 100 Kbytes.
399 Because two directories are provided with the variable, the
400 build system also issue a
401 warning when the disk space in the
402 <filename>${SSTATE_DIR}</filename> directory drops
403 below 1 Gbyte or the number of free inodes drops
404 below 100 Kbytes.
405 Subsequent warnings are issued during intervals as
406 defined by the <filename>BB_DISKMON_WARNINTERVAL</filename>
407 variable.
408 </para>
409
410 <para>
411 The second example stops the build after all currently
412 executing tasks complete when the minimum disk space
413 in the <filename>${<link linkend='var-TMPDIR'>TMPDIR</link>}</filename>
414 directory drops below 1 Gbyte.
415 No disk monitoring occurs for the free inodes in this case.
416 </para>
417
418 <para>
419 The final example immediately aborts the build when the
420 number of free inodes in the <filename>${TMPDIR}</filename> directory
421 drops below 100 Kbytes.
422 No disk space monitoring for the directory itself occurs
423 in this case.
424 </para>
425 </glossdef>
426 </glossentry>
427
428 <glossentry id='var-BB_DISKMON_WARNINTERVAL'><glossterm>BB_DISKMON_WARNINTERVAL</glossterm>
429 <glossdef>
430 <para>
431 Defines the disk space and free inode warning intervals.
432 To set these intervals, define the variable in your
433 <filename>conf/local.conf</filename> file in the
434 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
435 </para>
436
437 <para>
438 If you are going to use the
439 <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must
440 also use the
441 <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable
442 and define its action as "WARN".
443 During the build, subsequent warnings are issued each time
444 disk space or number of free inodes further reduces by
445 the respective interval.
446 </para>
447
448 <para>
449 If you do not provide a <filename>BB_DISKMON_WARNINTERVAL</filename>
450 variable and you do use <filename>BB_DISKMON_DIRS</filename> with
451 the "WARN" action, the disk monitoring interval defaults to
452 the following:
453 <literallayout class='monospaced'>
454 BB_DISKMON_WARNINTERVAL = "50M,5K"
455 </literallayout>
456 </para>
457
458 <para>
459 When specifying the variable in your configuration file,
460 use the following form:
461 <literallayout class='monospaced'>
462 BB_DISKMON_WARNINTERVAL = "&lt;disk_space_interval&gt;,&lt;disk_inode_interval&gt;"
463
464 where:
465
466 &lt;disk_space_interval&gt; is:
467 An interval of memory expressed in either
468 G, M, or K for Gbytes, Mbytes, or Kbytes,
469 respectively. You cannot use GB, MB, or KB.
470
471 &lt;disk_inode_interval&gt; is:
472 An interval of free inodes expressed in either
473 G, M, or K for Gbytes, Mbytes, or Kbytes,
474 respectively. You cannot use GB, MB, or KB.
475 </literallayout>
476 </para>
477
478 <para>
479 Here is an example:
480 <literallayout class='monospaced'>
481 BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K"
482 BB_DISKMON_WARNINTERVAL = "50M,5K"
483 </literallayout>
484 These variables cause the OpenEmbedded build system to
485 issue subsequent warnings each time the available
486 disk space further reduces by 50 Mbytes or the number
487 of free inodes further reduces by 5 Kbytes in the
488 <filename>${SSTATE_DIR}</filename> directory.
489 Subsequent warnings based on the interval occur each time
490 a respective interval is reached beyond the initial warning
491 (i.e. 1 Gbytes and 100 Kbytes).
492 </para>
493 </glossdef>
494 </glossentry>
495
496 <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm>
497 <glossdef>
498 <para>
499 Causes tarballs of the Git repositories to be placed in the
500 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
501 directory.
502 For performance reasons, creating and placing tarballs of
503 the Git repositories is not the default action by the
504 OpenEmbedded build system.
505 <literallayout class='monospaced'>
506 BB_Generate_MIRROR_TARBALLS = "1"
507 </literallayout>
508 Set this variable in your <filename>local.conf</filename>
509 file in the
510 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
511 </para>
512 </glossdef>
513 </glossentry>
514
515 <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm>
516 <glossdef>
517 <para>The maximum number of tasks BitBake should run in parallel at any one time.
518 If your host development system supports multiple cores a good rule of thumb
519 is to set this variable to twice the number of cores.</para>
520 </glossdef>
521 </glossentry>
522
523 <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm>
524 <glossdef>
525 <para>
526 Allows you to extend a recipe so that it builds variants of the software.
527 Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>,
528 which is a copy of Quilt built to run on the build system;
529 "crosses" such as <filename>gcc-cross</filename>,
530 which is a compiler built to run on the build machine but produces binaries
531 that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>;
532 "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>;
533 and "mulitlibs" in the form "<filename>multilib:&lt;multilib_name&gt;</filename>".
534 </para>
535
536 <para>
537 To build a different variant of the recipe with a minimal amount of code, it usually
538 is as simple as adding the following to your recipe:
539 <literallayout class='monospaced'>
540 BBCLASSEXTEND =+ "native nativesdk"
541 BBCLASSEXTEND =+ "multilib:&lt;multilib_name&gt;"
542 </literallayout>
543 </para>
544 </glossdef>
545 </glossentry>
546
547 <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm>
548 <glossdef>
549 <para>Lists the names of configured layers.
550 These names are used to find the other <filename>BBFILE_*</filename>
551 variables.
552 Typically, each layer will append its name to this variable in its
553 <filename>conf/layer.conf</filename> file.
554 </para>
555 </glossdef>
556 </glossentry>
557
558 <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm>
559 <glossdef>
560 <para>Variable that expands to match files from
561 <link linkend='var-BBFILES'><filename>BBFILES</filename></link>
562 in a particular layer.
563 This variable is used in the <filename>conf/layer.conf</filename> file and must
564 be suffixed with the name of the specific layer (e.g.
565 <filename>BBFILE_PATTERN_emenlow</filename>).</para>
566 </glossdef>
567 </glossentry>
568
569 <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm>
570 <glossdef>
571 <para>Assigns the priority for recipe files in each layer.</para>
572 <para>This variable is useful in situations where the same recipe appears in
573 more than one layer.
574 Setting this variable allows you to prioritize a
575 layer against other layers that contain the same recipe - effectively
576 letting you control the precedence for the multiple layers.
577 The precedence established through this variable stands regardless of a
578 recipe's version
579 (<link linkend='var-PV'><filename>PV</filename></link> variable).
580 For example, a layer that has a recipe with a higher <filename>PV</filename> value but for
581 which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a
582 lower precedence.</para>
583 <para>A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher
584 precedence.
585 For example, the value 6 has a higher precedence than the value 5.
586 If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer
587 dependencies (see the
588 <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for
589 more information.
590 The default priority, if unspecified
591 for a layer with no dependencies, is the lowest defined priority + 1
592 (or 1 if no priorities are defined).</para>
593 <tip>
594 You can use the command <filename>bitbake-layers show_layers</filename> to list
595 all configured layers along with their priorities.
596 </tip>
597 </glossdef>
598 </glossentry>
599
600 <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
601 <glossdef>
602 <para>List of recipe files used by BitBake to build software.</para>
603 </glossdef>
604 </glossentry>
605
606 <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm>
607 <glossdef>
608 <para>Variable that controls how BitBake displays logs on build failure.</para>
609 </glossdef>
610 </glossentry>
611
612 <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm>
613 <glossdef>
614 <para>Lists the layers to enable during the build.
615 This variable is defined in the <filename>bblayers.conf</filename> configuration
616 file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
617 Here is an example:
618 <literallayout class='monospaced'>
619 BBLAYERS = " \
620 /home/scottrif/poky/meta \
621 /home/scottrif/poky/meta-yocto \
622 /home/scottrif/poky/meta-yocto-bsp \
623 /home/scottrif/poky/meta-mykernel \
624 "
625
626 BBLAYERS_NON_REMOVABLE ?= " \
627 /home/scottrif/poky/meta \
628 /home/scottrif/poky/meta-yocto \
629 "
630 </literallayout>
631 This example enables four layers, one of which is a custom, user-defined layer
632 named <filename>meta-mykernel</filename>.
633 </para>
634 </glossdef>
635 </glossentry>
636
637 <glossentry id='var-BBLAYERS_NON_REMOVABLE'><glossterm>BBLAYERS_NON_REMOVABLE</glossterm>
638 <glossdef>
639Core layer for images cannot be removed
640 <para>Lists core layers that cannot be removed from the
641 <filename>bblayers.conf</filename> file.
642 In order for BitBake to build your image, your
643 <filename>bblayers.conf</filename> file must include the
644 <filename>meta</filename> and <filename>meta-yocto</filename>
645 core layers.
646 Here is an example that shows these two layers listed in
647 the <filename>BBLAYERS_NON_REMOVABLE</filename> statement:
648 <literallayout class='monospaced'>
649 BBLAYERS = " \
650 /home/scottrif/poky/meta \
651 /home/scottrif/poky/meta-yocto \
652 /home/scottrif/poky/meta-yocto-bsp \
653 /home/scottrif/poky/meta-mykernel \
654 "
655
656 BBLAYERS_NON_REMOVABLE ?= " \
657 /home/scottrif/poky/meta \
658 /home/scottrif/poky/meta-yocto \
659 "
660 </literallayout>
661 </para>
662 </glossdef>
663 </glossentry>
664
665 <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm>
666 <glossdef>
667 <para>
668 Prevents BitBake from processing recipes and recipe
669 append files.
670 Use the <filename>BBMASK</filename> variable from within the
671 <filename>conf/local.conf</filename> file found
672 in the
673 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
674 </para>
675
676 <para>
677 You can use the <filename>BBMASK</filename> variable
678 to "hide" these <filename>.bb</filename> and
679 <filename>.bbappend</filename> files.
680 BitBake ignores any recipe or recipe append files that
681 match the expression.
682 It is as if BitBake does not see them at all.
683 Consequently, matching files are not parsed or otherwise
684 used by BitBake.</para>
685 <para>
686 The value you provide is passed to Python's regular
687 expression compiler.
688 The expression is compared against the full paths to
689 the files.
690 For complete syntax information, see Python's
691 documentation at
692 <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
693 </para>
694
695 <para>
696 The following example uses a complete regular expression
697 to tell BitBake to ignore all recipe and recipe append
698 files in the <filename>/meta-ti/recipes-misc/</filename>
699 directory:
700 <literallayout class='monospaced'>
701 BBMASK = "/meta-ti/recipes-misc/"
702 </literallayout>
703 If you want to mask out multiple directories or recipes,
704 use the vertical bar to separate the regular expression
705 fragments.
706 This next example masks out multiple directories and
707 individual recipes:
708 <literallayout class='monospaced'>
709 BBMASK = "meta-ti/recipes-misc/|meta-ti/recipes-ti/packagegroup/"
710 BBMASK .= "|.*meta-oe/recipes-support/"
711 BBMASK .= "|.*openldap"
712 BBMASK .= "|.*opencv"
713 BBMASK .= "|.*lzma"
714 </literallayout>
715 Notice how the vertical bar is used to append the fragments.
716 <note>
717 When specifying a directory name, use the trailing
718 slash character to ensure you match just that directory
719 name.
720 </note>
721 </para>
722 </glossdef>
723 </glossentry>
724
725 <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
726 <glossdef>
727 <para>
728 Used by BitBake to locate
729 <filename>.bbclass</filename> and configuration files.
730 This variable is analogous to the
731 <filename>PATH</filename> variable.
732 <note>
733 If you run BitBake from a directory outside of the
734 <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>,
735 you must be sure to set
736 <filename>BBPATH</filename> to point to the
737 Build Directory.
738 Set the variable as you would any environment variable
739 and then run BitBake:
740 <literallayout class='monospaced'>
741 $ BBPATH = "&lt;build_directory&gt;"
742 $ export BBPATH
743 $ bitbake &lt;target&gt;
744 </literallayout>
745 </note>
746 </para>
747 </glossdef>
748 </glossentry>
749
750 <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm>
751 <glossdef>
752 <para>
753 Points to the server that runs memory-resident BitBake.
754 This variable is set by the
755 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
756 setup script and should not be hand-edited.
757 The variable is only used when you employ memory-resident
758 BitBake.
759 The setup script exports the value as follows:
760 <literallayout class='monospaced'>
761 export BBSERVER=localhost:$port
762 </literallayout>
763 For more information on how the
764 <filename>BBSERVER</filename> is used, see the
765 <filename>oe-init-build-env-memres</filename> script, which
766 is located in the
767 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
768 </para>
769 </glossdef>
770 </glossentry>
771
772 <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
773 <glossdef>
774 <para>
775 When inheriting <filename>binconfig.bbclass</filename>
776 from a recipe, this variable specifies a wildcard for
777 configuration scripts that need editing.
778 The scripts are edited to correct any paths that have been
779 set up during compilation so that they are correct for
780 use when installed into the sysroot and called by the
781 build processes of other recipes.
782 </para>
783
784 <para>
785 For more information on how this variable works, see
786 <filename>meta/classes/binconfig.bbclass</filename> in the
787 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
788 You can also find general information on the class in the
789 "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>"
790 section.
791 </para>
792 </glossdef>
793 </glossentry>
794
795 <glossentry id='var-BP'><glossterm>BP</glossterm>
796 <glossdef>
797 <para>The base recipe name and version but without any special
798 recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>,
799 and so forth).
800 <filename>BP</filename> is comprised of the following:
801 <literallayout class="monospaced">
802 ${BPN}-${PV}
803 </literallayout></para>
804 </glossdef>
805 </glossentry>
806
807 <glossentry id='var-BPN'><glossterm>BPN</glossterm>
808 <glossdef>
809 <para>The bare name of the recipe.
810 This variable is a version of the <link linkend='var-PN'><filename>PN</filename></link> variable
811 but removes common suffixes such as "-native" and "-cross" as well
812 as removes common prefixes such as multilib's "lib64-" and "lib32-".
813 The exact list of suffixes removed is specified by the
814 <link linkend='var-SPECIAL_PKGSUFFIX'><filename>SPECIAL_PKGSUFFIX</filename></link> variable.
815 The exact list of prefixes removed is specified by the
816 <link linkend='var-MLPREFIX'><filename>MLPREFIX</filename></link> variable.
817 Prefixes are removed for <filename>multilib</filename>
818 and <filename>nativesdk</filename> cases.</para>
819 </glossdef>
820 </glossentry>
821
822 <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm>
823 <glossdef>
824 <para>
825 Points to the location of the
826 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
827 You can define this directory indirectly through the
828 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
829 and
830 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>
831 scripts by passing in a Build Directory path when you run
832 the scripts.
833 If you run the scripts and do not provide a Build Directory
834 path, the <filename>BUILDDIR</filename> defaults to
835 <filename>build</filename> in the current directory.
836 </para>
837 </glossdef>
838 </glossentry>
839
840 <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm>
841 <glossdef>
842 <para>
843 For the BusyBox recipe, specifies whether to split the
844 output executable file into two parts: one for features
845 that require <filename>setuid root</filename>, and one for
846 the remaining features (i.e. those that do not require
847 <filename>setuid root</filename>).
848 </para>
849
850 <para>
851 The <filename>BUSYBOX_SPLIT_SUID</filename> variable
852 defaults to "1", which results in a single output
853 executable file.
854 Set the variable to "0" to split the output file.
855 </para>
856 </glossdef>
857 </glossentry>
858
859 </glossdiv>
860
861 <glossdiv id='var-glossary-c'><title>C</title>
862
863 <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm>
864 <glossdef>
865 <para>
866 Flags passed to the C compiler for the target system.
867 This variable evaluates to the same as
868 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>.
869 </para>
870 </glossdef>
871 </glossentry>
872
873 <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm>
874 <glossdef>
875 <para>A set of features common between
876 <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>
877 and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>.
878 See the glossary descriptions for these variables for more information.</para>
879 </glossdef>
880 </glossentry>
881
882 <glossentry id='var-COMMON_LICENSE_DIR'><glossterm>COMMON_LICENSE_DIR</glossterm>
883 <glossdef>
884 <para>
885 Points to <filename>meta/files/common-licenses</filename>
886 in the
887 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
888 which is where generic license files reside.
889 </para>
890 </glossdef>
891 </glossentry>
892
893 <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm>
894 <glossdef>
895 <para>A regular expression that resolves to one or more hosts
896 (when the recipe is native) or one or more targets (when
897 the recipe is non-native) with which a recipe is compatible.
898 The regular expression is matched against
899 <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>.
900 You can use the variable to stop recipes from being built
901 for classes of systems with which the recipes are not
902 compatible.
903 Stopping these builds is particularly useful with kernels.
904 The variable also helps to increase parsing speed
905 since the build system skips parsing recipes not
906 compatible with the current system.</para>
907 </glossdef>
908 </glossentry>
909
910 <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm>
911 <glossdef>
912 <para>A regular expression that resolves to one or more
913 target machines with which a recipe is compatible.
914 The regular expression is matched against
915 <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>.
916 You can use the variable to stop recipes from being built
917 for machines with which the recipes are not compatible.
918 Stopping these builds is particularly useful with kernels.
919 The variable also helps to increase parsing speed
920 since the build system skips parsing recipes not
921 compatible with the current machine.</para>
922 </glossdef>
923 </glossentry>
924
925 <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm>
926 <glossdef>
927 <para>
928 Defines wildcards to match when installing a list of
929 complementary packages for all the packages explicitly
930 (or implicitly) installed in an image.
931 The resulting list of complementary packages is associated
932 with an item that can be added to
933 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
934 An example usage of this is the "dev-pkgs" item that when
935 added to <filename>IMAGE_FEATURES</filename> will
936 install -dev packages (containing headers and other
937 development files) for every package in the image.
938 </para>
939
940 <para>
941 To add a new feature item pointing to a wildcard, use a
942 variable flag to specify the feature item name and
943 use the value to specify the wildcard.
944 Here is an example:
945 <literallayout class='monospaced'>
946 COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
947 </literallayout>
948 </para>
949 </glossdef>
950 </glossentry>
951
952 <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm>
953 <glossdef>
954 <para>
955 Identifies editable or configurable files that are part of a package.
956 If the Package Management System (PMS) is being used to update
957 packages on the target system, it is possible that
958 configuration files you have changed after the original installation
959 and that you now want to remain unchanged are overwritten.
960 In other words, editable files might exist in the package that you do not
961 want reset as part of the package update process.
962 You can use the <filename>CONFFILES</filename> variable to list the files in the
963 package that you wish to prevent the PMS from overwriting during this update process.
964 </para>
965
966 <para>
967 To use the <filename>CONFFILES</filename> variable, provide a package name
968 override that identifies the resulting package.
969 Then, provide a space-separated list of files.
970 Here is an example:
971 <literallayout class='monospaced'>
972 CONFFILES_${PN} += "${sysconfdir}/file1 \
973 ${sysconfdir}/file2 ${sysconfdir}/file3"
974 </literallayout>
975 </para>
976
977 <para>
978 A relationship exists between the <filename>CONFFILES</filename> and
979 <filename><link linkend='var-FILES'>FILES</link></filename> variables.
980 The files listed within <filename>CONFFILES</filename> must be a subset of
981 the files listed within <filename>FILES</filename>.
982 Because the configuration files you provide with <filename>CONFFILES</filename>
983 are simply being identified so that the PMS will not overwrite them,
984 it makes sense that
985 the files must already be included as part of the package through the
986 <filename>FILES</filename> variable.
987 </para>
988
989 <note>
990 When specifying paths as part of the <filename>CONFFILES</filename> variable,
991 it is good practice to use appropriate path variables.
992 For example, <filename>${sysconfdir}</filename> rather than
993 <filename>/etc</filename> or <filename>${bindir}</filename> rather
994 than <filename>/usr/bin</filename>.
995 You can find a list of these variables at the top of the
996 <filename>/meta/conf/bitbake.conf</filename> file in the
997 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
998 </note>
999 </glossdef>
1000 </glossentry>
1001
1002 <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm>
1003 <glossdef>
1004 <para>
1005 A list of files that contains <filename>autoconf</filename> test results relevant
1006 to the current build.
1007 This variable is used by the Autotools utilities when running
1008 <filename>configure</filename>.
1009 </para>
1010 </glossdef>
1011 </glossentry>
1012
1013 <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm>
1014 <glossdef>
1015 <para>
1016 Specifies the list of packages to be added to the image.
1017 You should only set this variable in the
1018 <filename>local.conf</filename> configuration file found
1019 in the
1020 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
1021 </para>
1022
1023 <para>
1024 This variable replaces <filename>POKY_EXTRA_INSTALL</filename>, which is no longer supported.
1025 </para>
1026 </glossdef>
1027 </glossentry>
1028
1029 <glossentry id='var-COREBASE'><glossterm>COREBASE</glossterm>
1030 <glossdef>
1031 <para>
1032 Specifies the parent directory of the OpenEmbedded
1033 Core Metadata layer (i.e. <filename>/meta</filename>).
1034 </para>
1035
1036 <para>
1037 It is an important distinction that
1038 <filename>COREBASE</filename> points to the parent of this
1039 layer and not the layer itself.
1040 Consider an example where you have cloned the Poky Git
1041 repository and retained the <filename>poky</filename>
1042 name for your local copy of the repository.
1043 In this case, <filename>COREBASE</filename> points to
1044 the <filename>poky</filename> folder because it is the
1045 parent directory of the <filename>poky/meta</filename>
1046 layer.
1047 </para>
1048 </glossdef>
1049 </glossentry>
1050
1051 </glossdiv>
1052
1053 <glossdiv id='var-glossary-d'><title>D</title>
1054
1055 <glossentry id='var-D'><glossterm>D</glossterm>
1056 <glossdef>
1057 <para>The destination directory.</para>
1058 </glossdef>
1059 </glossentry>
1060
1061 <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm>
1062 <glossdef>
1063 <para>
1064 The date and time on which the current build started.
1065 The format is suitable for timestamps.
1066 </para>
1067 </glossdef>
1068 </glossentry>
1069
1070 <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
1071 <glossdef>
1072 <para>
1073 Specifies to build packages with debugging information.
1074 This influences the value of the
1075 <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename>
1076 variable.
1077 </para>
1078 </glossdef>
1079 </glossentry>
1080
1081 <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm>
1082 <glossdef>
1083 <para>
1084 The options to pass in
1085 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
1086 and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling
1087 a system for debugging.
1088 This variable defaults to "-O -fno-omit-frame-pointer -g".
1089 </para>
1090 </glossdef>
1091 </glossentry>
1092
1093 <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm>
1094 <glossdef>
1095 <para>
1096 Specifies a weak bias for recipe selection priority.
1097 </para>
1098 <para>
1099 The most common usage of this is variable is to set
1100 it to "-1" within a recipe for a development version of a
1101 piece of software.
1102 Using the variable in this way causes the stable version
1103 of the recipe to build by default in the absence of
1104 <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename>
1105 being used to build the development version.
1106 </para>
1107 <note>
1108 The bias provided by <filename>DEFAULT_PREFERENCE</filename>
1109 is weak and is overridden by
1110 <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename>
1111 if the that variable is different between two layers
1112 that contain different versions of the same recipe.
1113 </note>
1114 </glossdef>
1115 </glossentry>
1116
1117 <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm>
1118 <glossdef>
1119 <para>
1120 Lists a recipe's build-time dependencies
1121 (i.e. other recipe files).
1122 The system ensures that all the dependencies listed
1123 have been built and have their contents in the appropriate
1124 sysroots before the recipe's configure task is executed.
1125 </para>
1126
1127 <para>
1128 Consider this simple example for two recipes named "a" and
1129 "b" that produce similarly named packages.
1130 In this example, the <filename>DEPENDS</filename>
1131 statement appears in the "a" recipe:
1132 <literallayout class='monospaced'>
1133 DEPENDS = "b"
1134 </literallayout>
1135 Here, the dependency is such that the
1136 <filename>do_configure</filename> task for recipe "a"
1137 depends on the <filename>do_populate_sysroot</filename>
1138 task of recipe "b".
1139 This means anything that recipe "b" puts into sysroot
1140 is available when recipe "a" is configuring itself.
1141 </para>
1142
1143 <para>
1144 For information on runtime dependencies, see the
1145 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
1146 variable.
1147 </para>
1148 </glossdef>
1149 </glossentry>
1150
1151 <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm>
1152 <glossdef>
1153 <para>
1154 Points to the general area that the OpenEmbedded build
1155 system uses to place images, packages, SDKs and other output
1156 files that are ready to be used outside of the build system.
1157 By default, this directory resides within the
1158 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1159 as <filename>tmp/deploy</filename>.
1160 </para>
1161
1162 <para>
1163 For more information on the structure of the Build
1164 Directory, see
1165 "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>"
1166 section.
1167 For more detail on the contents of the
1168 <filename>deploy</filename> directory, see the
1169 "<link linkend='images-dev-environment'>Images</link>" and
1170 "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
1171 sections.
1172 </para>
1173 </glossdef>
1174 </glossentry>
1175
1176 <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm>
1177 <glossdef>
1178 <para>
1179 Points to the area that the OpenEmbedded build system uses
1180 to place images and other associated output files that are
1181 ready to be deployed onto the target machine.
1182 The directory is machine-specific as it contains the
1183 <filename>${MACHINE}</filename> name.
1184 By default, this directory resides within the
1185 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1186 as <filename>tmp/deploy/images/${MACHINE}/</filename>.
1187 </para>
1188
1189 <para>
1190 For more information on the structure of the Build
1191 Directory, see
1192 "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>"
1193 section.
1194 For more detail on the contents of the
1195 <filename>deploy</filename> directory, see the
1196 "<link linkend='images-dev-environment'>Images</link>" and
1197 "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
1198 sections.
1199 </para>
1200 </glossdef>
1201 </glossentry>
1202
1203 <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm>
1204 <glossdef>
1205 <para>The package description used by package managers.
1206 If not set, <filename>DESCRIPTION</filename> takes
1207 the value of the
1208 <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>
1209 variable.
1210 </para>
1211 </glossdef>
1212 </glossentry>
1213
1214 <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
1215 <glossdef>
1216 <para>
1217 The short name of the distribution.
1218 This variable corresponds to a file with the
1219 extension <filename>.conf</filename>
1220 located in a <filename>conf/distro</filename> directory
1221 within the
1222 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
1223 that contains the distribution configuration.
1224 The value must not contain spaces, and is typically all lower-case.
1225 </para>
1226 <para>
1227 If the variable is blank, a set of default configuration
1228 will be used, which is specified
1229 within <filename>meta/conf/distro/defaultsetup.conf</filename>.
1230 </para>
1231 </glossdef>
1232 </glossentry>
1233
1234 <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm>
1235 <glossdef>
1236 <para>
1237 Specifies a list of distro-specific packages to add to all images.
1238 This variable takes affect through
1239 <filename>packagegroup-base</filename> so the
1240 variable only really applies to the more full-featured
1241 images that include <filename>packagegroup-base</filename>.
1242 You can use this variable to keep distro policy out of
1243 generic images.
1244 As with all other distro variables, you set this variable
1245 in the distro <filename>.conf</filename> file.
1246 </para>
1247 </glossdef>
1248 </glossentry>
1249
1250 <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm>
1251 <glossdef>
1252 <para>
1253 Specifies a list of distro-specific packages to add to all images
1254 if the packages exist.
1255 The packages might not exist or be empty (e.g. kernel modules).
1256 The list of packages are automatically installed but you can
1257 remove them.
1258 </para>
1259 </glossdef>
1260 </glossentry>
1261
1262 <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm>
1263 <glossdef>
1264 <para>The features enabled for the distribution.
1265 For a list of supported features that ship with the
1266 Yocto Project, see the
1267 "<link linkend='ref-features-distro'>Distro</link>"
1268 section.
1269 </para>
1270 </glossdef>
1271 </glossentry>
1272
1273 <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm>
1274 <glossdef>
1275 <para>Features to be added to
1276 <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>
1277 if not also present in
1278 <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>.
1279 </para>
1280
1281 <para>
1282 This variable is set in the <filename>meta/conf/bitbake.conf</filename> file.
1283 It is not intended to be user-configurable.
1284 It is best to just reference the variable to see which distro features are
1285 being backfilled for all distro configurations.
1286 See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for
1287 more information.
1288 </para>
1289 </glossdef>
1290 </glossentry>
1291
1292 <glossentry id='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><glossterm>DISTRO_FEATURES_BACKFILL_CONSIDERED</glossterm>
1293 <glossdef>
1294 <para>Features from
1295 <filename><link linkend='var-DISTRO_FEATURES_BACKFILL'>DISTRO_FEATURES_BACKFILL</link></filename>
1296 that should not be backfilled (i.e. added to
1297 <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>)
1298 during the build.
1299 See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for
1300 more information.
1301 </para>
1302 </glossdef>
1303 </glossentry>
1304
1305 <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm>
1306 <glossdef>
1307 <para>The long name of the distribution.</para>
1308 </glossdef>
1309 </glossentry>
1310
1311 <glossentry id='var-DISTRO_PN_ALIAS'><glossterm>DISTRO_PN_ALIAS</glossterm>
1312 <glossdef>
1313 <para>Alias names used for the recipe in various Linux distributions.</para>
1314 <para>See the
1315 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-DISTRO_PN_ALIAS'>Handling
1316 a Package Name Alias</ulink>" section in the Yocto Project Development
1317 Manual for more information.</para>
1318 </glossdef>
1319 </glossentry>
1320
1321 <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm>
1322 <glossdef>
1323 <para>the version of the distribution.</para>
1324 </glossdef>
1325 </glossentry>
1326
1327 <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm>
1328 <glossdef>
1329 <para>
1330 This variable lists overrides specific to the current
1331 distribution.
1332 By default, the variable list includes the value of the
1333 <filename><link linkend='var-DISTRO'>DISTRO</link></filename>
1334 variable.
1335 You can extend the variable to apply any variable overrides
1336 you want as part of the distribution and are not
1337 already in <filename>OVERRIDES</filename> through
1338 some other means.
1339 </para>
1340 </glossdef>
1341 </glossentry>
1342
1343 <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm>
1344 <glossdef>
1345 <para>
1346 The central download directory used by the build process to
1347 store downloads.
1348 By default, <filename>DL_DIR</filename> gets files
1349 suitable for mirroring for everything except Git
1350 repositories.
1351 If you want tarballs of Git repositories, use the
1352 <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link>
1353 variable.
1354 </para>
1355
1356 <para>
1357 You can set this directory by defining the
1358 <filename>DL_DIR</filename> variable in the
1359 <filename>/conf/local.conf</filename> file.
1360 This directory is self-maintaining and you should not have
1361 to touch it.
1362 By default, the directory is <filename>downloads</filename>
1363 in the
1364 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
1365 <literallayout class='monospaced'>
1366 #DL_DIR ?= "${TOPDIR}/downloads"
1367 </literallayout>
1368 To specify a different download directory, simply remove
1369 the comment from the line and provide your directory.
1370 </para>
1371
1372 <para>
1373 During a first build, the system downloads many different
1374 source code tarballs from various upstream projects.
1375 Downloading can take a while, particularly if your network
1376 connection is slow.
1377 Tarballs are all stored in the directory defined by
1378 <filename>DL_DIR</filename> and the build system looks there
1379 first to find source tarballs.
1380 <note>
1381 When wiping and rebuilding, you can preserve this
1382 directory to speed up this part of subsequent
1383 builds.
1384 </note>
1385 </para>
1386
1387 <para>
1388 You can safely share this directory between multiple builds
1389 on the same development machine.
1390 For additional information on how the build process gets
1391 source files when working behind a firewall or proxy server,
1392 see this specific question in the
1393 "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>"
1394 chapter.
1395 </para>
1396 </glossdef>
1397
1398 </glossentry>
1399 </glossdiv>
1400
1401 <glossdiv id='var-glossary-e'><title>E</title>
1402
1403 <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
1404 <glossdef>
1405 <para></para>
1406 <para>Variable that controls which locales for
1407 <filename>eglibc</filename> are generated during the
1408 build (useful if the target device has 64Mbytes
1409 of RAM or less).</para>
1410 </glossdef>
1411 </glossentry>
1412
1413 <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm>
1414 <glossdef>
1415 <para>
1416 Specifies the quality assurance checks whose failures are
1417 reported as errors by the OpenEmbedded build system.
1418 You set this variable in your distribution configuration
1419 file.
1420 For a list of the checks you can control with this variable,
1421 see the
1422 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
1423 section.
1424 </para>
1425 </glossdef>
1426 </glossentry>
1427
1428 <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
1429 <glossdef>
1430 <para>
1431 Directs BitBake to exclude a recipe from world builds (i.e.
1432 <filename>bitbake world</filename>).
1433 During world builds, BitBake locates, parses and builds all
1434 recipes found in every layer exposed in the
1435 <filename>bblayers.conf</filename> configuration file.
1436 </para>
1437
1438 <para>
1439 To exclude a recipe from a world build using this variable,
1440 set the variable to "1" in the recipe.
1441 </para>
1442
1443 <note>
1444 Recipes added to <filename>EXCLUDE_FROM_WORLD</filename>
1445 may still be built during a world build in order to satisfy
1446 dependencies of other recipes.
1447 Adding a recipe to <filename>EXCLUDE_FROM_WORLD</filename>
1448 only ensures that the recipe is not explicitly added
1449 to the list of build targets in a world build.
1450 </note>
1451 </glossdef>
1452 </glossentry>
1453
1454 <glossentry id='var-EXTENDPE'><glossterm>EXTENDPE</glossterm>
1455 <glossdef>
1456 <para>
1457 Used with file and pathnames to create a prefix for a recipe's
1458 version based on the recipe's
1459 <link linkend='var-PE'><filename>PE</filename></link> value.
1460 If <filename>PE</filename> is set and greater than zero for a recipe,
1461 <filename>EXTENDPE</filename> becomes that value (e.g if
1462 <filename>PE</filename> is equal to "1" then <filename>EXTENDPE</filename>
1463 becomes "1_").
1464 If a recipe's <filename>PE</filename> is not set (the default) or is equal to
1465 zero, <filename>EXTENDPE</filename> becomes "".</para>
1466 <para>See the <link linkend='var-STAMP'><filename>STAMP</filename></link>
1467 variable for an example.
1468 </para>
1469 </glossdef>
1470 </glossentry>
1471
1472 <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm>
1473 <glossdef>
1474 <para>
1475 The full package version specification as it appears on the
1476 final packages produced by a recipe.
1477 The variable's value is normally used to fix a runtime
1478 dependency to the exact same version of another package
1479 in the same recipe:
1480 <literallayout class='monospaced'>
1481 RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})"
1482 </literallayout>
1483 </para>
1484
1485 <para>
1486 The dependency relationships are intended to force the
1487 package manager to upgrade these types of packages in
1488 lock-step.
1489 </para>
1490 </glossdef>
1491 </glossentry>
1492
1493 <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
1494 <glossdef>
1495 <para>
1496 If <filename>externalsrc.bbclass</filename> is inherited,
1497 this variable points to the source tree, which is
1498 outside of the OpenEmbedded build system.
1499 When set, this variable sets the
1500 <link linkend='var-S'><filename>S</filename></link>
1501 variable, which is what the OpenEmbedded build system uses
1502 to locate unpacked recipe source code.
1503 </para>
1504
1505 <para>
1506 For more information on
1507 <filename>externalsrc.bbclass</filename>, see the
1508 "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>"
1509 section.
1510 You can also find information on how to use this variable
1511 in the
1512 "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
1513 section in the Yocto Project Development Manual.
1514 </para>
1515 </glossdef>
1516 </glossentry>
1517
1518 <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
1519 <glossdef>
1520 <para>
1521 If <filename>externalsrc.bbclass</filename> is inherited,
1522 this variable points to the directory in which the recipe's
1523 source code is built,
1524 which is outside of the OpenEmbedded build system.
1525 When set, this variable sets the
1526 <link linkend='var-B'><filename>B</filename></link>
1527 variable, which is what the OpenEmbedded build system uses
1528 to locate the Build Directory.
1529 </para>
1530
1531 <para>
1532 For more information on
1533 <filename>externalsrc.bbclass</filename>, see the
1534 "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>"
1535 section.
1536 You can also find information on how to use this variable
1537 in the
1538 "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>"
1539 section in the Yocto Project Development Manual.
1540 </para>
1541 </glossdef>
1542 </glossentry>
1543
1544 <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm>
1545 <glossdef>
1546 <para>
1547 The list of additional features to include in an image.
1548 Typically, you configure this variable in your
1549 <filename>local.conf</filename> file, which is found in the
1550 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
1551 Although you can use this variable from within a recipe,
1552 best practices dictate that you do not.
1553 <note>
1554 To enable primary features from within the image
1555 recipe, use the
1556 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
1557 variable.
1558 </note>
1559 </para>
1560
1561 <para>
1562 Here are some examples of features you can add:
1563 <literallayout class='monospaced'>
1564"dbg-pkgs" - Adds -dbg packages for all installed packages
1565 including symbol information for debugging and
1566 profiling.
1567
1568"debug-tweaks" - Makes an image suitable for development.
1569 For example, ssh root access has a blank
1570 password. You should remove this feature
1571 before you produce a production image.
1572
1573"dev-pkgs" - Adds -dev packages for all installed packages.
1574 This is useful if you want to develop against
1575 the libraries in the image.
1576
1577"read-only-rootfs" - Creates an image whose root
1578 filesystem is read-only. See the
1579 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
1580 section in the Yocto Project
1581 Development Manual for more
1582 information
1583
1584"tools-debug" - Adds debugging tools such as gdb and
1585 strace.
1586
1587"tools-profile" - Adds profiling tools such as oprofile,
1588 exmap, lttng and valgrind (x86 only).
1589
1590"tools-sdk" - Adds development tools such as gcc, make,
1591 pkgconfig and so forth.
1592
1593"tools-testapps" - Adds useful testing tools such as
1594 ts_print, aplay, arecord and so
1595 forth.
1596
1597 </literallayout>
1598 </para>
1599
1600 <para>
1601 For a complete list of image features that ships with the
1602 Yocto Project, see the
1603 "<link linkend="ref-features-image">Images</link>"
1604 section.
1605 </para>
1606
1607 <para>
1608 For an example that shows how to customize your image by
1609 using this variable, see the
1610 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>"
1611 section in the Yocto Project Development Manual.
1612 </para>
1613 </glossdef>
1614 </glossentry>
1615
1616 <glossentry id='var-EXTRA_IMAGEDEPENDS'><glossterm>EXTRA_IMAGEDEPENDS</glossterm>
1617 <glossdef>
1618 <para>A list of recipes to build that do not provide packages
1619 for installing into the root filesystem.
1620 </para>
1621 <para>Sometimes a recipe is required to build the final image but is not
1622 needed in the root filesystem.
1623 You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to
1624 list these recipes and thus, specify the dependencies.
1625 A typical example is a required bootloader in a machine configuration.
1626 </para>
1627 <note>
1628 To add packages to the root filesystem, see the various
1629 <filename>*<link linkend='var-RDEPENDS'>RDEPENDS</link></filename>
1630 and <filename>*<link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></filename>
1631 variables.
1632 </note>
1633 </glossdef>
1634 </glossentry>
1635
1636 <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
1637 <glossdef>
1638 <para>Additional <filename>cmake</filename> options.</para>
1639 </glossdef>
1640 </glossentry>
1641
1642 <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm>
1643 <glossdef>
1644 <para>Additional <filename>configure</filename> script options.</para>
1645 </glossdef>
1646 </glossentry>
1647
1648 <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm>
1649 <glossdef>
1650 <para>Additional GNU <filename>make</filename> options.</para>
1651 </glossdef>
1652 </glossentry>
1653
1654 </glossdiv>
1655
1656 <glossdiv id='var-glossary-f'><title>F</title>
1657
1658 <glossentry id='var-FILES'><glossterm>FILES</glossterm>
1659 <glossdef>
1660 <para>
1661 The list of directories or files that are placed in packages.
1662 </para>
1663
1664 <para>
1665 To use the <filename>FILES</filename> variable, provide a package name
1666 override that identifies the resulting package.
1667 Then, provide a space-separated list of files or paths that identifies the
1668 files you want included as part of the resulting package.
1669 Here is an example:
1670 <literallayout class='monospaced'>
1671 FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile"
1672 </literallayout>
1673 </para>
1674
1675 <note>
1676 When specifying paths as part of the <filename>FILES</filename> variable,
1677 it is good practice to use appropriate path variables.
1678 For example, <filename>${sysconfdir}</filename> rather than
1679 <filename>/etc</filename> or <filename>${bindir}</filename> rather
1680 than <filename>/usr/bin</filename>.
1681 You can find a list of these variables at the top of the
1682 <filename>/meta/conf/bitbake.conf</filename> file in the
1683 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1684 </note>
1685
1686 <para>
1687 If some of the files you provide with the <filename>FILES</filename> variable
1688 are editable and you know they should not be
1689 overwritten during the package update process by the Package Management
1690 System (PMS), you can identify these files so that the PMS will not
1691 overwrite them.
1692 See the <filename><link linkend='var-CONFFILES'>CONFFILES</link></filename>
1693 variable for information on how to identify these files to the PMS.
1694 </para>
1695
1696 </glossdef>
1697 </glossentry>
1698
1699 <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm>
1700 <glossdef>
1701 <para>
1702 Extends the search path the OpenEmbedded build system uses
1703 when looking for files and patches as it processes recipes
1704 and append files.
1705 The default directories BitBake uses when it processes
1706 recipes are initially defined by the
1707 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
1708 variable.
1709 You can extend <filename>FILESPATH</filename> variable
1710 by using <filename>FILESEXTRAPATHS</filename>.
1711 </para>
1712
1713 <para>
1714 Best practices dictate that you accomplish this by using
1715 <filename>FILESEXTRAPATHS</filename> from within a
1716 <filename>.bbappend</filename> file and that you prepend
1717 paths as follows:
1718 <literallayout class='monospaced'>
1719 FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
1720 </literallayout>
1721 In the above example, the build system first looks for files
1722 in a directory that has the same name as the corresponding
1723 append file.
1724 <note>
1725 <para>When extending <filename>FILESEXTRAPATHS</filename>,
1726 be sure to use the immediate expansion
1727 (<filename>:=</filename>) operator.
1728 Immediate expansion makes sure that BitBake evaluates
1729 <link linkend='var-THISDIR'><filename>THISDIR</filename></link>
1730 at the time the directive is encountered rather than at
1731 some later time when expansion might result in a
1732 directory that does not contain the files you need.
1733 </para>
1734 <para>Also, include the trailing separating colon
1735 character if you are prepending.
1736 The trailing colon character is necessary because you
1737 are directing BitBake to extend the path by prepending
1738 directories to the search path.</para>
1739 </note>
1740 Here is another common use:
1741 <literallayout class='monospaced'>
1742 FILESEXTRAPATHS_prepend := "${THISDIR}/files:"
1743 </literallayout>
1744 In this example, the build system extends the
1745 <filename>FILESPATH</filename> variable to include a
1746 directory named <filename>files</filename> that is in the
1747 same directory as the corresponding append file.
1748 </para>
1749
1750 <para>
1751 Here is a final example that specifically adds three paths:
1752 <literallayout class='monospaced'>
1753 FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:"
1754 </literallayout>
1755 </para>
1756
1757 <para>
1758 By prepending paths in <filename>.bbappend</filename>
1759 files, you allow multiple append files that reside in
1760 different layers but are used for the same recipe to
1761 correctly extend the path.
1762 </para>
1763 </glossdef>
1764 </glossentry>
1765
1766 <glossentry id='var-FILESOVERRIDES'><glossterm>FILESOVERRIDES</glossterm>
1767 <glossdef>
1768 <para>
1769 A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>
1770 used by the OpenEmbedded build system for creating
1771 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>.
1772 You can find more information on how overrides are handled
1773 in the BitBake Manual that is located at
1774 <filename>bitbake/doc/manual</filename> in the
1775 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1776 </para>
1777
1778 <para>
1779 By default, the <filename>FILESOVERRIDES</filename>
1780 variable is defined as:
1781 <literallayout class='monospaced'>
1782 FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}"
1783 </literallayout>
1784
1785 <note>
1786 Do not hand-edit the <filename>FILESOVERRIDES</filename>
1787 variable.
1788 The values match up with expected overrides and are
1789 used in an expected manner by the build system.
1790 </note>
1791 </para>
1792 </glossdef>
1793 </glossentry>
1794
1795 <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm>
1796 <glossdef>
1797 <para>
1798 The default set of directories the OpenEmbedded build system
1799 uses when searching for patches and files.
1800 During the build process, BitBake searches each directory in
1801 <filename>FILESPATH</filename> in the specified order when
1802 looking for files and patches specified by each
1803 <filename>file://</filename> URI in a recipe.
1804 </para>
1805
1806 <para>
1807 The default value for the <filename>FILESPATH</filename>
1808 variable is defined in the <filename>base.bbclass</filename>
1809 class found in <filename>meta/classes</filename> in the
1810 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
1811 <literallayout class='monospaced'>
1812 FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
1813 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}"
1814 </literallayout>
1815 <note>
1816 Do not hand-edit the <filename>FILESPATH</filename>
1817 variable.
1818 If you want the build system to look in directories
1819 other than the defaults, extend the
1820 <filename>FILESPATH</filename> variable by using the
1821 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
1822 variable.
1823 </note>
1824 Be aware that the default <filename>FILESPATH</filename>
1825 directories do not map to directories in custom layers
1826 where append files (<filename>.bbappend</filename>)
1827 are used.
1828 If you want the build system to find patches or files
1829 that reside with your append files, you need to extend
1830 the <filename>FILESPATH</filename> variable by using
1831 the
1832 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
1833 variable.
1834 </para>
1835 </glossdef>
1836 </glossentry>
1837
1838 <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm>
1839 <glossdef>
1840 <para>Allows you to define your own file permissions settings table as part of
1841 your configuration for the packaging process.
1842 For example, suppose you need a consistent set of custom permissions for
1843 a set of groups and users across an entire work project.
1844 It is best to do this in the packages themselves but this is not always
1845 possible.
1846 </para>
1847 <para>
1848 By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which
1849 is located in the <filename>meta/files</filename> folder in the
1850 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1851 If you create your own file permissions setting table, you should place it in your
1852 layer or the distros layer.
1853 </para>
1854 <para>
1855 You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
1856 <filename>conf/local.conf</filename> file, which is found in the
1857 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to
1858 point to your custom <filename>fs-perms.txt</filename>.
1859 You can specify more than a single file permissions setting table.
1860 The paths you specify to these files must be defined within the
1861 <link linkend='var-BBPATH'><filename>BBPATH</filename></link> variable.
1862 </para>
1863 <para>
1864 For guidance on how to create your own file permissions settings table file,
1865 examine the existing <filename>fs-perms.txt</filename>.
1866 </para>
1867 </glossdef>
1868 </glossentry>
1869
1870 <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm>
1871 <glossdef>
1872 <para>
1873 The options to pass in
1874 <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename>
1875 and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>
1876 when compiling an optimized system.
1877 This variable defaults to
1878 "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
1879 </para>
1880 </glossdef>
1881 </glossentry>
1882
1883 </glossdiv>
1884
1885<!-- <glossdiv id='var-glossary-g'><title>G</title>-->
1886<!-- </glossdiv>-->
1887
1888 <glossdiv id='var-glossary-h'><title>H</title>
1889
1890 <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm>
1891 <glossdef>
1892 <para>Website where more information about the software the recipe is building
1893 can be found.</para>
1894 </glossdef>
1895 </glossentry>
1896
1897 <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm>
1898 <glossdef>
1899 <para>
1900 Specifies the system, including the architecture and the
1901 operating system, for with the build is occurring
1902 in the context of the current
1903 recipe.
1904 The OpenEmbedded build system automatically sets this
1905 variable.
1906 You do not need to set the variable yourself.
1907 </para>
1908
1909 <para>
1910 Here are two examples:
1911 <itemizedlist>
1912 <listitem><para>Given a native recipe on a 32-bit
1913 x86 machine running Linux, the value is
1914 "i686-linux".
1915 </para></listitem>
1916 <listitem><para>Given a recipe being built for a
1917 little-endian MIPS target running Linux,
1918 the value might be "mipsel-linux".
1919 </para></listitem>
1920 </itemizedlist>
1921 </para>
1922 </glossdef>
1923 </glossentry>
1924
1925 </glossdiv>
1926
1927 <glossdiv id='var-glossary-i'><title>I</title>
1928
1929 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
1930 <glossdef>
1931 <para>
1932 The base name of image output files.
1933 This variable defaults to the recipe name
1934 (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
1935 </para>
1936 </glossdef>
1937 </glossentry>
1938
1939 <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm>
1940 <glossdef>
1941 <para>
1942 A list of classes that all images should inherit.
1943 You typically use this variable to specify the list of
1944 classes that register the different types of images
1945 the OpenEmbedded build system creates.
1946 </para>
1947
1948 <para>
1949 The default value for <filename>IMAGE_CLASSES</filename> is
1950 <filename>image_types</filename>.
1951 You can set this variable in your
1952 <filename>local.conf</filename> or in a distribution
1953 configuration file.
1954 </para>
1955
1956 <para>
1957 For more information, see
1958 <filename>meta/classes/image_types.bbclass</filename> in the
1959 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1960 </para>
1961 </glossdef>
1962 </glossentry>
1963
1964 <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm>
1965 <glossdef>
1966 <para>
1967 The primary list of features to include in an image.
1968 Typically, you configure this variable in an image recipe.
1969 Although you can use this variable from your
1970 <filename>local.conf</filename> file, which is found in the
1971 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
1972 best practices dictate that you do not.
1973 <note>
1974 To enable extra features from outside the image recipe,
1975 use the
1976 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
1977 </note>
1978 For a list of image features that ships with the Yocto
1979 Project, see the
1980 "<link linkend="ref-features-image">Images</link>"
1981 section.
1982 </para>
1983
1984 <para>
1985 For example that shows how to customize your image by
1986 using this variable, see the
1987 "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>"
1988 section in the Yocto Project Development Manual.
1989 </para>
1990 </glossdef>
1991 </glossentry>
1992
1993 <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm>
1994 <glossdef>
1995 <para>
1996 Specifies the formats the OpenEmbedded build system uses
1997 during the build when creating the root filesystem.
1998 For example, setting <filename>IMAGE_FSTYPES</filename>
1999 as follows causes the build system to create root
2000 filesystems using two formats: <filename>.ext3</filename>
2001 and <filename>tar.bz2</filename>:
2002 <literallayout class='monospaced'>
2003 IMAGE_FSTYPES = "ext3 tar.bz2"
2004 </literallayout>
2005 For the complete list of supported image formats from which
2006 you can choose, see
2007 <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>.
2008 </para>
2009 </glossdef>
2010 </glossentry>
2011
2012 <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
2013 <glossdef>
2014 <para>
2015 Specifies the packages to install into an image.
2016 The <filename>IMAGE_INSTALL</filename> variable is a mechanism for an image
2017 recipe and you should use it with care to avoid ordering issues.
2018 </para>
2019
2020 <para>
2021 Image recipes set <filename>IMAGE_INSTALL</filename> to specify the
2022 packages to install into an image through <filename>image.bbclass</filename>.
2023 Additionally, "helper" classes exist, such as <filename>core-image.bbclass</filename>,
2024 that can take
2025 <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> lists
2026 and turn these into auto-generated entries in
2027 <filename>IMAGE_INSTALL</filename> in addition to its default contents.
2028 </para>
2029
2030 <para>
2031 Using <filename>IMAGE_INSTALL</filename> with the <filename>+=</filename>
2032 operator from the <filename>/conf/local.conf</filename> file or from within
2033 an image recipe is not recommended as it can cause ordering issues.
2034 Since <filename>core-image.bbclass</filename> sets <filename>IMAGE_INSTALL</filename>
2035 to a default value using the <filename>?=</filename> operator, using a
2036 <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename>
2037 will result in unexpected behavior when used in
2038 <filename>/conf/local.conf</filename>.
2039 Furthermore, the same operation from with an image recipe may or may not
2040 succeed depending on the specific situation.
2041 In both these cases, the behavior is contrary to how most users expect
2042 the <filename>+=</filename> operator to work.
2043 </para>
2044
2045 <para>
2046 When you use this variable, it is best to use it as follows:
2047 <literallayout class='monospaced'>
2048 IMAGE_INSTALL_append = " package-name"
2049 </literallayout>
2050 Be sure to include the space between the quotation character and the start of the
2051 package name.
2052 </para>
2053 </glossdef>
2054 </glossentry>
2055
2056 <glossentry id='var-IMAGE_LINGUAS'><glossterm>IMAGE_LINGUAS</glossterm>
2057 <glossdef>
2058 <para>
2059 Specifies the list of locales to install into the image
2060 during the root filesystem construction process.
2061 The OpenEmbedded build system automatically splits locale
2062 files, which are used for localization, into separate
2063 packages.
2064 Setting the <filename>IMAGE_LINGUAS</filename> variable
2065 ensures that any locale packages that correspond to packages
2066 already selected for installation into the image are also
2067 installed.
2068 Here is an example:
2069 <literallayout class='monospaced'>
2070 IMAGE_LINGUAS = "pt-br de-de"
2071 </literallayout>
2072 In this example, the build system ensures any Brazilian
2073 Portuguese and German locale files that correspond to
2074 packages in the image are installed (i.e.
2075 <filename>*-locale-pt-br</filename>
2076 and <filename>*-locale-de-de</filename> as well as
2077 <filename>*-locale-pt</filename>
2078 and <filename>*-locale-de</filename>, since some software
2079 packages only provide locale files by language and not by
2080 country-specific language).
2081 </para>
2082 </glossdef>
2083 </glossentry>
2084
2085 <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm>
2086 <glossdef>
2087 <para>
2088 The name of the output image files minus the extension.
2089 This variable is derived using the
2090 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
2091 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
2092 and
2093 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
2094 variables:
2095 <literallayout class='monospaced'>
2096 IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}"
2097 </literallayout>
2098 </para>
2099 </glossdef>
2100 </glossentry>
2101
2102 <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm>
2103 <glossdef>
2104 <para>
2105 Defines a multiplier that the build system applies to the initial image
2106 size for cases when the multiplier times the returned disk usage value
2107 for the image is greater than the sum of
2108 <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>
2109 and
2110 <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>.
2111 The result of the multiplier applied to the initial image size creates
2112 free disk space in the image as overhead.
2113 By default, the build process uses a multiplier of 1.3 for this variable.
2114 This default value results in 30% free disk space added to the image when this
2115 method is used to determine the final generated image size.
2116 You should be aware that post install scripts and the package management
2117 system uses disk space inside this overhead area.
2118 Consequently, the multiplier does not produce an image with
2119 all the theoretical free disk space.
2120 See <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>
2121 for information on how the build system determines the overall image size.
2122 </para>
2123
2124 <para>
2125 The default 30% free disk space typically gives the image enough room to boot
2126 and allows for basic post installs while still leaving a small amount of
2127 free disk space.
2128 If 30% free space is inadequate, you can increase the default value.
2129 For example, the following setting gives you 50% free space added to the image:
2130 <literallayout class='monospaced'>
2131 IMAGE_OVERHEAD_FACTOR = "1.5"
2132 </literallayout>
2133 </para>
2134
2135 <para>
2136 Alternatively, you can ensure a specific amount of free disk space is added
2137 to the image by using
2138 <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>
2139 the variable.
2140 </para>
2141 </glossdef>
2142 </glossentry>
2143
2144 <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm>
2145 <glossdef>
2146 <para>
2147 Added by classes to run post processing commands once the
2148 OpenEmbedded build system has created the image.
2149 You can specify shell commands separated by semicolons:
2150 <literallayout class='monospaced'>
2151 IMAGE_POSTPROCESS_COMMAND += "&lt;shell_command&gt;; ... "
2152 </literallayout>
2153 If you need to pass the path to the root filesystem within
2154 the command, you can use
2155 <filename>${IMAGE_ROOTFS}</filename>, which points to
2156 the root filesystem image.
2157 </para>
2158 </glossdef>
2159 </glossentry>
2160
2161 <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm>
2162 <glossdef>
2163 <para>
2164 The location of the root filesystem while it is under
2165 construction (i.e. during <filename>do_rootfs</filename>).
2166 This variable is not configurable.
2167 Do not change it.
2168 </para>
2169 </glossdef>
2170 </glossentry>
2171
2172 <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm>
2173 <glossdef>
2174 <para>
2175 Defines additional free disk space created in the image in Kbytes.
2176 By default, this variable is set to "0".
2177 This free disk space is added to the image after the build system determines
2178 the image size as described in
2179 <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>.
2180 </para>
2181
2182 <para>
2183 This variable is particularly useful when you want to ensure that a
2184 specific amount of free disk space is available on a device after an image
2185 is installed and running.
2186 For example, to be sure 5 Gbytes of free disk space is available, set the
2187 variable as follows:
2188 <literallayout class='monospaced'>
2189 IMAGE_ROOTFS_EXTRA_SPACE = "5242880"
2190 </literallayout>
2191 </para>
2192 </glossdef>
2193 </glossentry>
2194
2195 <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm>
2196 <glossdef>
2197 <para>
2198 Defines the size in Kbytes for the generated image.
2199 The OpenEmbedded build system determines the final size for the generated
2200 image using an algorithm that takes into account the initial disk space used
2201 for the generated image, a requested size for the image, and requested
2202 additional free disk space to be added to the image.
2203 Programatically, the build system determines the final size of the
2204 generated image as follows:
2205 <literallayout class='monospaced'>
2206 if (image-du * overhead) &lt; rootfs-size:
2207 internal-rootfs-size = rootfs-size + xspace
2208 else:
2209 internal-rootfs-size = (image-du * overhead) + xspace
2210
2211 where:
2212
2213 image-du = Returned value of the du command on
2214 the image.
2215
2216 overhead = IMAGE_OVERHEAD_FACTOR
2217
2218 rootfs-size = IMAGE_ROOTFS_SIZE
2219
2220 internal-rootfs-size = Initial root filesystem
2221 size before any modifications.
2222
2223 xspace = IMAGE_ROOTFS_EXTRA_SPACE
2224 </literallayout>
2225 See the <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link>
2226 and <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link>
2227 variables for related information.
2228<!-- In the above example, <filename>overhead</filename> is defined by the
2229 <filename><link linkend='var-IMAGE_OVERHEAD_FACTOR'>IMAGE_OVERHEAD_FACTOR</link></filename>
2230 variable, <filename>xspace</filename> is defined by the
2231 <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>
2232 variable, and <filename>du</filename> is the results of the disk usage command
2233 on the initially generated image. -->
2234 </para>
2235 </glossdef>
2236 </glossentry>
2237
2238 <glossentry id='var-IMAGE_TYPES'><glossterm>IMAGE_TYPES</glossterm>
2239 <glossdef>
2240 <para>
2241 Specifies the complete list of supported image types
2242 by default:
2243 <literallayout class='monospaced'>
2244 jffs2
2245 sum.jffs2
2246 cramfs
2247 ext2
2248 ext2.gz
2249 ext2.bz2
2250 ext3
2251 ext3.gz
2252 ext2.lzma
2253 btrfs
2254 live
2255 squashfs
2256 squashfs-xz
2257 ubi
2258 ubifs
2259 tar
2260 tar.gz
2261 tar.bz2
2262 tar.xz
2263 cpio
2264 cpio.gz
2265 cpio.xz
2266 cpio.lzma
2267 vmdk
2268 elf
2269 </literallayout>
2270 For more information on how these types of images, see
2271 <filename>meta/classes/image_types*.bbclass</filename>
2272 in the
2273 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
2274 </para>
2275 </glossdef>
2276 </glossentry>
2277
2278 <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm>
2279 <glossdef>
2280 <para>Helps define the recipe revision for recipes that share
2281 a common <filename>include</filename> file.
2282 You can think of this variable as part of the recipe revision
2283 as set from within an include file.</para>
2284 <para>Suppose, for example, you have a set of recipes that
2285 are used across several projects.
2286 And, within each of those recipes the revision
2287 (its <link linkend='var-PR'><filename>PR</filename></link>
2288 value) is set accordingly.
2289 In this case, when the revision of those recipes changes,
2290 the burden is on you to find all those recipes and
2291 be sure that they get changed to reflect the updated
2292 version of the recipe.
2293 In this scenario, it can get complicated when recipes
2294 that are used in many places and provide common functionality
2295 are upgraded to a new revision.</para>
2296 <para>A more efficient way of dealing with this situation is
2297 to set the <filename>INC_PR</filename> variable inside
2298 the <filename>include</filename> files that the recipes
2299 share and then expand the <filename>INC_PR</filename>
2300 variable within the recipes to help
2301 define the recipe revision.
2302 </para>
2303 <para>
2304 The following provides an example that shows how to use
2305 the <filename>INC_PR</filename> variable
2306 given a common <filename>include</filename> file that
2307 defines the variable.
2308 Once the variable is defined in the
2309 <filename>include</filename> file, you can use the
2310 variable to set the <filename>PR</filename> values in
2311 each recipe.
2312 You will notice that when you set a recipe's
2313 <filename>PR</filename> you can provide more granular
2314 revisioning by appending values to the
2315 <filename>INC_PR</filename> variable:
2316 <literallayout class='monospaced'>
2317recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
2318recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1"
2319recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0"
2320recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2321 </literallayout>
2322 The first line of the example establishes the baseline
2323 revision to be used for all recipes that use the
2324 <filename>include</filename> file.
2325 The remaining lines in the example are from individual
2326 recipes and show how the <filename>PR</filename> value
2327 is set.</para>
2328 </glossdef>
2329 </glossentry>
2330
2331 <glossentry id='var-INCOMPATIBLE_LICENSE'><glossterm>INCOMPATIBLE_LICENSE</glossterm>
2332 <glossdef>
2333 <para>
2334 Specifies a space-separated list of license names
2335 (as they would appear in
2336 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>)
2337 that should be excluded from the build.
2338 Recipes that provide no alternatives to listed incompatible
2339 licenses are not built.
2340 Packages that are individually licensed with the specified
2341 incompatible licenses will be deleted.
2342 </para>
2343
2344 <note>
2345 This functionality is only regularly tested using
2346 the following setting:
2347 <literallayout class='monospaced'>
2348 INCOMPATIBLE_LICENSE = "GPLv3"
2349 </literallayout>
2350 Although you can use other settings, you might be required
2351 to remove dependencies on or provide alternatives to
2352 components that are required to produce a functional system
2353 image.
2354 </note>
2355 </glossdef>
2356 </glossentry>
2357
2358 <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm>
2359 <glossdef>
2360 <para>
2361 Prevents the default dependencies, namely the C compiler
2362 and standard C library (libc), from being added to
2363 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>.
2364 This variable is usually used within recipes that do not
2365 require any compilation using the C compiler.
2366 </para>
2367
2368 <para>
2369 Set the variable to "1" to prevent the default dependencies
2370 from being added.
2371 </para>
2372 </glossdef>
2373 </glossentry>
2374
2375 <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm>
2376 <glossdef>
2377 <para>
2378 If set to "1", causes the build to not strip binaries in resulting packages.
2379 </para>
2380 </glossdef>
2381 </glossentry>
2382
2383 <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
2384 <glossdef>
2385 <para>
2386 Causes the named class to be inherited at
2387 this point during parsing.
2388 The variable is only valid in configuration files.
2389 </para>
2390 </glossdef>
2391 </glossentry>
2392
2393 <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
2394 <glossdef>
2395 <para>
2396 Defines the format for the output image of an initial
2397 RAM disk (initramfs), which is used during boot.
2398 Supported formats are the same as those supported by the
2399 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
2400 variable.
2401 </para>
2402 </glossdef>
2403 </glossentry>
2404
2405 <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm>
2406 <glossdef>
2407 <para>
2408 The filename of the initscript as installed to <filename>${etcdir}/init.d</filename>.
2409 </para>
2410 <para>
2411 This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>.
2412 The variable is Mandatory.
2413 </para>
2414 </glossdef>
2415 </glossentry>
2416
2417 <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
2418 <glossdef>
2419 <para>
2420 A list of the packages that contain initscripts.
2421 If multiple packages are specified, you need to append the package name
2422 to the other <filename>INITSCRIPT_*</filename> as an override.</para>
2423 <para>
2424 This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>.
2425 The variable is optional and defaults to the
2426 <link linkend='var-PN'><filename>PN</filename></link> variable.
2427 </para>
2428 </glossdef>
2429 </glossentry>
2430
2431 <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm>
2432 <glossdef>
2433 <para>
2434 Specifies the options to pass to <filename>update-rc.d</filename>.
2435 Here is an example:
2436 <literallayout class='monospaced'>
2437 INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ."
2438 </literallayout>
2439 In this example, the script has a runlevel of 99,
2440 starts the script in initlevels 2 and 5, and
2441 stops the script in levels 0, 1 and 6.
2442 </para>
2443 <para>
2444 The variable is mandatory and is used in recipes when using
2445 <filename>update-rc.d.bbclass</filename>.
2446 </para>
2447 </glossdef>
2448 </glossentry>
2449
2450 <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm>
2451 <glossdef>
2452 <para>
2453 Specifies the QA checks to skip for a specific package
2454 within a recipe.
2455 For example, to skip the check for symbolic link
2456 <filename>.so</filename> files in the main package of a
2457 recipe, add the following to the recipe.
2458 The package name override must be used, which in this
2459 example is <filename>${PN}</filename>:
2460 <literallayout class='monospaced'>
2461 INSANE_SKIP_${PN} += "dev-so"
2462 </literallayout>
2463 </para>
2464 <para>
2465 See the "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
2466 section for a list of the valid QA checks you can
2467 specify using this variable.
2468 </para>
2469 </glossdef>
2470 </glossentry>
2471
2472 <glossentry id='var-IPK_FEED_URIS'><glossterm>IPK_FEED_URIS</glossterm>
2473 <glossdef>
2474 <para>
2475 When the IPK backend is in use and package management
2476 is enabled on the target, you can use this variable to
2477 set up <filename>opkg</filename> in the target image
2478 to point to package feeds on a nominated server.
2479 Once the feed is established, you can perform
2480 installations or upgrades using the package manager
2481 at runtime.
2482 </para>
2483 </glossdef>
2484 </glossentry>
2485
2486<!--
2487 <glossentry id='var-INTERCEPT_DIR'><glossterm>INTERCEPT_DIR</glossterm>
2488 <glossdef>
2489 <para>
2490 An environment variable that defines the directory where
2491 post installation hooks are installed for the
2492 post install environment.
2493 This variable is fixed as follows:
2494 <literallayout class='monospaced'>
2495 ${WORKDIR}/intercept_scripts
2496 </literallayout>
2497 </para>
2498
2499 <para>
2500 After installation of a target's root filesystem,
2501 post installation scripts, which are essentially bash scripts,
2502 are all executed just a single time.
2503 Limiting execution of these scripts minimizes installation
2504 time that would be lengthened due to certain packages
2505 triggering redundant operations.
2506 For example, consider the installation of font packages
2507 as a common example.
2508 Without limiting the execution of post installation scripts,
2509 all font directories would be rescanned to create the
2510 cache after each individual font package was installed.
2511 </para>
2512
2513 <para>
2514 Do not edit the <filename>INTERCEPT_DIR</filename>
2515 variable.
2516 </para>
2517 </glossdef>
2518 </glossentry>
2519-->
2520
2521 </glossdiv>
2522
2523<!-- <glossdiv id='var-glossary-j'><title>J</title>-->
2524<!-- </glossdiv>-->
2525
2526 <glossdiv id='var-glossary-k'><title>K</title>
2527
2528 <glossentry id='var-KARCH'><glossterm>KARCH</glossterm>
2529 <glossdef>
2530 <para>
2531 Defines the kernel architecture used when assembling
2532 the configuration.
2533 Architectures supported for this release are:
2534 <literallayout class='monospaced'>
2535 powerpc
2536 i386
2537 x86_64
2538 arm
2539 qemu
2540 mips
2541 </literallayout>
2542 </para>
2543
2544 <para>
2545 You define the <filename>KARCH</filename> variable in the
2546 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>.
2547 </para>
2548 </glossdef>
2549 </glossentry>
2550
2551 <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm>
2552 <glossdef>
2553 <para>
2554 A regular expression used by the build process to explicitly identify the kernel
2555 branch that is validated, patched and configured during a build.
2556 The <filename>KBRANCH</filename> variable is optional.
2557 You can use it to trigger checks to ensure the exact kernel branch you want is
2558 being used by the build process.
2559 </para>
2560
2561 <para>
2562 Values for this variable are set in the kernel's recipe file and the kernel's
2563 append file.
2564 For example, if you are using the Yocto Project kernel that is based on the
2565 Linux 3.4 kernel, the kernel recipe file is the
2566 <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file.
2567 Following is the default value for <filename>KBRANCH</filename> and the default
2568 override for the architectures the Yocto Project supports:
2569 <literallayout class='monospaced'>
2570 KBRANCH_DEFAULT = "standard/base"
2571 KBRANCH = "${KBRANCH_DEFAULT}"
2572 </literallayout>
2573 This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git
2574 repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
2575 </para>
2576
2577 <para>
2578 This variable is also used from the kernel's append file to identify the kernel
2579 branch specific to a particular machine or target hardware.
2580 The kernel's append file is located in the BSP layer for a given machine.
2581 For example, the kernel append file for the Crown Bay BSP is in the
2582 <filename>meta-intel</filename> Git repository and is named
2583 <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>.
2584 Here are the related statements from the append file:
2585 <literallayout class='monospaced'>
2586 COMPATIBLE_MACHINE_crownbay = "crownbay"
2587 KMACHINE_crownbay = "crownbay"
2588 KBRANCH_crownbay = "standard/crownbay"
2589
2590 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
2591 KMACHINE_crownbay-noemgd = "crownbay"
2592 KBRANCH_crownbay-noemgd = "standard/crownbay"
2593 </literallayout>
2594 The <filename>KBRANCH_*</filename> statements identify the kernel branch to
2595 use when building for the Crown Bay BSP.
2596 In this case there are two identical statements: one for each type of
2597 Crown Bay machine.
2598 </para>
2599 </glossdef>
2600 </glossentry>
2601
2602 <glossentry id='var-KBRANCH_DEFAULT'><glossterm>KBRANCH_DEFAULT</glossterm>
2603 <glossdef>
2604 <para>
2605 Defines the Linux kernel source repository's default
2606 branch used to build the Linux kernel.
2607 The <filename>KBRANCH_DEFAULT</filename> value is
2608 the default value for
2609 <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link>.
2610 Unless you specify otherwise,
2611 <filename>KBRANCH_DEFAULT</filename> initializes to
2612 "master".
2613 </para>
2614 </glossdef>
2615 </glossentry>
2616
2617 <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm>
2618 <glossdef>
2619 <para>
2620 Specifies additional <filename>make</filename>
2621 command-line arguments the OpenEmbedded build system
2622 passes on when compiling the kernel.
2623 </para>
2624 </glossdef>
2625 </glossentry>
2626
2627 <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm>
2628 <glossdef>
2629 <para>Includes additional metadata from the Yocto Project kernel Git repository.
2630 In the OpenEmbedded build system, the default Board Support Packages (BSPs)
2631 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
2632 is provided through
2633 the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>
2634 and <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> variables.
2635 You can use the <filename>KERNEL_FEATURES</filename> variable to further
2636 add metadata for all BSPs.</para>
2637 <para>The metadata you add through this variable includes config fragments and
2638 features descriptions,
2639 which usually includes patches as well as config fragments.
2640 You typically override the <filename>KERNEL_FEATURES</filename> variable
2641 for a specific machine.
2642 In this way, you can provide validated, but optional, sets of kernel
2643 configurations and features.</para>
2644 <para>For example, the following adds <filename>netfilter</filename> to all
2645 the Yocto Project kernels and adds sound support to the <filename>qemux86</filename>
2646 machine:
2647 <literallayout class='monospaced'>
2648 # Add netfilter to all linux-yocto kernels
2649 KERNEL_FEATURES="features/netfilter"
2650
2651 # Add sound support to the qemux86 machine
2652 KERNEL_FEATURES_append_qemux86=" cfg/sound"
2653 </literallayout></para>
2654 </glossdef>
2655 </glossentry>
2656
2657 <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
2658 <glossdef>
2659 <para>The type of kernel to build for a device, usually set by the
2660 machine configuration files and defaults to "zImage".
2661 This variable is used
2662 when building the kernel and is passed to <filename>make</filename> as the target to
2663 build.</para>
2664 </glossdef>
2665 </glossentry>
2666
2667 <glossentry id='var-KERNEL_PATH'><glossterm>KERNEL_PATH</glossterm>
2668 <glossdef>
2669 <para>
2670 The location of the kernel sources.
2671 This variable is set to the value of the
2672 <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link>
2673 within the <filename>module.bbclass</filename> class.
2674 For information on how this variable is used, see the
2675 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
2676 section.
2677 </para>
2678
2679 <para>
2680 The <link linkend='var-KERNEL_SRC'><filename>KERNEL_SRC</filename></link>
2681 variable is identical to the <filename>KERNEL_PATH</filename>
2682 variable.
2683 </para>
2684 </glossdef>
2685 </glossentry>
2686
2687 <glossentry id='var-KERNEL_SRC'><glossterm>KERNEL_SRC</glossterm>
2688 <glossdef>
2689 <para>
2690 The location of the kernel sources.
2691 This variable is set to the value of the
2692 <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link>
2693 within the <filename>module.bbclass</filename> class.
2694 For information on how this variable is used, see the
2695 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>"
2696 section.
2697 </para>
2698
2699 <para>
2700 The <link linkend='var-KERNEL_PATH'><filename>KERNEL_PATH</filename></link>
2701 variable is identical to the <filename>KERNEL_SRC</filename>
2702 variable.
2703 </para>
2704 </glossdef>
2705 </glossentry>
2706
2707 <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm>
2708 <glossdef>
2709 <para>
2710 Provides a short description of a configuration fragment.
2711 You use this variable in the <filename>.scc</filename>
2712 file that describes a configuration fragment file.
2713 Here is the variable used in a file named
2714 <filename>smp.scc</filename> to describe SMP being
2715 enabled:
2716 <literallayout class='monospaced'>
2717 define KFEATURE_DESCRIPTION "Enable SMP"
2718 </literallayout>
2719 </para>
2720 </glossdef>
2721 </glossentry>
2722
2723 <glossentry id='var-KMACHINE'><glossterm>KMACHINE</glossterm>
2724 <glossdef>
2725 <para>
2726 The machine as known by the kernel.
2727 Sometimes the machine name used by the kernel does not match the machine name
2728 used by the OpenEmbedded build system.
2729 For example, the machine name that the OpenEmbedded build system understands as
2730 <filename>qemuarm</filename> goes by a different name in the Linux Yocto kernel.
2731 The kernel understands that machine as <filename>arm_versatile926ejs</filename>.
2732 For cases like these, the <filename>KMACHINE</filename> variable maps the
2733 kernel machine name to the OpenEmbedded build system machine name.
2734 </para>
2735
2736 <para>
2737 Kernel machine names are initially defined in the
2738 Yocto Linux Kernel's <filename>meta</filename> branch.
2739 From the <filename>meta</filename> branch, look in
2740 the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file.
2741 For example, from the <filename>meta</filename> branch in the
2742 <filename>linux-yocto-3.0</filename> kernel, the
2743 <filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file
2744 has the following:
2745 <literallayout class='monospaced'>
2746 define KMACHINE cedartrail
2747 define KTYPE standard
2748 define KARCH i386
2749
2750 include ktypes/standard
2751 branch cedartrail
2752
2753 include cedartrail.scc
2754 </literallayout>
2755 You can see that the kernel understands the machine name for
2756 the Cedar Trail Board Support Package (BSP) as
2757 <filename>cedartrail</filename>.
2758 </para>
2759
2760 <para>
2761 If you look in the Cedar Trail BSP layer in the
2762 <filename>meta-intel</filename>
2763 <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink>
2764 at <filename>meta-cedartrail/recipes-kernel/linux/linux-yocto_3.0.bbappend</filename>,
2765 you will find the following statements among others:
2766 <literallayout class='monospaced'>
2767 COMPATIBLE_MACHINE_cedartrail = "cedartrail"
2768 KMACHINE_cedartrail = "cedartrail"
2769 KBRANCH_cedartrail = "yocto/standard/cedartrail"
2770 KERNEL_FEATURES_append_cedartrail += "bsp/cedartrail/cedartrail-pvr-merge.scc"
2771 KERNEL_FEATURES_append_cedartrail += "cfg/efi-ext.scc"
2772
2773 COMPATIBLE_MACHINE_cedartrail-nopvr = "cedartrail"
2774 KMACHINE_cedartrail-nopvr = "cedartrail"
2775 KBRANCH_cedartrail-nopvr = "yocto/standard/cedartrail"
2776 KERNEL_FEATURES_append_cedartrail-nopvr += " cfg/smp.scc"
2777 </literallayout>
2778 The <filename>KMACHINE</filename> statements in the kernel's append file make sure that
2779 the OpenEmbedded build system and the Yocto Linux kernel understand the same machine
2780 names.
2781 </para>
2782
2783 <para>
2784 This append file uses two <filename>KMACHINE</filename> statements.
2785 The first is not really necessary but does ensure that the machine known to the
2786 OpenEmbedded build system as <filename>cedartrail</filename> maps to the machine
2787 in the kernel also known as <filename>cedartrail</filename>:
2788 <literallayout class='monospaced'>
2789 KMACHINE_cedartrail = "cedartrail"
2790 </literallayout>
2791 </para>
2792
2793 <para>
2794 The second statement is a good example of why the <filename>KMACHINE</filename> variable
2795 is needed.
2796 In this example, the OpenEmbedded build system uses the <filename>cedartrail-nopvr</filename>
2797 machine name to refer to the Cedar Trail BSP that does not support the proprietary
2798 PowerVR driver.
2799 The kernel, however, uses the machine name <filename>cedartrail</filename>.
2800 Thus, the append file must map the <filename>cedartrail-nopvr</filename> machine name to
2801 the kernel's <filename>cedartrail</filename> name:
2802 <literallayout class='monospaced'>
2803 KMACHINE_cedartrail-nopvr = "cedartrail"
2804 </literallayout>
2805 </para>
2806
2807 <para>
2808 BSPs that ship with the Yocto Project release provide all mappings between the Yocto
2809 Project kernel machine names and the OpenEmbedded machine names.
2810 Be sure to use the <filename>KMACHINE</filename> if you create a BSP and the machine
2811 name you use is different than that used in the kernel.
2812 </para>
2813 </glossdef>
2814 </glossentry>
2815
2816 <glossentry id='var-KTYPE'><glossterm>KTYPE</glossterm>
2817 <glossdef>
2818 <para>
2819 Defines the kernel type to be used in assembling the
2820 configuration.
2821 The linux-yocto recipes define "standard", "tiny",
2822 and "preempt-rt" kernel types.
2823 See the
2824 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>"
2825 section in the Yocto Project Linux Kernel Development
2826 Manual for more information on kernel types.
2827 </para>
2828
2829 <para>
2830 You define the <filename>KTYPE</filename> variable in the
2831 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>.
2832 The value you use must match the value used for the
2833 <link linkend='var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></link>
2834 value used by the kernel recipe.
2835 </para>
2836 </glossdef>
2837 </glossentry>
2838 </glossdiv>
2839
2840 <glossdiv id='var-glossary-l'><title>L</title>
2841
2842 <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
2843 <glossdef>
2844 <para>Lists the layers that this recipe depends upon, separated by spaces.
2845 Optionally, you can specify a specific layer version for a dependency
2846 by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3"
2847 to be compared against
2848 <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename>
2849 in this case).
2850 An error will be produced if any dependency is missing or
2851 the version numbers do not match exactly (if specified).
2852 This variable is used in the <filename>conf/layer.conf</filename> file
2853 and must be suffixed with the name of the specific layer (e.g.
2854 <filename>LAYERDEPENDS_mylayer</filename>).</para>
2855 </glossdef>
2856 </glossentry>
2857
2858 <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
2859 <glossdef>
2860 <para>When used inside the <filename>layer.conf</filename> configuration
2861 file, this variable provides the path of the current layer.
2862 This variable is not available outside of <filename>layer.conf</filename>
2863 and references are expanded immediately when parsing of the file completes.</para>
2864 </glossdef>
2865 </glossentry>
2866
2867 <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
2868 <glossdef>
2869 <para>Optionally specifies the version of a layer as a single number.
2870 You can use this within
2871 <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link>
2872 for another layer in order to depend on a specific version
2873 of the layer.
2874 This variable is used in the <filename>conf/layer.conf</filename> file
2875 and must be suffixed with the name of the specific layer (e.g.
2876 <filename>LAYERVERSION_mylayer</filename>).</para>
2877 </glossdef>
2878 </glossentry>
2879
2880 <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm>
2881 <glossdef>
2882 <para>Checksums of the license text in the recipe source code.</para>
2883 <para>This variable tracks changes in license text of the source
2884 code files.
2885 If the license text is changed, it will trigger a build
2886 failure, which gives the developer an opportunity to review any
2887 license change.</para>
2888 <para>
2889 This variable must be defined for all recipes (unless
2890 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>
2891 is set to "CLOSED")</para>
2892 <para>For more information, see the
2893 <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>
2894 Tracking License Changes</link> section</para>
2895 </glossdef>
2896 </glossentry>
2897
2898 <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
2899 <glossdef>
2900 <para>
2901 The list of source licenses for the recipe.
2902 Follow these rules:
2903 <itemizedlist>
2904 <listitem><para>Do not use spaces within individual
2905 license names.</para></listitem>
2906 <listitem><para>Separate license names using
2907 | (pipe) when there is a choice between licenses.
2908 </para></listitem>
2909 <listitem><para>Separate license names using
2910 &amp; (ampersand) when multiple licenses exist
2911 that cover different parts of the source.
2912 </para></listitem>
2913 <listitem><para>You can use spaces between license
2914 names.</para></listitem>
2915 </itemizedlist>
2916 </para>
2917
2918 <para>
2919 Here are some examples:
2920 <literallayout class='monospaced'>
2921 LICENSE = "LGPLv2.1 | GPLv3"
2922 LICENSE = "MPL-1 &amp; LGPLv2.1"
2923 LICENSE = "GPLv2+"
2924 </literallayout>
2925 The first example is from the recipes for Qt, which the user
2926 may choose to distribute under either the LGPL version
2927 2.1 or GPL version 3.
2928 The second example is from Cairo where two licenses cover
2929 different parts of the source code.
2930 The final example is from <filename>sysstat</filename>,
2931 which presents a single license.
2932 </para>
2933
2934 <para>
2935 You can also specify licenses on a per-package basis to
2936 handle situations where components of the output have
2937 different licenses.
2938 For example, a piece of software whose code is
2939 licensed under GPLv2 but has accompanying documentation
2940 licensed under the GNU Free Documentation License 1.2 could
2941 be specified as follows:
2942 <literallayout class='monospaced'>
2943 LICENSE = "GFDL-1.2 &amp; GPLv2"
2944 LICENSE_${PN} = "GPLv2"
2945 LICENSE_${PN}-doc = "GFDL-1.2"
2946 </literallayout>
2947 </para>
2948 </glossdef>
2949 </glossentry>
2950
2951 <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm>
2952 <glossdef>
2953 <para>Path to additional licenses used during the build.
2954 By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename>
2955 to define the directory that holds common license text used during the build.
2956 The <filename>LICENSE_PATH</filename> variable allows you to extend that
2957 location to other areas that have additional licenses:
2958 <literallayout class='monospaced'>
2959 LICENSE_PATH += "/path/to/additional/common/licenses"
2960 </literallayout></para>
2961 </glossdef>
2962 </glossentry>
2963
2964 <glossentry id='var-LINUX_KERNEL_TYPE'><glossterm>LINUX_KERNEL_TYPE</glossterm>
2965 <glossdef>
2966 <para>
2967 Defines the kernel type to be used in assembling the
2968 configuration.
2969 The linux-yocto recipes define "standard", "tiny", and
2970 "preempt-rt" kernel types.
2971 See the
2972 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>"
2973 section in the Yocto Project Linux Kernel Development
2974 Manual for more information on kernel types.
2975 </para>
2976
2977 <para>
2978 If you do not specify a
2979 <filename>LINUX_KERNEL_TYPE</filename>, it defaults to
2980 "standard".
2981 Together with
2982 <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>,
2983 the <filename>LINUX_KERNEL_TYPE</filename> variable
2984 defines the search
2985 arguments used by the kernel tools to find the appropriate
2986 description within the kernel
2987 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
2988 with which to build out the sources and configuration.
2989 </para>
2990 </glossdef>
2991 </glossentry>
2992
2993 <glossentry id='var-LINUX_VERSION'><glossterm>LINUX_VERSION</glossterm>
2994 <glossdef>
2995 <para>The Linux version from <filename>kernel.org</filename>
2996 on which the Linux kernel image being built using the
2997 OpenEmbedded build system is based.
2998 You define this variable in the kernel recipe.
2999 For example, the <filename>linux-yocto-3.4.bb</filename>
3000 kernel recipe found in
3001 <filename>meta/recipes-kernel/linux</filename>
3002 defines the variables as follows:
3003 <literallayout class='monospaced'>
3004 LINUX_VERSION ?= "3.4.24"
3005 </literallayout>
3006 The <filename>LINUX_VERSION</filename> variable is used to
3007 define <link linkend='var-PV'><filename>PV</filename></link>
3008 for the recipe:
3009 <literallayout class='monospaced'>
3010 PV = "${LINUX_VERSION}+git${SRCPV}"
3011 </literallayout></para>
3012 </glossdef>
3013 </glossentry>
3014
3015 <glossentry id='var-LINUX_VERSION_EXTENSION'><glossterm>LINUX_VERSION_EXTENSION</glossterm>
3016 <glossdef>
3017 <para>A string extension compiled into the version
3018 string of the Linux kernel built with the OpenEmbedded
3019 build system.
3020 You define this variable in the kernel recipe.
3021 For example, the linux-yocto kernel recipes all define
3022 the variable as follows:
3023 <literallayout class='monospaced'>
3024 LINUX_VERSION_EXTENSION ?= "-yocto-${<link linkend='var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</link>}"
3025 </literallayout>
3026 Defining this variable essentially sets the
3027 Linux kernel configuration item
3028 <filename>CONFIG_LOCALVERSION</filename>, which is visible
3029 through the <filename>uname</filename> command.
3030 Here is an example that shows the extension assuming it
3031 was set as previously shown:
3032 <literallayout class='monospaced'>
3033 $ uname -r
3034 3.7.0-rc8-custom
3035 </literallayout>
3036 </para>
3037 </glossdef>
3038 </glossentry>
3039
3040 <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm>
3041 <glossdef>
3042 <para>
3043 Specifies the directory to which the OpenEmbedded build
3044 system writes overall log files.
3045 The default directory is <filename>${TMPDIR}/log</filename>.
3046 </para>
3047 <para>
3048 For the directory containing logs specific to each task,
3049 see the <link linkend='var-T'><filename>T</filename></link>
3050 variable.
3051 </para>
3052 </glossdef>
3053 </glossentry>
3054
3055 </glossdiv>
3056
3057 <glossdiv id='var-glossary-m'><title>M</title>
3058
3059 <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
3060 <glossdef>
3061 <para>
3062 Specifies the target device for which the image is built.
3063 You define <filename>MACHINE</filename> in the
3064 <filename>local.conf</filename> file found in the
3065 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
3066 By default, <filename>MACHINE</filename> is set to
3067 "qemux86", which is an x86-based architecture machine to
3068 be emulated using QEMU:
3069 <literallayout class='monospaced'>
3070 MACHINE ?= "qemux86"
3071 </literallayout>
3072 The variable corresponds to a machine configuration file of the
3073 same name, through which machine-specific configurations are set.
3074 Thus, when <filename>MACHINE</filename> is set to "qemux86" there
3075 exists the corresponding <filename>qemux86.conf</filename> machine
3076 configuration file, which can be found in the
3077 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
3078 in <filename>meta/conf/machine</filename>.
3079 </para>
3080
3081 <para>
3082 The list of machines supported by the Yocto Project as
3083 shipped include the following:
3084 <literallayout class='monospaced'>
3085 MACHINE ?= "qemuarm"
3086 MACHINE ?= "qemumips"
3087 MACHINE ?= "qemuppc"
3088 MACHINE ?= "qemux86"
3089 MACHINE ?= "qemux86-64"
3090 MACHINE ?= "genericx86"
3091 MACHINE ?= "beagleboard"
3092 MACHINE ?= "mpc8315e-rdb"
3093 MACHINE ?= "routerstationpro"
3094 </literallayout>
3095 The last four are Yocto Project reference hardware boards, which
3096 are provided in the <filename>meta-yocto-bsp</filename> layer.
3097 <note>Adding additional Board Support Package (BSP) layers
3098 to your configuration adds new possible settings for
3099 <filename>MACHINE</filename>.
3100 </note>
3101 </para>
3102 </glossdef>
3103 </glossentry>
3104
3105 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm>
3106 <glossdef>
3107 <para></para>
3108 <para>
3109 A list of required machine-specific packages to install as part of
3110 the image being built.
3111 The build process depends on these packages being present.
3112 Furthermore, because this is a "machine essential" variable, the list of
3113 packages are essential for the machine to boot.
3114 The impact of this variable affects images based on
3115 <filename>packagegroup-core-boot</filename>,
3116 including the <filename>core-image-minimal</filename> image.
3117 </para>
3118 <para>
3119 This variable is similar to the
3120 <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename>
3121 variable with the exception that the image being built has a build
3122 dependency on the variable's list of packages.
3123 In other words, the image will not build if a file in this list is not found.
3124 </para>
3125 <para>
3126 As an example, suppose the machine for which you are building requires
3127 <filename>example-init</filename> to be run during boot to initialize the hardware.
3128 In this case, you would use the following in the machine's
3129 <filename>.conf</filename> configuration file:
3130 <literallayout class='monospaced'>
3131 MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init"
3132 </literallayout>
3133 </para>
3134 </glossdef>
3135 </glossentry>
3136
3137 <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm>
3138 <glossdef>
3139 <para></para>
3140 <para>
3141 A list of recommended machine-specific packages to install as part of
3142 the image being built.
3143 The build process does not depend on these packages being present.
3144 However, because this is a "machine essential" variable, the list of
3145 packages are essential for the machine to boot.
3146 The impact of this variable affects images based on
3147 <filename>packagegroup-core-boot</filename>,
3148 including the <filename>core-image-minimal</filename> image.
3149 </para>
3150 <para>
3151 This variable is similar to the
3152 <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename>
3153 variable with the exception that the image being built does not have a build
3154 dependency on the variable's list of packages.
3155 In other words, the image will still build if a package in this list is not found.
3156 Typically, this variable is used to handle essential kernel modules, whose
3157 functionality may be selected to be built into the kernel rather than as a module,
3158 in which case a package will not be produced.
3159 </para>
3160 <para>
3161 Consider an example where you have a custom kernel where a specific touchscreen
3162 driver is required for the machine to be usable.
3163 However, the driver can be built as a module or
3164 into the kernel depending on the kernel configuration.
3165 If the driver is built as a module, you want it to be installed.
3166 But, when the driver is built into the kernel, you still want the
3167 build to succeed.
3168 This variable sets up a "recommends" relationship so that in the latter case,
3169 the build will not fail due to the missing package.
3170 To accomplish this, assuming the package for the module was called
3171 <filename>kernel-module-ab123</filename>, you would use the
3172 following in the machine's <filename>.conf</filename> configuration
3173 file:
3174 <literallayout class='monospaced'>
3175 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123"
3176 </literallayout>
3177 </para>
3178 <para>
3179 Some examples of these machine essentials are flash, screen, keyboard, mouse,
3180 or touchscreen drivers (depending on the machine).
3181 </para>
3182 </glossdef>
3183 </glossentry>
3184
3185 <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
3186 <glossdef>
3187 <para>
3188 A list of machine-specific packages to install as part of the
3189 image being built that are not essential for the machine to boot.
3190 However, the build process for more fully-featured images
3191 depends on the packages being present.
3192 </para>
3193 <para>
3194 This variable affects all images based on
3195 <filename>packagegroup-base</filename>, which does not include the
3196 <filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
3197 images.
3198 </para>
3199 <para>
3200 The variable is similar to the
3201 <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename>
3202 variable with the exception that the image being built has a build
3203 dependency on the variable's list of packages.
3204 In other words, the image will not build if a file in this list is not found.
3205 </para>
3206 <para>
3207 An example is a machine that has WiFi capability but is not
3208 essential for the machine to boot the image.
3209 However, if you are building a more fully-featured image, you want to enable
3210 the WiFi.
3211 The package containing the firmware for the WiFi hardware is always
3212 expected to exist, so it is acceptable for the build process to depend upon
3213 finding the package.
3214 In this case, assuming the package for the firmware was called
3215 <filename>wifidriver-firmware</filename>, you would use the following in the
3216 <filename>.conf</filename> file for the machine:
3217 <literallayout class='monospaced'>
3218 MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware"
3219 </literallayout>
3220 </para>
3221 </glossdef>
3222 </glossentry>
3223
3224 <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm>
3225 <glossdef>
3226 <para></para>
3227 <para>
3228 A list of machine-specific packages to install as part of the
3229 image being built that are not essential for booting the machine.
3230 The image being built has no build dependency on this list of packages.
3231 </para>
3232 <para>
3233 This variable affects only images based on
3234 <filename>packagegroup-base</filename>, which does not include the
3235 <filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
3236 images.
3237 </para>
3238 <para>
3239 This variable is similar to the
3240 <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename>
3241 variable with the exception that the image being built does not have a build
3242 dependency on the variable's list of packages.
3243 In other words, the image will build if a file in this list is not found.
3244 </para>
3245 <para>
3246 An example is a machine that has WiFi capability but is not essential
3247 For the machine to boot the image.
3248 However, if you are building a more fully-featured image, you want to enable
3249 WiFi.
3250 In this case, the package containing the WiFi kernel module will not be produced
3251 if the WiFi driver is built into the kernel, in which case you still want the
3252 build to succeed instead of failing as a result of the package not being found.
3253 To accomplish this, assuming the package for the module was called
3254 <filename>kernel-module-examplewifi</filename>, you would use the
3255 following in the <filename>.conf</filename> file for the machine:
3256 <literallayout class='monospaced'>
3257 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi"
3258 </literallayout>
3259 </para>
3260 </glossdef>
3261 </glossentry>
3262
3263 <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
3264 <glossdef>
3265 <para>Specifies the list of hardware features the
3266 <link linkend='var-MACHINE'>MACHINE</link> supports.
3267 For example, including the "bluetooth" feature causes the
3268 <filename>bluez</filename> bluetooth daemon to be built and
3269 added to the image.
3270 It also causes the <filename>connman</filename> recipe
3271 to look at <filename>MACHINE_FEATURES</filename> and when it
3272 finds "bluetooth" there it enables the bluetooth
3273 support in ConnMan.
3274 </para>
3275
3276 <para>
3277 For a list of features supported by the Yocto Project as shipped,
3278 see the "<link linkend='ref-features-machine'>Machine</link>" section.
3279 </para>
3280 </glossdef>
3281 </glossentry>
3282
3283 <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm>
3284 <glossdef>
3285 <para>Features to be added to
3286 <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>
3287 if not also present in
3288 <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>.
3289 </para>
3290
3291 <para>
3292 This variable is set in the <filename>meta/conf/bitbake.conf</filename> file.
3293 It is not intended to be user-configurable.
3294 It is best to just reference the variable to see which machine features are
3295 being backfilled for all machine configurations.
3296 See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for
3297 more information.
3298 </para>
3299 </glossdef>
3300 </glossentry>
3301
3302 <glossentry id='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><glossterm>MACHINE_FEATURES_BACKFILL_CONSIDERED</glossterm>
3303 <glossdef>
3304 <para>Features from
3305 <filename><link linkend='var-MACHINE_FEATURES_BACKFILL'>MACHINE_FEATURES_BACKFILL</link></filename>
3306 that should not be backfilled (i.e. added to
3307 <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>)
3308 during the build.
3309 See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for
3310 more information.
3311 </para>
3312 </glossdef>
3313 </glossentry>
3314
3315 <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm>
3316 <glossdef>
3317 <para>
3318 Lists overrides specific to the current machine.
3319 By default, this list includes the value
3320 of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>.
3321 You can extend the list to apply variable overrides for
3322 classes of machines.
3323 For example, all QEMU emulated machines (e.g. qemuarm,
3324 qemux86, and so forth) include a common file named
3325 <filename>meta/conf/machine/include/qemu.inc</filename>
3326 that prepends <filename>MACHINEOVERRIDES</filename> with
3327 the following variable override:
3328 <literallayout class='monospaced'>
3329 MACHINEOVERRIDES =. "qemuall:"
3330 </literallayout>
3331 Applying an override like <filename>qemuall</filename>
3332 affects all QEMU emulated machines elsewhere.
3333 Here is an example from the
3334 <filename>connman-conf</filename> recipe:
3335 <literallayout class='monospaced'>
3336 SRC_URI_append_qemuall = "file://wired.config \
3337 file://wired-setup \
3338 "
3339 </literallayout>
3340 </para>
3341 </glossdef>
3342 </glossentry>
3343
3344 <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm>
3345 <glossdef>
3346 <para>The email address of the distribution maintainer.</para>
3347 </glossdef>
3348 </glossentry>
3349
3350 <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm>
3351 <glossdef>
3352 <para>
3353 Specifies additional paths from which the OpenEmbedded
3354 build system gets source code.
3355 When the build system searches for source code, it first
3356 tries the local download directory.
3357 If that location fails, the build system tries locations
3358 defined by
3359 <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>,
3360 the upstream source, and then locations specified by
3361 <filename>MIRRORS</filename> in that order.
3362 </para>
3363
3364 <para>
3365 Assuming your distribution
3366 (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>)
3367 is "poky", the default value for
3368 <filename>MIRRORS</filename> is defined in the
3369 <filename>conf/distro/poky.conf</filename> file in the
3370 <filename>meta-yocto</filename> Git repository.
3371 </para>
3372 </glossdef>
3373 </glossentry>
3374
3375 <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm>
3376 <glossdef>
3377 <para>
3378 Specifies a prefix has been added to
3379 <link linkend='var-PN'><filename>PN</filename></link> to create a special version
3380 of a recipe or package, such as a Multilib version.
3381 The variable is used in places where the prefix needs to be
3382 added to or removed from a the name (e.g. the
3383 <link linkend='var-BPN'><filename>BPN</filename></link> variable).
3384 <filename>MLPREFIX</filename> gets set when a prefix has been
3385 added to <filename>PN</filename>.
3386 </para>
3387 </glossdef>
3388 </glossentry>
3389
3390 <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm>
3391 <glossdef>
3392 <para>
3393 Controls creation of the <filename>modules-*.tgz</filename>
3394 file.
3395 Set this variable to "0" to disable creation of this
3396 file, which contains all of the kernel modules resulting
3397 from a kernel build.
3398 </para>
3399 </glossdef>
3400 </glossentry>
3401
3402 <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm>
3403 <glossdef>
3404 <para>
3405 Separates files for different machines such that you can build
3406 for multiple target machines using the same output directories.
3407 See the <link linkend='var-STAMP'><filename>STAMP</filename></link> variable
3408 for an example.
3409 </para>
3410 </glossdef>
3411 </glossentry>
3412
3413 </glossdiv>
3414
3415 <glossdiv id='var-glossary-n'><title>N</title>
3416
3417 <glossentry id='var-NATIVELSBSTRING'><glossterm>NATIVELSBSTRING</glossterm>
3418 <glossdef>
3419 <para>
3420 A string identifying the host distribution.
3421 Strings consist of the host distributor ID
3422 followed by the release, as reported by the
3423 <filename>lsb_release</filename> tool
3424 or as read from <filename>/etc/lsb-release</filename>.
3425 For example, when running a build on Ubuntu 12.10, the value
3426 is "Ubuntu-12.10".
3427 If this information is unable to be determined, the value
3428 resolves to "Unknown".
3429 </para>
3430 <para>
3431 This variable is used by default to isolate native shared
3432 state packages for different distributions (e.g. to avoid
3433 problems with <filename>glibc</filename> version
3434 incompatibilities).
3435 Additionally, the variable is checked against
3436 <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
3437 if that variable is set.
3438 </para>
3439 </glossdef>
3440 </glossentry>
3441
3442 <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm>
3443 <glossdef>
3444 <para>
3445 Prevents installation of all "recommended-only" packages.
3446 Recommended-only packages are packages installed only
3447 through the
3448 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
3449 variable).
3450 Setting the <filename>NO_RECOMMENDATIONS</filename> variable
3451 to "1" turns this feature on:
3452 <literallayout class='monospaced'>
3453 NO_RECOMMENDATIONS = "1"
3454 </literallayout>
3455 You can set this variable globally in your
3456 <filename>local.conf</filename> file or you can attach it to
3457 a specific image recipe by using the recipe name override:
3458 <literallayout class='monospaced'>
3459 NO_RECOMMENDATIONS_pn-&lt;target_image&gt; = "&lt;package_name&gt;"
3460 </literallayout>
3461 </para>
3462
3463 <para>
3464 It is important to realize that if you choose to not install
3465 packages using this variable and some other packages are
3466 dependent on them (i.e. listed in a recipe's
3467 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
3468 variable), the OpenEmbedded build system ignores your
3469 request and will install the packages to avoid dependency
3470 errors.
3471 <note>
3472 Some recommended packages might be required for certain
3473 system functionality, such as kernel modules.
3474 It is up to you to add packages with
3475 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
3476 variable.
3477 </note>
3478 </para>
3479
3480 <para>
3481 Support for this variable exists only when using the
3482 IPK and RPM packaging backend.
3483 Support does not exist for DEB.
3484 </para>
3485
3486 <para>
3487 See the
3488 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
3489 and the
3490 <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
3491 variables for related information.
3492 </para>
3493 </glossdef>
3494 </glossentry>
3495 </glossdiv>
3496
3497 <glossdiv id='var-glossary-o'><title>O</title>
3498
3499 <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm>
3500 <glossdef>
3501 <para>
3502 When a recipe inherits the
3503 <filename>binconfig.bbclass</filename> class, this variable
3504 specifies additional arguments passed to the "sed" command.
3505 The sed command alters any paths in configuration scripts
3506 that have been set up during compilation.
3507 Inheriting this class results in all paths in these scripts
3508 being changed to point into the
3509 <filename>sysroots/</filename> directory so that all builds
3510 that use the script will use the correct directories
3511 for the cross compiling layout.
3512 </para>
3513
3514 <para>
3515 See the <filename>meta/classes/binconfig.bbclass</filename>
3516 in the
3517 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
3518 for details on how this class applies these additional
3519 sed command arguments.
3520 For general information on the
3521 <filename>binconfig.bbclass</filename> class, see the
3522 "<link linkend='ref-classes-binconfig'>Binary Configuration Scripts - <filename>binconfig.bbclass</filename></link>"
3523 section.
3524 </para>
3525 </glossdef>
3526 </glossentry>
3527
3528 <glossentry id='var-OE_IMPORTS'><glossterm>OE_IMPORTS</glossterm>
3529 <glossdef>
3530 <para>
3531 An internal variable used to tell the OpenEmbedded build
3532 system what Python modules to import for every Python
3533 function run by the system.
3534 </para>
3535
3536 <note>
3537 Do not set this variable.
3538 It is for internal use only.
3539 </note>
3540 </glossdef>
3541 </glossentry>
3542
3543 <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm>
3544 <glossdef>
3545 <para>
3546 Controls how the OpenEmbedded build system spawns
3547 interactive terminals on the host development system
3548 (e.g. using the BitBake command with the
3549 <filename>-c devshell</filename> command-line option).
3550 For more information, see the
3551 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section
3552 in the Yocto Project Development Manual.
3553 </para>
3554
3555 <para>
3556 You can use the following values for the
3557 <filename>OE_TERMINAL</filename> variable:
3558 <literallayout class='monospaced'>
3559 auto
3560 gnome
3561 xfce
3562 rxvt
3563 screen
3564 konsole
3565 none
3566 </literallayout>
3567 <note>Konsole support only works for KDE 3.x.
3568 Also, "auto" is the default behavior for
3569 <filename>OE_TERMINAL</filename></note>
3570 </para>
3571 </glossdef>
3572 </glossentry>
3573
3574 <glossentry id='var-OEROOT'><glossterm>OEROOT</glossterm>
3575 <glossdef>
3576 <para>
3577 The directory from which the top-level build environment
3578 setup script is sourced.
3579 The Yocto Project makes two top-level build environment
3580 setup scripts available:
3581 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
3582 and
3583 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>.
3584 When you run one of these scripts, the
3585 <filename>OEROOT</filename> variable resolves to the
3586 directory that holds the script.
3587 </para>
3588
3589 <para>
3590 For additional information on how this variable is used,
3591 see the initialization scripts.
3592 </para>
3593 </glossdef>
3594 </glossentry>
3595
3596 <glossentry id='var-OLDEST_KERNEL'><glossterm>OLDEST_KERNEL</glossterm>
3597 <glossdef>
3598 <para>
3599 Declares the oldest version of the Linux kernel that the
3600 produced binaries must support.
3601 This variable is passed into the build of the Embedded
3602 GNU C Library (<filename>eglibc</filename>).
3603 </para>
3604
3605 <para>
3606 The default for this variable comes from the
3607 <filename>meta/conf/bitbake.conf</filename> configuration
3608 file.
3609 You can override this default by setting the variable
3610 in a custom distribution configuration file.
3611 </para>
3612 </glossdef>
3613 </glossentry>
3614
3615 <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm>
3616 <glossdef>
3617 <para>
3618 BitBake uses <filename>OVERRIDES</filename> to control
3619 what variables are overridden after BitBake parses
3620 recipes and configuration files.
3621 You can find more information on how overrides are handled
3622 in the BitBake Manual that is located at
3623 <filename>bitbake/doc/manual</filename> in the
3624 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
3625 </para>
3626 </glossdef>
3627 </glossentry>
3628 </glossdiv>
3629
3630 <glossdiv id='var-glossary-p'><title>P</title>
3631
3632 <glossentry id='var-P'><glossterm>P</glossterm>
3633 <glossdef>
3634 <para>The recipe name and version.
3635 <filename>P</filename> is comprised of the following:
3636 <literallayout class='monospaced'>
3637 ${PN}-${PV}
3638 </literallayout></para>
3639 </glossdef>
3640 </glossentry>
3641
3642 <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
3643 <glossdef>
3644 <para>The architecture of the resulting package or packages.</para>
3645 </glossdef>
3646 </glossentry>
3647
3648 <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm>
3649 <glossdef>
3650 <para>Enables easily adding packages to
3651 <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
3652 before <filename>${<link linkend='var-PN'>PN</link>}</filename>
3653 so that the packages can pick up files that would normally be
3654 included in the default package.</para>
3655 </glossdef>
3656 </glossentry>
3657
3658 <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm>
3659 <glossdef>
3660 <para>This variable, which is set in the <filename>local.conf</filename> configuration
3661 file found in the <filename>conf</filename> folder of the
3662 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
3663 specifies the package manager to use when packaging data.
3664 You can provide one or more arguments for the variable with the first
3665 argument being the package manager used to create images:
3666 <literallayout class='monospaced'>
3667 PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
3668 </literallayout>
3669 For information on build performance effects as a result of the
3670 package manager use, see
3671 <link linkend='ref-classes-package'>Packaging - <filename>package*.bbclass</filename></link>
3672 in this manual.
3673 </para>
3674 </glossdef>
3675 </glossentry>
3676
3677 <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm>
3678 <glossdef>
3679 <para>
3680 Lists packages that should not be installed into an image.
3681 For example:
3682 <literallayout class='monospaced'>
3683 PACKAGE_EXCLUDE = "&lt;package_name&gt; &lt;package_name&gt; &lt;package_name&gt; ..."
3684 </literallayout>
3685 You can set this variable globally in your
3686 <filename>local.conf</filename> file or you can attach it to
3687 a specific image recipe by using the recipe name override:
3688 <literallayout class='monospaced'>
3689 PACKAGE_EXCLUDE_pn-&lt;target_image&gt; = "&lt;package_name&gt;"
3690 </literallayout>
3691 </para>
3692
3693 <para>
3694 If you choose to not install
3695 a package using this variable and some other package is
3696 dependent on it (i.e. listed in a recipe's
3697 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>
3698 variable), the OpenEmbedded build system generates a fatal
3699 installation error.
3700 Because the build system halts the process with a fatal
3701 error, you can use the variable with an iterative
3702 development process to remove specific components from a
3703 system.
3704 </para>
3705
3706 <para>
3707 Support for this variable exists only when using the
3708 IPK and RPM packaging backend.
3709 Support does not exist for DEB.
3710 </para>
3711
3712 <para>
3713 See the
3714 <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>
3715 and the
3716 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>
3717 variables for related information.
3718 </para>
3719 </glossdef>
3720 </glossentry>
3721
3722 <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm>
3723 <glossdef>
3724 <para>Specifies the list of architectures compatible with the device CPU.
3725 This variable is useful when you build for several different devices that use
3726 miscellaneous processors such as XScale and ARM926-EJS).</para>
3727 </glossdef>
3728 </glossentry>
3729
3730 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
3731 <glossdef>
3732 <para>
3733 Defines one or more packages to include in an image when
3734 a specific item is included in
3735 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
3736 When setting the value, <filename>PACKAGE_GROUP</filename>
3737 should have the name of the feature item as an override.
3738 Here is an example:
3739 <literallayout class='monospaced'>
3740 PACKAGE_GROUP_widget = "package1 package2"
3741 </literallayout>
3742 In this example, if "widget" were added to
3743 <filename>IMAGE_FEATURES</filename>, "package1" and
3744 "package2" would be included in the image.
3745 <note>
3746 Packages installed by features defined through
3747 <filename>PACKAGE_GROUP</filename> are often package
3748 groups.
3749 While similarly named, you should not confuse the
3750 <filename>PACKAGE_GROUP</filename> variable with
3751 package groups, which are discussed elsewhere in the
3752 documentation.
3753 </note>
3754 </para>
3755 </glossdef>
3756 </glossentry>
3757
3758 <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm>
3759 <glossdef>
3760 <para>
3761 The final list of packages passed to the package manager
3762 for installation into the image.
3763 Because the package manager controls actual installation
3764 of all packages, the list of packages passed using
3765 <filename>PACKAGE_INSTALL</filename> is not the final list
3766 of packages that are actually installed.
3767 </para>
3768
3769 <para>
3770 This variable is internal to the image construction
3771 code.
3772 Use the
3773 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
3774 variable to specify packages for installation.
3775 </para>
3776 </glossdef>
3777 </glossentry>
3778
3779 <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm>
3780 <glossdef>
3781 <para>
3782 This variable provides a means of enabling or disabling
3783 features of a recipe on a per-recipe basis.
3784 <filename>PACKAGECONFIG</filename> blocks are defined
3785 in recipes when you specify features and then arguments
3786 that define feature behaviors.
3787 Here is the basic block structure:
3788 <literallayout class='monospaced'>
3789 PACKAGECONFIG ??= "f1 f2 f3 ..."
3790 PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1"
3791 PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2"
3792 PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3"
3793 </literallayout>
3794 The <filename>PACKAGECONFIG</filename>
3795 variable itself specifies a space-separated list of the
3796 features to enable.
3797 Following the features, you can determine the behavior of
3798 each feature by providing up to four order-dependent
3799 arguments, which are separated by commas.
3800 You can omit any argument you like but must retain the
3801 separating commas.
3802 The order is important and specifies the following:
3803 <orderedlist>
3804 <listitem><para>Extra arguments
3805 that should be added to the configure script
3806 argument list
3807 (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>)
3808 if the feature is enabled.</para></listitem>
3809 <listitem><para>Extra arguments
3810 that should be added to <filename>EXTRA_OECONF</filename>
3811 if the feature is disabled.
3812 </para></listitem>
3813 <listitem><para>Additional build dependencies
3814 (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>)
3815 that should be added if the feature is enabled.
3816 </para></listitem>
3817 <listitem><para>Additional runtime dependencies
3818 (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
3819 that should be added if the feature is enabled.
3820 </para></listitem>
3821 </orderedlist>
3822 </para>
3823
3824 <para>
3825 Consider the following
3826 <filename>PACKAGECONFIG</filename> block taken from the
3827 <filename>librsvg</filename> recipe.
3828 In this example the feature is <filename>croco</filename>,
3829 which has three arguments that determine the feature's
3830 behavior.
3831 <literallayout class='monospaced'>
3832 PACKAGECONFIG ??= "croco"
3833 PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco"
3834 </literallayout>
3835 The <filename>--with-croco</filename> and
3836 <filename>libcroco</filename> arguments apply only if
3837 the feature is enabled.
3838 In this case, <filename>--with-croco</filename> is
3839 added to the configure script argument list and
3840 <filename>libcroco</filename> is added to
3841 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>.
3842 On the other hand, if the feature is disabled say through
3843 a <filename>.bbappend</filename> file in another layer, then
3844 the second argument <filename>--without-croco</filename> is
3845 added to the configure script rather than
3846 <filename>--with-croco</filename>.
3847 </para>
3848
3849 <para>
3850 The basic <filename>PACKAGECONFIG</filename> structure
3851 previously described holds true regardless of whether you
3852 are creating a block or changing a block.
3853 When creating a block, use the structure inside your
3854 recipe.
3855 </para>
3856
3857 <para>
3858 If you want to change an existing
3859 <filename>PACKAGECONFIG</filename> block, you can do so
3860 one of two ways:
3861 <itemizedlist>
3862 <listitem><para><emphasis>Append file:</emphasis>
3863 Create an append file named
3864 <filename>&lt;recipename&gt;.bbappend</filename> in your
3865 layer and override the value of
3866 <filename>PACKAGECONFIG</filename>.
3867 You can either completely override the variable:
3868 <literallayout class='monospaced'>
3869 PACKAGECONFIG="f4 f5"
3870 </literallayout>
3871 Or, you can just amended the variable:
3872 <literallayout class='monospaced'>
3873 PACKAGECONFIG_append = " f4"
3874 </literallayout></para></listitem>
3875 <listitem><para><emphasis>Configuration file:</emphasis>
3876 This method is identical to changing the block
3877 through an append file except you edit your
3878 <filename>local.conf</filename> or
3879 <filename>&lt;mydistro&gt;.conf</filename> file.
3880 As with append files previously described,
3881 you can either completely override the variable:
3882 <literallayout class='monospaced'>
3883 PACKAGECONFIG_pn-&lt;recipename&gt;="f4 f5"
3884 </literallayout>
3885 Or, you can just amended the variable:
3886 <literallayout class='monospaced'>
3887 PACKAGECONFIG_append_pn-&lt;recipename&gt; = " f4"
3888 </literallayout></para></listitem>
3889 </itemizedlist>
3890 </para>
3891 </glossdef>
3892 </glossentry>
3893
3894 <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
3895 <glossdef>
3896 <para>The list of packages to be created from the recipe.
3897 The default value is the following:
3898 <literallayout class='monospaced'>
3899 ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN}
3900 </literallayout></para>
3901 </glossdef>
3902 </glossentry>
3903
3904 <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm>
3905 <glossdef>
3906 <para>
3907 A promise that your recipe satisfies runtime dependencies
3908 for optional modules that are found in other recipes.
3909 <filename>PACKAGES_DYNAMIC</filename>
3910 does not actually satisfy the dependencies, it only states that
3911 they should be satisfied.
3912 For example, if a hard, runtime dependency
3913 (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
3914 of another package is satisfied
3915 at build time through the <filename>PACKAGES_DYNAMIC</filename>
3916 variable, but a package with the module name is never actually
3917 produced, then the other package will be broken.
3918 Thus, if you attempt to include that package in an image,
3919 you will get a dependency failure from the packaging system
3920 during <filename>do_rootfs</filename>.
3921 </para>
3922 <para>
3923 Typically, if there is a chance that such a situation can
3924 occur and the package that is not created is valid
3925 without the dependency being satisfied, then you should use
3926 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>
3927 (a soft runtime dependency) instead of
3928 <filename>RDEPENDS</filename>.
3929 </para>
3930
3931 <para>
3932 For an example of how to use the <filename>PACKAGES_DYNAMIC</filename>
3933 variable when you are splitting packages, see the
3934 "<ulink url='&YOCTO_DOCS_DEV_URL;#handling-optional-module-packaging'>Handling Optional Module Packaging</ulink>" section
3935 in the Yocto Project Development Manual.
3936 </para>
3937 </glossdef>
3938 </glossentry>
3939
3940 <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm>
3941 <glossdef>
3942 <para>
3943 Extra options that are passed to the
3944 <filename>make</filename> command during the
3945 <filename>do_compile</filename> task in order to specify
3946 parallel compilation.
3947 This variable is usually in the form
3948 <filename>-j 4</filename>, where the number
3949 represents the maximum number of parallel threads make can
3950 run.
3951 If you development host supports multiple cores a good
3952 rule of thumb is to set this variable to twice the number
3953 of cores on the host.
3954 <note>
3955 Individual recipes might clear out this variable if
3956 the software being built has problems running its
3957 <filename>make</filename> process in parallel.
3958 </note>
3959 </para>
3960 </glossdef>
3961 </glossentry>
3962
3963 <glossentry id='var-PARALLEL_MAKEINST'><glossterm>PARALLEL_MAKEINST</glossterm>
3964 <glossdef>
3965 <para>
3966 Extra options passed to the
3967 <filename>make install</filename> command during the
3968 <filename>do_install</filename> task in order to specify
3969 parallel installation.
3970 This variable defaults to the value of
3971 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>.
3972 <note>
3973 Individual recipes might clear out this variable if
3974 the software being built has problems running its
3975 <filename>make install</filename> process in parallel.
3976 </note>
3977 </para>
3978 </glossdef>
3979 </glossentry>
3980
3981
3982
3983
3984PARALLEL_MAKEINST with the description ".
3985
3986
3987
3988
3989
3990 <glossentry id='var-PATCHRESOLVE'><glossterm>PATCHRESOLVE</glossterm>
3991 <glossdef>
3992 <para>
3993 Determines the action to take when a patch fails.
3994 You can set this variable to one of two values: "noop" and
3995 "user".
3996 </para>
3997
3998 <para>
3999 The default value of "noop" causes the build to simply fail
4000 when the OpenEmbedded build system cannot successfully
4001 apply a patch.
4002 Setting the value to "user" causes the build system to
4003 launch a shell and places you in the right location so that
4004 you can manually resolve the conflicts.
4005 </para>
4006
4007 <para>
4008 Set this variable in your
4009 <filename>local.conf</filename> file.
4010 </para>
4011 </glossdef>
4012 </glossentry>
4013
4014 <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm>
4015 <glossdef>
4016 <para>
4017 Specifies the utility used to apply patches for a recipe
4018 during <filename>do_patch</filename>.
4019 You can specify one of three utilities: "patch", "quilt", or
4020 "git".
4021 The default utility used is "quilt" except for the
4022 quilt-native recipe itself.
4023 Because the quilt tool is not available at the
4024 time quilt-native is being patched, it uses "patch".
4025 </para>
4026
4027 <para>
4028 If you wish to use an alternative patching tool, set the
4029 variable in the recipe using one of the following:
4030 <literallayout class='monospaced'>
4031 PATCHTOOL = "patch"
4032 PATCHTOOL = "quilt"
4033 PATCHTOOL = "git"
4034 </literallayout>
4035 </para>
4036 </glossdef>
4037 </glossentry>
4038
4039 <glossentry id='var-PE'><glossterm>PE</glossterm>
4040 <glossdef>
4041 <para>
4042 the epoch of the recipe.
4043 By default, this variable is unset.
4044 The field is used to make upgrades possible when the
4045 versioning scheme changes in some backwards incompatible
4046 way.
4047 </para>
4048 </glossdef>
4049 </glossentry>
4050
4051 <glossentry id='var-PF'><glossterm>PF</glossterm>
4052 <glossdef>
4053 <para>Specifies the recipe or package name and includes all version and revision
4054 numbers (i.e. <filename>eglibc-2.13-r20+svnr15508/</filename> and
4055 <filename>bash-4.2-r1/</filename>).
4056 This variable is comprised of the following:
4057 <literallayout class='monospaced'>
4058 ${<link linkend='var-PN'>PN</link>}-${<link linkend='var-EXTENDPE'>EXTENDPE</link>}${<link linkend='var-PV'>PV</link>}-${<link linkend='var-PR'>PR</link>}
4059 </literallayout></para>
4060 </glossdef>
4061 </glossentry>
4062
4063 <glossentry id='var-PKGD'><glossterm>PKGD</glossterm>
4064 <glossdef>
4065 <para>
4066 Points to the destination directory for files to be
4067 packaged before they are split into individual packages.
4068 This directory defaults to the following:
4069 <literallayout class='monospaced'>
4070 ${WORKDIR}/package
4071 </literallayout>
4072 Do not change this default.
4073 </para>
4074 </glossdef>
4075 </glossentry>
4076
4077 <glossentry id='var-PKGDATA_DIR'><glossterm>PKGDATA_DIR</glossterm>
4078 <glossdef>
4079 <para>
4080 Points to a shared, global-state directory that holds data
4081 generated during the packaging process.
4082 During the packaging process, the
4083 <filename>do_packagedata</filename> task packages
4084 data for each recipe and installs it into this temporary,
4085 shared area.
4086 </para>
4087 </glossdef>
4088 </glossentry>
4089
4090 <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm>
4091 <glossdef>
4092 <para>
4093 Points to the parent directory for files to be packaged
4094 after they have been split into individual packages.
4095 This directory defaults to the following:
4096 <literallayout class='monospaced'>
4097 ${WORKDIR}/packages-split
4098 </literallayout>
4099 Under this directory, the build system creates
4100 directories for each package specified in
4101 <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>.
4102 Do not change this default.
4103 </para>
4104 </glossdef>
4105 </glossentry>
4106
4107 <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm>
4108 <glossdef>
4109 <para>
4110 Points to a temporary work area used by the
4111 <filename>do_package</filename> task to write output
4112 from the <filename>do_packagedata</filename> task.
4113 The <filename>PKGDESTWORK</filename> location defaults to
4114 the following:
4115 <literallayout class='monospaced'>
4116 ${WORKDIR}/pkgdata
4117 </literallayout>
4118 The <filename>do_packagedata</filename> task then packages
4119 the data in the temporary work area and installs it into a
4120 shared directory pointed to by
4121 <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>.
4122 </para>
4123
4124 <para>
4125 Do not change this default.
4126 </para>
4127 </glossdef>
4128 </glossentry>
4129
4130 <glossentry id='var-PN'><glossterm>PN</glossterm>
4131 <glossdef>
4132 <para>This variable can have two separate functions depending on the context: a recipe
4133 name or a resulting package name.</para>
4134 <para><filename>PN</filename> refers to a recipe name in the context of a file used
4135 by the OpenEmbedded build system as input to create a package.
4136 The name is normally extracted from the recipe file name.
4137 For example, if the recipe is named
4138 <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename>
4139 will be "expat".</para>
4140 <para>
4141 The variable refers to a package name in the context of a file created or produced by the
4142 OpenEmbedded build system.</para>
4143 <para>If applicable, the <filename>PN</filename> variable also contains any special
4144 suffix or prefix.
4145 For example, using <filename>bash</filename> to build packages for the native
4146 machine, <filename>PN</filename> is <filename>bash-native</filename>.
4147 Using <filename>bash</filename> to build packages for the target and for Multilib,
4148 <filename>PN</filename> would be <filename>bash</filename> and
4149 <filename>lib64-bash</filename>, respectively.
4150 </para>
4151 </glossdef>
4152 </glossentry>
4153
4154 <glossentry id='var-PR'><glossterm>PR</glossterm>
4155 <glossdef>
4156 <para>The revision of the recipe.
4157 The default value for this variable is "r0".
4158 </para>
4159 </glossdef>
4160 </glossentry>
4161
4162 <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm>
4163 <glossdef>
4164 <para>
4165 If multiple recipes provide an item, this variable
4166 determines which recipe should be given preference.
4167 You should always suffix the variable with the name of the
4168 provided item, and you should set it to the
4169 <link linkend='var-PN'><filename>PN</filename></link>
4170 of the recipe to which you want to give precedence.
4171 Here is an example:
4172 <literallayout class='monospaced'>
4173 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
4174 </literallayout>
4175 </para>
4176 </glossdef>
4177 </glossentry>
4178
4179 <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm>
4180 <glossdef>
4181 <para>
4182 If there are multiple versions of recipes available, this
4183 variable determines which recipe should be given preference.
4184 You must always suffix the variable with the
4185 <link linkend='var-PN'><filename>PN</filename></link>
4186 you want to select, and you should set to the
4187 <link linkend='var-PV'><filename>PV</filename></link>
4188 accordingly for precedence.
4189 You can use the "<filename>%</filename>" character as a
4190 wildcard to match any number of characters, which can be
4191 useful when specifying versions that contain long revision
4192 numbers that could potentially change.
4193 Here are two examples:
4194 <literallayout class='monospaced'>
4195 PREFERRED_VERSION_python = "2.6.6"
4196 PREFERRED_VERSION_linux-yocto = "3.0+git%"
4197 </literallayout>
4198 </para>
4199 </glossdef>
4200 </glossentry>
4201
4202 <glossentry id='var-PREMIRRORS'><glossterm>PREMIRRORS</glossterm>
4203 <glossdef>
4204 <para>
4205 Specifies additional paths from which the OpenEmbedded
4206 build system gets source code.
4207 When the build system searches for source code, it first
4208 tries the local download directory.
4209 If that location fails, the build system tries locations
4210 defined by <filename>PREMIRRORS</filename>, the upstream
4211 source, and then locations specified by
4212 <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
4213 in that order.
4214 </para>
4215
4216 <para>
4217 Assuming your distribution
4218 (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>)
4219 is "poky", the default value for
4220 <filename>PREMIRRORS</filename> is defined in the
4221 <filename>conf/distro/poky.conf</filename> file in the
4222 <filename>meta-yocto</filename> Git repository.
4223 </para>
4224
4225 <para>
4226 Typically, you could add a specific server for the
4227 build system to attempt before any others by adding
4228 something like the following to the
4229 <filename>local.conf</filename> configuration file in the
4230 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
4231 <literallayout class='monospaced'>
4232 PREMIRRORS_prepend = "\
4233 git://.*/.* http://www.yoctoproject.org/sources/ \n \
4234 ftp://.*/.* http://www.yoctoproject.org/sources/ \n \
4235 http://.*/.* http://www.yoctoproject.org/sources/ \n \
4236 https://.*/.* http://www.yoctoproject.org/sources/ \n"
4237 </literallayout>
4238 These changes cause the build system to intercept
4239 Git, FTP, HTTP, and HTTPS requests and direct them to
4240 the <filename>http://</filename> sources mirror.
4241 You can use <filename>file://</filename> URLs to point
4242 to local directories or network shares as well.
4243 </para>
4244 </glossdef>
4245 </glossentry>
4246
4247 <glossentry id='var-PRINC'><glossterm>PRINC</glossterm>
4248 <glossdef>
4249 <para>Causes the <link linkend='var-PR'><filename>PR</filename></link>
4250 variable of <filename>.bbappend</filename> files to
4251 dynamically increment.
4252 This increment minimizes the impact of layer ordering.</para>
4253 <para>In order to ensure multiple <filename>.bbappend</filename> files can co-exist,
4254 <filename>PRINC</filename> should be self referencing.
4255 This variable defaults to 0.</para>
4256 <para>Following is an example that increments <filename>PR</filename> by two:
4257 <literallayout class='monospaced'>
4258 PRINC := "${@int(PRINC) + 2}"
4259 </literallayout>
4260 It is advisable not to use strings such as ".= '.1'" with the variable because
4261 this usage is very sensitive to layer ordering.
4262 You should avoid explicit assignments as they cannot
4263 adequately represent multiple
4264 <filename>.bbappend</filename> files.</para>
4265 </glossdef>
4266 </glossentry>
4267
4268 <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
4269 <glossdef>
4270 <para>
4271 A list of aliases that a recipe also provides.
4272 These aliases are useful for satisfying dependencies of
4273 other recipes during the build (as specified by
4274 <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>).
4275 <note>
4276 A recipe's own
4277 <filename><link linkend='var-PN'>PN</link></filename>
4278 is implicitly already in its
4279 <filename>PROVIDES</filename> list.
4280 </note>
4281 </para>
4282 </glossdef>
4283 </glossentry>
4284
4285 <glossentry id='var-PV'><glossterm>PV</glossterm>
4286 <glossdef>
4287 <para>The version of the recipe.
4288 The version is normally extracted from the recipe filename.
4289 For example, if the recipe is named
4290 <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename>
4291 will be "2.0.1".
4292 <filename>PV</filename> is generally not overridden within
4293 a recipe unless it is building an unstable (i.e. development) version from a source code repository
4294 (e.g. Git or Subversion).
4295 </para>
4296 </glossdef>
4297 </glossentry>
4298
4299 </glossdiv>
4300
4301<!-- <glossdiv id='var-glossary-q'><title>Q</title>-->
4302<!-- </glossdiv>-->
4303
4304 <glossdiv id='var-glossary-r'><title>R</title>
4305
4306 <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
4307 <glossdef>
4308 <para>
4309 The list of packages that conflict with packages.
4310 Note that packages will not be installed if conflicting
4311 packages are not first removed.
4312 </para>
4313
4314 <para>
4315 Like all package-controlling variables, you must always use
4316 them in conjunction with a package name override.
4317 Here is an example:
4318 <literallayout class='monospaced'>
4319 RCONFLICTS_${PN} = "another-conflicting-package-name"
4320 </literallayout>
4321 </para>
4322
4323 <para>
4324 BitBake, which the OpenEmbedded build system uses, supports
4325 specifying versioned dependencies.
4326 Although the syntax varies depending on the packaging
4327 format, BitBake hides these differences from you.
4328 Here is the general syntax to specify versions with
4329 the <filename>RCONFLICTS</filename> variable:
4330 <literallayout class='monospaced'>
4331 RCONFLICTS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)"
4332 </literallayout>
4333 For <filename>operator</filename>, you can specify the
4334 following:
4335 <literallayout class='monospaced'>
4336 =
4337 &lt;
4338 &gt;
4339 &lt;=
4340 &gt;=
4341 </literallayout>
4342 For example, the following sets up a dependency on version
4343 1.2 or greater of the package <filename>foo</filename>:
4344 <literallayout class='monospaced'>
4345 RCONFLICTS_${PN} = "foo (>= 1.2)"
4346 </literallayout>
4347 </para>
4348 </glossdef>
4349 </glossentry>
4350
4351 <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm>
4352 <glossdef>
4353 <para>
4354 Lists a package's runtime dependencies (i.e. other packages)
4355 that must be installed in order for the built package to run
4356 correctly.
4357 If a package in this list cannot be found during the build,
4358 you will get a build error.
4359 </para>
4360
4361 <para>
4362 When you use the <filename>RDEPENDS</filename> variable
4363 in a recipe, you are essentially stating that the recipe's
4364 <filename>do_build</filename> task depends on the existence
4365 of a specific package.
4366 Consider this simple example for two recipes named "a" and
4367 "b" that produce similarly named packages.
4368 In this example, the <filename>RDEPENDS</filename>
4369 statement appears in the "a" recipe:
4370 <literallayout class='monospaced'>
4371 RDEPENDS_${PN} = "b"
4372 </literallayout>
4373 Here, the dependency is such that the
4374 <filename>do_build</filename> task for recipe "a" depends
4375 on the <filename>do_package_write</filename> task
4376 of recipe "b".
4377 This means the package file for "b" must be available when
4378 the output for recipe "a" has been completely built.
4379 More importantly, package "a" will be marked as depending
4380 on package "b" in a manner that is understood by the
4381 package manager in use (i.e. rpm, opkg, or dpkg).
4382 </para>
4383
4384 <para>
4385 The names of the packages you list within
4386 <filename>RDEPENDS</filename> must be the names of other
4387 packages - they cannot be recipe names.
4388 Although package names and recipe names usually match,
4389 the important point here is that you are
4390 providing package names within the
4391 <filename>RDEPENDS</filename> variable.
4392 For an example of the default list of packages created from
4393 a recipe, see the
4394 <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
4395 variable.
4396 </para>
4397
4398 <para>
4399 Because the <filename>RDEPENDS</filename> variable applies
4400 to packages being built, you should always use the variable
4401 in a form with an attached package name.
4402 For example, suppose you are building a development package
4403 that depends on the <filename>perl</filename> package.
4404 In this case, you would use the following
4405 <filename>RDEPENDS</filename> statement:
4406 <literallayout class='monospaced'>
4407 RDEPENDS_${PN}-dev += "perl"
4408 </literallayout>
4409 In the example, the development package depends on
4410 the <filename>perl</filename> package.
4411 Thus, the <filename>RDEPENDS</filename> variable has the
4412 <filename>${PN}-dev</filename> package name as part of the
4413 variable.
4414 </para>
4415
4416 <para>
4417 The package name you attach to the
4418 <filename>RDEPENDS</filename> variable must appear
4419 as it would in the <filename>PACKAGES</filename>
4420 namespace before any renaming of the output package by
4421 classes like <filename>debian.bbclass</filename>.
4422 </para>
4423
4424 <para>
4425 In many cases you do not need to explicitly add
4426 runtime dependencies using
4427 <filename>RDEPENDS</filename> since some automatic
4428 handling occurs:
4429 <itemizedlist>
4430 <listitem><para><emphasis><filename>shlibdeps</filename></emphasis>: If
4431 a runtime package contains a shared library
4432 (<filename>.so</filename>), the build
4433 processes the library in order to determine other
4434 libraries to which it is dynamically linked.
4435 The build process adds these libraries to
4436 <filename>RDEPENDS</filename> when creating the runtime
4437 package.</para></listitem>
4438 <listitem><para><emphasis><filename>pcdeps</filename></emphasis>: If
4439 the package ships a <filename>pkg-config</filename>
4440 information file, the build process uses this file
4441 to add items to the <filename>RDEPENDS</filename>
4442 variable to create the runtime packages.
4443 </para></listitem>
4444 </itemizedlist>
4445 </para>
4446
4447 <para>
4448 BitBake, which the OpenEmbedded build system uses, supports
4449 specifying versioned dependencies.
4450 Although the syntax varies depending on the packaging
4451 format, BitBake hides these differences from you.
4452 Here is the general syntax to specify versions with
4453 the <filename>RDEPENDS</filename> variable:
4454 <literallayout class='monospaced'>
4455 RDEPENDS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)"
4456 </literallayout>
4457 For <filename>operator</filename>, you can specify the
4458 following:
4459 <literallayout class='monospaced'>
4460 =
4461 &lt;
4462 &gt;
4463 &lt;=
4464 &gt;=
4465 </literallayout>
4466 For example, the following sets up a dependency on version
4467 1.2 or greater of the package <filename>foo</filename>:
4468 <literallayout class='monospaced'>
4469 RDEPENDS_${PN} = "foo (>= 1.2)"
4470 </literallayout>
4471 </para>
4472
4473 <para>
4474 For information on build-time dependencies, see the
4475 <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>
4476 variable.
4477 </para>
4478 </glossdef>
4479 </glossentry>
4480
4481 <glossentry id='var-RM_OLD_IMAGE'><glossterm>RM_OLD_IMAGE</glossterm>
4482 <glossdef>
4483 <para>
4484 Reclaims disk space by removing previously built
4485 versions of the same image from the
4486 <filename>images</filename> directory pointed to by the
4487 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>
4488 variable.
4489 </para>
4490
4491 <para>
4492 Set this variable to "1" in your
4493 <filename>local.conf</filename> file to remove these
4494 images.
4495 </para>
4496 </glossdef>
4497 </glossentry>
4498
4499 <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm>
4500 <glossdef>
4501 <para>
4502 With <filename>rm_work</filename> enabled, this
4503 variable specifies a list of recipes whose work directories
4504 should not be removed.
4505 See the "<link linkend='ref-classes-rm-work'>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></link>"
4506 section for more details.
4507 </para>
4508 </glossdef>
4509 </glossentry>
4510
4511 <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm>
4512 <glossdef>
4513 <para>
4514 Added by classes to run post processing commands once the
4515 OpenEmbedded build system has created the root filesystem.
4516 You can specify shell commands separated by semicolons:
4517 <literallayout class='monospaced'>
4518 ROOTFS_POSTPROCESS_COMMAND += "&lt;shell_command&gt;; ... "
4519 </literallayout>
4520 If you need to pass the path to the root filesystem within
4521 the command, you can use
4522 <filename>${IMAGE_ROOTFS}</filename>, which points to
4523 the root filesystem image.
4524 </para>
4525 </glossdef>
4526 </glossentry>
4527
4528 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm>
4529 <glossdef>
4530 <para>
4531 A list of package name aliases that a package also provides.
4532 These aliases are useful for satisfying runtime dependencies
4533 of other packages both during the build and on the target
4534 (as specified by
4535 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>).
4536 <note>
4537 A package's own name is implicitly already in its
4538 <filename>RPROVIDES</filename> list.
4539 </note>
4540 </para>
4541 <para>
4542 As with all package-controlling variables, you must always
4543 use the variable in conjunction with a package name override.
4544 Here is an example:
4545 <literallayout class='monospaced'>
4546 RPROVIDES_${PN} = "widget-abi-2"
4547 </literallayout>
4548 </para>
4549 </glossdef>
4550 </glossentry>
4551
4552 <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm>
4553 <glossdef>
4554 <para>
4555 A list of packages that extends the usability of a package
4556 being built.
4557 The package being built does not depend on this list of
4558 packages in order to successfully build, but needs them for
4559 the extended usability.
4560 To specify runtime dependencies for packages, see the
4561 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>
4562 variable.
4563 </para>
4564
4565 <para>
4566 The OpenEmbedded build process automatically installs the
4567 list of packages as part of the built package.
4568 However, you can remove these packages later if you want.
4569 If, during the build, a package from the
4570 <filename>RRECOMMENDS</filename> list cannot be
4571 found, the build process continues without an error.
4572 </para>
4573
4574 <para>
4575 You can also prevent packages in the list from being
4576 installed by using several variables.
4577 See the
4578 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>,
4579 <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>,
4580 and
4581 <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
4582 variables for more information.
4583 </para>
4584
4585 <para>
4586 Because the <filename>RRECOMMENDS</filename> variable
4587 applies to packages being built, you should always attach
4588 an override to the variable to specify the particular
4589 package whose usability is being extended.
4590 For example, suppose you are building a development package
4591 that is extended to support wireless functionality.
4592 In this case, you would use the following:
4593 <literallayout class='monospaced'>
4594 RRECOMMENDS_${PN}-dev += "&lt;wireless_package_name&gt;"
4595 </literallayout>
4596 In the example, the package name
4597 (<filename>${<link linkend='var-PN'>PN</link>}-dev</filename>)
4598 must appear as it would in the
4599 <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
4600 namespace before any renaming of the output package by
4601 classes such as <filename>debian.bbclass</filename>.
4602 </para>
4603
4604 <para>
4605 BitBake, which the OpenEmbedded build system uses, supports
4606 specifying versioned recommends.
4607 Although the syntax varies depending on the packaging
4608 format, BitBake hides these differences from you.
4609 Here is the general syntax to specify versions with
4610 the <filename>RRECOMMENDS</filename> variable:
4611 <literallayout class='monospaced'>
4612 RRECOMMENDS_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)"
4613 </literallayout>
4614 For <filename>operator</filename>, you can specify the
4615 following:
4616 <literallayout class='monospaced'>
4617 =
4618 &lt;
4619 &gt;
4620 &lt;=
4621 &gt;=
4622 </literallayout>
4623 For example, the following sets up a recommend on version
4624 1.2 or greater of the package <filename>foo</filename>:
4625 <literallayout class='monospaced'>
4626 RRECOMMENDS_${PN} = "foo (>= 1.2)"
4627 </literallayout>
4628 </para>
4629 </glossdef>
4630 </glossentry>
4631
4632 <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
4633 <glossdef>
4634 <para>
4635 A list of packages replaced by a package.
4636 The package manager uses this variable to determine which
4637 package should be installed to replace other package(s)
4638 during an upgrade.
4639 In order to also have the other package(s) removed at the
4640 same time, you must add the name of the other
4641 package to the
4642 <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable.
4643 </para>
4644 <para>
4645 As with all package-controlling variables, you must use
4646 this variable in conjunction with a package name
4647 override.
4648 Here is an example:
4649 <literallayout class='monospaced'>
4650 RREPLACES_${PN} = "other-package-being-replaced"
4651 </literallayout>
4652 </para>
4653
4654 <para>
4655 BitBake, which the OpenEmbedded build system uses, supports
4656 specifying versioned replacements.
4657 Although the syntax varies depending on the packaging
4658 format, BitBake hides these differences from you.
4659 Here is the general syntax to specify versions with
4660 the <filename>RREPLACES</filename> variable:
4661 <literallayout class='monospaced'>
4662 RREPLACES_${PN} = "&lt;package&gt; (&lt;operator&gt; &lt;version&gt;)"
4663 </literallayout>
4664 For <filename>operator</filename>, you can specify the
4665 following:
4666 <literallayout class='monospaced'>
4667 =
4668 &lt;
4669 &gt;
4670 &lt;=
4671 &gt;=
4672 </literallayout>
4673 For example, the following sets up a replacement using
4674 version 1.2 or greater of the package
4675 <filename>foo</filename>:
4676 <literallayout class='monospaced'>
4677 RREPLACES_${PN} = "foo (>= 1.2)"
4678 </literallayout>
4679 </para>
4680 </glossdef>
4681 </glossentry>
4682
4683 <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm>
4684 <glossdef>
4685 <para>
4686 A list of additional packages that you can suggest for
4687 installation by the package manager at the time a package
4688 is installed.
4689 Not all package managers support this functionality.
4690 </para>
4691 <para>
4692 As with all package-controlling variables, you must always
4693 use this variable in conjunction with a package name
4694 override.
4695 Here is an example:
4696 <literallayout class='monospaced'>
4697 RSUGGESTS_${PN} = "useful-package another-package"
4698 </literallayout>
4699 </para>
4700 </glossdef>
4701 </glossentry>
4702
4703 </glossdiv>
4704
4705 <glossdiv id='var-glossary-s'><title>S</title>
4706
4707 <glossentry id='var-S'><glossterm>S</glossterm>
4708 <glossdef>
4709 <para>
4710 The location in the
4711 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
4712 where unpacked recipe source code resides.
4713 This location is within the working directory
4714 (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>),
4715 which is not static.
4716 The unpacked source location depends on the recipe name
4717 (<filename><link linkend='var-PN'>PN</link></filename>) and
4718 recipe version
4719 (<filename><link linkend='var-PV'>PV</link></filename>) as
4720 follows:
4721 <literallayout class='monospaced'>
4722 ${WORKDIR}/${PN}-${PV}
4723 </literallayout>
4724 As an example, assume a
4725 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
4726 top-level folder named <filename>poky</filename> and a
4727 default Build Directory at <filename>poky/build</filename>.
4728 In this case, the working directory the build system uses
4729 to keep the unpacked recipe for <filename>db</filename>
4730 is the following:
4731 <literallayout class='monospaced'>
4732 ~/poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19
4733 </literallayout>
4734 </para>
4735 </glossdef>
4736 </glossentry>
4737
4738 <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm>
4739 <glossdef>
4740 <para>
4741 A list of the host distribution identifiers that the
4742 build system has been tested against.
4743 Identifiers consist of the host distributor ID
4744 followed by the release,
4745 as reported by the <filename>lsb_release</filename> tool
4746 or as read from <filename>/etc/lsb-release</filename>.
4747 Separate the list items with explicit newline
4748 characters (<filename>\n</filename>).
4749 If <filename>SANITY_TESTED_DISTROS</filename> is not empty
4750 and the current value of
4751 <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link>
4752 does not appear in the list, then the build system reports
4753 a warning that indicates the current host distribution has
4754 not been tested as a build host.
4755 </para>
4756 </glossdef>
4757 </glossentry>
4758
4759 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
4760 <glossdef>
4761 <para>
4762 The target architecture for the SDK.
4763 Typically, you do not directly set this variable.
4764 Instead, use
4765 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
4766 </para>
4767 </glossdef>
4768 </glossentry>
4769
4770 <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
4771 <glossdef>
4772 <para>
4773 The base name for SDK output files.
4774 The name is derived from the
4775 <link linkend='var-DISTRO'><filename>DISTRO</filename></link>,
4776 <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
4777 <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>,
4778 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
4779 and
4780 <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>
4781 variables:
4782 <literallayout class='monospaced'>
4783 SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}"
4784 </literallayout>
4785 </para>
4786 </glossdef>
4787 </glossentry>
4788
4789 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm>
4790 <glossdef>
4791 <para>Equivalent to
4792 <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>.
4793 However, this variable applies to the SDK generated from an
4794 image using the following command:
4795 <literallayout class='monospaced'>
4796 $ bitbake -c populate_sdk imagename
4797 </literallayout>
4798 </para>
4799 </glossdef>
4800 </glossentry>
4801
4802 <glossentry id='var-SDKMACHINE'><glossterm>SDKMACHINE</glossterm>
4803 <glossdef>
4804 <para>
4805 The architecture of the machine that runs Application
4806 Development Toolkit (ADT) items.
4807 In other words, packages are built so that they will run
4808 on the target you specify with the argument.
4809 This implies that you can build out ADT/SDK items that
4810 run on an architecture other than that of your build host.
4811 For example, you can use an x86_64-based build host to
4812 create packages that will run on an i686-based
4813 SDK Machine.
4814 </para>
4815
4816 <para>
4817 You can use "i686" and "x86_64" as possible values for this
4818 variable.
4819 The variable defaults to "i686" and is set in the
4820 <filename>local.conf</filename> file in the
4821 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
4822 <literallayout class='monospaced'>
4823 SDKMACHINE ?= "i686"
4824 </literallayout>
4825 </para>
4826 </glossdef>
4827 </glossentry>
4828
4829 <glossentry id='var-SECTION'><glossterm>SECTION</glossterm>
4830 <glossdef>
4831 <para>The section in which packages should be categorized.
4832 Package management utilities can make use of this variable.</para>
4833 </glossdef>
4834 </glossentry>
4835
4836 <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm>
4837 <glossdef>
4838 <para>
4839 The variable takes the value of
4840 <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename>
4841 unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1".
4842 In this case the value of
4843 <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used.
4844 </para>
4845 </glossdef>
4846 </glossentry>
4847
4848 <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm>
4849 <glossdef>
4850 <para>
4851 Defines a serial console (TTY) to enable using getty.
4852 Provide a value that specifies the baud rate followed by
4853 the TTY device name separated by a space.
4854 You cannot specify more than one TTY device:
4855 <literallayout class='monospaced'>
4856 SERIAL_CONSOLE = "115200 ttyS0"
4857 </literallayout>
4858 <note>
4859 The <filename>SERIAL_CONSOLE</filename> variable
4860 is deprecated.
4861 Please use the
4862 <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>
4863 variable.
4864 </note>
4865 </para>
4866 </glossdef>
4867 </glossentry>
4868
4869 <glossentry id='var-SERIAL_CONSOLES'><glossterm>SERIAL_CONSOLES</glossterm>
4870 <glossdef>
4871 <para>
4872 Defines the serial consoles (TTYs) to enable using getty.
4873 Provide a value that specifies the baud rate followed by
4874 the TTY device name separated by a semicolon.
4875 Use spaces to separate multiple devices:
4876 <literallayout class='monospaced'>
4877 SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1"
4878 </literallayout>
4879 </para>
4880 </glossdef>
4881 </glossentry>
4882
4883 <glossentry id='var-SERIAL_CONSOLES_CHECK'><glossterm>SERIAL_CONSOLES_CHECK</glossterm>
4884 <glossdef>
4885 <para>
4886 Similar to
4887 <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>
4888 except the device is checked for existence before attempting
4889 to enable it.
4890 This variable is currently only supported with SysVinit
4891 (i.e. not with systemd).
4892 </para>
4893 </glossdef>
4894 </glossentry>
4895
4896 <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm>
4897 <glossdef>
4898 <para>
4899 A list of recipe dependencies that should not be used to
4900 determine signatures of tasks from one recipe when they
4901 depend on tasks from another recipe.
4902 For example:
4903 <literallayout class='monospaced'>
4904 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2"
4905 </literallayout>
4906 In this example, <filename>intone</filename> depends on
4907 <filename>mplayer2</filename>.
4908 </para>
4909
4910 <para>
4911 Use of this variable is one mechanism to remove dependencies
4912 that affect task signatures and thus force rebuilds when a
4913 recipe changes.
4914 <caution>
4915 If you add an inappropriate dependency for a recipe
4916 relationship, the software might break during
4917 runtime if the interface of the second recipe was
4918 changed after the first recipe had been built.
4919 </caution>
4920 </para>
4921 </glossdef>
4922 </glossentry>
4923
4924 <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm>
4925 <glossdef>
4926 <para>
4927 A list of recipes that are completely stable and will
4928 never change.
4929 The ABI for the recipes in the list are presented by
4930 output from the tasks run to build the recipe.
4931 Use of this variable is one way to remove dependencies from
4932 one recipe on another that affect task signatures and
4933 thus force rebuilds when the recipe changes.
4934 <caution>
4935 If you add an inappropriate variable to this list,
4936 the software might break at runtime if the
4937 interface of the recipe was changed after the other
4938 had been built.
4939 </caution>
4940 </para>
4941 </glossdef>
4942 </glossentry>
4943
4944 <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm>
4945 <glossdef>
4946 <para>
4947 Specifies the number of bits for the target system CPU.
4948 The value should be either "32" or "64".
4949 </para>
4950 </glossdef>
4951 </glossentry>
4952
4953 <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm>
4954 <glossdef>
4955 <para>
4956 Specifies the endian byte order of the target system.
4957 The value should be either "le" for little-endian or "be" for big-endian.
4958 </para>
4959 </glossdef>
4960 </glossentry>
4961
4962 <glossentry id='var-SOC_FAMILY'><glossterm>SOC_FAMILY</glossterm>
4963 <glossdef>
4964 <para>
4965 Groups together machines based upon the same family
4966 of SOC (System On Chip).
4967 You typically set this variable in a common
4968 <filename>.inc</filename> file that you include in the
4969 configuration files of all the machines.
4970 <note>
4971 You must include
4972 <filename>conf/machine/include/soc-family.inc</filename>
4973 for this variable to appear in
4974 <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>.
4975 </note>
4976 </para>
4977 </glossdef>
4978 </glossentry>
4979
4980 <glossentry id='var-SOLIBS'><glossterm>SOLIBS</glossterm>
4981 <glossdef>
4982 <para>
4983 Defines the suffix for shared libraries used on the
4984 target platform.
4985 By default, this suffix is ".so.*" for all Linux-based
4986 systems and is defined in the
4987 <filename>meta/conf/bitbake.conf</filename> configuration
4988 file.
4989 </para>
4990
4991 <para>
4992 You will see this variable referenced in the default values
4993 of <filename>FILES_${PN}</filename>.
4994 </para>
4995 </glossdef>
4996 </glossentry>
4997
4998 <glossentry id='var-SOLIBSDEV'><glossterm>SOLIBSDEV</glossterm>
4999 <glossdef>
5000 <para>
5001 Defines the suffix for the development symbolic link
5002 (symlink) for shared libraries on the target platform.
5003 By default, this suffix is ".so" for Linux-based
5004 systems and is defined in the
5005 <filename>meta/conf/bitbake.conf</filename> configuration
5006 file.
5007 </para>
5008
5009 <para>
5010 You will see this variable referenced in the default values
5011 of <filename>FILES_${PN}-dev</filename>.
5012 </para>
5013 </glossdef>
5014 </glossentry>
5015
5016 <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm>
5017 <glossdef>
5018 <para>
5019 A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the
5020 OpenEmbedded build system to create variants of recipes or packages.
5021 The list specifies the prefixes to strip off during certain circumstances
5022 such as the generation of the <link linkend='var-BPN'><filename>BPN</filename></link> variable.
5023 </para>
5024 </glossdef>
5025 </glossentry>
5026
5027 <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm>
5028 <glossdef>
5029 <para>The list of source files - local or remote.
5030 This variable tells the OpenEmbedded build system which bits
5031 to pull in for the build and how to pull them in.
5032 For example, if the recipe or append file only needs to
5033 fetch a tarball from the Internet, the recipe or
5034 append file uses a single <filename>SRC_URI</filename>
5035 entry.
5036 On the other hand, if the recipe or append file needs to
5037 fetch a tarball, apply two patches, and include a custom
5038 file, the recipe or append file would include four
5039 instances of the variable.</para>
5040 <para>The following list explains the available URI protocols:
5041 <itemizedlist>
5042 <listitem><para><emphasis><filename>file://</filename> -</emphasis>
5043 Fetches files, which are usually files shipped with
5044 the
5045 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
5046 from the local machine.
5047 The path is relative to the
5048 <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
5049 variable.
5050 Thus, the build system searches, in order, from the
5051 following directories, which are assumed to be a
5052 subdirectories of the directory in which the
5053 recipe file (<filename>.bb</filename>) or
5054 append file (<filename>.bbappend</filename>)
5055 resides:
5056 <itemizedlist>
5057 <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis>
5058 The base recipe name without any special
5059 suffix or version numbers.
5060 </para></listitem>
5061 <listitem><para><emphasis><filename>${BP}</filename> -</emphasis>
5062 <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>.
5063 The base recipe name and version but without
5064 any special package name suffix.
5065 </para></listitem>
5066 <listitem><para><emphasis>files -</emphasis>
5067 Files within a directory, which is named
5068 <filename>files</filename> and is also
5069 alongside the recipe or append file.
5070 </para></listitem>
5071 </itemizedlist>
5072 <note>
5073 If you want the build system to pick up files
5074 specified through a
5075 <filename>SRC_URI</filename>
5076 statement from your append file, you need to be
5077 sure to extend the
5078 <filename>FILESPATH</filename>
5079 variable by also using the
5080 <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>
5081 variable from within your append file.
5082 </note>
5083 </para></listitem>
5084 <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a
5085 Bazaar revision control repository.</para></listitem>
5086 <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a
5087 Git revision control repository.</para></listitem>
5088 <listitem><para><emphasis><filename>osc://</filename> -</emphasis> Fetches files from
5089 an OSC (OpenSUSE Build service) revision control repository.</para></listitem>
5090 <listitem><para><emphasis><filename>repo://</filename> -</emphasis> Fetches files from
5091 a repo (Git) repository.</para></listitem>
5092 <listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from
5093 an SVK revision control repository.</para></listitem>
5094 <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from
5095 the Internet using <filename>http</filename>.</para></listitem>
5096 <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files
5097 from the Internet using <filename>https</filename>.</para></listitem>
5098 <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files
5099 from the Internet using <filename>ftp</filename>.</para></listitem>
5100 <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from
5101 a CVS revision control repository.</para></listitem>
5102 <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from
5103 a Mercurial (<filename>hg</filename>) revision control repository.</para></listitem>
5104 <listitem><para><emphasis><filename>p4://</filename> -</emphasis> Fetches files from
5105 a Perforce (<filename>p4</filename>) revision control repository.</para></listitem>
5106 <listitem><para><emphasis><filename>ssh://</filename> -</emphasis> Fetches files from
5107 a secure shell.</para></listitem>
5108 <listitem><para><emphasis><filename>svn://</filename> -</emphasis> Fetches files from
5109 a Subversion (<filename>svn</filename>) revision control repository.</para></listitem>
5110 </itemizedlist>
5111 </para>
5112 <para>Standard and recipe-specific options for <filename>SRC_URI</filename> exist.
5113 Here are standard options:
5114 <itemizedlist>
5115 <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply
5116 the patch or not.
5117 The default action is to apply the patch.</para></listitem>
5118 <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which
5119 striplevel to use when applying the patch.
5120 The default level is 1.</para></listitem>
5121 <listitem><para><emphasis><filename>patchdir</filename> -</emphasis> Specifies
5122 the directory in which the patch should be applied.
5123 The default is <filename>${</filename><link linkend='var-S'><filename>S</filename></link><filename>}</filename>.
5124 </para></listitem>
5125 </itemizedlist>
5126 </para>
5127 <para>Here are options specific to recipes building code from a revision control system:
5128 <itemizedlist>
5129 <listitem><para><emphasis><filename>mindate</filename> -</emphasis>
5130 Apply the patch only if
5131 <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link>
5132 is equal to or greater than <filename>mindate</filename>.
5133 </para></listitem>
5134 <listitem><para><emphasis><filename>maxdate</filename> -</emphasis>
5135 Apply the patch only if <filename>SRCDATE</filename>
5136 is not later than <filename>mindate</filename>.
5137 </para></listitem>
5138 <listitem><para><emphasis><filename>minrev</filename> -</emphasis>
5139 Apply the patch only if <filename>SRCREV</filename>
5140 is equal to or greater than <filename>minrev</filename>.
5141 </para></listitem>
5142 <listitem><para><emphasis><filename>maxrev</filename> -</emphasis>
5143 Apply the patch only if <filename>SRCREV</filename>
5144 is not later than <filename>maxrev</filename>.
5145 </para></listitem>
5146 <listitem><para><emphasis><filename>rev</filename> -</emphasis>
5147 Apply the patch only if <filename>SRCREV</filename>
5148 is equal to <filename>rev</filename>.
5149 </para></listitem>
5150 <listitem><para><emphasis><filename>notrev</filename> -</emphasis>
5151 Apply the patch only if <filename>SRCREV</filename>
5152 is not equal to <filename>rev</filename>.
5153 </para></listitem>
5154 </itemizedlist>
5155 </para>
5156 <para>Here are some additional options worth mentioning:
5157 <itemizedlist>
5158 <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls
5159 whether or not to unpack the file if it is an archive.
5160 The default action is to unpack the file.</para></listitem>
5161 <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file
5162 (or extracts its contents) into the specified
5163 subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
5164 This option is useful for unusual tarballs or other archives that
5165 do not have their files already in a subdirectory within the archive.
5166 </para></listitem>
5167 <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a
5168 name to be used for association with <filename>SRC_URI</filename> checksums
5169 when you have more than one file specified in <filename>SRC_URI</filename>.
5170 </para></listitem>
5171 <listitem><para><emphasis><filename>downloadfilename</filename> -</emphasis> Specifies
5172 the filename used when storing the downloaded file.</para></listitem>
5173 </itemizedlist>
5174 </para>
5175 </glossdef>
5176 </glossentry>
5177
5178 <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm>
5179 <glossdef>
5180 <para></para>
5181 <para>
5182 By default, the OpenEmbedded build system automatically detects whether
5183 <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>
5184 contains files that are machine-specific.
5185 If so, the build system automatically changes
5186 <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>.
5187 Setting this variable to "0" disables this behavior.
5188 </para>
5189 </glossdef>
5190 </glossentry>
5191
5192 <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm>
5193 <glossdef>
5194 <para>
5195 The date of the source code used to build the package.
5196 This variable applies only if the source was fetched from a Source Code Manager (SCM).
5197 </para>
5198 </glossdef>
5199 </glossentry>
5200
5201 <glossentry id='var-SRCPV'><glossterm>SRCPV</glossterm>
5202 <glossdef>
5203 <para>
5204 Returns the version string of the current package.
5205 This string is used to help define the value of
5206 <link linkend='var-PV'><filename>PV</filename></link>.
5207 </para>
5208
5209 <para>
5210 The <filename>SRCPV</filename> variable is defined in the
5211 <filename>meta/conf/bitbake.conf</filename> configuration
5212 file in the
5213 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
5214 as follows:
5215 <literallayout class='monospaced'>
5216 SRCPV = "${@bb.fetch2.get_srcrev(d)}"
5217 </literallayout>
5218 </para>
5219
5220 <para>
5221 Recipes that need to define <filename>PV</filename> do so
5222 with the help of the <filename>SRCPV</filename>.
5223 For example, the <filename>ofono</filename> recipe
5224 (<filename>ofono_git.bb</filename>) located in
5225 <filename>meta/recipes-connectivity</filename> in the
5226 Source Directory defines <filename>PV</filename> as
5227 follows:
5228 <literallayout class='monospaced'>
5229 PV = "1.5.0+git${SRCPV}"
5230 </literallayout>
5231 </para>
5232 </glossdef>
5233 </glossentry>
5234
5235 <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm>
5236 <glossdef>
5237 <para>
5238 The revision of the source code used to build the package.
5239 This variable applies to Subversion, Git, Mercurial and Bazaar
5240 only.
5241 Note that if you wish to build a fixed revision and you wish
5242 to avoid performing a query on the remote repository every time
5243 BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a
5244 full revision identifier and not just a tag.
5245 </para>
5246 </glossdef>
5247 </glossentry>
5248
5249 <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm>
5250 <glossdef>
5251 <para>The directory for the shared state cache.</para>
5252 </glossdef>
5253 </glossentry>
5254
5255 <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm>
5256 <glossdef>
5257 <para>
5258 Configures the OpenEmbedded build system to search other
5259 mirror locations for prebuilt cache data objects before
5260 building out the data.
5261 This variable works like fetcher
5262 <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>
5263 and <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
5264 and points to the cache locations to check for the shared
5265 objects.
5266 </para>
5267
5268 <para>
5269 You can specify a filesystem directory or a remote URL such
5270 as HTTP or FTP.
5271 The locations you specify need to contain the shared state
5272 cache (sstate-cache) results from previous builds.
5273 The sstate-cache you point to can also be from builds on
5274 other machines.
5275 </para>
5276
5277 <para>
5278 If a mirror uses the same structure as
5279 <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>,
5280 you need to add
5281 "PATH" at the end as shown in the examples below.
5282 The build system substitutes the correct path within the
5283 directory structure.
5284 <literallayout class='monospaced'>
5285 SSTATE_MIRRORS ?= "\
5286 file://.* http://someserver.tld/share/sstate/PATH \n \
5287 file://.* file:///some/local/dir/sstate/PATH"
5288 </literallayout>
5289 </para>
5290 </glossdef>
5291 </glossentry>
5292
5293 <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm>
5294 <glossdef>
5295 <para>
5296 The directory with kernel headers that are required to build out-of-tree
5297 modules.
5298 </para>
5299 </glossdef>
5300 </glossentry>
5301
5302 <glossentry id='var-STAMP'><glossterm>STAMP</glossterm>
5303 <glossdef>
5304 <para>
5305 Specifies the base path used to create recipe stamp files.
5306 The path to an actual stamp file is constructed by evaluating this
5307 string and then appending additional information.
5308 Currently, the default assignment for <filename>STAMP</filename>
5309 as set in the <filename>meta/conf/bitbake.conf</filename> file
5310 is:
5311 <literallayout class='monospaced'>
5312 STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}"
5313 </literallayout>
5314 See <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link>,
5315 <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>,
5316 <link linkend='var-PN'><filename>PN</filename></link>,
5317 <link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>,
5318 <link linkend='var-PV'><filename>PV</filename></link>, and
5319 <link linkend='var-PR'><filename>PR</filename></link> for related variable
5320 information.
5321 </para>
5322 </glossdef>
5323 </glossentry>
5324
5325 <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm>
5326 <glossdef>
5327 <para>
5328 Specifies the base directory in which the OpenEmbedded
5329 build system places stamps.
5330 The default directory is
5331 <filename>${TMPDIR}/stamps</filename>.
5332 </para>
5333 </glossdef>
5334 </glossentry>
5335
5336 <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm>
5337 <glossdef>
5338 <para>The short (72 characters or less) summary of the binary package for packaging
5339 systems such as <filename>opkg</filename>, <filename>rpm</filename> or
5340 <filename>dpkg</filename>.
5341 By default, <filename>SUMMARY</filename> is used to define
5342 the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>
5343 variable if <filename>DESCRIPTION</filename> is not set
5344 in the recipe.
5345 </para>
5346 </glossdef>
5347 </glossentry>
5348
5349 <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm>
5350 <glossdef>
5351 <para>
5352 A list of functions to execute after files are staged into
5353 the sysroot.
5354 These functions are usually used to apply additional
5355 processing on the staged files, or to stage additional
5356 files.
5357 </para>
5358 </glossdef>
5359 </glossentry>
5360
5361 </glossdiv>
5362
5363 <glossdiv id='var-glossary-t'><title>T</title>
5364
5365 <glossentry id='var-T'><glossterm>T</glossterm>
5366 <glossdef>
5367 <para>This variable points to a directory were BitBake places
5368 temporary files, which consist mostly of task logs and
5369 scripts, when building a particular recipe.
5370 The variable is typically set as follows:
5371 <literallayout class='monospaced'>
5372 T = "${WORKDIR}/temp"
5373 </literallayout>
5374 The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
5375 is the directory into which BitBake unpacks and builds the
5376 recipe.
5377 The default <filename>bitbake.conf</filename> file sets this variable.</para>
5378 <para>The <filename>T</filename> variable is not to be confused with
5379 the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> variable,
5380 which points to the root of the directory tree where BitBake
5381 places the output of an entire build.
5382 </para>
5383 </glossdef>
5384 </glossentry>
5385
5386 <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm>
5387 <glossdef>
5388 <para>
5389 The target machine's architecture.
5390 The OpenEmbedded build system supports many
5391 architectures.
5392 Here is an example list of architectures supported.
5393 This list is by no means complete as the architecture
5394 is configurable:
5395 <literallayout class='monospaced'>
5396 arm
5397 i586
5398 x86_64
5399 powerpc
5400 powerpc64
5401 mips
5402 mipsel
5403 </literallayout>
5404 </para>
5405 </glossdef>
5406 </glossentry>
5407
5408 <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm>
5409 <glossdef>
5410 <para>
5411 Flags passed to the C compiler for the target system.
5412 This variable evaluates to the same as
5413 <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename>.
5414 </para>
5415 </glossdef>
5416 </glossentry>
5417
5418
5419 <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm>
5420 <glossdef>
5421 <para>Specifies the method for handling FPU code.
5422 For FPU-less targets, which include most ARM CPUs, the variable must be
5423 set to "soft".
5424 If not, the kernel emulation gets used, which results in a performance penalty.</para>
5425 </glossdef>
5426 </glossentry>
5427
5428 <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm>
5429 <glossdef>
5430 <para>Specifies the target's operating system.
5431 The variable can be set to "linux" for <filename>eglibc</filename>-based systems and
5432 to "linux-uclibc" for <filename>uclibc</filename>.
5433 For ARM/EABI targets, there are also "linux-gnueabi" and
5434 "linux-uclibc-gnueabi" values possible.</para>
5435 </glossdef>
5436 </glossentry>
5437
5438 <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm>
5439 <glossdef>
5440 <para>
5441 Specifies which variant of the GNU standard C library (<filename>libc</filename>)
5442 to use during the build process.
5443 This variable replaces <filename>POKYLIBC</filename>, which is no longer
5444 supported.
5445 </para>
5446 <para>
5447 You can select <filename>eglibc</filename> or <filename>uclibc</filename>.
5448 <note>
5449 This release of the Yocto Project does not support the
5450 <filename>glibc</filename> implementation of <filename>libc</filename>.
5451 </note>
5452 </para>
5453 </glossdef>
5454 </glossentry>
5455
5456 <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm>
5457 <glossdef>
5458 <para>
5459 The toolchain selector.
5460 This variable replaces <filename>POKYMODE</filename>, which is no longer
5461 supported.
5462 </para>
5463 <para>
5464 The <filename>TCMODE</filename> variable selects the external toolchain
5465 built using the OpenEmbedded build system or a few supported combinations of
5466 the upstream GCC or CodeSourcery Labs toolchain.
5467 The variable identifies the <filename>tcmode-*</filename> files used in
5468 the <filename>meta/conf/distro/include</filename> directory, which is found in the
5469 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
5470 </para>
5471 <para>
5472 By default, <filename>TCMODE</filename> is set to "default", which
5473 chooses the <filename>tcmode-default.inc</filename> file.
5474 The variable is similar to
5475 <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, which controls
5476 the variant of the GNU standard C library (<filename>libc</filename>)
5477 used during the build process: <filename>eglibc</filename> or <filename>uclibc</filename>.
5478 </para>
5479 </glossdef>
5480 </glossentry>
5481
5482 <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm>
5483 <glossdef>
5484 <para>
5485 Automatically runs the series of automated tests for
5486 images when an image is successfully built.
5487 <note>
5488 Currently, there is only support for running these tests
5489 under QEMU.
5490 </note>
5491 These tests are written in Python making use of the
5492 <filename>unittest</filename> module, and the majority of
5493 them run commands on the target system over
5494 <filename>ssh</filename>.
5495 You can set this variable to "1" in your
5496 <filename>local.conf</filename> file in the
5497 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
5498 to have the OpenEmbedded build system automatically run
5499 these tests after an image successfully builds:
5500 <literallayout class='monospaced'>
5501 TEST_IMAGE = "1"
5502 </literallayout>
5503 For more information on enabling, running, and writing
5504 these tests, see the
5505 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
5506 section in the Yocto Project Development Manual and the
5507 "<link linkend='ref-classes-testimage'><filename>testimage.bbclass</filename></link>"
5508 section.
5509 </para>
5510 </glossdef>
5511 </glossentry>
5512
5513 <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm>
5514 <glossdef>
5515 <para>
5516 The time in seconds allowed for an image to boot before
5517 automated runtime tests begin to run against an
5518 image.
5519 The default timeout period to allow the boot process to
5520 reach the login prompt is 500 seconds.
5521 You can specify a different value in the
5522 <filename>local.conf</filename> file.
5523 </para>
5524
5525 <para>
5526 For more information on testing images, see the
5527 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
5528 section in the Yocto Project Development Manual.
5529 </para>
5530 </glossdef>
5531 </glossentry>
5532
5533 <glossentry id='var-TEST_SUITES'><glossterm>TEST_SUITES</glossterm>
5534 <glossdef>
5535 <para>
5536 An ordered list of tests (modules) to run against
5537 an image when performing automated runtime testing.
5538 </para>
5539
5540 <para>
5541 The OpenEmbedded build system provides a core set of tests
5542 that can be used against images.
5543 <note>
5544 Currently, there is only support for running these tests
5545 under QEMU.
5546 </note>
5547 Tests include <filename>ping</filename>,
5548 <filename>ssh</filename>, <filename>df</filename> among
5549 others.
5550 You can add your own tests to the list of tests by
5551 appending <filename>TEST_SUITES</filename> as follows:
5552 <literallayout class='monospaced'>
5553 TEST_SUITES_append = " mytest"
5554 </literallayout>
5555 Alternatively, you can provide the "auto" option to
5556 have all applicable tests run against the image.
5557 <literallayout class='monospaced'>
5558 TEST_SUITES_append = " auto"
5559 </literallayout>
5560 Using this option causes the build system to automatically
5561 run tests that are applicable to the image.
5562 Tests that are not applicable are skipped.
5563 </para>
5564
5565 <para>
5566 The order in which tests are run is important.
5567 Tests that depend on another test must appear later in the
5568 list than the test on which they depend.
5569 For example, if you append the list of tests with two
5570 tests (<filename>test_A</filename> and
5571 <filename>test_B</filename>) where
5572 <filename>test_B</filename> is dependent on
5573 <filename>test_A</filename>, then you must order the tests
5574 as follows:
5575 <literallayout class='monospaced'>
5576 TEST_SUITES = " test_A test_B"
5577 </literallayout>
5578 </para>
5579
5580 <para>
5581 For more information on testing images, see the
5582 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
5583 section in the Yocto Project Development Manual.
5584 </para>
5585 </glossdef>
5586 </glossentry>
5587
5588 <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm>
5589 <glossdef>
5590 <para>
5591 The directory in which the file BitBake is currently
5592 parsing is located.
5593 Do not manually set this variable.
5594 </para>
5595 </glossdef>
5596 </glossentry>
5597
5598 <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm>
5599 <glossdef>
5600 <para>
5601 This variable is the base directory the OpenEmbedded
5602 build system uses for all build output and intermediate
5603 files (other than the shared state cache).
5604 By default, the <filename>TMPDIR</filename> variable points
5605 to <filename>tmp</filename> within the
5606 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
5607 </para>
5608
5609 <para>
5610 If you want to establish this directory in a location other
5611 than the default, you can uncomment and edit the following
5612 statement in the
5613 <filename>conf/local.conf</filename> file in the
5614 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
5615 <literallayout class='monospaced'>
5616 #TMPDIR = "${TOPDIR}/tmp"
5617 </literallayout>
5618 </para>
5619 </glossdef>
5620 </glossentry>
5621
5622 <glossentry id='var-TOOLCHAIN_HOST_TASK'><glossterm>TOOLCHAIN_HOST_TASK</glossterm>
5623 <glossdef>
5624 <para>
5625 This variable lists packages the OpenEmbedded build system
5626 uses when building an SDK, which contains a
5627 cross-development environment.
5628 The packages specified by this variable are part of the
5629 toolchain set that runs on the
5630 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>,
5631 and each package should usually have the prefix
5632 "nativesdk-".
5633 When building an SDK using
5634 <filename>bitbake -c populate_sdk &lt;imagename&gt;</filename>,
5635 a default list of packages is set in this variable, but
5636 you can add additional packages to the list.
5637 </para>
5638
5639 <para>
5640 For background information on cross-development toolchains
5641 in the Yocto Project development environment, see the
5642 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
5643 section.
5644 For information on setting up a cross-development
5645 environment, see the
5646 "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>"
5647 section in the Yocto Project Application Developer's Guide.
5648 </para>
5649 </glossdef>
5650 </glossentry>
5651
5652 <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm>
5653 <glossdef>
5654 <para>
5655 This variable lists packages the OpenEmbedded build system
5656 uses when it creates the target part of an SDK
5657 (i.e. the part built for the target hardware), which
5658 includes libraries and headers.
5659 </para>
5660
5661 <para>
5662 For background information on cross-development toolchains
5663 in the Yocto Project development environment, see the
5664 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
5665 section.
5666 For information on setting up a cross-development
5667 environment, see the
5668 "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>"
5669 section in the Yocto Project Application Developer's Guide.
5670 </para>
5671 </glossdef>
5672 </glossentry>
5673
5674 <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm>
5675 <glossdef>
5676 <para>
5677 This variable points to the
5678 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
5679 BitBake automatically sets this variable.
5680 </para>
5681 </glossdef>
5682 </glossentry>
5683
5684 <glossentry id='var-TRANSLATED_TARGET_ARCH'><glossterm>TRANSLATED_TARGET_ARCH</glossterm>
5685 <glossdef>
5686 <para>
5687 A sanitized version of
5688 <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>.
5689 This variable is used where the architecture is needed in
5690 a value where underscores are not allowed, for example
5691 within package filenames.
5692 In this case, dash characters replace any underscore
5693 characters used in TARGET_ARCH.
5694 </para>
5695
5696 <para>
5697 Do not edit this variable.
5698 </para>
5699 </glossdef>
5700 </glossentry>
5701
5702 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
5703 <glossdef>
5704 <para>
5705 The package architecture understood by the packaging
5706 system to define the architecture, ABI, and tuning of
5707 output packages.
5708 </para>
5709 </glossdef>
5710 </glossentry>
5711
5712 </glossdiv>
5713
5714 <glossdiv id='var-glossary-u'><title>U</title>
5715
5716 <glossentry id='var-UBOOT_ENTRYPOINT'><glossterm>UBOOT_ENTRYPOINT</glossterm>
5717 <glossdef>
5718 <para>
5719 Specifies the entry point for the U-Boot image.
5720 During U-Boot image creation, the
5721 <filename>UBOOT_ENTRYPOINT</filename> variable is passed
5722 as a command-line parameter to the
5723 <filename>uboot-mkimage</filename> utility.
5724 </para>
5725 </glossdef>
5726 </glossentry>
5727
5728 <glossentry id='var-UBOOT_LOADADDRESS'><glossterm>UBOOT_LOADADDRESS</glossterm>
5729 <glossdef>
5730 <para>
5731 Specifies the load address for the U-Boot image.
5732 During U-Boot image creation, the
5733 <filename>UBOOT_LOADADDRESS</filename> variable is passed
5734 as a command-line parameter to the
5735 <filename>uboot-mkimage</filename> utility.
5736 </para>
5737 </glossdef>
5738 </glossentry>
5739
5740 <glossentry id='var-UBOOT_MACHINE'><glossterm>UBOOT_MACHINE</glossterm>
5741 <glossdef>
5742 <para>
5743 Specifies the value passed on the
5744 <filename>make</filename> command line when building
5745 a U-Boot image.
5746 The value indicates the target platform configuration.
5747 You typically set this variable from the machine
5748 configuration file (i.e.
5749 <filename>conf/machine/&lt;machine_name&gt;.conf</filename>).
5750 </para>
5751 </glossdef>
5752 </glossentry>
5753
5754 <glossentry id='var-UBOOT_TARGET'><glossterm>UBOOT_TARGET</glossterm>
5755 <glossdef>
5756 <para>
5757 Specifies the target used for building U-Boot.
5758 The target is passed directly as part of the "make" command
5759 (e.g. SPL and AIS).
5760 If you do not specifically set this variable, the
5761 OpenEmbedded build process passes and uses "all" for the
5762 target during the U-Boot building process.
5763 </para>
5764 </glossdef>
5765 </glossentry>
5766
5767 <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm>
5768 <glossdef>
5769 <para>
5770 A list of classes to globally inherit.
5771 These classes are used by the OpenEmbedded build system
5772 to enable extra features (e.g.
5773 <filename>buildstats</filename>,
5774 <filename>image-mklibs</filename>, and so forth).
5775 </para>
5776
5777 <para>
5778 The default list is set in your
5779 <filename>local.conf</filename> file:
5780 <literallayout class='monospaced'>
5781 USER_CLASSES ?= "buildstats image-mklibs image-prelink"
5782 </literallayout>
5783 For more information, see
5784 <filename>meta-yocto/conf/local.conf.sample</filename> in
5785 the
5786 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
5787 </para>
5788 </glossdef>
5789 </glossentry>
5790
5791 </glossdiv>
5792
5793<!-- <glossdiv id='var-glossary-v'><title>V</title>-->
5794<!-- </glossdiv>-->
5795
5796 <glossdiv id='var-glossary-w'><title>W</title>
5797
5798 <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm>
5799 <glossdef>
5800 <para>
5801 Specifies the quality assurance checks whose failures are
5802 reported as warnings by the OpenEmbedded build system.
5803 You set this variable in your distribution configuration
5804 file.
5805 For a list of the checks you can control with this variable,
5806 see the
5807 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
5808 section.
5809 </para>
5810 </glossdef>
5811 </glossentry>
5812
5813 <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
5814 <glossdef>
5815 <para>
5816 The pathname of the working directory in which the OpenEmbedded build system
5817 builds a recipe.
5818 This directory is located within the
5819 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> directory structure and changes
5820 as different packages are built.
5821 </para>
5822
5823 <para>
5824 The actual <filename>WORKDIR</filename> directory depends on several things:
5825 <itemizedlist>
5826 <listitem>The temporary directory - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link></listitem>
5827 <listitem>The package architecture - <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link></listitem>
5828 <listitem>The target machine - <link linkend='var-MACHINE'><filename>MACHINE</filename></link></listitem>
5829 <listitem>The target operating system - <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link></listitem>
5830 <listitem>The recipe name - <link linkend='var-PN'><filename>PN</filename></link></listitem>
5831 <listitem>The recipe version - <link linkend='var-PV'><filename>PV</filename></link></listitem>
5832 <listitem>The recipe revision - <link linkend='var-PR'><filename>PR</filename></link></listitem>
5833 </itemizedlist>
5834 </para>
5835
5836 <para>
5837 For packages that are not dependent on a particular machine,
5838 <filename>WORKDIR</filename> is defined as follows:
5839 <literallayout class='monospaced'>
5840 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
5841 </literallayout>
5842 As an example, assume a
5843 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
5844 folder name <filename>poky</filename> and a default
5845 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
5846 at <filename>poky/build</filename>.
5847 In this case, the working directory the build system uses to build
5848 the <filename>v86d</filename> package is the following:
5849 <literallayout class='monospaced'>
5850 ~/poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0
5851 </literallayout>
5852 </para>
5853
5854 <para>
5855 For packages that are dependent on a particular machine, <filename>WORKDIR</filename>
5856 is defined slightly different:
5857 <literallayout class='monospaced'>
5858 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
5859 </literallayout>
5860 As an example, again assume a Source Directory top-level folder
5861 named <filename>poky</filename> and a default Build Directory
5862 at <filename>poky/build</filename>.
5863 In this case, the working directory the build system uses to build
5864 the <filename>acl</filename> recipe, which is being built for a
5865 MIPS-based device, is the following:
5866 <literallayout class='monospaced'>
5867 ~/poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2
5868 </literallayout>
5869 </para>
5870 </glossdef>
5871 </glossentry>
5872
5873 </glossdiv>
5874
5875<!-- <glossdiv id='var-glossary-x'><title>X</title>-->
5876<!-- </glossdiv>-->
5877
5878<!-- <glossdiv id='var-glossary-y'><title>Y</title>-->
5879<!-- </glossdiv>-->
5880
5881<!-- <glossdiv id='var-glossary-z'><title>Z</title>-->
5882<!-- </glossdiv>-->
5883
5884</glossary>
5885</chapter>
5886<!--
5887vim: expandtab tw=80 ts=4
5888-->
diff --git a/documentation/ref-manual/ref-varlocality.xml b/documentation/ref-manual/ref-varlocality.xml
new file mode 100644
index 0000000000..d3f873298d
--- /dev/null
+++ b/documentation/ref-manual/ref-varlocality.xml
@@ -0,0 +1,196 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='ref-varlocality'>
6 <title>Variable Context</title>
7
8 <para>
9 While you can use most variables in almost any context such as
10 <filename>.conf</filename>, <filename>.bbclass</filename>,
11 <filename>.inc</filename>, and <filename>.bb</filename> files,
12 some variables are often associated with a particular locality or context.
13 This chapter describes some common associations.
14 </para>
15
16 <section id='ref-varlocality-configuration'>
17 <title>Configuration</title>
18
19 <para>
20 The following subsections provide lists of variables whose context is
21 configuration: distribution, machine, and local.
22 </para>
23
24 <section id='ref-varlocality-config-distro'>
25 <title>Distribution (Distro)</title>
26
27 <para>
28 This section lists variables whose configuration context is the
29 distribution, or distro.
30 <itemizedlist>
31 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem>
32 <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename>
33 </para></listitem>
34 <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link>
35 </filename></para></listitem>
36 <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename>
37 </para></listitem>
38 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
39 </filename></para></listitem>
40 <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename>
41 </para></listitem>
42 <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename>
43 </para></listitem>
44 <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename>
45 </para></listitem>
46 <listitem><para><filename><link linkend='var-TCLIBC'>TCLIBC</link></filename>
47 </para></listitem>
48 </itemizedlist>
49 </para>
50 </section>
51
52 <section id='ref-varlocality-config-machine'>
53 <title>Machine</title>
54
55 <para>
56 This section lists variables whose configuration context is the
57 machine.
58 <itemizedlist>
59 <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename>
60 </para></listitem>
61 <listitem><para><filename><link linkend='var-SERIAL_CONSOLES'>SERIAL_CONSOLES</link>
62 </filename></para></listitem>
63 <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link>
64 </filename></para></listitem>
65 <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link>
66 </filename></para></listitem>
67 <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link>
68 </filename></para></listitem>
69 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS
70 </link></filename></para></listitem>
71 <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS
72 </link></filename></para></listitem>
73 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS
74 </link></filename></para></listitem>
75 <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>
76 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem>
77 </itemizedlist>
78 </para>
79 </section>
80
81 <section id='ref-varlocality-config-local'>
82 <title>Local</title>
83
84 <para>
85 This section lists variables whose configuration context is the
86 local configuration through the <filename>local.conf</filename>
87 file.
88 <itemizedlist>
89 <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename>
90 </para></listitem>
91 <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename>
92 </para></listitem>
93 <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>
94 </para></listitem>
95 <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename>
96 </para></listitem>
97 <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES
98 </link></filename></para></listitem>
99 <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link>
100 </filename></para></listitem>
101 <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link>
102 </filename></para></listitem>
103 <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link>
104 </filename></para></listitem>
105 <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>
106 ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem>
107 </itemizedlist>
108 </para>
109 </section>
110 </section>
111
112 <section id='ref-varlocality-recipes'>
113 <title>Recipes</title>
114
115 <para>
116 The following subsections provide lists of variables whose context is
117 recipes: required, dependencies, path, and extra build information.
118 </para>
119
120 <section id='ref-varlocality-recipe-required'>
121 <title>Required</title>
122
123 <para>
124 This section lists variables that are required for recipes.
125 <itemizedlist>
126 <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link>
127 </filename></para></listitem>
128 <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
129 </filename></para></listitem>
130 <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - used
131 in recipes that fetch local or remote files.
132 </para></listitem>
133 </itemizedlist>
134 </para>
135 </section>
136
137 <section id='ref-varlocality-recipe-dependencies'>
138 <title>Dependencies</title>
139
140 <para>
141 This section lists variables that define recipe dependencies.
142 <itemizedlist>
143 <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link>
144 </filename></para></listitem>
145 <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link>
146 </filename></para></listitem>
147 <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link>
148 </filename></para></listitem>
149 <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link>
150 </filename></para></listitem>
151 <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link>
152 </filename></para></listitem>
153 </itemizedlist>
154 </para>
155 </section>
156
157 <section id='ref-varlocality-recipe-paths'>
158 <title>Paths</title>
159
160 <para>
161 This section lists variables that define recipe paths.
162 <itemizedlist>
163 <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link>
164 </filename></para></listitem>
165 <listitem><para><filename><link linkend='var-S'>S</link>
166 </filename></para></listitem>
167 <listitem><para><filename><link linkend='var-FILES'>FILES</link>
168 </filename></para></listitem>
169 </itemizedlist>
170 </para>
171 </section>
172
173 <section id='ref-varlocality-recipe-build'>
174 <title>Extra Build Information</title>
175
176 <para>
177 This section lists variables that define extra build information for recipes.
178 <itemizedlist>
179 <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link>
180 </filename></para></listitem>
181 <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link>
182 </filename></para></listitem>
183 <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link>
184 </filename></para></listitem>
185 <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>
186 </para></listitem>
187 <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE
188 </link></filename></para></listitem>
189 </itemizedlist>
190 </para>
191 </section>
192 </section>
193</chapter>
194<!--
195vim: expandtab tw=80 ts=4 spell spelllang=en_gb
196-->
diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml
new file mode 100644
index 0000000000..c48951f934
--- /dev/null
+++ b/documentation/ref-manual/resources.xml
@@ -0,0 +1,128 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='resources'>
6<title>Contributing to the Yocto Project</title>
7
8<section id='resources-intro'>
9 <title>Introduction</title>
10 <para>
11 The Yocto Project team is happy for people to experiment with the Yocto Project.
12 A number of places exist to find help if you run into difficulties or find bugs.
13 To find out how to download source code,
14 see the "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto Project Release</ulink>"
15 section in the Yocto Project Development Manual.
16 </para>
17</section>
18
19<section id='resources-bugtracker'>
20 <title>Tracking Bugs</title>
21
22 <para>
23 If you find problems with the Yocto Project, you should report them using the
24 Bugzilla application at <ulink url='&YOCTO_BUGZILLA_URL;'></ulink>.
25 </para>
26</section>
27
28<section id='resources-mailinglist'>
29 <title>Mailing lists</title>
30
31 <para>
32 A number of mailing lists maintained by the Yocto Project exist
33 as well as related OpenEmbedded mailing lists for discussion,
34 patch submission and announcements.
35 To subscribe to one of the following mailing lists, click on the
36 appropriate URL in the following list and follow the instructions:
37 <itemizedlist>
38 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> -
39 General Yocto Project discussion mailing list. </para></listitem>
40 <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'></ulink> -
41 Discussion mailing list about OpenEmbedded-Core (the core metadata).</para></listitem>
42 <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-devel'></ulink> -
43 Discussion mailing list about OpenEmbedded.</para></listitem>
44 <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/bitbake-devel'></ulink> -
45 Discussion mailing list about the
46 <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>
47 build tool.</para></listitem>
48 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> -
49 Discussion mailing list about
50 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>.
51 </para></listitem>
52 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> -
53 Mailing list to receive official Yocto Project release and milestone
54 announcements.</para></listitem>
55 </itemizedlist>
56 </para>
57</section>
58
59<section id='resources-irc'>
60 <title>Internet Relay Chat (IRC)</title>
61
62 <para>
63 Two IRC channels on freenode are available for the Yocto Project and Poky discussions:
64 <itemizedlist>
65 <listitem><para><filename>#yocto</filename></para></listitem>
66 <listitem><para><filename>#poky</filename></para></listitem>
67 </itemizedlist>
68 </para>
69</section>
70
71<section id='resources-links'>
72 <title>Links</title>
73
74 <para>
75 Here is a list of resources you will find helpful:
76 <itemizedlist>
77 <listitem><para><emphasis>
78 <ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>:
79 </emphasis> The home site for the Yocto
80 Project.</para></listitem>
81 <listitem><para><emphasis>
82 <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis>
83 The company who acquired OpenedHand in 2008 and began
84 development on the Yocto Project.</para></listitem>
85 <listitem><para><emphasis>
86 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
87 The upstream, generic, embedded distribution used as the basis
88 for the build system in the Yocto Project.
89 Poky derives from and contributes back to the OpenEmbedded
90 project.</para></listitem>
91 <listitem><para><emphasis>
92 <ulink url='http://developer.berlios.de/projects/bitbake/'>
93 BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
94 <listitem><para><emphasis>
95 BitBake User Manual:</emphasis>
96 A comprehensive guide to the BitBake tool.
97 You can find the BitBake User Manual in the
98 <filename>bitbake/doc/manual</filename> directory, which is
99 found in the
100 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
101 </para></listitem>
102 <listitem><para><emphasis>
103 <ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
104 </emphasis> An open source machine emulator and virtualizer.
105 </para></listitem>
106 </itemizedlist>
107 </para>
108</section>
109
110<section id='resources-contributions'>
111 <title>Contributions</title>
112
113 <para>
114 The Yocto Project gladly accepts contributions.
115 You can submit changes to the project either by creating and sending
116 pull requests,
117 or by submitting patches through email.
118 For information on how to do both as well as information on how
119 to find out who is the maintainer for areas of code, see the
120 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>"
121 section in the Yocto Project Development Manual.
122 </para>
123</section>
124
125</chapter>
126<!--
127vim: expandtab tw=80 ts=4
128-->
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
new file mode 100644
index 0000000000..be9c38709a
--- /dev/null
+++ b/documentation/ref-manual/technical-details.xml
@@ -0,0 +1,1335 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='technical-details'>
6<title>Technical Details</title>
7
8 <para>
9 This chapter provides technical details for various parts of the Yocto Project.
10 Currently, topics include Yocto Project components,
11 shared state (sstate) cache, x32, and Licenses.
12 </para>
13
14<section id='usingpoky-components'>
15 <title>Yocto Project Components</title>
16
17 <para>
18 The BitBake task executor together with various types of configuration files form the
19 OpenEmbedded Core.
20 This section overviews these by describing what they are used for
21 and how they interact.
22 </para>
23
24 <para>
25 BitBake handles the parsing and execution of the data files.
26 The data itself is of various types:
27 <itemizedlist>
28 <listitem><para><emphasis>Recipes:</emphasis> Provides details about particular
29 pieces of software.</para></listitem>
30 <listitem><para><emphasis>Class Data:</emphasis> Abstracts common build
31 information (e.g. how to build a Linux kernel).</para></listitem>
32 <listitem><para><emphasis>Configuration Data:</emphasis> Defines machine-specific settings,
33 policy decisions, and so forth.
34 Configuration data acts as the glue to bind everything together.</para></listitem>
35 </itemizedlist>
36 For more information on data, see the
37 "<ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-terms'>Yocto Project Terms</ulink>"
38 section in the Yocto Project Development Manual.
39 </para>
40
41 <para>
42 BitBake knows how to combine multiple data sources together and refers to each data source
43 as a layer.
44 For information on layers, see the
45 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and
46 Creating Layers</ulink>" section of the Yocto Project Development Manual.
47 </para>
48
49 <para>
50 Following are some brief details on these core components.
51 For more detailed information on these components, see the
52 "<link linkend='ref-structure'>Source Directory Structure</link>" chapter.
53 </para>
54
55 <section id='usingpoky-components-bitbake'>
56 <title>BitBake</title>
57
58 <para>
59 BitBake is the tool at the heart of the OpenEmbedded build system
60 and is responsible for parsing the
61 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
62 generating a list of tasks from it, and then executing those tasks.
63 To see a list of the options BitBake supports, use the following
64 help command:
65 <literallayout class='monospaced'>
66 $ bitbake --help
67 </literallayout>
68 </para>
69
70 <para>
71 The most common usage for BitBake is <filename>bitbake &lt;packagename&gt;</filename>, where
72 <filename>packagename</filename> is the name of the package you want to build
73 (referred to as the "target" in this manual).
74 The target often equates to the first part of a <filename>.bb</filename> filename.
75 So, to run the <filename>matchbox-desktop_1.2.3.bb</filename> file, you
76 might type the following:
77 <literallayout class='monospaced'>
78 $ bitbake matchbox-desktop
79 </literallayout>
80 Several different versions of <filename>matchbox-desktop</filename> might exist.
81 BitBake chooses the one selected by the distribution configuration.
82 You can get more details about how BitBake chooses between different
83 target versions and providers in the
84 "<link linkend='ref-bitbake-providers'>Preferences and Providers</link>" section.
85 </para>
86
87 <para>
88 BitBake also tries to execute any dependent tasks first.
89 So for example, before building <filename>matchbox-desktop</filename>, BitBake
90 would build a cross compiler and <filename>eglibc</filename> if they had not already
91 been built.
92 <note>This release of the Yocto Project does not support the <filename>glibc</filename>
93 GNU version of the Unix standard C library. By default, the OpenEmbedded build system
94 builds with <filename>eglibc</filename>.</note>
95 </para>
96
97 <para>
98 A useful BitBake option to consider is the <filename>-k</filename> or
99 <filename>--continue</filename> option.
100 This option instructs BitBake to try and continue processing the job as much
101 as possible even after encountering an error.
102 When an error occurs, the target that
103 failed and those that depend on it cannot be remade.
104 However, when you use this option other dependencies can still be processed.
105 </para>
106 </section>
107
108 <section id='usingpoky-components-metadata'>
109 <title>Metadata (Recipes)</title>
110
111 <para>
112 The <filename>.bb</filename> files are usually referred to as "recipes."
113 In general, a recipe contains information about a single piece of software.
114 The information includes the location from which to download the source patches
115 (if any are needed), which special configuration options to apply,
116 how to compile the source files, and how to package the compiled output.
117 </para>
118
119 <para>
120 The term "package" can also be used to describe recipes.
121 However, since the same word is used for the packaged output from the OpenEmbedded
122 build system (i.e. <filename>.ipk</filename> or <filename>.deb</filename> files),
123 this document avoids using the term "package" when referring to recipes.
124 </para>
125 </section>
126
127 <section id='usingpoky-components-classes'>
128 <title>Classes</title>
129
130 <para>
131 Class files (<filename>.bbclass</filename>) contain information that
132 is useful to share between
133 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> files.
134 An example is the Autotools class, which contains
135 common settings for any application that Autotools uses.
136 The "<link linkend='ref-classes'>Classes</link>" chapter provides details
137 about common classes and how to use them.
138 </para>
139 </section>
140
141 <section id='usingpoky-components-configuration'>
142 <title>Configuration</title>
143
144 <para>
145 The configuration files (<filename>.conf</filename>) define various configuration variables
146 that govern the OpenEmbedded build process.
147 These files fall into several areas that define machine configuration options,
148 distribution configuration options, compiler tuning options, general common configuration
149 options, and user configuration options in <filename>local.conf</filename>, which is found
150 in the
151 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
152 </para>
153 </section>
154</section>
155
156<section id="cross-development-toolchain-generation">
157 <title>Cross-Development Toolchain Generation</title>
158
159 <para>
160 The Yocto Project does most of the work for you when it comes to
161 creating
162 <ulink url='&YOCTO_DOCS_DEV_URL;#cross-development-toolchain'>cross-development toolchains</ulink>.
163 This section provides some technical background information on how
164 cross-development toolchains are created and used.
165 For more information on these toolchain, you can also see the
166 <ulink url='&YOCTO_DOCS_ADT_URL;'>the Yocto Project Application Developer's Guide</ulink>.
167 </para>
168
169 <para>
170 In the Yocto Project development environment, cross-development
171 toolchains are used to build the image and applications that run on the
172 target hardware.
173 With just a few commands, the OpenEmbedded build system creates
174 these necessary toolchains for you.
175 </para>
176
177 <para>
178 The following figure shows a high-level build environment regarding
179 toolchain construction and use.
180 </para>
181
182 <para>
183 <imagedata fileref="figures/cross-development-toolchains.png" width="8in" depth="6in" align="center" />
184 </para>
185
186 <para>
187 Most of the work occurs on the Build Host.
188 This is the machine used to build images and generally work within the
189 the Yocto Project environment.
190 When you run BitBake to create an image, the OpenEmbedded build system
191 uses the host <filename>gcc</filename> compiler to bootstrap a
192 cross-compiler named <filename>gcc-cross</filename>.
193 The <filename>gcc-cross</filename> compiler is what BitBake uses to
194 compile source files when creating the target image.
195 You can think of <filename>gcc-cross</filename> simply as an
196 automatically generated cross-compiler that is used internally within
197 BitBake only.
198 </para>
199
200 <para>
201 The chain of events that occurs when <filename>gcc-cross</filename> is
202 bootstrapped is as follows:
203 <literallayout class='monospaced'>
204 gcc -> binutils-cross -> gcc-cross-initial -> linux-libc-headers -> eglibc-initial -> eglibc -> gcc-cross -> gcc-runtime
205 </literallayout>
206 <itemizedlist>
207 <listitem><para><filename>gcc</filename>:
208 The build host's GNU Compiler Collection (GCC).
209 </para></listitem>
210 <listitem><para><filename>binutils-cross</filename>:
211 The bare minimum binary utilities needed in order to run
212 the <filename>gcc-cross-initial</filename> phase of the
213 bootstrap operation.
214 </para></listitem>
215 <listitem><para><filename>gcc-cross-initial</filename>:
216 An early stage of the bootstrap process for creating
217 the cross-compiler.
218 This stage builds enough of the <filename>gcc-cross</filename>,
219 the C library, and other pieces needed to finish building the
220 final cross-compiler in later stages.
221 This tool is a "native" package (i.e. it is designed to run on
222 the build host).
223 </para></listitem>
224 <listitem><para><filename>linux-libc-headers</filename>:
225 Headers needed for the cross-compiler.
226 </para></listitem>
227 <listitem><para><filename>eglibc-initial</filename>:
228 An initial version of the Embedded GLIBC needed to bootstrap
229 <filename>eglibc</filename>.
230 </para></listitem>
231 <listitem><para><filename>gcc-cross</filename>:
232 The final stage of the bootstrap process for the
233 cross-compiler.
234 This stage results in the actual cross-compiler that
235 BitBake uses when it builds an image for a targeted
236 device.
237 <note>
238 If you are replacing this cross compiler toolchain
239 with a custom version, you must replace
240 <filename>gcc-cross</filename>.
241 </note>
242 This tool is also a "native" package (i.e. it is
243 designed to run on the build host).
244 </para></listitem>
245 <listitem><para><filename>gcc-runtime</filename>:
246 Runtime libraries resulting from the toolchain bootstrapping
247 process.
248 This tool produces a binary that consists of the
249 runtime libraries need for the targeted device.
250 </para></listitem>
251 </itemizedlist>
252 </para>
253
254 <para>
255 You can use the OpenEmbedded build system to build an installer for
256 the relocatable SDK used to develop applications.
257 When you run the installer, it installs the toolchain, which contains
258 the development tools (e.g., the
259 <filename>gcc-cross-canadian</filename>),
260 <filename>binutils-cross-canadian</filename>, and other
261 <filename>nativesdk-*</filename> tools you need to cross-compile and
262 test your software.
263 The figure shows the commands you use to easily build out this
264 toolchain.
265 This cross-development toolchain is built to execute on the
266 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>,
267 which might or might not be the same
268 machine as the Build Host.
269 <note>
270 If your target architecture is supported by the Yocto Project,
271 you can take advantage of pre-built images that ship with the
272 Yocto Project and already contain cross-development toolchain
273 installers.
274 </note>
275 </para>
276
277 <para>
278 Here is the bootstrap process for the relocatable toolchain:
279 <literallayout class='monospaced'>
280 gcc -> binutils-crosssdk -> gcc-crosssdk-initial -> linux-libc-headers -> eglibc-initial -> nativesdk-eglibc -> gcc-crosssdk -> gcc-cross-canadian
281 </literallayout>
282 <itemizedlist>
283 <listitem><para><filename>gcc</filename>:
284 The build host's GNU Compiler Collection (GCC).
285 </para></listitem>
286 <listitem><para><filename>binutils-crosssdk</filename>:
287 The bare minimum binary utilities needed in order to run
288 the <filename>gcc-crosssdk-initial</filename> phase of the
289 bootstrap operation.
290 </para></listitem>
291 <listitem><para><filename>gcc-crosssdk-initial</filename>:
292 An early stage of the bootstrap process for creating
293 the cross-compiler.
294 This stage builds enough of the
295 <filename>gcc-crosssdk</filename> and supporting pieces so that
296 the final stage of the bootstrap process can produce the
297 finished cross-compiler.
298 This tool is a "native" binary that runs on the build host.
299 </para></listitem>
300 <listitem><para><filename>linux-libc-headers</filename>:
301 Headers needed for the cross-compiler.
302 </para></listitem>
303 <listitem><para><filename>eglibc-initial</filename>:
304 An initial version of the Embedded GLIBC needed to bootstrap
305 <filename>nativesdk-eglibc</filename>.
306 </para></listitem>
307 <listitem><para><filename>nativesdk-eglibc</filename>:
308 The Embedded GLIBC needed to bootstrap the
309 <filename>gcc-crosssdk</filename>.
310 </para></listitem>
311 <listitem><para><filename>gcc-crosssdk</filename>:
312 The final stage of the bootstrap process for the
313 relocatable cross-compiler.
314 The <filename>gcc-crosssdk</filename> is a transitory compiler
315 and never leaves the build host.
316 Its purpose is to help in the bootstrap process to create the
317 eventual relocatable <filename>gcc-cross-canadian</filename>
318 compiler, which is relocatable.
319 This tool is also a "native" package (i.e. it is
320 designed to run on the build host).
321 </para></listitem>
322 <listitem><para><filename>gcc-cross-canadian</filename>:
323 The final relocatable cross-compiler.
324 When run on the
325 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>,
326 this tool
327 produces executable code that runs on the target device.
328 </para></listitem>
329 </itemizedlist>
330 </para>
331</section>
332
333<section id="shared-state-cache">
334 <title>Shared State Cache</title>
335
336 <para>
337 By design, the OpenEmbedded build system builds everything from scratch unless
338 BitBake can determine that parts do not need to be rebuilt.
339 Fundamentally, building from scratch is attractive as it means all parts are
340 built fresh and there is no possibility of stale data causing problems.
341 When developers hit problems, they typically default back to building from scratch
342 so they know the state of things from the start.
343 </para>
344
345 <para>
346 Building an image from scratch is both an advantage and a disadvantage to the process.
347 As mentioned in the previous paragraph, building from scratch ensures that
348 everything is current and starts from a known state.
349 However, building from scratch also takes much longer as it generally means
350 rebuilding things that do not necessarily need rebuilt.
351 </para>
352
353 <para>
354 The Yocto Project implements shared state code that supports incremental builds.
355 The implementation of the shared state code answers the following questions that
356 were fundamental roadblocks within the OpenEmbedded incremental build support system:
357 <itemizedlist>
358 <listitem>What pieces of the system have changed and what pieces have not changed?</listitem>
359 <listitem>How are changed pieces of software removed and replaced?</listitem>
360 <listitem>How are pre-built components that do not need to be rebuilt from scratch
361 used when they are available?</listitem>
362 </itemizedlist>
363 </para>
364
365 <para>
366 For the first question, the build system detects changes in the "inputs" to a given task by
367 creating a checksum (or signature) of the task's inputs.
368 If the checksum changes, the system assumes the inputs have changed and the task needs to be
369 rerun.
370 For the second question, the shared state (sstate) code tracks which tasks add which output
371 to the build process.
372 This means the output from a given task can be removed, upgraded or otherwise manipulated.
373 The third question is partly addressed by the solution for the second question
374 assuming the build system can fetch the sstate objects from remote locations and
375 install them if they are deemed to be valid.
376 </para>
377
378 <note>
379 The OpenEmbedded build system does not maintain
380 <link linkend='var-PR'><filename>PR</filename></link> information
381 as part of the shared state packages.
382 Consequently, considerations exist that affect maintaining shared
383 state feeds.
384 For information on how the OpenEmbedded works with packages and can
385 track incrementing <filename>PR</filename> information, see the
386 "<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-package-revision-number'>Incrementing a Package Revision Number</ulink>"
387 section.
388 </note>
389
390 <para>
391 The rest of this section goes into detail about the overall incremental build
392 architecture, the checksums (signatures), shared state, and some tips and tricks.
393 </para>
394
395 <section id='overall-architecture'>
396 <title>Overall Architecture</title>
397
398 <para>
399 When determining what parts of the system need to be built, BitBake
400 uses a per-task basis and does not use a per-recipe basis.
401 You might wonder why using a per-task basis is preferred over a per-recipe basis.
402 To help explain, consider having the IPK packaging backend enabled and then switching to DEB.
403 In this case, <filename>do_install</filename> and <filename>do_package</filename>
404 output are still valid.
405 However, with a per-recipe approach, the build would not include the
406 <filename>.deb</filename> files.
407 Consequently, you would have to invalidate the whole build and rerun it.
408 Rerunning everything is not the best situation.
409 Also in this case, the core must be "taught" much about specific tasks.
410 This methodology does not scale well and does not allow users to easily add new tasks
411 in layers or as external recipes without touching the packaged-staging core.
412 </para>
413 </section>
414
415 <section id='checksums'>
416 <title>Checksums (Signatures)</title>
417
418 <para>
419 The shared state code uses a checksum, which is a unique signature of a task's
420 inputs, to determine if a task needs to be run again.
421 Because it is a change in a task's inputs that triggers a rerun, the process
422 needs to detect all the inputs to a given task.
423 For shell tasks, this turns out to be fairly easy because
424 the build process generates a "run" shell script for each task and
425 it is possible to create a checksum that gives you a good idea of when
426 the task's data changes.
427 </para>
428
429 <para>
430 To complicate the problem, there are things that should not be included in
431 the checksum.
432 First, there is the actual specific build path of a given task -
433 the <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
434 It does not matter if the working directory changes because it should not
435 affect the output for target packages.
436 Also, the build process has the objective of making native or cross packages relocatable.
437 The checksum therefore needs to exclude <filename>WORKDIR</filename>.
438 The simplistic approach for excluding the working directory is to set
439 <filename>WORKDIR</filename> to some fixed value and create the checksum
440 for the "run" script.
441 </para>
442
443 <para>
444 Another problem results from the "run" scripts containing functions that
445 might or might not get called.
446 The incremental build solution contains code that figures out dependencies
447 between shell functions.
448 This code is used to prune the "run" scripts down to the minimum set,
449 thereby alleviating this problem and making the "run" scripts much more
450 readable as a bonus.
451 </para>
452
453 <para>
454 So far we have solutions for shell scripts.
455 What about Python tasks?
456 The same approach applies even though these tasks are more difficult.
457 The process needs to figure out what variables a Python function accesses
458 and what functions it calls.
459 Again, the incremental build solution contains code that first figures out
460 the variable and function dependencies, and then creates a checksum for the data
461 used as the input to the task.
462 </para>
463
464 <para>
465 Like the <filename>WORKDIR</filename> case, situations exist where dependencies
466 should be ignored.
467 For these cases, you can instruct the build process to ignore a dependency
468 by using a line like the following:
469 <literallayout class='monospaced'>
470 PACKAGE_ARCHS[vardepsexclude] = "MACHINE"
471 </literallayout>
472 This example ensures that the <filename>PACKAGE_ARCHS</filename> variable does not
473 depend on the value of <filename>MACHINE</filename>, even if it does reference it.
474 </para>
475
476 <para>
477 Equally, there are cases where we need to add dependencies BitBake is not able to find.
478 You can accomplish this by using a line like the following:
479 <literallayout class='monospaced'>
480 PACKAGE_ARCHS[vardeps] = "MACHINE"
481 </literallayout>
482 This example explicitly adds the <filename>MACHINE</filename> variable as a
483 dependency for <filename>PACKAGE_ARCHS</filename>.
484 </para>
485
486 <para>
487 Consider a case with in-line Python, for example, where BitBake is not
488 able to figure out dependencies.
489 When running in debug mode (i.e. using <filename>-DDD</filename>), BitBake
490 produces output when it discovers something for which it cannot figure out
491 dependencies.
492 The Yocto Project team has currently not managed to cover those dependencies
493 in detail and is aware of the need to fix this situation.
494 </para>
495
496 <para>
497 Thus far, this section has limited discussion to the direct inputs into a task.
498 Information based on direct inputs is referred to as the "basehash" in the
499 code.
500 However, there is still the question of a task's indirect inputs - the
501 things that were already built and present in the
502 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
503 The checksum (or signature) for a particular task needs to add the hashes
504 of all the tasks on which the particular task depends.
505 Choosing which dependencies to add is a policy decision.
506 However, the effect is to generate a master checksum that combines the basehash
507 and the hashes of the task's dependencies.
508 </para>
509
510 <para>
511 At the code level, there are a variety of ways both the basehash and the
512 dependent task hashes can be influenced.
513 Within the BitBake configuration file, we can give BitBake some extra information
514 to help it construct the basehash.
515 The following statements effectively result in a list of global variable
516 dependency excludes - variables never included in any checksum:
517 <literallayout class='monospaced'>
518 BB_HASHBASE_WHITELIST ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH"
519 BB_HASHBASE_WHITELIST += "DL_DIR SSTATE_DIR THISDIR FILESEXTRAPATHS"
520 BB_HASHBASE_WHITELIST += "FILE_DIRNAME HOME LOGNAME SHELL TERM USER"
521 BB_HASHBASE_WHITELIST += "FILESPATH USERNAME STAGING_DIR_HOST STAGING_DIR_TARGET"
522 </literallayout>
523 The previous example actually excludes
524 <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>
525 since it is actually constructed as a path within
526 <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, which is on
527 the whitelist.
528 </para>
529
530 <para>
531 The rules for deciding which hashes of dependent tasks to include through
532 dependency chains are more complex and are generally accomplished with a
533 Python function.
534 The code in <filename>meta/lib/oe/sstatesig.py</filename> shows two examples
535 of this and also illustrates how you can insert your own policy into the system
536 if so desired.
537 This file defines the two basic signature generators <filename>OE-Core</filename>
538 uses: "OEBasic" and "OEBasicHash".
539 By default, there is a dummy "noop" signature handler enabled in BitBake.
540 This means that behavior is unchanged from previous versions.
541 <filename>OE-Core</filename> uses the "OEBasicHash" signature handler by default
542 through this setting in the <filename>bitbake.conf</filename> file:
543 <literallayout class='monospaced'>
544 BB_SIGNATURE_HANDLER ?= "OEBasicHash"
545 </literallayout>
546 The "OEBasicHash" <filename>BB_SIGNATURE_HANDLER</filename> is the same as the
547 "OEBasic" version but adds the task hash to the stamp files.
548 This results in any
549 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
550 change that changes the task hash, automatically
551 causing the task to be run again.
552 This removes the need to bump <link linkend='var-PR'><filename>PR</filename></link>
553 values and changes to Metadata automatically ripple across the build.
554 </para>
555
556 <para>
557 It is also worth noting that the end result of these signature generators is to
558 make some dependency and hash information available to the build.
559 This information includes:
560 <literallayout class='monospaced'>
561 BB_BASEHASH_task-&lt;taskname&gt; - the base hashes for each task in the recipe
562 BB_BASEHASH_&lt;filename:taskname&gt; - the base hashes for each dependent task
563 BBHASHDEPS_&lt;filename:taskname&gt; - The task dependencies for each task
564 BB_TASKHASH - the hash of the currently running task
565 </literallayout>
566 </para>
567 </section>
568
569 <section id='shared-state'>
570 <title>Shared State</title>
571
572 <para>
573 Checksums and dependencies, as discussed in the previous section, solve half the
574 problem.
575 The other part of the problem is being able to use checksum information during the build
576 and being able to reuse or rebuild specific components.
577 </para>
578
579 <para>
580 The shared state class (<filename>sstate.bbclass</filename>)
581 is a relatively generic implementation of how to "capture" a snapshot of a given task.
582 The idea is that the build process does not care about the source of a task's output.
583 Output could be freshly built or it could be downloaded and unpacked from
584 somewhere - the build process does not need to worry about its source.
585 </para>
586
587 <para>
588 There are two types of output, one is just about creating a directory
589 in <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
590 A good example is the output of either <filename>do_install</filename> or
591 <filename>do_package</filename>.
592 The other type of output occurs when a set of data is merged into a shared directory
593 tree such as the sysroot.
594 </para>
595
596 <para>
597 The Yocto Project team has tried to keep the details of the implementation hidden in
598 <filename>sstate.bbclass</filename>.
599 From a user's perspective, adding shared state wrapping to a task
600 is as simple as this <filename>do_deploy</filename> example taken from
601 <filename>do_deploy.bbclass</filename>:
602 <literallayout class='monospaced'>
603 DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
604 SSTATETASKS += "do_deploy"
605 do_deploy[sstate-name] = "deploy"
606 do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"
607 do_deploy[sstate-outputdirs] = "${DEPLOY_DIR_IMAGE}"
608
609 python do_deploy_setscene () {
610 sstate_setscene(d)
611 }
612 addtask do_deploy_setscene
613 </literallayout>
614 In the example, we add some extra flags to the task, a name field ("deploy"), an
615 input directory where the task sends data, and the output
616 directory where the data from the task should eventually be copied.
617 We also add a <filename>_setscene</filename> variant of the task and add the task
618 name to the <filename>SSTATETASKS</filename> list.
619 </para>
620
621 <para>
622 If you have a directory whose contents you need to preserve, you can do this with
623 a line like the following:
624 <literallayout class='monospaced'>
625 do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}"
626 </literallayout>
627 This method, as well as the following example, also works for multiple directories.
628 <literallayout class='monospaced'>
629 do_package[sstate-inputdirs] = "${PKGDESTWORK} ${SHLIBSWORKDIR}"
630 do_package[sstate-outputdirs] = "${PKGDATA_DIR} ${SHLIBSDIR}"
631 do_package[sstate-lockfile] = "${PACKAGELOCK}"
632 </literallayout>
633 These methods also include the ability to take a lockfile when manipulating
634 shared state directory structures since some cases are sensitive to file
635 additions or removals.
636 </para>
637
638 <para>
639 Behind the scenes, the shared state code works by looking in
640 <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> and
641 <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
642 for shared state files.
643 Here is an example:
644 <literallayout class='monospaced'>
645 SSTATE_MIRRORS ?= "\
646 file://.* http://someserver.tld/share/sstate/PATH \n \
647 file://.* file:///some/local/dir/sstate/PATH"
648 </literallayout>
649 <note>
650 The shared state directory (<filename>SSTATE_DIR</filename>) is
651 organized into two-character subdirectories, where the subdirectory
652 names are based on the first two characters of the hash.
653 If the shared state directory structure for a mirror has the
654 same structure as <filename>SSTATE_DIR</filename>, you must
655 specify "PATH" as part of the URI to enable the build system
656 to map to the appropriate subdirectory.
657 </note>
658 </para>
659
660 <para>
661 The shared state package validity can be detected just by looking at the
662 filename since the filename contains the task checksum (or signature) as
663 described earlier in this section.
664 If a valid shared state package is found, the build process downloads it
665 and uses it to accelerate the task.
666 </para>
667
668 <para>
669 The build processes use the <filename>*_setscene</filename> tasks
670 for the task acceleration phase.
671 BitBake goes through this phase before the main execution code and tries
672 to accelerate any tasks for which it can find shared state packages.
673 If a shared state package for a task is available, the shared state
674 package is used.
675 This means the task and any tasks on which it is dependent are not
676 executed.
677 </para>
678
679 <para>
680 As a real world example, the aim is when building an IPK-based image,
681 only the <filename>do_package_write_ipk</filename> tasks would have their
682 shared state packages fetched and extracted.
683 Since the sysroot is not used, it would never get extracted.
684 This is another reason why a task-based approach is preferred over a
685 recipe-based approach, which would have to install the output from every task.
686 </para>
687 </section>
688
689 <section id='tips-and-tricks'>
690 <title>Tips and Tricks</title>
691
692 <para>
693 The code in the build system that supports incremental builds is not
694 simple code.
695 This section presents some tips and tricks that help you work around
696 issues related to shared state code.
697 </para>
698
699 <section id='debugging'>
700 <title>Debugging</title>
701
702 <para>
703 When things go wrong, debugging needs to be straightforward.
704 Because of this, the Yocto Project team included strong debugging
705 tools:
706 <itemizedlist>
707 <listitem><para>Whenever a shared state package is written out, so is a
708 corresponding <filename>.siginfo</filename> file.
709 This practice results in a pickled Python database of all
710 the metadata that went into creating the hash for a given shared state
711 package.</para></listitem>
712 <listitem><para>If you run BitBake with the <filename>--dump-signatures</filename>
713 (or <filename>-S</filename>) option, BitBake dumps out
714 <filename>.siginfo</filename> files in
715 the stamp directory for every task it would have executed instead of
716 building the specified target package.</para></listitem>
717 <listitem><para>There is a <filename>bitbake-diffsigs</filename> command that
718 can process <filename>.siginfo</filename> files.
719 If you specify one of these files, BitBake dumps out the dependency
720 information in the file.
721 If you specify two files, BitBake compares the two files and dumps out
722 the differences between the two.
723 This more easily helps answer the question of "What
724 changed between X and Y?"</para></listitem>
725 </itemizedlist>
726 </para>
727 </section>
728
729 <section id='invalidating-shared-state'>
730 <title>Invalidating Shared State</title>
731
732 <para>
733 The shared state code uses checksums and shared state
734 cache to avoid unnecessarily rebuilding tasks.
735 As with all schemes, this one has some drawbacks.
736 It is possible that you could make implicit changes that are not factored
737 into the checksum calculation, but do affect a task's output.
738 A good example is perhaps when a tool changes its output.
739 Assume that the output of <filename>rpmdeps</filename> needed to change.
740 The result of the change should be that all the
741 <filename>package</filename>, <filename>package_write_rpm</filename>,
742 and <filename>package_deploy-rpm</filename> shared state cache
743 items would become invalid.
744 But, because this is a change that is external to the code and therefore implicit,
745 the associated shared state cache items do not become invalidated.
746 In this case, the build process uses the cached items rather than running the
747 task again.
748 Obviously, these types of implicit changes can cause problems.
749 </para>
750
751 <para>
752 To avoid these problems during the build, you need to understand the effects of any
753 change you make.
754 Note that any changes you make directly to a function automatically are factored into
755 the checksum calculation and thus, will invalidate the associated area of sstate cache.
756 You need to be aware of any implicit changes that are not obvious changes to the
757 code and could affect the output of a given task.
758 Once you are aware of such changes, you can take steps to invalidate the cache
759 and force the tasks to run.
760 The steps to take are as simple as changing function's comments in the source code.
761 For example, to invalidate package shared state files, change the comment statements
762 of <filename>do_package</filename> or the comments of one of the functions it calls.
763 The change is purely cosmetic, but it causes the checksum to be recalculated and
764 forces the task to be run again.
765 </para>
766
767 <note>
768 For an example of a commit that makes a cosmetic change to invalidate
769 a shared state, see this
770 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54'>commit</ulink>.
771 </note>
772 </section>
773 </section>
774</section>
775
776<section id='x32'>
777 <title>x32</title>
778
779 <para>
780 x32 is a processor-specific Application Binary Interface (psABI) for x86_64.
781 An ABI defines the calling conventions between functions in a processing environment.
782 The interface determines what registers are used and what the sizes are for various C data types.
783 </para>
784
785 <para>
786 Some processing environments prefer using 32-bit applications even when running
787 on Intel 64-bit platforms.
788 Consider the i386 psABI, which is a very old 32-bit ABI for Intel 64-bit platforms.
789 The i386 psABI does not provide efficient use and access of the Intel 64-bit processor resources,
790 leaving the system underutilized.
791 Now consider the x86_64 psABI.
792 This ABI is newer and uses 64-bits for data sizes and program pointers.
793 The extra bits increase the footprint size of the programs, libraries,
794 and also increases the memory and file system size requirements.
795 Executing under the x32 psABI enables user programs to utilize CPU and system resources
796 more efficiently while keeping the memory footprint of the applications low.
797 Extra bits are used for registers but not for addressing mechanisms.
798 </para>
799
800 <section id='support'>
801 <title>Support</title>
802
803 <para>
804 While the x32 psABI specifications are not fully finalized, this Yocto Project
805 release supports current development specifications of x32 psABI.
806 As of this release of the Yocto Project, x32 psABI support exists as follows:
807 <itemizedlist>
808 <listitem><para>You can create packages and images in x32 psABI format on x86_64 architecture targets.
809 </para></listitem>
810 <listitem><para>You can successfully build many recipes with the x32 toolchain.</para></listitem>
811 <listitem><para>You can create and boot <filename>core-image-minimal</filename> and
812 <filename>core-image-sato</filename> images.</para></listitem>
813 </itemizedlist>
814 </para>
815 </section>
816
817 <section id='stabilizing-and-completing-x32'>
818 <title>Stabilizing and Completing x32</title>
819
820 <para>
821 As of this Yocto Project release, the x32 psABI kernel and library
822 interfaces specifications are not finalized.
823 </para>
824
825 <para>
826 Future Plans for the x32 psABI in the Yocto Project include the following:
827 <itemizedlist>
828 <listitem><para>Enhance and fix the few remaining recipes so they
829 work with and support x32 toolchains.</para></listitem>
830 <listitem><para>Enhance RPM Package Manager (RPM) support for x32 binaries.</para></listitem>
831 <listitem><para>Support larger images.</para></listitem>
832 </itemizedlist>
833 </para>
834 </section>
835
836 <section id='using-x32-right-now'>
837 <title>Using x32 Right Now</title>
838
839 <para>
840 Follow these steps to use the x32 spABI:
841 <itemizedlist>
842 <listitem><para>Enable the x32 psABI tuning file for <filename>x86_64</filename>
843 machines by editing the <filename>conf/local.conf</filename> like this:
844 <literallayout class='monospaced'>
845 MACHINE = "qemux86-64"
846 DEFAULTTUNE = "x86-64-x32"
847 baselib = "${@d.getVar('BASE_LIB_tune-' + (d.getVar('DEFAULTTUNE', True) \
848 or 'INVALID'), True) or 'lib'}"
849 #MACHINE = "genericx86"
850 #DEFAULTTUNE = "core2-64-x32"
851 </literallayout></para></listitem>
852 <listitem><para>As usual, use BitBake to build an image that supports the x32 psABI.
853 Here is an example:
854 <literallayout class='monospaced'>
855 $ bitbake core-image-sato
856 </literallayout></para></listitem>
857 <listitem><para>As usual, run your image using QEMU:
858 <literallayout class='monospaced'>
859 $ runqemu qemux86-64 core-image-sato
860 </literallayout></para></listitem>
861 </itemizedlist>
862 </para>
863 </section>
864</section>
865
866<section id="wayland">
867 <title>Wayland</title>
868
869 <para>
870 <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Wayland</ulink>
871 is a computer display server protocol that when implemented
872 provides a method for compositing window managers to communicate
873 directly with applications and video hardware and expects them to
874 communicate with input hardware using other libraries.
875 Using Wayland with supporting targets can result in better control
876 over graphics frame rendering than an application might otherwise
877 achieve.
878 </para>
879
880 <para>
881 The Yocto Project provides the Wayland protocol libraries and the
882 reference Weston compositor as part of it release.
883 This section describes what you need to do to implement Wayland and
884 use the compositor when building an image for a supporting target.
885 </para>
886
887 <section id="wayland-support">
888 <title>Support</title>
889
890 <para>
891 The Wayland protocol libraries and the reference Weston compositor
892 ship as integrated packages in the <filename>meta</filename> layer
893 of the
894 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
895 Specifically, you can find the recipes that build both Wayland
896 and Weston at <filename>meta/recipes-graphics/wayland</filename>.
897 </para>
898
899 <para>
900 You can build both the Wayland and Weston packages for use only
901 with targets that accept the
902 <ulink url='http://dri.freedesktop.org/wiki/'>Mesa 3D and Direct Rendering Infrastructure</ulink>,
903 which is also known as Mesa DRI.
904 This implies that you cannot build and use the packages if your
905 target uses, for example, the
906 <trademark class='registered'>Intel</trademark> Embedded Media and
907 Graphics Driver (<trademark class='registered'>Intel</trademark>
908 EMGD) that overrides Mesa DRI.
909 </para>
910
911 <note>
912 Due to lack of EGL support, Weston 1.0.3 will not run directly on
913 the emulated QEMU hardware.
914 However, this version of Weston will run under X emulation without
915 issues.
916 </note>
917 </section>
918
919 <section id="enabling-wayland-in-an-image">
920 <title>Enabling Wayland in an Image</title>
921
922 <para>
923 To enable Wayland, you need to enable it to be built and enable
924 it to be included in the image.
925 </para>
926
927 <section id="enable-building">
928 <title>Building</title>
929
930 <para>
931 To cause Mesa to build the <filename>wayland-egl</filename>
932 platform and Weston to build Wayland with Kernel Mode
933 Setting
934 (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>)
935 support, include the "wayland" flag in the
936 <link linkend="var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></link>
937 statement in your <filename>local.conf</filename> file:
938 <literallayout class='monospaced'>
939 DISTRO_FEATURES_append = " wayland"
940 </literallayout>
941 </para>
942
943 <note>
944 If X11 has been enabled elsewhere, Weston will build Wayland
945 with X11 support
946 </note>
947 </section>
948
949 <section id="enable-installation-in-an-image">
950 <title>Installing</title>
951
952 <para>
953 To install the Wayland feature into an image, you must
954 include the following
955 <link linkend='var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></link>
956 statement in your <filename>local.conf</filename> file:
957 <literallayout class='monospaced'>
958 CORE_IMAGE_EXTRA_INSTALL += "wayland weston"
959 </literallayout>
960 </para>
961 </section>
962 </section>
963
964 <section id="running-weston">
965 <title>Running Weston</title>
966
967 <para>
968 To run Weston inside X11, enabling it as described earlier and
969 building a Sato image is sufficient.
970 If you are running your image under Sato, a Weston Launcher appears
971 in the "Utility" category.
972 </para>
973
974 <para>
975 Alternatively, you can run Weston through the command-line
976 interpretor (CLI), which is better suited for development work.
977 To run Weston under the CLI you need to do the following after
978 your image is built:
979 <orderedlist>
980 <listitem><para>Run these commands to export
981 <filename>XDG_RUNTIME_DIR</filename>:
982 <literallayout class='monospaced'>
983 mkdir -p /tmp/$USER-weston
984 chmod 0700 /tmp/$USER-weston
985 export XDG_RUNTIME_DIR=/tmp/$USER=weston
986 </literallayout></para></listitem>
987 <listitem><para>Launch Weston in the shell:
988 <literallayout class='monospaced'>
989 weston
990 </literallayout></para></listitem>
991 </orderedlist>
992 </para>
993 </section>
994</section>
995
996<section id="licenses">
997 <title>Licenses</title>
998
999 <para>
1000 This section describes the mechanism by which the OpenEmbedded build system
1001 tracks changes to licensing text.
1002 The section also describes how to enable commercially licensed recipes,
1003 which by default are disabled.
1004 </para>
1005
1006 <para>
1007 For information that can help you maintain compliance with various open
1008 source licensing during the lifecycle of the product, see the
1009 "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Project's Lifecycle</ulink>" section
1010 in the Yocto Project Development Manual.
1011 </para>
1012
1013 <section id="usingpoky-configuring-LIC_FILES_CHKSUM">
1014 <title>Tracking License Changes</title>
1015
1016 <para>
1017 The license of an upstream project might change in the future.
1018 In order to prevent these changes going unnoticed, the
1019 <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename>
1020 variable tracks changes to the license text. The checksums are validated at the end of the
1021 configure step, and if the checksums do not match, the build will fail.
1022 </para>
1023
1024 <section id="usingpoky-specifying-LIC_FILES_CHKSUM">
1025 <title>Specifying the <filename>LIC_FILES_CHKSUM</filename> Variable</title>
1026
1027 <para>
1028 The <filename>LIC_FILES_CHKSUM</filename>
1029 variable contains checksums of the license text in the source code for the recipe.
1030 Following is an example of how to specify <filename>LIC_FILES_CHKSUM</filename>:
1031 <literallayout class='monospaced'>
1032 LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \
1033 file://licfile1.txt;beginline=5;endline=29;md5=yyyy \
1034 file://licfile2.txt;endline=50;md5=zzzz \
1035 ..."
1036 </literallayout>
1037 </para>
1038
1039 <para>
1040 The build system uses the
1041 <filename><link linkend='var-S'>S</link></filename> variable as
1042 the default directory used when searching files listed in
1043 <filename>LIC_FILES_CHKSUM</filename>.
1044 The previous example employs the default directory.
1045 </para>
1046
1047 <para>
1048 Consider this next example:
1049 <literallayout class='monospaced'>
1050 LIC_FILES_CHKSUM = "file://src/ls.c;beginline=5;endline=16;\
1051 md5=bb14ed3c4cda583abc85401304b5cd4e"
1052 LIC_FILES_CHKSUM = "file://${WORKDIR}/license.html;md5=5c94767cedb5d6987c902ac850ded2c6"
1053 </literallayout>
1054 </para>
1055
1056 <para>
1057 The first line locates a file in
1058 <filename>${S}/src/ls.c</filename>.
1059 The second line refers to a file in
1060 <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>.
1061 </para>
1062 <para>
1063 Note that <filename>LIC_FILES_CHKSUM</filename> variable is
1064 mandatory for all recipes, unless the
1065 <filename>LICENSE</filename> variable is set to "CLOSED".
1066 </para>
1067 </section>
1068
1069 <section id="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax">
1070 <title>Explanation of Syntax</title>
1071 <para>
1072 As mentioned in the previous section, the
1073 <filename>LIC_FILES_CHKSUM</filename> variable lists all the
1074 important files that contain the license text for the source code.
1075 It is possible to specify a checksum for an entire file, or a specific section of a
1076 file (specified by beginning and ending line numbers with the "beginline" and "endline"
1077 parameters, respectively).
1078 The latter is useful for source files with a license notice header,
1079 README documents, and so forth.
1080 If you do not use the "beginline" parameter, then it is assumed that the text begins on the
1081 first line of the file.
1082 Similarly, if you do not use the "endline" parameter, it is assumed that the license text
1083 ends with the last line of the file.
1084 </para>
1085
1086 <para>
1087 The "md5" parameter stores the md5 checksum of the license text.
1088 If the license text changes in any way as compared to this parameter
1089 then a mismatch occurs.
1090 This mismatch triggers a build failure and notifies the developer.
1091 Notification allows the developer to review and address the license text changes.
1092 Also note that if a mismatch occurs during the build, the correct md5
1093 checksum is placed in the build log and can be easily copied to the recipe.
1094 </para>
1095
1096 <para>
1097 There is no limit to how many files you can specify using the
1098 <filename>LIC_FILES_CHKSUM</filename> variable.
1099 Generally, however, every project requires a few specifications for license tracking.
1100 Many projects have a "COPYING" file that stores the license information for all the source
1101 code files.
1102 This practice allows you to just track the "COPYING" file as long as it is kept up to date.
1103 </para>
1104
1105 <tip>
1106 If you specify an empty or invalid "md5" parameter, BitBake returns an md5 mis-match
1107 error and displays the correct "md5" parameter value during the build.
1108 The correct parameter is also captured in the build log.
1109 </tip>
1110
1111 <tip>
1112 If the whole file contains only license text, you do not need to use the "beginline" and
1113 "endline" parameters.
1114 </tip>
1115 </section>
1116 </section>
1117
1118 <section id="enabling-commercially-licensed-recipes">
1119 <title>Enabling Commercially Licensed Recipes</title>
1120
1121 <para>
1122 By default, the OpenEmbedded build system disables
1123 components that have commercial or other special licensing
1124 requirements.
1125 Such requirements are defined on a
1126 recipe-by-recipe basis through the <filename>LICENSE_FLAGS</filename> variable
1127 definition in the affected recipe.
1128 For instance, the
1129 <filename>$HOME/poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
1130 recipe contains the following statement:
1131 <literallayout class='monospaced'>
1132 LICENSE_FLAGS = "commercial"
1133 </literallayout>
1134 Here is a slightly more complicated example that contains both an
1135 explicit recipe name and version (after variable expansion):
1136 <literallayout class='monospaced'>
1137 LICENSE_FLAGS = "license_${PN}_${PV}"
1138 </literallayout>
1139 In order for a component restricted by a <filename>LICENSE_FLAGS</filename>
1140 definition to be enabled and included in an image, it
1141 needs to have a matching entry in the global
1142 <filename>LICENSE_FLAGS_WHITELIST</filename> variable, which is a variable
1143 typically defined in your <filename>local.conf</filename> file.
1144 For example, to enable
1145 the <filename>$HOME/poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename>
1146 package, you could add either the string
1147 "commercial_gst-plugins-ugly" or the more general string
1148 "commercial" to <filename>LICENSE_FLAGS_WHITELIST</filename>.
1149 See the
1150 "<link linkend='license-flag-matching'>License Flag Matching</link>" section
1151 for a full explanation of how <filename>LICENSE_FLAGS</filename> matching works.
1152 Here is the example:
1153 <literallayout class='monospaced'>
1154 LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly"
1155 </literallayout>
1156 Likewise, to additionally enable the package built from the recipe containing
1157 <filename>LICENSE_FLAGS = "license_${PN}_${PV}"</filename>, and assuming
1158 that the actual recipe name was <filename>emgd_1.10.bb</filename>,
1159 the following string would enable that package as well as
1160 the original <filename>gst-plugins-ugly</filename> package:
1161 <literallayout class='monospaced'>
1162 LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly license_emgd_1.10"
1163 </literallayout>
1164 As a convenience, you do not need to specify the complete license string
1165 in the whitelist for every package.
1166 you can use an abbreviated form, which consists
1167 of just the first portion or portions of the license string before
1168 the initial underscore character or characters.
1169 A partial string will match
1170 any license that contains the given string as the first
1171 portion of its license.
1172 For example, the following
1173 whitelist string will also match both of the packages
1174 previously mentioned as well as any other packages that have
1175 licenses starting with "commercial" or "license".
1176 <literallayout class='monospaced'>
1177 LICENSE_FLAGS_WHITELIST = "commercial license"
1178 </literallayout>
1179 </para>
1180
1181 <section id="license-flag-matching">
1182 <title>License Flag Matching</title>
1183
1184 <para>
1185 License flag matching allows you to control what recipes the
1186 OpenEmbedded build system includes in the build.
1187 Fundamentally, the build system attempts to match
1188 <filename>LICENSE_FLAG</filename> strings found in
1189 recipes against <filename>LICENSE_FLAGS_WHITELIST</filename>
1190 strings found in the whitelist.
1191 A match, causes the build system to include a recipe in the
1192 build, while failure to find a match causes the build system to
1193 exclude a recipe.
1194 </para>
1195
1196 <para>
1197 In general, license flag matching is simple.
1198 However, understanding some concepts will help you
1199 correctly and effectively use matching.
1200 </para>
1201
1202 <para>
1203 Before a flag
1204 defined by a particular recipe is tested against the
1205 contents of the whitelist, the expanded string
1206 <filename>_${PN}</filename> is appended to the flag.
1207 This expansion makes each <filename>LICENSE_FLAGS</filename>
1208 value recipe-specific.
1209 After expansion, the string is then matched against the
1210 whitelist.
1211 Thus, specifying
1212 <filename>LICENSE_FLAGS = "commercial"</filename>
1213 in recipe "foo", for example, results in the string
1214 <filename>"commercial_foo"</filename>.
1215 And, to create a match, that string must appear in the
1216 whitelist.
1217 </para>
1218
1219 <para>
1220 Judicious use of the <filename>LICENSE_FLAGS</filename>
1221 strings and the contents of the
1222 <filename>LICENSE_FLAGS_WHITELIST</filename> variable
1223 allows you a lot of flexibility for including or excluding
1224 recipes based on licensing.
1225 For example, you can broaden the matching capabilities by
1226 using license flags string subsets in the whitelist.
1227 <note>When using a string subset, be sure to use the part of
1228 the expanded string that precedes the appended underscore
1229 character (e.g. <filename>usethispart_1.3</filename>,
1230 <filename>usethispart_1.4</filename>, and so forth).
1231 </note>
1232 For example, simply specifying the string "commercial" in
1233 the whitelist matches any expanded
1234 <filename>LICENSE_FLAGS</filename> definition that starts with
1235 the string "commercial" such as "commercial_foo" and
1236 "commercial_bar", which are the strings the build system
1237 automatically generates for hypothetical recipes named
1238 "foo" and "bar" assuming those recipes simply specify the
1239 following:
1240 <literallayout class='monospaced'>
1241 LICENSE_FLAGS = "commercial"
1242 </literallayout>
1243 Thus, you can choose to exhaustively
1244 enumerate each license flag in the whitelist and
1245 allow only specific recipes into the image, or
1246 you can use a string subset that causes a broader range of
1247 matches to allow a range of recipes into the image.
1248 </para>
1249
1250 <para>
1251 This scheme works even if the
1252 <filename>LICENSE_FLAG</filename> string already
1253 has <filename>_${PN}</filename> appended.
1254 For example, the build system turns the license flag
1255 "commercial_1.2_foo" into "commercial_1.2_foo_foo" and would
1256 match both the general "commercial" and the specific
1257 "commercial_1.2_foo" strings found in the whitelist, as
1258 expected.
1259 </para>
1260
1261 <para>
1262 Here are some other scenarios:
1263 <itemizedlist>
1264 <listitem><para>You can specify a versioned string in the
1265 recipe such as "commercial_foo_1.2" in a "foo" recipe.
1266 The build system expands this string to
1267 "commercial_foo_1.2_foo".
1268 Combine this license flag with a whitelist that has
1269 the string "commercial" and you match the flag along
1270 with any other flag that starts with the string
1271 "commercial".</para></listitem>
1272 <listitem><para>Under the same circumstances, you can
1273 use "commercial_foo" in the whitelist and the
1274 build system not only matches "commercial_foo_1.2" but
1275 also matches any license flag with the string
1276 "commercial_foo", regardless of the version.
1277 </para></listitem>
1278 <listitem><para>You can be very specific and use both the
1279 package and version parts in the whitelist (e.g.
1280 "commercial_foo_1.2") to specifically match a
1281 versioned recipe.</para></listitem>
1282 </itemizedlist>
1283 </para>
1284 </section>
1285
1286 <section id="other-variables-related-to-commercial-licenses">
1287 <title>Other Variables Related to Commercial Licenses</title>
1288
1289 <para>
1290 Other helpful variables related to commercial
1291 license handling exist and are defined in the
1292 <filename>$HOME/poky/meta/conf/distro/include/default-distrovars.inc</filename> file:
1293 <literallayout class='monospaced'>
1294 COMMERCIAL_AUDIO_PLUGINS ?= ""
1295 COMMERCIAL_VIDEO_PLUGINS ?= ""
1296 COMMERCIAL_QT = ""
1297 </literallayout>
1298 If you want to enable these components, you can do so by making sure you have
1299 statements similar to the following
1300 in your <filename>local.conf</filename> configuration file:
1301 <literallayout class='monospaced'>
1302 COMMERCIAL_AUDIO_PLUGINS = "gst-plugins-ugly-mad \
1303 gst-plugins-ugly-mpegaudioparse"
1304 COMMERCIAL_VIDEO_PLUGINS = "gst-plugins-ugly-mpeg2dec \
1305 gst-plugins-ugly-mpegstream gst-plugins-bad-mpegvideoparse"
1306 COMMERCIAL_QT ?= "qmmp"
1307 LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp"
1308 </literallayout>
1309 Of course, you could also create a matching whitelist
1310 for those components using the more general "commercial"
1311 in the whitelist, but that would also enable all the
1312 other packages with <filename>LICENSE_FLAGS</filename> containing
1313 "commercial", which you may or may not want:
1314 <literallayout class='monospaced'>
1315 LICENSE_FLAGS_WHITELIST = "commercial"
1316 </literallayout>
1317 </para>
1318
1319 <para>
1320 Specifying audio and video plug-ins as part of the
1321 <filename>COMMERCIAL_AUDIO_PLUGINS</filename> and
1322 <filename>COMMERCIAL_VIDEO_PLUGINS</filename> statements
1323 or commercial Qt components as part of
1324 the <filename>COMMERCIAL_QT</filename> statement (along
1325 with the enabling <filename>LICENSE_FLAGS_WHITELIST</filename>) includes the
1326 plug-ins or components into built images, thus adding
1327 support for media formats or components.
1328 </para>
1329 </section>
1330 </section>
1331</section>
1332</chapter>
1333<!--
1334vim: expandtab tw=80 ts=4
1335-->
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
new file mode 100644
index 0000000000..b00e7bc14e
--- /dev/null
+++ b/documentation/ref-manual/usingpoky.xml
@@ -0,0 +1,848 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='usingpoky'>
6<title>Using the Yocto Project</title>
7
8 <para>
9 This chapter describes common usage for the Yocto Project.
10 The information is introductory in nature as other manuals in the Yocto Project
11 documentation set provide more details on how to use the Yocto Project.
12 </para>
13
14<section id='usingpoky-build'>
15 <title>Running a Build</title>
16
17 <para>
18 This section provides a summary of the build process and provides information
19 for less obvious aspects of the build process.
20 For general information on how to build an image using the OpenEmbedded build
21 system, see the
22 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
23 section of the Yocto Project Quick Start.
24 </para>
25
26 <section id='build-overview'>
27 <title>Build Overview</title>
28
29 <para>
30 The first thing you need to do is set up the OpenEmbedded build
31 environment by sourcing an environment setup script
32 (i.e.
33 <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
34 or
35 <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
36 Here is an example:
37 <literallayout class='monospaced'>
38 $ source &OE_INIT_FILE; [&lt;build_dir&gt;]
39 </literallayout>
40 </para>
41
42 <para>
43 The <filename>build_dir</filename> is optional and specifies the directory the
44 OpenEmbedded build system uses for the build -
45 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
46 If you do not specify a Build Directory, it defaults to a directory
47 named <filename>build</filename> in your current working directory.
48 A common practice is to use a different Build Directory for different targets.
49 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
50 target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target.
51 See the "<link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>"
52 section for more information on this script.
53 </para>
54
55 <para>
56 Once the build environment is set up, you can build a target using:
57 <literallayout class='monospaced'>
58 $ bitbake &lt;target&gt;
59 </literallayout>
60 </para>
61
62 <para>
63 The <filename>target</filename> is the name of the recipe you want to build.
64 Common targets are the images in <filename>meta/recipes-core/images</filename>,
65 <filename>/meta/recipes-sato/images</filename>, etc. all found in the
66 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
67 Or, the target can be the name of a recipe for a specific piece of software such as
68 BusyBox.
69 For more details about the images the OpenEmbedded build system supports, see the
70 "<link linkend="ref-images">Images</link>" chapter.
71 </para>
72
73 <note>
74 Building an image without GNU General Public License Version 3 (GPLv3) components
75 is only supported for minimal and base images.
76 See the "<link linkend='ref-images'>Images</link>" chapter for more information.
77 </note>
78 </section>
79
80 <section id='building-an-image-using-gpl-components'>
81 <title>Building an Image Using GPL Components</title>
82
83 <para>
84 When building an image using GPL components, you need to maintain your original
85 settings and not switch back and forth applying different versions of the GNU
86 General Public License.
87 If you rebuild using different versions of GPL, dependency errors might occur
88 due to some components not being rebuilt.
89 </para>
90 </section>
91</section>
92
93<section id='usingpoky-install'>
94 <title>Installing and Using the Result</title>
95
96 <para>
97 Once an image has been built, it often needs to be installed.
98 The images and kernels built by the OpenEmbedded build system are placed in the
99 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in
100 <filename class="directory">tmp/deploy/images</filename>.
101 For information on how to run pre-built images such as <filename>qemux86</filename>
102 and <filename>qemuarm</filename>, see the
103 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>"
104 section in the Yocto Project Quick Start.
105 For information about how to install these images, see the documentation for your
106 particular board or machine.
107 </para>
108</section>
109
110<section id='usingpoky-debugging'>
111 <title>Debugging Build Failures</title>
112
113 <para>
114 The exact method for debugging build failures depends on the nature of the
115 problem and on the system's area from which the bug originates.
116 Standard debugging practices such as comparison against the last
117 known working version with examination of the changes and the re-application of steps
118 to identify the one causing the problem are
119 valid for the Yocto Project just as they are for any other system.
120 Even though it is impossible to detail every possible potential failure,
121 this section provides some general tips to aid in debugging.
122 </para>
123
124 <para>
125 For discussions on debugging, see the
126 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
127 and
128 "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working within Eclipse</ulink>"
129 sections in the Yocto Project Development Manual.
130 </para>
131
132 <section id='usingpoky-debugging-taskfailures'>
133 <title>Task Failures</title>
134
135 <para>The log file for shell tasks is available in
136 <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>.
137 For example, the <filename>compile</filename> task for the QEMU minimal image for the x86
138 machine (<filename>qemux86</filename>) might be
139 <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>.
140 To see what BitBake runs to generate that log, look at the corresponding
141 <filename>run.do_taskname.pid</filename> file located in the same directory.
142 </para>
143
144 <para>
145 Presently, the output from Python tasks is sent directly to the console.
146 </para>
147 </section>
148
149 <section id='usingpoky-debugging-taskrunning'>
150 <title>Running Specific Tasks</title>
151
152 <para>
153 Any given package consists of a set of tasks.
154 The standard BitBake behavior in most cases is: <filename>fetch</filename>,
155 <filename>unpack</filename>,
156 <filename>patch</filename>, <filename>configure</filename>,
157 <filename>compile</filename>, <filename>install</filename>, <filename>package</filename>,
158 <filename>package_write</filename>, and <filename>build</filename>.
159 The default task is <filename>build</filename> and any tasks on which it depends
160 build first.
161 Some tasks exist, such as <filename>devshell</filename>, that are not part of the
162 default build chain.
163 If you wish to run a task that is not part of the default build chain, you can use the
164 <filename>-c</filename> option in BitBake.
165 Here is an example:
166 <literallayout class='monospaced'>
167 $ bitbake matchbox-desktop -c devshell
168 </literallayout>
169 </para>
170
171 <para>
172 If you wish to rerun a task, use the <filename>-f</filename> force option.
173 For example, the following sequence forces recompilation after changing files in the
174 working directory.
175 <literallayout class='monospaced'>
176 $ bitbake matchbox-desktop
177 .
178 .
179 [make some changes to the source code in the working directory]
180 .
181 .
182 $ bitbake matchbox-desktop -c compile -f
183 $ bitbake matchbox-desktop
184 </literallayout>
185 </para>
186
187 <para>
188 This sequence first builds and then recompiles
189 <filename>matchbox-desktop</filename>.
190 The last command reruns all tasks (basically the packaging tasks) after the compile.
191 BitBake recognizes that the <filename>compile</filename> task was rerun and therefore
192 understands that the other tasks also need to be run again.
193 </para>
194
195 <para>
196 You can view a list of tasks in a given package by running the
197 <filename>listtasks</filename> task as follows:
198 <literallayout class='monospaced'>
199 $ bitbake matchbox-desktop -c listtasks
200 </literallayout>
201 The results are in the file <filename>${WORKDIR}/temp/log.do_listtasks</filename>.
202 </para>
203 </section>
204
205 <section id='usingpoky-debugging-dependencies'>
206 <title>Dependency Graphs</title>
207
208 <para>
209 Sometimes it can be hard to see why BitBake wants to build some other packages before a given
210 package you have specified.
211 The <filename>bitbake -g targetname</filename> command creates the
212 <filename>depends.dot</filename>, <filename>package-depends.dot</filename>,
213 and <filename>task-depends.dot</filename> files in the current directory.
214 These files show the package and task dependencies and are useful for debugging problems.
215 You can use the <filename>bitbake -g -u depexp targetname</filename> command to
216 display the results in a more human-readable form.
217 </para>
218 </section>
219
220 <section id='usingpoky-debugging-bitbake'>
221 <title>General BitBake Problems</title>
222
223 <para>
224 You can see debug output from BitBake by using the <filename>-D</filename> option.
225 The debug output gives more information about what BitBake
226 is doing and the reason behind it.
227 Each <filename>-D</filename> option you use increases the logging level.
228 The most common usage is <filename>-DDD</filename>.
229 </para>
230
231 <para>
232 The output from <filename>bitbake -DDD -v targetname</filename> can reveal why
233 BitBake chose a certain version of a package or why BitBake
234 picked a certain provider.
235 This command could also help you in a situation where you think BitBake did something
236 unexpected.
237 </para>
238 </section>
239
240 <section id='development-host-system-issues'>
241 <title>Development Host System Issues</title>
242
243 <para>
244 Sometimes issues on the host development system can cause your
245 build to fail.
246 Following are known, host-specific problems.
247 Be sure to always consult the
248 <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>
249 for a look at all release-related issues.
250 <itemizedlist>
251 <listitem><para><emphasis><filename>eglibc-initial</filename> fails to build</emphasis>:
252 If your development host system has the unpatched
253 <filename>GNU Make 3.82</filename>,
254 the <filename>do_install</filename> task
255 fails for <filename>eglibc-initial</filename> during the
256 build.</para>
257 <para>Typically, every distribution that ships
258 <filename>GNU Make 3.82</filename> as
259 the default already has the patched version.
260 However, some distributions, such as Debian, have
261 <filename>GNU Make 3.82</filename> as an option, which
262 is unpatched.
263 You will see this error on these types of distributions.
264 Switch to <filename>GNU Make 3.81</filename> or patch
265 your <filename>make</filename> to solve the problem.
266 </para></listitem>
267 </itemizedlist>
268 </para>
269 </section>
270
271 <section id='usingpoky-debugging-buildfile'>
272 <title>Building with No Dependencies</title>
273 <para>
274 If you really want to build a specific <filename>.bb</filename> file, you can use
275 the command form <filename>bitbake -b &lt;somepath/somefile.bb&gt;</filename>.
276 This command form does not check for dependencies so you should use it
277 only when you know its dependencies already exist.
278 You can also specify fragments of the filename.
279 In this case, BitBake checks for a unique match.
280 </para>
281 </section>
282
283 <section id='usingpoky-debugging-variables'>
284 <title>Variables</title>
285 <para>
286 You can use the <filename>-e</filename> BitBake option to
287 display the resulting environment for a configuration
288 when you do not specify a package or for a specific package when
289 you do specify the package.
290 If you want to show the environment resulting from parsing a single
291 recipe, use the <filename>-b recipename</filename> form.
292 </para>
293 </section>
294
295 <section id='recipe-logging-mechanisms'>
296 <title>Recipe Logging Mechanisms</title>
297 <para>
298 Best practices exist while writing recipes that both log build progress and
299 act on build conditions such as warnings and errors.
300 Both Python and Bash language bindings exist for the logging mechanism:
301 <itemizedlist>
302 <listitem><para><emphasis>Python:</emphasis> For Python functions, BitBake
303 supports several loglevels: <filename>bb.fatal</filename>,
304 <filename>bb.error</filename>, <filename>bb.warn</filename>,
305 <filename>bb.note</filename>, <filename>bb.plain</filename>,
306 and <filename>bb.debug</filename>.</para></listitem>
307 <listitem><para><emphasis>Bash:</emphasis> For Bash functions, the same set
308 of loglevels exist and are accessed with a similar syntax:
309 <filename>bbfatal</filename>, <filename>bberror</filename>,
310 <filename>bbwarn</filename>, <filename>bbnote</filename>,
311 <filename>bbplain</filename>, and <filename>bbdebug</filename>.</para></listitem>
312 </itemizedlist>
313 </para>
314
315 <para>
316 For guidance on how logging is handled in both Python and Bash recipes, see the
317 <filename>logging.bbclass</filename> file in the
318 <filename>meta/classes</filename> folder of the
319 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
320 </para>
321
322 <section id='logging-with-python'>
323 <title>Logging With Python</title>
324 <para>
325 When creating recipes using Python and inserting code that handles build logs,
326 keep in mind the goal is to have informative logs while keeping the console as
327 "silent" as possible.
328 Also, if you want status messages in the log, use the "debug" loglevel.
329 </para>
330
331 <para>
332 Following is an example written in Python.
333 The code handles logging for a function that determines the number of tasks
334 needed to be run:
335 <literallayout class='monospaced'>
336 python do_listtasks() {
337 bb.debug(2, "Starting to figure out the task list")
338 if noteworthy_condition:
339 bb.note("There are 47 tasks to run")
340 bb.debug(2, "Got to point xyz")
341 if warning_trigger:
342 bb.warn("Detected warning_trigger, this might be a problem later.")
343 if recoverable_error:
344 bb.error("Hit recoverable_error, you really need to fix this!")
345 if fatal_error:
346 bb.fatal("fatal_error detected, unable to print the task list")
347 bb.plain("The tasks present are abc")
348 bb.debug(2, "Finished figuring out the tasklist")
349 }
350 </literallayout>
351 </para>
352 </section>
353
354 <section id='logging-with-bash'>
355 <title>Logging With Bash</title>
356 <para>
357 When creating recipes using Bash and inserting code that handles build
358 logs, you have the same goals - informative with minimal console output.
359 The syntax you use for recipes written in Bash is similar to that of
360 recipes written in Python described in the previous section.
361 </para>
362
363 <para>
364 Following is an example written in Bash.
365 The code logs the progress of the <filename>do_my_function</filename> function.
366 <literallayout class='monospaced'>
367 do_my_function() {
368 bbdebug 2 "Running do_my_function"
369 if [ exceptional_condition ]; then
370 bbnote "Hit exceptional_condition"
371 fi
372 bbdebug 2 "Got to point xyz"
373 if [ warning_trigger ]; then
374 bbwarn "Detected warning_trigger, this might cause a problem later."
375 fi
376 if [ recoverable_error ]; then
377 bberror "Hit recoverable_error, correcting"
378 fi
379 if [ fatal_error ]; then
380 bbfatal "fatal_error detected"
381 fi
382 bbdebug 2 "Completed do_my_function"
383 }
384 </literallayout>
385 </para>
386 </section>
387 </section>
388
389 <section id='usingpoky-debugging-others'>
390 <title>Other Tips</title>
391
392 <para>
393 Here are some other tips that you might find useful:
394 <itemizedlist>
395 <listitem><para>When adding new packages, it is worth watching for
396 undesirable items making their way into compiler command lines.
397 For example, you do not want references to local system files like
398 <filename>/usr/lib/</filename> or <filename>/usr/include/</filename>.
399 </para></listitem>
400 <listitem><para>If you want to remove the <filename>psplash</filename>
401 boot splashscreen,
402 add <filename>psplash=false</filename> to the kernel command line.
403 Doing so prevents <filename>psplash</filename> from loading
404 and thus allows you to see the console.
405 It is also possible to switch out of the splashscreen by
406 switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus).
407 </para></listitem>
408 </itemizedlist>
409 </para>
410 </section>
411</section>
412
413<section id='maintaining-build-output-quality'>
414 <title>Maintaining Build Output Quality</title>
415
416 <para>
417 Many factors can influence the quality of a build.
418 For example, if you upgrade a recipe to use a new version of an upstream software
419 package or you experiment with some new configuration options, subtle changes
420 can occur that you might not detect until later.
421 Consider the case where your recipe is using a newer version of an upstream package.
422 In this case, a new version of a piece of software might introduce an optional
423 dependency on another library, which is auto-detected.
424 If that library has already been built when the software is building,
425 the software will link to the built library and that library will be pulled
426 into your image along with the new software even if you did not want the
427 library.
428 </para>
429
430 <para>
431 The <filename>buildhistory</filename> class exists to help you maintain
432 the quality of your build output.
433 You can use the class to highlight unexpected and possibly unwanted
434 changes in the build output.
435 When you enable build history, it records information about the contents of
436 each package and image and then commits that information to a local Git
437 repository where you can examine the information.
438 </para>
439
440 <para>
441 The remainder of this section describes the following:
442 <itemizedlist>
443 <listitem><para>How you can enable and disable
444 build history</para></listitem>
445 <listitem><para>How to understand what the build history contains
446 </para></listitem>
447 <listitem><para>How to limit the information used for build history
448 </para></listitem>
449 <listitem><para>How to examine the build history from both a
450 command-line and web interface</para></listitem>
451 </itemizedlist>
452 </para>
453
454 <section id='enabling-and-disabling-build-history'>
455 <title>Enabling and Disabling Build History</title>
456
457 <para>
458 Build history is disabled by default.
459 To enable it, add the following statements to the end of your
460 <filename>conf/local.conf</filename> file found in the
461 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
462 <literallayout class='monospaced'>
463 INHERIT += "buildhistory"
464 BUILDHISTORY_COMMIT = "1"
465 </literallayout>
466 Enabling build history as previously described
467 causes the build process to collect build
468 output information and commit it to a local
469 <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> repository.
470 <note>
471 Enabling build history increases your build times slightly,
472 particularly for images, and increases the amount of disk
473 space used during the build.
474 </note>
475 </para>
476
477 <para>
478 You can disable build history by removing the previous statements
479 from your <filename>conf/local.conf</filename> file.
480 However, you should realize that enabling and disabling
481 build history in this manner can change the
482 <filename>do_package</filename> task checksums, which if you
483 are using the OEBasicHash signature generator (the default
484 for many current distro configurations including
485 <filename>DISTRO = "poky"</filename> and
486 <filename>DISTRO = ""</filename>) and will result in the packaging
487 tasks being re-run during the subsequent build.
488 </para>
489
490 <para>
491 To disable the build history functionality without causing the
492 packaging tasks to be re-run, add this statement to your
493 <filename>conf/local.conf</filename> file:
494 <literallayout class='monospaced'>
495 BUILDHISTORY_FEATURES = ""
496 </literallayout>
497 </para>
498 </section>
499
500 <section id='understanding-what-the-build-history-contains'>
501 <title>Understanding What the Build History Contains</title>
502
503 <para>
504 Build history information is kept in
505 <filename>$</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/buildhistory</filename>
506 in the Build Directory.
507 The following is an example abbreviated listing:
508 <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" />
509 </para>
510
511 <para>
512 At the top level, there is a <filename>metadata-revs</filename> file
513 that lists the revisions of the repositories for the layers enabled
514 when the build was produced.
515 The rest of the data splits into separate
516 <filename>packages</filename>, <filename>images</filename> and
517 <filename>sdk</filename> directories, the contents of which are
518 described below.
519 </para>
520
521 <section id='build-history-package-information'>
522 <title>Build History Package Information</title>
523
524 <para>
525 The history for each package contains a text file that has
526 name-value pairs with information about the package.
527 For example, <filename>buildhistory/packages/core2-poky-linux/busybox/busybox/latest</filename>
528 contains the following:
529 <literallayout class='monospaced'>
530 PV = 1.19.3
531 PR = r3
532 RDEPENDS = update-rc.d eglibc (>= 2.13)
533 RRECOMMENDS = busybox-syslog busybox-udhcpc
534 PKGSIZE = 564701
535 FILES = /usr/bin/* /usr/sbin/* /usr/libexec/* /usr/lib/lib*.so.* \
536 /etc /com /var /bin/* /sbin/* /lib/*.so.* /usr/share/busybox \
537 /usr/lib/busybox/* /usr/share/pixmaps /usr/share/applications \
538 /usr/share/idl /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers
539 FILELIST = /etc/busybox.links /etc/init.d/hwclock.sh /bin/busybox /bin/sh
540 </literallayout>
541 Most of these name-value pairs correspond to variables used
542 to produce the package.
543 The exceptions are <filename>FILELIST</filename>, which is the
544 actual list of files in the package, and
545 <filename>PKGSIZE</filename>, which is the total size of files
546 in the package in bytes.
547 </para>
548
549 <para>
550 There is also a file corresponding to the recipe from which the
551 package came (e.g.
552 <filename>buildhistory/packages/core2-poky-linux/busybox/latest</filename>):
553 <literallayout class='monospaced'>
554 PV = 1.19.3
555 PR = r3
556 DEPENDS = virtual/i586-poky-linux-gcc virtual/i586-poky-linux-compilerlibs \
557 virtual/libc update-rc.d-native
558 PACKAGES = busybox-httpd busybox-udhcpd busybox-udhcpc busybox-syslog \
559 busybox-mdev busybox-dbg busybox busybox-doc busybox-dev \
560 busybox-staticdev busybox-locale
561 </literallayout>
562 </para>
563
564 <para>
565 Finally, for those recipes fetched from a version control
566 system (e.g., Git), a file exists that lists source revisions
567 that are specified in the recipe and lists the actual revisions
568 used during the build.
569 Listed and actual revisions might differ when
570 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
571 is set to
572 <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>.
573 Here is an example assuming
574 <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>):
575 <literallayout class='monospaced'>
576 # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf"
577 SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf"
578 # SRCREV_emgd = "caea08c988e0f41103bbe18eafca20348f95da02"
579 SRCREV_emgd = "caea08c988e0f41103bbe18eafca20348f95da02"
580 # SRCREV_meta = "c2ed0f16fdec628242a682897d5d86df4547cf24"
581 SRCREV_meta = "c2ed0f16fdec628242a682897d5d86df4547cf24"
582 </literallayout>
583 You can use the <filename>buildhistory-collect-srcrevs</filename>
584 command to collect the stored <filename>SRCREV</filename> values
585 from build history and report them in a format suitable for use in
586 global configuration (e.g., <filename>local.conf</filename>
587 or a distro include file) to override floating
588 <filename>AUTOREV</filename> values to a fixed set of revisions.
589 Here is some example output from this command:
590 <literallayout class='monospaced'>
591 # emenlow-poky-linux
592 SRCREV_machine_pn-linux-yocto = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf"
593 SRCREV_emgd_pn-linux-yocto = "caea08c988e0f41103bbe18eafca20348f95da02"
594 SRCREV_meta_pn-linux-yocto = "c2ed0f16fdec628242a682897d5d86df4547cf24"
595 # core2-poky-linux
596 SRCREV_pn-kmod = "62081c0f68905b22f375156d4532fd37fa5c8d33"
597 SRCREV_pn-blktrace = "d6918c8832793b4205ed3bfede78c2f915c23385"
598 SRCREV_pn-opkg = "649"
599 </literallayout>
600 <note>
601 Here are some notes on using the
602 <filename>buildhistory-collect-srcrevs</filename> command:
603 <itemizedlist>
604 <listitem><para>By default, only values where the
605 <filename>SRCREV</filename> was
606 not hardcoded (usually when <filename>AUTOREV</filename>
607 was used) are reported.
608 Use the <filename>-a</filename> option to see all
609 <filename>SRCREV</filename> values.
610 </para></listitem>
611 <listitem><para>The output statements might not have any effect
612 if overrides are applied elsewhere in the build system
613 configuration.
614 Use the <filename>-f</filename> option to add the
615 <filename>forcevariable</filename> override to each output line
616 if you need to work around this restriction.
617 </para></listitem>
618 <listitem><para>The script does apply special handling when
619 building for multiple machines.
620 However, the script does place a
621 comment before each set of values that specifies
622 which triplet to which they belong as shown above
623 (e.g., <filename>emenlow-poky-linux</filename>).
624 </para></listitem>
625 </itemizedlist>
626 </note>
627 </para>
628 </section>
629
630 <section id='build-history-image-information'>
631 <title>Build History Image Information</title>
632
633 <para>
634 The files produced for each image are as follows:
635 <itemizedlist>
636 <listitem><para><filename>image-files:</filename>
637 A directory containing selected files from the root
638 filesystem.
639 The files are defined by
640 <filename>BUILDHISTORY_IMAGE_FILES</filename>.
641 </para></listitem>
642 <listitem><para><filename>build-id:</filename>
643 Human-readable information about the build configuration
644 and metadata source revisions.</para></listitem>
645 <listitem><para><filename>*.dot:</filename>
646 Dependency graphs for the image that are
647 compatible with <filename>graphviz</filename>.
648 </para></listitem>
649 <listitem><para><filename>files-in-image.txt:</filename>
650 A list of files in the image with permissions,
651 owner, group, size, and symlink information.
652 </para></listitem>
653 <listitem><para><filename>image-info.txt:</filename>
654 A text file containing name-value pairs with information
655 about the image.
656 See the following listing example for more information.
657 </para></listitem>
658 <listitem><para><filename>installed-package-names.txt:</filename>
659 A list of installed packages by name only.</para></listitem>
660 <listitem><para><filename>installed-package-sizes.txt:</filename>
661 A list of installed packages ordered by size.
662 </para></listitem>
663 <listitem><para><filename>installed-packages.txt:</filename>
664 A list of installed packages with full package
665 filenames.</para></listitem>
666 </itemizedlist>
667 <note>
668 Installed package information is able to be gathered and
669 produced even if package management is disabled for the final
670 image.
671 </note>
672 </para>
673
674 <para>
675 Here is an example of <filename>image-info.txt</filename>:
676 <literallayout class='monospaced'>
677 DISTRO = poky
678 DISTRO_VERSION = 1.1+snapshot-20120207
679 USER_CLASSES = image-mklibs image-prelink
680 IMAGE_CLASSES = image_types
681 IMAGE_FEATURES = debug-tweaks x11-base apps-x11-core \
682 package-management ssh-server-dropbear package-management
683 IMAGE_LINGUAS = en-us en-gb
684 IMAGE_INSTALL = task-core-boot task-base-extended
685 BAD_RECOMMENDATIONS =
686 ROOTFS_POSTPROCESS_COMMAND = buildhistory_get_image_installed ; rootfs_update_timestamp ;
687 IMAGE_POSTPROCESS_COMMAND = buildhistory_get_imageinfo ;
688 IMAGESIZE = 171816
689 </literallayout>
690 Other than <filename>IMAGESIZE</filename>, which is the
691 total size of the files in the image in Kbytes, the
692 name-value pairs are variables that may have influenced the
693 content of the image.
694 This information is often useful when you are trying to determine
695 why a change in the package or file listings has occurred.
696 </para>
697 </section>
698
699 <section id='using-build-history-to-gather-image-information-only'>
700 <title>Using Build History to Gather Image Information Only</title>
701
702 <para>
703 As you can see, build history produces image information,
704 including dependency graphs, so you can see why something
705 was pulled into the image.
706 If you are just interested in this information and not
707 interested in collecting history or any package information,
708 you can enable writing only image information without
709 any history by adding the following
710 to your <filename>conf/local.conf</filename> file found in the
711 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
712 <literallayout class='monospaced'>
713 INHERIT += "buildhistory"
714 BUILDHISTORY_COMMIT = "0"
715 BUILDHISTORY_FEATURES = "image"
716 </literallayout>
717 </para>
718 </section>
719
720 <section id='build-history-sdk-information'>
721 <title>Build History SDK Information</title>
722 <para>
723 Build history collects similar information on the contents
724 of SDKs (e.g., <filename>meta-toolchain</filename>
725 or <filename>bitbake -c populate_sdk imagename</filename>)
726 as compared to information it collects for images.
727 The following list shows the files produced for each SDK:
728 <itemizedlist>
729 <listitem><para><filename>files-in-sdk.txt:</filename>
730 A list of files in the SDK with permissions,
731 owner, group, size, and symlink information.
732 This list includes both the host and target parts
733 of the SDK.
734 </para></listitem>
735 <listitem><para><filename>sdk-info.txt:</filename>
736 A text file containing name-value pairs with information
737 about the SDK.
738 See the following listing example for more information.
739 </para></listitem>
740 <listitem><para>The following information appears under
741 each of the <filename>host</filename>
742 and <filename>target</filename> directories
743 for the portions of the SDK that run on the host and
744 on the target, respectively:
745 <itemizedlist>
746 <listitem><para><filename>depends.dot:</filename>
747 Dependency graph for the SDK that is
748 compatible with <filename>graphviz</filename>.
749 </para></listitem>
750 <listitem><para><filename>installed-package-names.txt:</filename>
751 A list of installed packages by name only.
752 </para></listitem>
753 <listitem><para><filename>installed-package-sizes.txt:</filename>
754 A list of installed packages ordered by size.
755 </para></listitem>
756 <listitem><para><filename>installed-packages.txt:</filename>
757 A list of installed packages with full package
758 filenames.</para></listitem>
759 </itemizedlist>
760 </para></listitem>
761 </itemizedlist>
762 </para>
763
764 <para>
765 Here is an example of <filename>sdk-info.txt</filename>:
766 <literallayout class='monospaced'>
767 DISTRO = poky
768 DISTRO_VERSION = 1.3+snapshot-20130327
769 SDK_NAME = poky-eglibc-i686-arm
770 SDK_VERSION = 1.3+snapshot
771 SDKMACHINE =
772 SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs
773 BAD_RECOMMENDATIONS =
774 SDKSIZE = 352712
775 </literallayout>
776 Other than <filename>SDKSIZE</filename>, which is the
777 total size of the files in the SDK in Kbytes, the
778 name-value pairs are variables that might have influenced the
779 content of the SDK.
780 This information is often useful when you are trying to
781 determine why a change in the package or file listings
782 has occurred.
783 </para>
784 </section>
785
786 <section id='examining-build-history-information'>
787 <title>Examining Build History Information</title>
788
789 <para>
790 You can examine build history output from the command line or
791 from a web interface.
792 </para>
793
794 <para>
795 To see any changes that have occurred (assuming you have
796 <filename>BUILDHISTORY_COMMIT = "1"</filename>), you can simply
797 use any Git command that allows you to view the history of
798 a repository.
799 Here is one method:
800 <literallayout class='monospaced'>
801 $ git log -p
802 </literallayout>
803 You need to realize, however, that this method does show
804 changes that are not significant (e.g. a package's size
805 changing by a few bytes).
806 </para>
807
808 <para>
809 A command-line tool called <filename>buildhistory-diff</filename>
810 does exist, though, that queries the Git repository and prints just
811 the differences that might be significant in human-readable form.
812 Here is an example:
813 <literallayout class='monospaced'>
814 $ ~/poky/poky/scripts/buildhistory-diff . HEAD^
815 Changes to images/qemux86_64/eglibc/core-image-minimal (files-in-image.txt):
816 /etc/anotherpkg.conf was added
817 /sbin/anotherpkg was added
818 * (installed-package-names.txt):
819 * anotherpkg was added
820 Changes to images/qemux86_64/eglibc/core-image-minimal (installed-package-names.txt):
821 anotherpkg was added
822 packages/qemux86_64-poky-linux/v86d: PACKAGES: added "v86d-extras"
823 * PR changed from "r0" to "r1"
824 * PV changed from "0.1.10" to "0.1.12"
825 packages/qemux86_64-poky-linux/v86d/v86d: PKGSIZE changed from 110579 to 144381 (+30%)
826 * PR changed from "r0" to "r1"
827 * PV changed from "0.1.10" to "0.1.12"
828 </literallayout>
829 </para>
830
831 <para>
832 To see changes to the build history using a web interface, follow
833 the instruction in the <filename>README</filename> file here.
834 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/buildhistory-web/'></ulink>.
835 </para>
836
837 <para>
838 Here is a sample screenshot of the interface:
839 <imagedata fileref="figures/buildhistory-web.png" align="center" scalefit="1" width="130%" contentdepth="130%" />
840 </para>
841 </section>
842 </section>
843</section>
844
845</chapter>
846<!--
847vim: expandtab tw=80 ts=4
848-->
diff --git a/documentation/template/Vera.ttf b/documentation/template/Vera.ttf
new file mode 100644
index 0000000000..58cd6b5e61
--- /dev/null
+++ b/documentation/template/Vera.ttf
Binary files differ
diff --git a/documentation/template/Vera.xml b/documentation/template/Vera.xml
new file mode 100644
index 0000000000..3c82043e35
--- /dev/null
+++ b/documentation/template/Vera.xml
@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><font-metrics type="TYPE0"><font-name>BitstreamVeraSans</font-name><embed/><cap-height>729</cap-height><x-height>546</x-height><ascender>928</ascender><descender>-235</descender><bbox><left>-183</left><bottom>-235</bottom><right>1287</right><top>928</top></bbox><flags>32</flags><stemv>0</stemv><italicangle>0</italicangle><subtype>TYPE0</subtype><multibyte-extras><cid-type>CIDFontType2</cid-type><default-width>0</default-width><bfranges><bf gi="3" ue="126" us="32"/><bf gi="172" ue="160" us="160"/><bf gi="163" ue="161" us="161"/><bf gi="132" ue="163" us="162"/><bf gi="189" ue="164" us="164"/><bf gi="150" ue="165" us="165"/><bf gi="231" ue="166" us="166"/><bf gi="134" ue="167" us="167"/><bf gi="142" ue="168" us="168"/><bf gi="139" ue="169" us="169"/><bf gi="157" ue="170" us="170"/><bf gi="169" ue="171" us="171"/><bf gi="164" ue="172" us="172"/><bf gi="256" ue="173" us="173"/><bf gi="138" ue="174" us="174"/><bf gi="217" ue="175" us="175"/><bf gi="131" ue="176" us="176"/><bf gi="147" ue="177" us="177"/><bf gi="241" ue="179" us="178"/><bf gi="141" ue="180" us="180"/><bf gi="151" ue="181" us="181"/><bf gi="136" ue="182" us="182"/><bf gi="195" ue="183" us="183"/><bf gi="221" ue="184" us="184"/><bf gi="240" ue="185" us="185"/><bf gi="158" ue="186" us="186"/><bf gi="170" ue="187" us="187"/><bf gi="243" ue="190" us="188"/><bf gi="162" ue="191" us="191"/><bf gi="173" ue="192" us="192"/><bf gi="201" ue="193" us="193"/><bf gi="199" ue="194" us="194"/><bf gi="174" ue="195" us="195"/><bf gi="98" ue="197" us="196"/><bf gi="144" ue="198" us="198"/><bf gi="100" ue="199" us="199"/><bf gi="203" ue="200" us="200"/><bf gi="101" ue="201" us="201"/><bf gi="200" ue="202" us="202"/><bf gi="202" ue="203" us="203"/><bf gi="207" ue="204" us="204"/><bf gi="204" ue="207" us="205"/><bf gi="232" ue="208" us="208"/><bf gi="102" ue="209" us="209"/><bf gi="210" ue="210" us="210"/><bf gi="208" ue="212" us="211"/><bf gi="175" ue="213" us="213"/><bf gi="103" ue="214" us="214"/><bf gi="239" ue="215" us="215"/><bf gi="145" ue="216" us="216"/><bf gi="213" ue="217" us="217"/><bf gi="211" ue="219" us="218"/><bf gi="104" ue="220" us="220"/><bf gi="234" ue="221" us="221"/><bf gi="236" ue="222" us="222"/><bf gi="137" ue="223" us="223"/><bf gi="106" ue="224" us="224"/><bf gi="105" ue="225" us="225"/><bf gi="107" ue="226" us="226"/><bf gi="109" ue="227" us="227"/><bf gi="108" ue="228" us="228"/><bf gi="110" ue="229" us="229"/><bf gi="160" ue="230" us="230"/><bf gi="111" ue="231" us="231"/><bf gi="113" ue="232" us="232"/><bf gi="112" ue="233" us="233"/><bf gi="114" ue="235" us="234"/><bf gi="117" ue="236" us="236"/><bf gi="116" ue="237" us="237"/><bf gi="118" ue="239" us="238"/><bf gi="233" ue="240" us="240"/><bf gi="120" ue="241" us="241"/><bf gi="122" ue="242" us="242"/><bf gi="121" ue="243" us="243"/><bf gi="123" ue="244" us="244"/><bf gi="125" ue="245" us="245"/><bf gi="124" ue="246" us="246"/><bf gi="184" ue="247" us="247"/><bf gi="161" ue="248" us="248"/><bf gi="127" ue="249" us="249"/><bf gi="126" ue="250" us="250"/><bf gi="128" ue="252" us="251"/><bf gi="235" ue="253" us="253"/><bf gi="237" ue="254" us="254"/><bf gi="186" ue="255" us="255"/><bf gi="251" ue="263" us="262"/><bf gi="253" ue="269" us="268"/><bf gi="0" ue="270" us="270"/><bf gi="0" ue="271" us="271"/><bf gi="0" ue="272" us="272"/><bf gi="255" ue="273" us="273"/><bf gi="246" ue="287" us="286"/><bf gi="248" ue="304" us="304"/><bf gi="214" ue="305" us="305"/><bf gi="225" ue="322" us="321"/><bf gi="176" ue="339" us="338"/><bf gi="249" ue="351" us="350"/><bf gi="227" ue="353" us="352"/><bf gi="187" ue="376" us="376"/><bf gi="229" ue="382" us="381"/><bf gi="166" ue="402" us="402"/><bf gi="215" ue="710" us="710"/><bf gi="224" ue="711" us="711"/><bf gi="218" ue="730" us="728"/><bf gi="223" ue="731" us="731"/><bf gi="216" ue="732" us="732"/><bf gi="222" ue="733" us="733"/><bf gi="159" ue="937" us="937"/><bf gi="155" ue="960" us="960"/><bf gi="178" ue="8212" us="8211"/><bf gi="0" ue="8213" us="8213"/><bf gi="0" ue="8214" us="8214"/><bf gi="0" ue="8215" us="8215"/><bf gi="182" ue="8217" us="8216"/><bf gi="196" ue="8218" us="8218"/><bf gi="0" ue="8219" us="8219"/><bf gi="180" ue="8221" us="8220"/><bf gi="197" ue="8222" us="8222"/><bf gi="0" ue="8223" us="8223"/><bf gi="130" ue="8224" us="8224"/><bf gi="194" ue="8225" us="8225"/><bf gi="135" ue="8226" us="8226"/><bf gi="0" ue="8227" us="8227"/><bf gi="0" ue="8228" us="8228"/><bf gi="0" ue="8229" us="8229"/><bf gi="171" ue="8230" us="8230"/><bf gi="198" ue="8240" us="8240"/><bf gi="190" ue="8250" us="8249"/><bf gi="258" ue="8364" us="8364"/><bf gi="140" ue="8482" us="8482"/><bf gi="152" ue="8706" us="8706"/><bf gi="0" ue="8707" us="8707"/><bf gi="0" ue="8708" us="8708"/><bf gi="0" ue="8709" us="8709"/><bf gi="168" ue="8710" us="8710"/><bf gi="154" ue="8719" us="8719"/><bf gi="0" ue="8720" us="8720"/><bf gi="153" ue="8721" us="8721"/><bf gi="238" ue="8722" us="8722"/><bf gi="0" ue="8723" us="8723"/><bf gi="0" ue="8724" us="8724"/><bf gi="188" ue="8725" us="8725"/><bf gi="0" ue="8726" us="8726"/><bf gi="0" ue="8727" us="8727"/><bf gi="0" ue="8728" us="8728"/><bf gi="257" ue="8729" us="8729"/><bf gi="165" ue="8730" us="8730"/><bf gi="0" ue="8731" us="8731"/><bf gi="0" ue="8732" us="8732"/><bf gi="0" ue="8733" us="8733"/><bf gi="146" ue="8734" us="8734"/><bf gi="156" ue="8747" us="8747"/><bf gi="167" ue="8776" us="8776"/><bf gi="143" ue="8800" us="8800"/><bf gi="0" ue="8801" us="8801"/><bf gi="0" ue="8802" us="8802"/><bf gi="0" ue="8803" us="8803"/><bf gi="148" ue="8805" us="8804"/><bf gi="185" ue="9674" us="9674"/><bf gi="192" ue="64258" us="64257"/><bf gi="0" ue="65535" us="65535"/></bfranges><cid-widths start-index="0"><wx w="600"/><wx w="0"/><wx w="317"/><wx w="317"/><wx w="400"/><wx w="459"/><wx w="837"/><wx w="636"/><wx w="950"/><wx w="779"/><wx w="274"/><wx w="390"/><wx w="390"/><wx w="500"/><wx w="837"/><wx w="317"/><wx w="360"/><wx w="317"/><wx w="336"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="636"/><wx w="336"/><wx w="336"/><wx w="837"/><wx w="837"/><wx w="837"/><wx w="530"/><wx w="1000"/><wx w="684"/><wx w="686"/><wx w="698"/><wx w="770"/><wx w="631"/><wx w="575"/><wx w="774"/><wx w="751"/><wx w="294"/><wx w="294"/><wx w="655"/><wx w="557"/><wx w="862"/><wx w="748"/><wx w="787"/><wx w="603"/><wx w="787"/><wx w="694"/><wx w="634"/><wx w="610"/><wx w="731"/><wx w="684"/><wx w="988"/><wx w="685"/><wx w="610"/><wx w="685"/><wx w="390"/><wx w="336"/><wx w="390"/><wx w="837"/><wx w="500"/><wx w="500"/><wx w="612"/><wx w="634"/><wx w="549"/><wx w="634"/><wx w="615"/><wx w="352"/><wx w="634"/><wx w="633"/><wx w="277"/><wx w="277"/><wx w="579"/><wx w="277"/><wx w="974"/><wx w="633"/><wx w="611"/><wx w="634"/><wx w="634"/><wx w="411"/><wx w="520"/><wx w="392"/><wx w="633"/><wx w="591"/><wx w="817"/><wx w="591"/><wx w="591"/><wx w="524"/><wx w="636"/><wx w="336"/><wx w="636"/><wx w="837"/><wx w="684"/><wx w="684"/><wx w="698"/><wx w="631"/><wx w="748"/><wx w="787"/><wx w="731"/><wx w="612"/><wx w="612"/><wx w="612"/><wx w="612"/><wx w="612"/><wx w="612"/><wx w="549"/><wx w="615"/><wx w="615"/><wx w="615"/><wx w="615"/><wx w="277"/><wx w="277"/><wx w="277"/><wx w="277"/><wx w="633"/><wx w="611"/><wx w="611"/><wx w="611"/><wx w="611"/><wx w="611"/><wx w="633"/><wx w="633"/><wx w="633"/><wx w="633"/><wx w="500"/><wx w="500"/><wx w="636"/><wx w="636"/><wx w="500"/><wx w="589"/><wx w="636"/><wx w="629"/><wx w="1000"/><wx w="1000"/><wx w="1000"/><wx w="500"/><wx w="500"/><wx w="837"/><wx w="974"/><wx w="787"/><wx w="833"/><wx w="837"/><wx w="837"/><wx w="837"/><wx w="636"/><wx w="636"/><wx w="517"/><wx w="673"/><wx w="756"/><wx w="588"/><wx w="520"/><wx w="471"/><wx w="471"/><wx w="764"/><wx w="981"/><wx w="611"/><wx w="530"/><wx w="400"/><wx w="837"/><wx w="637"/><wx w="636"/><wx w="837"/><wx w="668"/><wx w="611"/><wx w="611"/><wx w="1000"/><wx w="636"/><wx w="684"/><wx w="684"/><wx w="787"/><wx w="1069"/><wx w="1022"/><wx w="500"/><wx w="1000"/><wx w="518"/><wx w="518"/><wx w="317"/><wx w="317"/><wx w="837"/><wx w="494"/><wx w="591"/><wx w="610"/><wx w="166"/><wx w="636"/><wx w="399"/><wx w="399"/><wx w="629"/><wx w="629"/><wx w="500"/><wx w="317"/><wx w="317"/><wx w="518"/><wx w="1341"/><wx w="684"/><wx w="631"/><wx w="684"/><wx w="631"/><wx w="631"/><wx w="294"/><wx w="294"/><wx w="294"/><wx w="294"/><wx w="787"/><wx w="787"/><wx w="787"/><wx w="731"/><wx w="731"/><wx w="731"/><wx w="277"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="562"/><wx w="284"/><wx w="634"/><wx w="520"/><wx w="685"/><wx w="524"/><wx w="336"/><wx w="774"/><wx w="611"/><wx w="610"/><wx w="591"/><wx w="604"/><wx w="634"/><wx w="837"/><wx w="837"/><wx w="400"/><wx w="400"/><wx w="400"/><wx w="969"/><wx w="969"/><wx w="969"/><wx w="774"/><wx w="634"/><wx w="294"/><wx w="634"/><wx w="520"/><wx w="698"/><wx w="549"/><wx w="698"/><wx w="549"/><wx w="634"/><wx w="360"/><wx w="317"/><wx w="636"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="400"/><wx w="500"/><wx w="500"/></cid-widths></multibyte-extras><kerning kpx1="246"><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="169"/><pair kern="-26" kpx2="197"/><pair kern="-35" kpx2="55"/><pair kern="-49" kpx2="60"/><pair kern="-49" kpx2="187"/><pair kern="-21" kpx2="181"/><pair kern="-17" kpx2="170"/><pair kern="-49" kpx2="234"/></kerning><kerning kpx1="235"><pair kern="-142" kpx2="17"/><pair kern="-17" kpx2="169"/><pair kern="-146" kpx2="197"/><pair kern="-17" kpx2="16"/><pair kern="-72" kpx2="29"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="43"><pair kern="-35" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-35" kpx2="197"/><pair kern="-30" kpx2="181"/></kerning><kerning kpx1="16"><pair kern="36" kpx2="246"/><pair kern="-17" kpx2="235"/><pair kern="-21" kpx2="199"/><pair kern="18" kpx2="123"/><pair kern="27" kpx2="208"/><pair kern="-118" kpx2="187"/><pair kern="-49" kpx2="59"/><pair kern="18" kpx2="124"/><pair kern="-21" kpx2="201"/><pair kern="-118" kpx2="60"/><pair kern="36" kpx2="52"/><pair kern="18" kpx2="125"/><pair kern="36" kpx2="42"/><pair kern="-118" kpx2="234"/><pair kern="18" kpx2="122"/><pair kern="27" kpx2="210"/><pair kern="-21" kpx2="36"/><pair kern="18" kpx2="82"/><pair kern="-40" kpx2="58"/><pair kern="-91" kpx2="55"/><pair kern="-17" kpx2="186"/><pair kern="27" kpx2="175"/><pair kern="27" kpx2="50"/><pair kern="27" kpx2="209"/><pair kern="27" kpx2="103"/><pair kern="-21" kpx2="98"/><pair kern="55" kpx2="45"/><pair kern="-21" kpx2="173"/><pair kern="-17" kpx2="92"/><pair kern="-26" kpx2="89"/><pair kern="18" kpx2="121"/><pair kern="-58" kpx2="57"/><pair kern="-35" kpx2="37"/><pair kern="-21" kpx2="174"/></kerning><kerning kpx1="112"><pair kern="-17" kpx2="91"/></kerning><kerning kpx1="123"><pair kern="-72" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-63" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-30" kpx2="91"/><pair kern="-35" kpx2="181"/></kerning><kerning kpx1="251"><pair kern="-17" kpx2="169"/><pair kern="-17" kpx2="60"/><pair kern="-17" kpx2="187"/><pair kern="18" kpx2="181"/><pair kern="-17" kpx2="170"/><pair kern="-17" kpx2="234"/></kerning><kerning kpx1="213"><pair kern="-17" kpx2="229"/><pair kern="-17" kpx2="61"/></kerning><kerning kpx1="208"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="27" kpx2="16"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="98"/><pair kern="-17" kpx2="181"/><pair kern="-63" kpx2="59"/><pair kern="-40" kpx2="17"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="29"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="187"><pair kern="-114" kpx2="126"/><pair kern="-137" kpx2="107"/><pair kern="-132" kpx2="72"/><pair kern="-77" kpx2="199"/><pair kern="-118" kpx2="16"/><pair kern="-132" kpx2="123"/><pair kern="-132" kpx2="112"/><pair kern="-54" kpx2="251"/><pair kern="-54" kpx2="208"/><pair kern="-132" kpx2="113"/><pair kern="-54" kpx2="180"/><pair kern="-137" kpx2="105"/><pair kern="-114" kpx2="129"/><pair kern="-132" kpx2="124"/><pair kern="-109" kpx2="169"/><pair kern="-77" kpx2="201"/><pair kern="-54" kpx2="253"/><pair kern="-137" kpx2="106"/><pair kern="-132" kpx2="29"/><pair kern="-132" kpx2="125"/><pair kern="-72" kpx2="170"/><pair kern="-132" kpx2="115"/><pair kern="-114" kpx2="88"/><pair kern="-132" kpx2="122"/><pair kern="-54" kpx2="100"/><pair kern="-137" kpx2="68"/><pair kern="-54" kpx2="210"/><pair kern="-77" kpx2="36"/><pair kern="-132" kpx2="82"/><pair kern="-132" kpx2="114"/><pair kern="-54" kpx2="175"/><pair kern="-114" kpx2="127"/><pair kern="-54" kpx2="50"/><pair kern="-54" kpx2="209"/><pair kern="-54" kpx2="103"/><pair kern="-137" kpx2="108"/><pair kern="-77" kpx2="98"/><pair kern="-35" kpx2="76"/><pair kern="-17" kpx2="181"/><pair kern="-202" kpx2="17"/><pair kern="-114" kpx2="128"/><pair kern="-77" kpx2="173"/><pair kern="-137" kpx2="109"/><pair kern="-128" kpx2="197"/><pair kern="-54" kpx2="38"/><pair kern="-132" kpx2="121"/><pair kern="-137" kpx2="110"/><pair kern="-77" kpx2="174"/></kerning><kerning kpx1="113"><pair kern="-17" kpx2="91"/></kerning><kerning kpx1="144"><pair kern="-40" kpx2="180"/><pair kern="-54" kpx2="197"/><pair kern="-44" kpx2="181"/></kerning><kerning kpx1="59"><pair kern="-72" kpx2="100"/><pair kern="-63" kpx2="210"/><pair kern="-17" kpx2="55"/><pair kern="-44" kpx2="114"/><pair kern="-44" kpx2="72"/><pair kern="-63" kpx2="175"/><pair kern="-49" kpx2="16"/><pair kern="-63" kpx2="50"/><pair kern="-63" kpx2="209"/><pair kern="-44" kpx2="112"/><pair kern="-72" kpx2="251"/><pair kern="-63" kpx2="103"/><pair kern="-63" kpx2="208"/><pair kern="-44" kpx2="113"/><pair kern="-40" kpx2="181"/><pair kern="-77" kpx2="180"/><pair kern="-54" kpx2="169"/><pair kern="-21" kpx2="197"/><pair kern="-72" kpx2="38"/><pair kern="-72" kpx2="253"/><pair kern="-44" kpx2="115"/></kerning><kerning kpx1="73"><pair kern="31" kpx2="180"/><pair kern="-17" kpx2="90"/><pair kern="-72" kpx2="17"/><pair kern="-17" kpx2="235"/><pair kern="-35" kpx2="169"/><pair kern="-114" kpx2="197"/><pair kern="-17" kpx2="186"/><pair kern="-17" kpx2="92"/><pair kern="-17" kpx2="87"/><pair kern="-54" kpx2="16"/><pair kern="-35" kpx2="29"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="41"><pair kern="-17" kpx2="227"/><pair kern="-54" kpx2="126"/><pair kern="-91" kpx2="107"/><pair kern="-91" kpx2="235"/><pair kern="-54" kpx2="72"/><pair kern="-91" kpx2="199"/><pair kern="-35" kpx2="123"/><pair kern="-54" kpx2="112"/><pair kern="-54" kpx2="113"/><pair kern="-17" kpx2="54"/><pair kern="-21" kpx2="180"/><pair kern="-91" kpx2="105"/><pair kern="-54" kpx2="129"/><pair kern="-35" kpx2="124"/><pair kern="-91" kpx2="201"/><pair kern="-72" kpx2="85"/><pair kern="-91" kpx2="106"/><pair kern="-77" kpx2="29"/><pair kern="-35" kpx2="125"/><pair kern="-54" kpx2="115"/><pair kern="-54" kpx2="88"/><pair kern="-35" kpx2="122"/><pair kern="-91" kpx2="68"/><pair kern="-91" kpx2="36"/><pair kern="-35" kpx2="82"/><pair kern="-91" kpx2="186"/><pair kern="-17" kpx2="55"/><pair kern="-54" kpx2="114"/><pair kern="-54" kpx2="127"/><pair kern="-91" kpx2="108"/><pair kern="-91" kpx2="98"/><pair kern="-72" kpx2="76"/><pair kern="-160" kpx2="17"/><pair kern="-54" kpx2="128"/><pair kern="-91" kpx2="173"/><pair kern="-91" kpx2="109"/><pair kern="-183" kpx2="197"/><pair kern="-91" kpx2="92"/><pair kern="-35" kpx2="121"/><pair kern="-91" kpx2="110"/><pair kern="-91" kpx2="174"/><pair kern="-17" kpx2="249"/></kerning><kerning kpx1="124"><pair kern="-72" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-63" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-30" kpx2="91"/><pair kern="-35" kpx2="181"/></kerning><kerning kpx1="169"><pair kern="-17" kpx2="90"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="246"/><pair kern="-17" kpx2="235"/><pair kern="-17" kpx2="58"/><pair kern="-17" kpx2="186"/><pair kern="-54" kpx2="55"/><pair kern="-17" kpx2="251"/><pair kern="-72" kpx2="187"/><pair kern="-17" kpx2="39"/><pair kern="73" kpx2="144"/><pair kern="-17" kpx2="45"/><pair kern="-17" kpx2="92"/><pair kern="-17" kpx2="38"/><pair kern="-72" kpx2="60"/><pair kern="-17" kpx2="89"/><pair kern="-17" kpx2="253"/><pair kern="-54" kpx2="57"/><pair kern="-17" kpx2="37"/><pair kern="-17" kpx2="42"/><pair kern="-72" kpx2="234"/></kerning><kerning kpx1="201"><pair kern="-17" kpx2="246"/><pair kern="-67" kpx2="235"/><pair kern="-21" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-17" kpx2="251"/><pair kern="-17" kpx2="113"/><pair kern="-77" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-35" kpx2="73"/><pair kern="-17" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-77" kpx2="60"/><pair kern="27" kpx2="201"/><pair kern="-17" kpx2="29"/><pair kern="-77" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="122"/><pair kern="-17" kpx2="210"/><pair kern="-17" kpx2="82"/><pair kern="-54" kpx2="58"/><pair kern="-67" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="27" kpx2="98"/><pair kern="-123" kpx2="181"/><pair kern="-17" kpx2="17"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="84"/><pair kern="-17" kpx2="121"/><pair kern="-63" kpx2="57"/><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="87"/><pair kern="-17" kpx2="72"/><pair kern="27" kpx2="199"/><pair kern="-17" kpx2="71"/><pair kern="-128" kpx2="180"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="52"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="115"/><pair kern="-40" kpx2="90"/><pair kern="-17" kpx2="111"/><pair kern="27" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-17" kpx2="50"/><pair kern="27" kpx2="173"/><pair kern="-67" kpx2="92"/><pair kern="22" kpx2="197"/><pair kern="-58" kpx2="89"/><pair kern="27" kpx2="174"/></kerning><kerning kpx1="60"><pair kern="-114" kpx2="126"/><pair kern="-137" kpx2="107"/><pair kern="-132" kpx2="72"/><pair kern="-77" kpx2="199"/><pair kern="-118" kpx2="16"/><pair kern="-132" kpx2="123"/><pair kern="-132" kpx2="112"/><pair kern="-54" kpx2="251"/><pair kern="-54" kpx2="208"/><pair kern="-132" kpx2="113"/><pair kern="-54" kpx2="180"/><pair kern="-137" kpx2="105"/><pair kern="-114" kpx2="129"/><pair kern="-132" kpx2="124"/><pair kern="-109" kpx2="169"/><pair kern="-77" kpx2="201"/><pair kern="-54" kpx2="253"/><pair kern="-137" kpx2="106"/><pair kern="-132" kpx2="29"/><pair kern="-132" kpx2="125"/><pair kern="-72" kpx2="170"/><pair kern="-132" kpx2="115"/><pair kern="-114" kpx2="88"/><pair kern="-132" kpx2="122"/><pair kern="-54" kpx2="100"/><pair kern="-137" kpx2="68"/><pair kern="-54" kpx2="210"/><pair kern="-77" kpx2="36"/><pair kern="-132" kpx2="82"/><pair kern="-132" kpx2="114"/><pair kern="-54" kpx2="175"/><pair kern="-114" kpx2="127"/><pair kern="-54" kpx2="50"/><pair kern="-54" kpx2="209"/><pair kern="-54" kpx2="103"/><pair kern="-137" kpx2="108"/><pair kern="-77" kpx2="98"/><pair kern="-35" kpx2="76"/><pair kern="-17" kpx2="181"/><pair kern="-202" kpx2="17"/><pair kern="-114" kpx2="128"/><pair kern="-77" kpx2="173"/><pair kern="-137" kpx2="109"/><pair kern="-128" kpx2="197"/><pair kern="-54" kpx2="38"/><pair kern="-132" kpx2="121"/><pair kern="-137" kpx2="110"/><pair kern="-77" kpx2="174"/></kerning><kerning kpx1="85"><pair kern="-21" kpx2="254"/><pair kern="-21" kpx2="72"/><pair kern="-63" kpx2="16"/><pair kern="-21" kpx2="112"/><pair kern="-21" kpx2="123"/><pair kern="-17" kpx2="80"/><pair kern="-21" kpx2="113"/><pair kern="-17" kpx2="71"/><pair kern="-21" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-21" kpx2="252"/><pair kern="-21" kpx2="70"/><pair kern="-17" kpx2="85"/><pair kern="-17" kpx2="29"/><pair kern="-21" kpx2="125"/><pair kern="-21" kpx2="115"/><pair kern="-21" kpx2="111"/><pair kern="-21" kpx2="122"/><pair kern="-21" kpx2="82"/><pair kern="-17" kpx2="75"/><pair kern="-21" kpx2="114"/><pair kern="-26" kpx2="91"/><pair kern="-17" kpx2="81"/><pair kern="41" kpx2="181"/><pair kern="-91" kpx2="17"/><pair kern="-151" kpx2="197"/><pair kern="-17" kpx2="74"/><pair kern="-17" kpx2="84"/><pair kern="-21" kpx2="121"/><pair kern="-17" kpx2="247"/><pair kern="-17" kpx2="120"/></kerning><kerning kpx1="61"><pair kern="-17" kpx2="180"/><pair kern="-17" kpx2="197"/><pair kern="-17" kpx2="16"/><pair kern="-17" kpx2="181"/></kerning><kerning kpx1="234"><pair kern="-114" kpx2="126"/><pair kern="-137" kpx2="107"/><pair kern="-132" kpx2="72"/><pair kern="-77" kpx2="199"/><pair kern="-118" kpx2="16"/><pair kern="-132" kpx2="123"/><pair kern="-132" kpx2="112"/><pair kern="-54" kpx2="251"/><pair kern="-54" kpx2="208"/><pair kern="-132" kpx2="113"/><pair kern="-54" kpx2="180"/><pair kern="-137" kpx2="105"/><pair kern="-114" kpx2="129"/><pair kern="-132" kpx2="124"/><pair kern="-109" kpx2="169"/><pair kern="-77" kpx2="201"/><pair kern="-54" kpx2="253"/><pair kern="-137" kpx2="106"/><pair kern="-132" kpx2="29"/><pair kern="-132" kpx2="125"/><pair kern="-72" kpx2="170"/><pair kern="-132" kpx2="115"/><pair kern="-114" kpx2="88"/><pair kern="-132" kpx2="122"/><pair kern="-54" kpx2="100"/><pair kern="-137" kpx2="68"/><pair kern="-54" kpx2="210"/><pair kern="-77" kpx2="36"/><pair kern="-132" kpx2="82"/><pair kern="-132" kpx2="114"/><pair kern="-54" kpx2="175"/><pair kern="-114" kpx2="127"/><pair kern="-54" kpx2="50"/><pair kern="-54" kpx2="209"/><pair kern="-54" kpx2="103"/><pair kern="-137" kpx2="108"/><pair kern="-77" kpx2="98"/><pair kern="-35" kpx2="76"/><pair kern="-17" kpx2="181"/><pair kern="-202" kpx2="17"/><pair kern="-114" kpx2="128"/><pair kern="-77" kpx2="173"/><pair kern="-137" kpx2="109"/><pair kern="-128" kpx2="197"/><pair kern="-54" kpx2="38"/><pair kern="-132" kpx2="121"/><pair kern="-137" kpx2="110"/><pair kern="-77" kpx2="174"/></kerning><kerning kpx1="100"><pair kern="-17" kpx2="169"/><pair kern="-17" kpx2="60"/><pair kern="-17" kpx2="187"/><pair kern="18" kpx2="181"/><pair kern="-17" kpx2="170"/><pair kern="-17" kpx2="234"/></kerning><kerning kpx1="122"><pair kern="-72" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-63" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-30" kpx2="91"/><pair kern="-35" kpx2="181"/></kerning><kerning kpx1="47"><pair kern="-17" kpx2="126"/><pair kern="-91" kpx2="235"/><pair kern="-49" kpx2="104"/><pair kern="-17" kpx2="72"/><pair kern="22" kpx2="199"/><pair kern="-17" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-49" kpx2="213"/><pair kern="-35" kpx2="208"/><pair kern="-132" kpx2="187"/><pair kern="-17" kpx2="113"/><pair kern="-202" kpx2="180"/><pair kern="-17" kpx2="129"/><pair kern="-17" kpx2="124"/><pair kern="22" kpx2="201"/><pair kern="-132" kpx2="60"/><pair kern="-49" kpx2="211"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="115"/><pair kern="-132" kpx2="234"/><pair kern="-17" kpx2="88"/><pair kern="-17" kpx2="122"/><pair kern="-35" kpx2="210"/><pair kern="22" kpx2="36"/><pair kern="-17" kpx2="82"/><pair kern="-91" kpx2="58"/><pair kern="-91" kpx2="186"/><pair kern="-137" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-35" kpx2="175"/><pair kern="-17" kpx2="127"/><pair kern="-35" kpx2="50"/><pair kern="-35" kpx2="209"/><pair kern="-35" kpx2="103"/><pair kern="22" kpx2="98"/><pair kern="-262" kpx2="181"/><pair kern="-17" kpx2="128"/><pair kern="22" kpx2="173"/><pair kern="-49" kpx2="212"/><pair kern="-91" kpx2="92"/><pair kern="-17" kpx2="121"/><pair kern="-109" kpx2="57"/><pair kern="22" kpx2="174"/><pair kern="-49" kpx2="56"/></kerning><kerning kpx1="210"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="27" kpx2="16"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="98"/><pair kern="-17" kpx2="181"/><pair kern="-63" kpx2="59"/><pair kern="-40" kpx2="17"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="29"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="58"><pair kern="-35" kpx2="126"/><pair kern="-63" kpx2="107"/><pair kern="-17" kpx2="235"/><pair kern="-58" kpx2="72"/><pair kern="-54" kpx2="199"/><pair kern="-40" kpx2="16"/><pair kern="-58" kpx2="112"/><pair kern="-58" kpx2="123"/><pair kern="-58" kpx2="113"/><pair kern="-17" kpx2="180"/><pair kern="-63" kpx2="105"/><pair kern="-35" kpx2="129"/><pair kern="-58" kpx2="124"/><pair kern="-54" kpx2="169"/><pair kern="-54" kpx2="201"/><pair kern="-44" kpx2="85"/><pair kern="-63" kpx2="106"/><pair kern="-58" kpx2="29"/><pair kern="-58" kpx2="125"/><pair kern="-17" kpx2="170"/><pair kern="-58" kpx2="115"/><pair kern="-35" kpx2="88"/><pair kern="-58" kpx2="122"/><pair kern="-63" kpx2="68"/><pair kern="-54" kpx2="36"/><pair kern="-58" kpx2="82"/><pair kern="-17" kpx2="186"/><pair kern="-58" kpx2="114"/><pair kern="-35" kpx2="127"/><pair kern="-63" kpx2="108"/><pair kern="-54" kpx2="98"/><pair kern="-21" kpx2="76"/><pair kern="-114" kpx2="17"/><pair kern="-35" kpx2="128"/><pair kern="-54" kpx2="173"/><pair kern="-63" kpx2="109"/><pair kern="-128" kpx2="197"/><pair kern="-17" kpx2="92"/><pair kern="-58" kpx2="121"/><pair kern="-63" kpx2="110"/><pair kern="-54" kpx2="174"/></kerning><kerning kpx1="82"><pair kern="-72" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-63" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-30" kpx2="91"/><pair kern="-35" kpx2="181"/></kerning><kerning kpx1="186"><pair kern="-142" kpx2="17"/><pair kern="-17" kpx2="169"/><pair kern="-146" kpx2="197"/><pair kern="-17" kpx2="16"/><pair kern="-72" kpx2="29"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="175"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="27" kpx2="16"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="98"/><pair kern="-17" kpx2="181"/><pair kern="-63" kpx2="59"/><pair kern="-40" kpx2="17"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="29"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="209"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="27" kpx2="16"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="98"/><pair kern="-17" kpx2="181"/><pair kern="-63" kpx2="59"/><pair kern="-40" kpx2="17"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="29"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="103"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="27" kpx2="16"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="98"/><pair kern="-17" kpx2="181"/><pair kern="-63" kpx2="59"/><pair kern="-40" kpx2="17"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="29"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="81"><pair kern="-72" kpx2="180"/><pair kern="-44" kpx2="197"/><pair kern="-54" kpx2="181"/></kerning><kerning kpx1="98"><pair kern="-17" kpx2="246"/><pair kern="-67" kpx2="235"/><pair kern="-21" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-17" kpx2="251"/><pair kern="-17" kpx2="113"/><pair kern="-77" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-35" kpx2="73"/><pair kern="-17" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-77" kpx2="60"/><pair kern="27" kpx2="201"/><pair kern="-17" kpx2="29"/><pair kern="-77" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="122"/><pair kern="-17" kpx2="210"/><pair kern="-17" kpx2="82"/><pair kern="-54" kpx2="58"/><pair kern="-67" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="27" kpx2="98"/><pair kern="-123" kpx2="181"/><pair kern="-17" kpx2="17"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="84"/><pair kern="-17" kpx2="121"/><pair kern="-63" kpx2="57"/><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="87"/><pair kern="-17" kpx2="72"/><pair kern="27" kpx2="199"/><pair kern="-17" kpx2="71"/><pair kern="-128" kpx2="180"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="52"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="115"/><pair kern="-40" kpx2="90"/><pair kern="-17" kpx2="111"/><pair kern="27" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-17" kpx2="50"/><pair kern="27" kpx2="173"/><pair kern="-67" kpx2="92"/><pair kern="22" kpx2="197"/><pair kern="-58" kpx2="89"/><pair kern="27" kpx2="174"/></kerning><kerning kpx1="212"><pair kern="-17" kpx2="229"/><pair kern="-17" kpx2="61"/></kerning><kerning kpx1="229"><pair kern="-17" kpx2="180"/><pair kern="-17" kpx2="197"/><pair kern="-17" kpx2="16"/><pair kern="-17" kpx2="181"/></kerning><kerning kpx1="38"><pair kern="-17" kpx2="169"/><pair kern="-17" kpx2="60"/><pair kern="-17" kpx2="187"/><pair kern="18" kpx2="181"/><pair kern="-17" kpx2="170"/><pair kern="-17" kpx2="234"/></kerning><kerning kpx1="121"><pair kern="-72" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-63" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-30" kpx2="91"/><pair kern="-35" kpx2="181"/></kerning><kerning kpx1="57"><pair kern="-67" kpx2="126"/><pair kern="-77" kpx2="107"/><pair kern="-26" kpx2="235"/><pair kern="-77" kpx2="72"/><pair kern="-63" kpx2="199"/><pair kern="-58" kpx2="16"/><pair kern="-77" kpx2="123"/><pair kern="-77" kpx2="112"/><pair kern="-17" kpx2="208"/><pair kern="-77" kpx2="113"/><pair kern="-77" kpx2="105"/><pair kern="-67" kpx2="129"/><pair kern="-77" kpx2="124"/><pair kern="-86" kpx2="169"/><pair kern="-63" kpx2="201"/><pair kern="-77" kpx2="106"/><pair kern="-81" kpx2="29"/><pair kern="-77" kpx2="125"/><pair kern="-54" kpx2="170"/><pair kern="-77" kpx2="115"/><pair kern="-67" kpx2="88"/><pair kern="-77" kpx2="122"/><pair kern="-77" kpx2="68"/><pair kern="-17" kpx2="210"/><pair kern="-63" kpx2="36"/><pair kern="-77" kpx2="82"/><pair kern="-26" kpx2="186"/><pair kern="-77" kpx2="114"/><pair kern="-17" kpx2="175"/><pair kern="-67" kpx2="127"/><pair kern="-17" kpx2="50"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="-77" kpx2="108"/><pair kern="-63" kpx2="98"/><pair kern="-21" kpx2="76"/><pair kern="-128" kpx2="17"/><pair kern="-67" kpx2="128"/><pair kern="-63" kpx2="173"/><pair kern="-77" kpx2="109"/><pair kern="-137" kpx2="197"/><pair kern="-26" kpx2="92"/><pair kern="-77" kpx2="121"/><pair kern="-77" kpx2="110"/><pair kern="-63" kpx2="174"/></kerning><kerning kpx1="37"><pair kern="-17" kpx2="227"/><pair kern="-17" kpx2="246"/><pair kern="-17" kpx2="251"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-17" kpx2="54"/><pair kern="-54" kpx2="180"/><pair kern="-30" kpx2="169"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="170"/><pair kern="-54" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="210"/><pair kern="-35" kpx2="58"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="50"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="-54" kpx2="181"/><pair kern="-40" kpx2="197"/><pair kern="-17" kpx2="38"/><pair kern="-30" kpx2="57"/><pair kern="-17" kpx2="249"/></kerning><kerning kpx1="120"><pair kern="-72" kpx2="180"/><pair kern="-44" kpx2="197"/><pair kern="-54" kpx2="181"/></kerning><kerning kpx1="249"><pair kern="18" kpx2="173"/><pair kern="18" kpx2="36"/><pair kern="18" kpx2="201"/><pair kern="18" kpx2="199"/><pair kern="18" kpx2="174"/><pair kern="18" kpx2="98"/></kerning><kerning kpx1="227"><pair kern="18" kpx2="173"/><pair kern="18" kpx2="36"/><pair kern="18" kpx2="201"/><pair kern="18" kpx2="199"/><pair kern="18" kpx2="174"/><pair kern="18" kpx2="98"/></kerning><kerning kpx1="51"><pair kern="-17" kpx2="126"/><pair kern="-44" kpx2="107"/><pair kern="-35" kpx2="72"/><pair kern="-63" kpx2="199"/><pair kern="-21" kpx2="16"/><pair kern="-35" kpx2="123"/><pair kern="-35" kpx2="112"/><pair kern="-21" kpx2="187"/><pair kern="-35" kpx2="113"/><pair kern="-17" kpx2="86"/><pair kern="18" kpx2="180"/><pair kern="-44" kpx2="105"/><pair kern="-17" kpx2="129"/><pair kern="-35" kpx2="124"/><pair kern="-17" kpx2="169"/><pair kern="-63" kpx2="201"/><pair kern="-17" kpx2="85"/><pair kern="-21" kpx2="60"/><pair kern="-44" kpx2="106"/><pair kern="-35" kpx2="125"/><pair kern="-35" kpx2="115"/><pair kern="-21" kpx2="234"/><pair kern="-17" kpx2="88"/><pair kern="-35" kpx2="122"/><pair kern="-44" kpx2="68"/><pair kern="-63" kpx2="36"/><pair kern="-35" kpx2="82"/><pair kern="-35" kpx2="114"/><pair kern="-17" kpx2="250"/><pair kern="-17" kpx2="127"/><pair kern="-44" kpx2="108"/><pair kern="-63" kpx2="98"/><pair kern="-17" kpx2="81"/><pair kern="-21" kpx2="76"/><pair kern="18" kpx2="181"/><pair kern="-155" kpx2="17"/><pair kern="-17" kpx2="128"/><pair kern="-63" kpx2="173"/><pair kern="-44" kpx2="109"/><pair kern="-160" kpx2="197"/><pair kern="-35" kpx2="121"/><pair kern="-17" kpx2="228"/><pair kern="-44" kpx2="110"/><pair kern="-63" kpx2="174"/><pair kern="-17" kpx2="120"/></kerning><kerning kpx1="104"><pair kern="-17" kpx2="229"/><pair kern="-17" kpx2="61"/></kerning><kerning kpx1="72"><pair kern="-17" kpx2="91"/></kerning><kerning kpx1="199"><pair kern="-17" kpx2="246"/><pair kern="-67" kpx2="235"/><pair kern="-21" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-17" kpx2="251"/><pair kern="-17" kpx2="113"/><pair kern="-77" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-35" kpx2="73"/><pair kern="-17" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-77" kpx2="60"/><pair kern="27" kpx2="201"/><pair kern="-17" kpx2="29"/><pair kern="-77" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="122"/><pair kern="-17" kpx2="210"/><pair kern="-17" kpx2="82"/><pair kern="-54" kpx2="58"/><pair kern="-67" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="27" kpx2="98"/><pair kern="-123" kpx2="181"/><pair kern="-17" kpx2="17"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="84"/><pair kern="-17" kpx2="121"/><pair kern="-63" kpx2="57"/><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="87"/><pair kern="-17" kpx2="72"/><pair kern="27" kpx2="199"/><pair kern="-17" kpx2="71"/><pair kern="-128" kpx2="180"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="52"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="115"/><pair kern="-40" kpx2="90"/><pair kern="-17" kpx2="111"/><pair kern="27" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-17" kpx2="50"/><pair kern="27" kpx2="173"/><pair kern="-67" kpx2="92"/><pair kern="22" kpx2="197"/><pair kern="-58" kpx2="89"/><pair kern="27" kpx2="174"/></kerning><kerning kpx1="54"><pair kern="18" kpx2="173"/><pair kern="18" kpx2="36"/><pair kern="18" kpx2="201"/><pair kern="18" kpx2="199"/><pair kern="18" kpx2="174"/><pair kern="18" kpx2="98"/></kerning><kerning kpx1="180"><pair kern="-35" kpx2="235"/><pair kern="-35" kpx2="246"/><pair kern="-30" kpx2="43"/><pair kern="-72" kpx2="123"/><pair kern="-35" kpx2="251"/><pair kern="-35" kpx2="208"/><pair kern="-188" kpx2="144"/><pair kern="-58" kpx2="59"/><pair kern="-35" kpx2="73"/><pair kern="-30" kpx2="41"/><pair kern="-72" kpx2="124"/><pair kern="-54" kpx2="85"/><pair kern="-128" kpx2="201"/><pair kern="-17" kpx2="61"/><pair kern="-35" kpx2="100"/><pair kern="-72" kpx2="122"/><pair kern="-30" kpx2="47"/><pair kern="-35" kpx2="210"/><pair kern="-72" kpx2="82"/><pair kern="-35" kpx2="186"/><pair kern="-35" kpx2="175"/><pair kern="-35" kpx2="209"/><pair kern="-35" kpx2="103"/><pair kern="-128" kpx2="98"/><pair kern="-54" kpx2="81"/><pair kern="-17" kpx2="229"/><pair kern="-35" kpx2="38"/><pair kern="-72" kpx2="121"/><pair kern="-30" kpx2="37"/><pair kern="-54" kpx2="120"/><pair kern="-30" kpx2="51"/><pair kern="-128" kpx2="199"/><pair kern="-30" kpx2="53"/><pair kern="-30" kpx2="137"/><pair kern="-35" kpx2="233"/><pair kern="-35" kpx2="253"/><pair kern="-35" kpx2="52"/><pair kern="-72" kpx2="125"/><pair kern="-35" kpx2="42"/><pair kern="-35" kpx2="90"/><pair kern="-128" kpx2="36"/><pair kern="-35" kpx2="50"/><pair kern="-30" kpx2="39"/><pair kern="-30" kpx2="236"/><pair kern="-30" kpx2="45"/><pair kern="-128" kpx2="173"/><pair kern="-35" kpx2="92"/><pair kern="-35" kpx2="89"/><pair kern="-30" kpx2="46"/><pair kern="-128" kpx2="174"/></kerning><kerning kpx1="53"><pair kern="-21" kpx2="107"/><pair kern="-54" kpx2="235"/><pair kern="-40" kpx2="16"/><pair kern="-44" kpx2="112"/><pair kern="-44" kpx2="123"/><pair kern="-49" kpx2="251"/><pair kern="-44" kpx2="113"/><pair kern="-63" kpx2="187"/><pair kern="-44" kpx2="129"/><pair kern="-44" kpx2="124"/><pair kern="-54" kpx2="169"/><pair kern="-63" kpx2="60"/><pair kern="-40" kpx2="201"/><pair kern="-21" kpx2="106"/><pair kern="-30" kpx2="29"/><pair kern="-63" kpx2="234"/><pair kern="-49" kpx2="100"/><pair kern="-44" kpx2="122"/><pair kern="-21" kpx2="68"/><pair kern="-40" kpx2="58"/><pair kern="-44" kpx2="82"/><pair kern="-54" kpx2="186"/><pair kern="-40" kpx2="98"/><pair kern="-63" kpx2="181"/><pair kern="-35" kpx2="17"/><pair kern="-49" kpx2="38"/><pair kern="-44" kpx2="121"/><pair kern="-54" kpx2="57"/><pair kern="-44" kpx2="126"/><pair kern="-44" kpx2="72"/><pair kern="-40" kpx2="199"/><pair kern="-72" kpx2="180"/><pair kern="-21" kpx2="105"/><pair kern="-49" kpx2="253"/><pair kern="-44" kpx2="125"/><pair kern="-44" kpx2="115"/><pair kern="-17" kpx2="170"/><pair kern="-44" kpx2="88"/><pair kern="-40" kpx2="36"/><pair kern="-44" kpx2="114"/><pair kern="-72" kpx2="55"/><pair kern="-44" kpx2="127"/><pair kern="-21" kpx2="108"/><pair kern="-44" kpx2="128"/><pair kern="-40" kpx2="173"/><pair kern="-21" kpx2="109"/><pair kern="-54" kpx2="92"/><pair kern="-17" kpx2="197"/><pair kern="-21" kpx2="110"/><pair kern="-40" kpx2="174"/></kerning><kerning kpx1="137"><pair kern="-54" kpx2="180"/><pair kern="-40" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-54" kpx2="181"/></kerning><kerning kpx1="233"><pair kern="-44" kpx2="180"/><pair kern="-35" kpx2="197"/><pair kern="-54" kpx2="181"/></kerning><kerning kpx1="253"><pair kern="-17" kpx2="169"/><pair kern="-17" kpx2="60"/><pair kern="-17" kpx2="187"/><pair kern="18" kpx2="181"/><pair kern="-17" kpx2="170"/><pair kern="-17" kpx2="234"/></kerning><kerning kpx1="211"><pair kern="-17" kpx2="229"/><pair kern="-17" kpx2="61"/></kerning><kerning kpx1="78"><pair kern="-17" kpx2="107"/><pair kern="-30" kpx2="126"/><pair kern="-35" kpx2="235"/><pair kern="-35" kpx2="72"/><pair kern="-35" kpx2="112"/><pair kern="-35" kpx2="123"/><pair kern="-35" kpx2="113"/><pair kern="-17" kpx2="105"/><pair kern="-30" kpx2="129"/><pair kern="-35" kpx2="124"/><pair kern="-17" kpx2="106"/><pair kern="-35" kpx2="125"/><pair kern="-35" kpx2="115"/><pair kern="-30" kpx2="88"/><pair kern="-35" kpx2="122"/><pair kern="-17" kpx2="68"/><pair kern="-35" kpx2="82"/><pair kern="-35" kpx2="114"/><pair kern="-35" kpx2="186"/><pair kern="-30" kpx2="127"/><pair kern="-17" kpx2="108"/><pair kern="-30" kpx2="128"/><pair kern="-17" kpx2="109"/><pair kern="-35" kpx2="92"/><pair kern="-35" kpx2="121"/><pair kern="-17" kpx2="110"/></kerning><kerning kpx1="52"><pair kern="-21" kpx2="180"/><pair kern="-63" kpx2="197"/><pair kern="27" kpx2="16"/><pair kern="-17" kpx2="181"/></kerning><kerning kpx1="125"><pair kern="-72" kpx2="180"/><pair kern="-17" kpx2="17"/><pair kern="-63" kpx2="197"/><pair kern="18" kpx2="16"/><pair kern="-30" kpx2="91"/><pair kern="-35" kpx2="181"/></kerning><kerning kpx1="42"><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="169"/><pair kern="-26" kpx2="197"/><pair kern="-35" kpx2="55"/><pair kern="-49" kpx2="60"/><pair kern="-49" kpx2="187"/><pair kern="-21" kpx2="181"/><pair kern="-17" kpx2="170"/><pair kern="-49" kpx2="234"/></kerning><kerning kpx1="170"><pair kern="-17" kpx2="235"/><pair kern="-35" kpx2="199"/><pair kern="-17" kpx2="251"/><pair kern="-109" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-54" kpx2="59"/><pair kern="-109" kpx2="60"/><pair kern="-35" kpx2="201"/><pair kern="-17" kpx2="253"/><pair kern="-109" kpx2="234"/><pair kern="-17" kpx2="90"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="210"/><pair kern="-35" kpx2="36"/><pair kern="-54" kpx2="58"/><pair kern="-91" kpx2="55"/><pair kern="-17" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="50"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="-17" kpx2="39"/><pair kern="-35" kpx2="98"/><pair kern="-17" kpx2="45"/><pair kern="-35" kpx2="173"/><pair kern="-17" kpx2="92"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="89"/><pair kern="-86" kpx2="57"/><pair kern="-35" kpx2="37"/><pair kern="-35" kpx2="174"/></kerning><kerning kpx1="115"><pair kern="-17" kpx2="91"/></kerning><kerning kpx1="90"><pair kern="-91" kpx2="17"/><pair kern="-17" kpx2="169"/><pair kern="-104" kpx2="197"/><pair kern="-54" kpx2="29"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="36"><pair kern="-17" kpx2="246"/><pair kern="-67" kpx2="235"/><pair kern="-21" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-17" kpx2="251"/><pair kern="-17" kpx2="113"/><pair kern="-77" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-35" kpx2="73"/><pair kern="-17" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-77" kpx2="60"/><pair kern="27" kpx2="201"/><pair kern="-17" kpx2="29"/><pair kern="-77" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="122"/><pair kern="-17" kpx2="210"/><pair kern="-17" kpx2="82"/><pair kern="-54" kpx2="58"/><pair kern="-67" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="27" kpx2="98"/><pair kern="-123" kpx2="181"/><pair kern="-17" kpx2="17"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="84"/><pair kern="-17" kpx2="121"/><pair kern="-63" kpx2="57"/><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="87"/><pair kern="-17" kpx2="72"/><pair kern="27" kpx2="199"/><pair kern="-17" kpx2="71"/><pair kern="-128" kpx2="180"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="52"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="115"/><pair kern="-40" kpx2="90"/><pair kern="-17" kpx2="111"/><pair kern="27" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-17" kpx2="50"/><pair kern="27" kpx2="173"/><pair kern="-67" kpx2="92"/><pair kern="22" kpx2="197"/><pair kern="-58" kpx2="89"/><pair kern="27" kpx2="174"/></kerning><kerning kpx1="55"><pair kern="-165" kpx2="107"/><pair kern="-155" kpx2="235"/><pair kern="-91" kpx2="16"/><pair kern="-169" kpx2="112"/><pair kern="-169" kpx2="123"/><pair kern="-58" kpx2="251"/><pair kern="-169" kpx2="113"/><pair kern="-165" kpx2="86"/><pair kern="-151" kpx2="129"/><pair kern="-169" kpx2="124"/><pair kern="-91" kpx2="169"/><pair kern="-169" kpx2="252"/><pair kern="-169" kpx2="70"/><pair kern="-146" kpx2="85"/><pair kern="-77" kpx2="201"/><pair kern="-165" kpx2="106"/><pair kern="-109" kpx2="29"/><pair kern="-58" kpx2="100"/><pair kern="-169" kpx2="122"/><pair kern="-165" kpx2="68"/><pair kern="-169" kpx2="82"/><pair kern="-155" kpx2="186"/><pair kern="-165" kpx2="250"/><pair kern="-77" kpx2="98"/><pair kern="-21" kpx2="181"/><pair kern="-118" kpx2="17"/><pair kern="-58" kpx2="38"/><pair kern="-169" kpx2="121"/><pair kern="-165" kpx2="228"/><pair kern="-169" kpx2="254"/><pair kern="-151" kpx2="126"/><pair kern="-169" kpx2="72"/><pair kern="-77" kpx2="199"/><pair kern="-165" kpx2="105"/><pair kern="-58" kpx2="253"/><pair kern="-169" kpx2="125"/><pair kern="-169" kpx2="115"/><pair kern="-54" kpx2="170"/><pair kern="-151" kpx2="88"/><pair kern="-169" kpx2="111"/><pair kern="-165" kpx2="90"/><pair kern="-77" kpx2="36"/><pair kern="-17" kpx2="55"/><pair kern="-169" kpx2="114"/><pair kern="-151" kpx2="127"/><pair kern="-165" kpx2="108"/><pair kern="-30" kpx2="76"/><pair kern="-151" kpx2="128"/><pair kern="-77" kpx2="173"/><pair kern="-165" kpx2="109"/><pair kern="-155" kpx2="92"/><pair kern="-128" kpx2="197"/><pair kern="-165" kpx2="110"/><pair kern="-77" kpx2="174"/></kerning><kerning kpx1="114"><pair kern="-17" kpx2="91"/></kerning><kerning kpx1="50"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="27" kpx2="16"/><pair kern="-54" kpx2="187"/><pair kern="-17" kpx2="98"/><pair kern="-17" kpx2="181"/><pair kern="-63" kpx2="59"/><pair kern="-40" kpx2="17"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="29"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="91"><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="111"/><pair kern="-30" kpx2="122"/><pair kern="-30" kpx2="82"/><pair kern="-30" kpx2="114"/><pair kern="-30" kpx2="72"/><pair kern="-30" kpx2="112"/><pair kern="-30" kpx2="123"/><pair kern="-30" kpx2="113"/><pair kern="-30" kpx2="124"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-30" kpx2="121"/><pair kern="-30" kpx2="125"/><pair kern="-30" kpx2="115"/></kerning><kerning kpx1="39"><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="199"/><pair kern="-17" kpx2="98"/><pair kern="-54" kpx2="187"/><pair kern="-26" kpx2="181"/><pair kern="-21" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="169"/><pair kern="-91" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-54" kpx2="60"/><pair kern="-17" kpx2="57"/><pair kern="-17" kpx2="174"/><pair kern="-17" kpx2="170"/><pair kern="-54" kpx2="234"/></kerning><kerning kpx1="236"><pair kern="-17" kpx2="180"/><pair kern="-72" kpx2="17"/><pair kern="-91" kpx2="197"/><pair kern="-35" kpx2="29"/></kerning><kerning kpx1="45"><pair kern="-35" kpx2="180"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="36"/><pair kern="-17" kpx2="169"/><pair kern="-54" kpx2="197"/><pair kern="-17" kpx2="201"/><pair kern="-17" kpx2="199"/><pair kern="-35" kpx2="16"/><pair kern="-17" kpx2="174"/><pair kern="-17" kpx2="98"/><pair kern="-30" kpx2="181"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="173"><pair kern="-17" kpx2="246"/><pair kern="-67" kpx2="235"/><pair kern="-21" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-17" kpx2="251"/><pair kern="-17" kpx2="113"/><pair kern="-77" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-35" kpx2="73"/><pair kern="-17" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-77" kpx2="60"/><pair kern="27" kpx2="201"/><pair kern="-17" kpx2="29"/><pair kern="-77" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="122"/><pair kern="-17" kpx2="210"/><pair kern="-17" kpx2="82"/><pair kern="-54" kpx2="58"/><pair kern="-67" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="27" kpx2="98"/><pair kern="-123" kpx2="181"/><pair kern="-17" kpx2="17"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="84"/><pair kern="-17" kpx2="121"/><pair kern="-63" kpx2="57"/><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="87"/><pair kern="-17" kpx2="72"/><pair kern="27" kpx2="199"/><pair kern="-17" kpx2="71"/><pair kern="-128" kpx2="180"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="52"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="115"/><pair kern="-40" kpx2="90"/><pair kern="-17" kpx2="111"/><pair kern="27" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-17" kpx2="50"/><pair kern="27" kpx2="173"/><pair kern="-67" kpx2="92"/><pair kern="22" kpx2="197"/><pair kern="-58" kpx2="89"/><pair kern="27" kpx2="174"/></kerning><kerning kpx1="197"><pair kern="-35" kpx2="246"/><pair kern="-54" kpx2="235"/><pair kern="-35" kpx2="43"/><pair kern="-35" kpx2="123"/><pair kern="-54" kpx2="251"/><pair kern="-183" kpx2="187"/><pair kern="-54" kpx2="208"/><pair kern="18" kpx2="144"/><pair kern="-35" kpx2="59"/><pair kern="-17" kpx2="73"/><pair kern="-35" kpx2="41"/><pair kern="-35" kpx2="124"/><pair kern="-35" kpx2="85"/><pair kern="-183" kpx2="60"/><pair kern="18" kpx2="201"/><pair kern="-183" kpx2="234"/><pair kern="-54" kpx2="100"/><pair kern="-35" kpx2="122"/><pair kern="-35" kpx2="47"/><pair kern="-54" kpx2="210"/><pair kern="-35" kpx2="82"/><pair kern="-123" kpx2="58"/><pair kern="-54" kpx2="186"/><pair kern="-54" kpx2="175"/><pair kern="-54" kpx2="209"/><pair kern="-54" kpx2="103"/><pair kern="-35" kpx2="81"/><pair kern="18" kpx2="98"/><pair kern="-54" kpx2="38"/><pair kern="-35" kpx2="121"/><pair kern="-183" kpx2="57"/><pair kern="-35" kpx2="37"/><pair kern="-35" kpx2="120"/><pair kern="-35" kpx2="51"/><pair kern="18" kpx2="199"/><pair kern="-35" kpx2="53"/><pair kern="-35" kpx2="137"/><pair kern="-35" kpx2="233"/><pair kern="-54" kpx2="253"/><pair kern="-54" kpx2="52"/><pair kern="-35" kpx2="125"/><pair kern="-35" kpx2="42"/><pair kern="-95" kpx2="90"/><pair kern="18" kpx2="36"/><pair kern="-137" kpx2="55"/><pair kern="-54" kpx2="50"/><pair kern="-35" kpx2="39"/><pair kern="-35" kpx2="236"/><pair kern="22" kpx2="45"/><pair kern="18" kpx2="173"/><pair kern="-54" kpx2="92"/><pair kern="-114" kpx2="89"/><pair kern="-35" kpx2="46"/><pair kern="18" kpx2="174"/></kerning><kerning kpx1="92"><pair kern="-142" kpx2="17"/><pair kern="-17" kpx2="169"/><pair kern="-146" kpx2="197"/><pair kern="-17" kpx2="16"/><pair kern="-72" kpx2="29"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="89"><pair kern="-77" kpx2="17"/><pair kern="-17" kpx2="169"/><pair kern="-132" kpx2="197"/><pair kern="-26" kpx2="16"/><pair kern="-54" kpx2="29"/><pair kern="-17" kpx2="181"/><pair kern="-17" kpx2="170"/></kerning><kerning kpx1="46"><pair kern="-17" kpx2="107"/><pair kern="-72" kpx2="235"/><pair kern="-104" kpx2="16"/><pair kern="-49" kpx2="112"/><pair kern="-49" kpx2="123"/><pair kern="-54" kpx2="251"/><pair kern="-26" kpx2="213"/><pair kern="-49" kpx2="113"/><pair kern="-35" kpx2="187"/><pair kern="-54" kpx2="208"/><pair kern="-49" kpx2="129"/><pair kern="-49" kpx2="124"/><pair kern="-63" kpx2="169"/><pair kern="-35" kpx2="60"/><pair kern="-17" kpx2="201"/><pair kern="-17" kpx2="106"/><pair kern="-35" kpx2="234"/><pair kern="-54" kpx2="100"/><pair kern="-49" kpx2="122"/><pair kern="-17" kpx2="68"/><pair kern="-54" kpx2="210"/><pair kern="-35" kpx2="58"/><pair kern="-49" kpx2="82"/><pair kern="-72" kpx2="186"/><pair kern="-54" kpx2="175"/><pair kern="-54" kpx2="209"/><pair kern="-54" kpx2="103"/><pair kern="-17" kpx2="98"/><pair kern="-30" kpx2="181"/><pair kern="-26" kpx2="212"/><pair kern="-54" kpx2="38"/><pair kern="-49" kpx2="121"/><pair kern="-49" kpx2="126"/><pair kern="-26" kpx2="104"/><pair kern="-49" kpx2="72"/><pair kern="-17" kpx2="199"/><pair kern="-30" kpx2="180"/><pair kern="-17" kpx2="105"/><pair kern="-54" kpx2="253"/><pair kern="-26" kpx2="211"/><pair kern="-49" kpx2="125"/><pair kern="-49" kpx2="115"/><pair kern="-49" kpx2="88"/><pair kern="-17" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-49" kpx2="114"/><pair kern="-54" kpx2="50"/><pair kern="-49" kpx2="127"/><pair kern="-17" kpx2="108"/><pair kern="-49" kpx2="128"/><pair kern="-17" kpx2="173"/><pair kern="-17" kpx2="109"/><pair kern="-72" kpx2="92"/><pair kern="-17" kpx2="110"/><pair kern="-17" kpx2="174"/><pair kern="-26" kpx2="56"/></kerning><kerning kpx1="174"><pair kern="-17" kpx2="246"/><pair kern="-67" kpx2="235"/><pair kern="-21" kpx2="16"/><pair kern="-17" kpx2="112"/><pair kern="-17" kpx2="123"/><pair kern="-17" kpx2="251"/><pair kern="-17" kpx2="113"/><pair kern="-77" kpx2="187"/><pair kern="-17" kpx2="208"/><pair kern="-35" kpx2="73"/><pair kern="-17" kpx2="124"/><pair kern="-35" kpx2="169"/><pair kern="-17" kpx2="252"/><pair kern="-17" kpx2="70"/><pair kern="-77" kpx2="60"/><pair kern="27" kpx2="201"/><pair kern="-17" kpx2="29"/><pair kern="-77" kpx2="234"/><pair kern="-17" kpx2="100"/><pair kern="-17" kpx2="122"/><pair kern="-17" kpx2="210"/><pair kern="-17" kpx2="82"/><pair kern="-54" kpx2="58"/><pair kern="-67" kpx2="186"/><pair kern="-17" kpx2="175"/><pair kern="-17" kpx2="209"/><pair kern="-17" kpx2="103"/><pair kern="27" kpx2="98"/><pair kern="-123" kpx2="181"/><pair kern="-17" kpx2="17"/><pair kern="-17" kpx2="38"/><pair kern="-17" kpx2="84"/><pair kern="-17" kpx2="121"/><pair kern="-63" kpx2="57"/><pair kern="-17" kpx2="254"/><pair kern="-17" kpx2="87"/><pair kern="-17" kpx2="72"/><pair kern="27" kpx2="199"/><pair kern="-17" kpx2="71"/><pair kern="-128" kpx2="180"/><pair kern="-17" kpx2="253"/><pair kern="-17" kpx2="52"/><pair kern="-17" kpx2="125"/><pair kern="-17" kpx2="42"/><pair kern="-17" kpx2="115"/><pair kern="-40" kpx2="90"/><pair kern="-17" kpx2="111"/><pair kern="27" kpx2="36"/><pair kern="-77" kpx2="55"/><pair kern="-17" kpx2="114"/><pair kern="-17" kpx2="50"/><pair kern="27" kpx2="173"/><pair kern="-67" kpx2="92"/><pair kern="22" kpx2="197"/><pair kern="-58" kpx2="89"/><pair kern="27" kpx2="174"/></kerning><kerning kpx1="56"><pair kern="-17" kpx2="229"/><pair kern="-17" kpx2="61"/></kerning></font-metrics> \ No newline at end of file
diff --git a/documentation/template/VeraMoBd.ttf b/documentation/template/VeraMoBd.ttf
new file mode 100644
index 0000000000..9be6547ed6
--- /dev/null
+++ b/documentation/template/VeraMoBd.ttf
Binary files differ
diff --git a/documentation/template/VeraMoBd.xml b/documentation/template/VeraMoBd.xml
new file mode 100644
index 0000000000..9b33107a44
--- /dev/null
+++ b/documentation/template/VeraMoBd.xml
@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><font-metrics metrics-version="2" type="TYPE0"><font-name>BitstreamVeraSansMono-Bold</font-name><full-name>Bitstream Vera Sans Mono Bold</full-name><family-name>Bitstream Vera Sans Mono</family-name><embed/><cap-height>729</cap-height><x-height>546</x-height><ascender>759</ascender><descender>-240</descender><bbox><left>-19</left><bottom>-235</bottom><right>605</right><top>928</top></bbox><flags>34</flags><stemv>0</stemv><italicangle>0</italicangle><subtype>TYPE0</subtype><multibyte-extras><cid-type>CIDFontType2</cid-type><default-width>0</default-width><bfranges><bf gi="3" ue="126" us="32"/><bf gi="172" ue="160" us="160"/><bf gi="163" ue="161" us="161"/><bf gi="132" ue="163" us="162"/><bf gi="189" ue="164" us="164"/><bf gi="150" ue="165" us="165"/><bf gi="231" ue="166" us="166"/><bf gi="134" ue="167" us="167"/><bf gi="142" ue="168" us="168"/><bf gi="139" ue="169" us="169"/><bf gi="157" ue="170" us="170"/><bf gi="169" ue="171" us="171"/><bf gi="164" ue="172" us="172"/><bf gi="256" ue="173" us="173"/><bf gi="138" ue="174" us="174"/><bf gi="217" ue="175" us="175"/><bf gi="131" ue="176" us="176"/><bf gi="147" ue="177" us="177"/><bf gi="241" ue="179" us="178"/><bf gi="141" ue="180" us="180"/><bf gi="151" ue="181" us="181"/><bf gi="136" ue="182" us="182"/><bf gi="195" ue="183" us="183"/><bf gi="221" ue="184" us="184"/><bf gi="240" ue="185" us="185"/><bf gi="158" ue="186" us="186"/><bf gi="170" ue="187" us="187"/><bf gi="243" ue="190" us="188"/><bf gi="162" ue="191" us="191"/><bf gi="173" ue="192" us="192"/><bf gi="201" ue="193" us="193"/><bf gi="199" ue="194" us="194"/><bf gi="174" ue="195" us="195"/><bf gi="98" ue="197" us="196"/><bf gi="144" ue="198" us="198"/><bf gi="100" ue="199" us="199"/><bf gi="203" ue="200" us="200"/><bf gi="101" ue="201" us="201"/><bf gi="200" ue="202" us="202"/><bf gi="202" ue="203" us="203"/><bf gi="207" ue="204" us="204"/><bf gi="204" ue="207" us="205"/><bf gi="232" ue="208" us="208"/><bf gi="102" ue="209" us="209"/><bf gi="210" ue="210" us="210"/><bf gi="208" ue="212" us="211"/><bf gi="175" ue="213" us="213"/><bf gi="103" ue="214" us="214"/><bf gi="239" ue="215" us="215"/><bf gi="145" ue="216" us="216"/><bf gi="213" ue="217" us="217"/><bf gi="211" ue="219" us="218"/><bf gi="104" ue="220" us="220"/><bf gi="234" ue="221" us="221"/><bf gi="236" ue="222" us="222"/><bf gi="137" ue="223" us="223"/><bf gi="106" ue="224" us="224"/><bf gi="105" ue="225" us="225"/><bf gi="107" ue="226" us="226"/><bf gi="109" ue="227" us="227"/><bf gi="108" ue="228" us="228"/><bf gi="110" ue="229" us="229"/><bf gi="160" ue="230" us="230"/><bf gi="111" ue="231" us="231"/><bf gi="113" ue="232" us="232"/><bf gi="112" ue="233" us="233"/><bf gi="114" ue="235" us="234"/><bf gi="117" ue="236" us="236"/><bf gi="116" ue="237" us="237"/><bf gi="118" ue="239" us="238"/><bf gi="233" ue="240" us="240"/><bf gi="120" ue="241" us="241"/><bf gi="122" ue="242" us="242"/><bf gi="121" ue="243" us="243"/><bf gi="123" ue="244" us="244"/><bf gi="125" ue="245" us="245"/><bf gi="124" ue="246" us="246"/><bf gi="184" ue="247" us="247"/><bf gi="161" ue="248" us="248"/><bf gi="127" ue="249" us="249"/><bf gi="126" ue="250" us="250"/><bf gi="128" ue="252" us="251"/><bf gi="235" ue="253" us="253"/><bf gi="237" ue="254" us="254"/><bf gi="186" ue="255" us="255"/><bf gi="251" ue="263" us="262"/><bf gi="253" ue="269" us="268"/><bf gi="0" ue="270" us="270"/><bf gi="0" ue="271" us="271"/><bf gi="0" ue="272" us="272"/><bf gi="255" ue="273" us="273"/><bf gi="246" ue="287" us="286"/><bf gi="248" ue="304" us="304"/><bf gi="214" ue="305" us="305"/><bf gi="225" ue="322" us="321"/><bf gi="176" ue="339" us="338"/><bf gi="249" ue="351" us="350"/><bf gi="227" ue="353" us="352"/><bf gi="187" ue="376" us="376"/><bf gi="229" ue="382" us="381"/><bf gi="166" ue="402" us="402"/><bf gi="215" ue="710" us="710"/><bf gi="224" ue="711" us="711"/><bf gi="218" ue="730" us="728"/><bf gi="223" ue="731" us="731"/><bf gi="216" ue="732" us="732"/><bf gi="222" ue="733" us="733"/><bf gi="159" ue="937" us="937"/><bf gi="155" ue="960" us="960"/><bf gi="178" ue="8212" us="8211"/><bf gi="0" ue="8213" us="8213"/><bf gi="0" ue="8214" us="8214"/><bf gi="0" ue="8215" us="8215"/><bf gi="182" ue="8217" us="8216"/><bf gi="196" ue="8218" us="8218"/><bf gi="0" ue="8219" us="8219"/><bf gi="180" ue="8221" us="8220"/><bf gi="197" ue="8222" us="8222"/><bf gi="0" ue="8223" us="8223"/><bf gi="130" ue="8224" us="8224"/><bf gi="194" ue="8225" us="8225"/><bf gi="135" ue="8226" us="8226"/><bf gi="0" ue="8227" us="8227"/><bf gi="0" ue="8228" us="8228"/><bf gi="0" ue="8229" us="8229"/><bf gi="171" ue="8230" us="8230"/><bf gi="198" ue="8240" us="8240"/><bf gi="190" ue="8250" us="8249"/><bf gi="258" ue="8364" us="8364"/><bf gi="140" ue="8482" us="8482"/><bf gi="152" ue="8706" us="8706"/><bf gi="0" ue="8707" us="8707"/><bf gi="0" ue="8708" us="8708"/><bf gi="0" ue="8709" us="8709"/><bf gi="168" ue="8710" us="8710"/><bf gi="154" ue="8719" us="8719"/><bf gi="0" ue="8720" us="8720"/><bf gi="153" ue="8721" us="8721"/><bf gi="238" ue="8722" us="8722"/><bf gi="0" ue="8723" us="8723"/><bf gi="0" ue="8724" us="8724"/><bf gi="188" ue="8725" us="8725"/><bf gi="0" ue="8726" us="8726"/><bf gi="0" ue="8727" us="8727"/><bf gi="0" ue="8728" us="8728"/><bf gi="257" ue="8729" us="8729"/><bf gi="165" ue="8730" us="8730"/><bf gi="0" ue="8731" us="8731"/><bf gi="0" ue="8732" us="8732"/><bf gi="0" ue="8733" us="8733"/><bf gi="146" ue="8734" us="8734"/><bf gi="156" ue="8747" us="8747"/><bf gi="167" ue="8776" us="8776"/><bf gi="143" ue="8800" us="8800"/><bf gi="0" ue="8801" us="8801"/><bf gi="0" ue="8802" us="8802"/><bf gi="0" ue="8803" us="8803"/><bf gi="148" ue="8805" us="8804"/><bf gi="185" ue="9674" us="9674"/><bf gi="192" ue="64258" us="64257"/><bf gi="0" ue="65535" us="65535"/></bfranges><cid-widths start-index="0"><wx w="602"/><wx w="0"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/></cid-widths></multibyte-extras></font-metrics> \ No newline at end of file
diff --git a/documentation/template/VeraMono.ttf b/documentation/template/VeraMono.ttf
new file mode 100644
index 0000000000..139f0b4311
--- /dev/null
+++ b/documentation/template/VeraMono.ttf
Binary files differ
diff --git a/documentation/template/VeraMono.xml b/documentation/template/VeraMono.xml
new file mode 100644
index 0000000000..3a0a86659c
--- /dev/null
+++ b/documentation/template/VeraMono.xml
@@ -0,0 +1 @@
<?xml version="1.0" encoding="UTF-8"?><font-metrics metrics-version="2" type="TYPE0"><font-name>BitstreamVeraSansMono-Roman</font-name><full-name>Bitstream Vera Sans Mono</full-name><family-name>Bitstream Vera Sans Mono</family-name><embed/><cap-height>729</cap-height><x-height>546</x-height><ascender>759</ascender><descender>-240</descender><bbox><left>-4</left><bottom>-235</bottom><right>605</right><top>928</top></bbox><flags>34</flags><stemv>0</stemv><italicangle>0</italicangle><subtype>TYPE0</subtype><multibyte-extras><cid-type>CIDFontType2</cid-type><default-width>0</default-width><bfranges><bf gi="3" ue="126" us="32"/><bf gi="172" ue="160" us="160"/><bf gi="163" ue="161" us="161"/><bf gi="132" ue="163" us="162"/><bf gi="189" ue="164" us="164"/><bf gi="150" ue="165" us="165"/><bf gi="231" ue="166" us="166"/><bf gi="134" ue="167" us="167"/><bf gi="142" ue="168" us="168"/><bf gi="139" ue="169" us="169"/><bf gi="157" ue="170" us="170"/><bf gi="169" ue="171" us="171"/><bf gi="164" ue="172" us="172"/><bf gi="256" ue="173" us="173"/><bf gi="138" ue="174" us="174"/><bf gi="217" ue="175" us="175"/><bf gi="131" ue="176" us="176"/><bf gi="147" ue="177" us="177"/><bf gi="241" ue="179" us="178"/><bf gi="141" ue="180" us="180"/><bf gi="151" ue="181" us="181"/><bf gi="136" ue="182" us="182"/><bf gi="195" ue="183" us="183"/><bf gi="221" ue="184" us="184"/><bf gi="240" ue="185" us="185"/><bf gi="158" ue="186" us="186"/><bf gi="170" ue="187" us="187"/><bf gi="243" ue="190" us="188"/><bf gi="162" ue="191" us="191"/><bf gi="173" ue="192" us="192"/><bf gi="201" ue="193" us="193"/><bf gi="199" ue="194" us="194"/><bf gi="174" ue="195" us="195"/><bf gi="98" ue="197" us="196"/><bf gi="144" ue="198" us="198"/><bf gi="100" ue="199" us="199"/><bf gi="203" ue="200" us="200"/><bf gi="101" ue="201" us="201"/><bf gi="200" ue="202" us="202"/><bf gi="202" ue="203" us="203"/><bf gi="207" ue="204" us="204"/><bf gi="204" ue="207" us="205"/><bf gi="232" ue="208" us="208"/><bf gi="102" ue="209" us="209"/><bf gi="210" ue="210" us="210"/><bf gi="208" ue="212" us="211"/><bf gi="175" ue="213" us="213"/><bf gi="103" ue="214" us="214"/><bf gi="239" ue="215" us="215"/><bf gi="145" ue="216" us="216"/><bf gi="213" ue="217" us="217"/><bf gi="211" ue="219" us="218"/><bf gi="104" ue="220" us="220"/><bf gi="234" ue="221" us="221"/><bf gi="236" ue="222" us="222"/><bf gi="137" ue="223" us="223"/><bf gi="106" ue="224" us="224"/><bf gi="105" ue="225" us="225"/><bf gi="107" ue="226" us="226"/><bf gi="109" ue="227" us="227"/><bf gi="108" ue="228" us="228"/><bf gi="110" ue="229" us="229"/><bf gi="160" ue="230" us="230"/><bf gi="111" ue="231" us="231"/><bf gi="113" ue="232" us="232"/><bf gi="112" ue="233" us="233"/><bf gi="114" ue="235" us="234"/><bf gi="117" ue="236" us="236"/><bf gi="116" ue="237" us="237"/><bf gi="118" ue="239" us="238"/><bf gi="233" ue="240" us="240"/><bf gi="120" ue="241" us="241"/><bf gi="122" ue="242" us="242"/><bf gi="121" ue="243" us="243"/><bf gi="123" ue="244" us="244"/><bf gi="125" ue="245" us="245"/><bf gi="124" ue="246" us="246"/><bf gi="184" ue="247" us="247"/><bf gi="161" ue="248" us="248"/><bf gi="127" ue="249" us="249"/><bf gi="126" ue="250" us="250"/><bf gi="128" ue="252" us="251"/><bf gi="235" ue="253" us="253"/><bf gi="237" ue="254" us="254"/><bf gi="186" ue="255" us="255"/><bf gi="251" ue="263" us="262"/><bf gi="253" ue="269" us="268"/><bf gi="0" ue="270" us="270"/><bf gi="0" ue="271" us="271"/><bf gi="0" ue="272" us="272"/><bf gi="255" ue="273" us="273"/><bf gi="246" ue="287" us="286"/><bf gi="248" ue="304" us="304"/><bf gi="214" ue="305" us="305"/><bf gi="225" ue="322" us="321"/><bf gi="176" ue="339" us="338"/><bf gi="249" ue="351" us="350"/><bf gi="227" ue="353" us="352"/><bf gi="187" ue="376" us="376"/><bf gi="229" ue="382" us="381"/><bf gi="166" ue="402" us="402"/><bf gi="215" ue="710" us="710"/><bf gi="224" ue="711" us="711"/><bf gi="218" ue="730" us="728"/><bf gi="223" ue="731" us="731"/><bf gi="216" ue="732" us="732"/><bf gi="222" ue="733" us="733"/><bf gi="159" ue="937" us="937"/><bf gi="155" ue="960" us="960"/><bf gi="178" ue="8212" us="8211"/><bf gi="0" ue="8213" us="8213"/><bf gi="0" ue="8214" us="8214"/><bf gi="0" ue="8215" us="8215"/><bf gi="182" ue="8217" us="8216"/><bf gi="196" ue="8218" us="8218"/><bf gi="0" ue="8219" us="8219"/><bf gi="180" ue="8221" us="8220"/><bf gi="197" ue="8222" us="8222"/><bf gi="0" ue="8223" us="8223"/><bf gi="130" ue="8224" us="8224"/><bf gi="194" ue="8225" us="8225"/><bf gi="135" ue="8226" us="8226"/><bf gi="0" ue="8227" us="8227"/><bf gi="0" ue="8228" us="8228"/><bf gi="0" ue="8229" us="8229"/><bf gi="171" ue="8230" us="8230"/><bf gi="198" ue="8240" us="8240"/><bf gi="190" ue="8250" us="8249"/><bf gi="258" ue="8364" us="8364"/><bf gi="140" ue="8482" us="8482"/><bf gi="152" ue="8706" us="8706"/><bf gi="0" ue="8707" us="8707"/><bf gi="0" ue="8708" us="8708"/><bf gi="0" ue="8709" us="8709"/><bf gi="168" ue="8710" us="8710"/><bf gi="154" ue="8719" us="8719"/><bf gi="0" ue="8720" us="8720"/><bf gi="153" ue="8721" us="8721"/><bf gi="238" ue="8722" us="8722"/><bf gi="0" ue="8723" us="8723"/><bf gi="0" ue="8724" us="8724"/><bf gi="188" ue="8725" us="8725"/><bf gi="0" ue="8726" us="8726"/><bf gi="0" ue="8727" us="8727"/><bf gi="0" ue="8728" us="8728"/><bf gi="257" ue="8729" us="8729"/><bf gi="165" ue="8730" us="8730"/><bf gi="0" ue="8731" us="8731"/><bf gi="0" ue="8732" us="8732"/><bf gi="0" ue="8733" us="8733"/><bf gi="146" ue="8734" us="8734"/><bf gi="156" ue="8747" us="8747"/><bf gi="167" ue="8776" us="8776"/><bf gi="143" ue="8800" us="8800"/><bf gi="0" ue="8801" us="8801"/><bf gi="0" ue="8802" us="8802"/><bf gi="0" ue="8803" us="8803"/><bf gi="148" ue="8805" us="8804"/><bf gi="185" ue="9674" us="9674"/><bf gi="192" ue="64258" us="64257"/><bf gi="0" ue="65535" us="65535"/></bfranges><cid-widths start-index="0"><wx w="602"/><wx w="0"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/><wx w="602"/></cid-widths></multibyte-extras></font-metrics> \ No newline at end of file
diff --git a/documentation/template/draft.png b/documentation/template/draft.png
new file mode 100644
index 0000000000..53051a9ddd
--- /dev/null
+++ b/documentation/template/draft.png
Binary files differ
diff --git a/documentation/template/fop-config.xml b/documentation/template/fop-config.xml
new file mode 100644
index 0000000000..09cc5ca0f5
--- /dev/null
+++ b/documentation/template/fop-config.xml
@@ -0,0 +1,58 @@
1<fop version="1.0">
2
3 <!-- Strict user configuration -->
4 <strict-configuration>true</strict-configuration>
5
6 <!-- Strict FO validation -->
7 <strict-validation>true</strict-validation>
8
9 <!--
10 Set the baseDir so common/openedhand.svg references in plans still
11 work ok. Note, relative file references to current dir should still work.
12 -->
13 <base>../template</base>
14 <font-base>../template</font-base>
15
16 <!-- Source resolution in dpi (dots/pixels per inch) for determining the
17 size of pixels in SVG and bitmap images, default: 72dpi -->
18 <!-- <source-resolution>72</source-resolution> -->
19 <!-- Target resolution in dpi (dots/pixels per inch) for specifying the
20 target resolution for generated bitmaps, default: 72dpi -->
21 <!-- <target-resolution>72</target-resolution> -->
22
23 <!-- default page-height and page-width, in case
24 value is specified as auto -->
25 <default-page-settings height="11in" width="8.26in"/>
26
27 <!-- <use-cache>false</use-cache> -->
28
29 <renderers>
30 <renderer mime="application/pdf">
31 <fonts>
32 <font metrics-file="VeraMono.xml"
33 kerning="yes"
34 embed-url="VeraMono.ttf">
35 <font-triplet name="veramono" style="normal" weight="normal"/>
36 </font>
37
38 <font metrics-file="VeraMoBd.xml"
39 kerning="yes"
40 embed-url="VeraMoBd.ttf">
41 <font-triplet name="veramono" style="normal" weight="bold"/>
42 </font>
43
44 <font metrics-file="Vera.xml"
45 kerning="yes"
46 embed-url="Vera.ttf">
47 <font-triplet name="verasans" style="normal" weight="normal"/>
48 <font-triplet name="verasans" style="normal" weight="bold"/>
49 <font-triplet name="verasans" style="italic" weight="normal"/>
50 <font-triplet name="verasans" style="italic" weight="bold"/>
51 </font>
52
53 <auto-detect/>
54 </fonts>
55 </renderer>
56 </renderers>
57</fop>
58
diff --git a/documentation/template/ohand-color.svg b/documentation/template/ohand-color.svg
new file mode 100644
index 0000000000..e42ff9c6fc
--- /dev/null
+++ b/documentation/template/ohand-color.svg
@@ -0,0 +1,150 @@
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!-- Created with Inkscape (http://www.inkscape.org/) -->
3<svg
4 xmlns:dc="http://purl.org/dc/elements/1.1/"
5 xmlns:cc="http://web.resource.org/cc/"
6 xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
7 xmlns:svg="http://www.w3.org/2000/svg"
8 xmlns="http://www.w3.org/2000/svg"
9 xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
10 xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
11 width="141.17999"
12 height="55.34"
13 id="svg2207"
14 sodipodi:version="0.32"
15 inkscape:version="0.45"
16 version="1.0"
17 sodipodi:docname="ohand-color.svg"
18 inkscape:output_extension="org.inkscape.output.svg.inkscape"
19 sodipodi:docbase="/home/mallum/Projects/admin/oh-doc-tools/common"
20 sodipodi:modified="true">
21 <defs
22 id="defs3" />
23 <sodipodi:namedview
24 id="base"
25 pagecolor="#ffffff"
26 bordercolor="#666666"
27 borderopacity="1.0"
28 inkscape:pageopacity="0.0"
29 inkscape:pageshadow="2"
30 inkscape:zoom="1.2"
31 inkscape:cx="160"
32 inkscape:cy="146.21189"
33 inkscape:document-units="mm"
34 inkscape:current-layer="layer1"
35 height="55.34px"
36 width="141.18px"
37 inkscape:window-width="772"
38 inkscape:window-height="581"
39 inkscape:window-x="5"
40 inkscape:window-y="48" />
41 <metadata
42 id="metadata2211">
43 <rdf:RDF>
44 <cc:Work
45 rdf:about="">
46 <dc:format>image/svg+xml</dc:format>
47 <dc:type
48 rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
49 </cc:Work>
50 </rdf:RDF>
51 </metadata>
52 <g
53 inkscape:label="Layer 1"
54 inkscape:groupmode="layer"
55 id="layer1">
56 <g
57 id="g2094"
58 style="fill:#6d6d70;fill-opacity:1"
59 inkscape:export-filename="/home/mallum/Desktop/g2126.png"
60 inkscape:export-xdpi="312.71841"
61 inkscape:export-ydpi="312.71841"
62 transform="matrix(0.5954767,0,0,0.5954767,31.793058,-18.471052)">
63 <g
64 id="g19"
65 style="fill:#6d6d70;fill-opacity:1">
66 <path
67 style="fill:#6d6d70;fill-opacity:1"
68 id="path21"
69 d="M 48.693,50.633 C 40.282,50.633 33.439,57.477 33.439,65.888 L 33.439,81.142 L 41.066,81.142 L 41.066,65.888 C 41.066,61.684 44.486,58.261 48.692,58.261 C 52.897,58.261 56.32,61.684 56.32,65.888 C 56.32,70.093 52.897,73.516 48.692,73.516 C 45.677,73.516 43.065,71.756 41.828,69.211 L 41.828,79.504 C 43.892,80.549 46.224,81.142 48.692,81.142 C 57.103,81.142 63.947,74.3 63.947,65.888 C 63.948,57.477 57.104,50.633 48.693,50.633 z " />
70 </g>
71 <path
72 style="fill:#6d6d70;fill-opacity:1"
73 id="path23"
74 d="M 18.486,50.557 C 26.942,50.557 33.819,57.435 33.819,65.888 C 33.819,74.344 26.942,81.223 18.486,81.223 C 10.032,81.223 3.152,74.344 3.152,65.888 C 3.152,57.435 10.032,50.557 18.486,50.557 z M 18.486,73.556 C 22.713,73.556 26.153,70.118 26.153,65.888 C 26.153,61.661 22.713,58.222 18.486,58.222 C 14.258,58.222 10.819,61.661 10.819,65.888 C 10.82,70.117 14.259,73.556 18.486,73.556 z " />
75 <path
76 style="fill:#6d6d70;fill-opacity:1"
77 id="path25"
78 d="M 94.074,107.465 L 94.074,96.016 C 94.074,87.605 87.233,80.763 78.822,80.763 C 70.41,80.763 63.567,87.605 63.567,96.016 C 63.567,104.427 70.41,111.269 78.822,111.269 C 81.289,111.269 83.621,110.676 85.685,109.631 L 85.685,99.339 C 84.448,101.885 81.836,103.644 78.822,103.644 C 74.615,103.644 71.194,100.221 71.194,96.016 C 71.194,91.81 74.615,88.388 78.822,88.388 C 83.026,88.388 86.448,91.81 86.448,96.016 L 86.448,107.456 C 86.448,109.562 88.156,111.268 90.262,111.268 C 92.364,111.269 94.068,109.566 94.074,107.465 z " />
79 <path
80 style="fill:#6d6d70;fill-opacity:1"
81 id="path27"
82 d="M 124.197,95.814 C 124.088,87.496 117.293,80.762 108.949,80.762 C 100.59,80.762 93.783,87.52 93.697,95.856 L 93.693,95.856 L 93.695,107.456 C 93.695,109.562 95.402,111.268 97.509,111.268 C 99.611,111.268 101.316,109.566 101.321,107.464 L 101.321,95.994 L 101.321,95.994 C 101.333,91.798 104.747,88.388 108.948,88.388 C 113.147,88.388 116.563,91.798 116.575,95.994 L 116.575,107.456 C 116.575,109.562 118.282,111.268 120.387,111.268 C 122.492,111.268 124.201,109.562 124.201,107.456 L 124.201,95.814 L 124.197,95.814 z " />
83 <path
84 style="fill:#6d6d70;fill-opacity:1"
85 id="path29"
86 d="M 63.946,96.005 L 63.946,95.854 L 63.943,95.854 L 63.943,95.815 L 63.942,95.815 C 63.833,87.497 57.037,80.761 48.693,80.761 C 48.682,80.761 48.671,80.763 48.658,80.763 C 48.382,80.763 48.107,80.772 47.833,80.786 C 47.75,80.791 47.668,80.799 47.586,80.806 C 47.378,80.822 47.172,80.838 46.968,80.862 C 46.884,80.873 46.801,80.882 46.719,80.893 C 46.508,80.92 46.298,80.952 46.091,80.987 C 46.024,80.999 45.958,81.01 45.891,81.024 C 45.649,81.068 45.406,81.119 45.168,81.175 C 45.14,81.183 45.112,81.189 45.085,81.195 C 43.656,81.542 42.306,82.092 41.065,82.812 L 41.065,80.761 L 33.438,80.761 L 33.438,95.857 L 33.435,95.857 L 33.435,107.457 C 33.435,109.563 35.142,111.269 37.248,111.269 C 39.093,111.269 40.632,109.958 40.984,108.217 C 41.036,107.963 41.065,107.702 41.065,107.435 L 41.065,95.873 C 41.086,94.732 41.357,93.65 41.828,92.685 L 41.828,92.693 C 42.598,91.106 43.905,89.824 45.511,89.085 C 45.519,89.08 45.529,89.076 45.536,89.073 C 45.849,88.928 46.174,88.807 46.508,88.707 C 46.523,88.704 46.536,88.699 46.55,88.696 C 46.699,88.651 46.85,88.614 47.004,88.576 C 47.025,88.575 47.046,88.567 47.069,88.562 C 47.234,88.527 47.402,88.495 47.572,88.469 C 47.586,88.468 47.6,88.466 47.615,88.463 C 47.763,88.443 47.916,88.427 48.067,88.415 C 48.106,88.41 48.145,88.407 48.186,88.404 C 48.352,88.393 48.52,88.386 48.691,88.386 C 52.888,88.387 56.304,91.797 56.316,95.992 L 56.316,107.454 C 56.316,109.56 58.023,111.266 60.13,111.266 C 61.976,111.266 63.516,109.954 63.867,108.211 C 63.919,107.963 63.946,107.706 63.946,107.442 L 63.946,96.024 C 63.946,96.021 63.947,96.018 63.947,96.015 C 63.948,96.011 63.946,96.008 63.946,96.005 z " />
87 <path
88 style="fill:#6d6d70;fill-opacity:1"
89 id="path31"
90 d="M 180.644,50.633 C 178.539,50.633 176.832,52.341 176.832,54.447 L 176.832,65.887 C 176.832,70.092 173.41,73.513 169.203,73.513 C 164.998,73.513 161.576,70.092 161.576,65.887 C 161.576,61.683 164.998,58.26 169.203,58.26 C 172.219,58.26 174.83,60.019 176.068,62.565 L 176.068,52.271 C 174.004,51.225 171.673,50.632 169.203,50.632 C 160.793,50.632 153.951,57.476 153.951,65.887 C 153.951,74.298 160.793,81.141 169.203,81.141 C 177.615,81.141 184.459,74.298 184.459,65.887 L 184.459,54.447 C 184.458,52.341 182.751,50.633 180.644,50.633 z " />
91 <path
92 style="fill:#6d6d70;fill-opacity:1"
93 id="path33"
94 d="M 124.203,77.339 L 124.203,65.687 L 124.197,65.687 C 124.088,57.371 117.293,50.633 108.949,50.633 C 100.592,50.633 93.783,57.393 93.697,65.731 L 93.695,65.731 L 93.695,65.877 C 93.695,65.882 93.693,65.885 93.693,65.888 C 93.693,65.891 93.695,65.896 93.695,65.899 L 93.695,77.33 C 93.695,79.435 95.402,81.142 97.509,81.142 C 99.614,81.142 101.321,79.435 101.321,77.33 L 101.321,65.868 C 101.333,61.672 104.747,58.261 108.948,58.261 C 113.147,58.261 116.563,61.672 116.575,65.868 L 116.575,65.868 L 116.575,77.329 C 116.575,79.434 118.282,81.141 120.389,81.141 C 122.492,81.142 124.197,79.44 124.203,77.339 z " />
95 <path
96 style="fill:#6d6d70;fill-opacity:1"
97 id="path35"
98 d="M 150.517,80.761 C 148.41,80.761 146.703,82.469 146.703,84.575 L 146.703,96.015 C 146.703,100.22 143.283,103.643 139.076,103.643 C 134.871,103.643 131.449,100.22 131.449,96.015 C 131.449,91.808 134.871,88.387 139.076,88.387 C 142.092,88.387 144.703,90.145 145.941,92.692 L 145.941,82.397 C 143.875,81.353 141.545,80.76 139.076,80.76 C 130.666,80.76 123.822,87.604 123.822,96.015 C 123.822,104.426 130.666,111.268 139.076,111.268 C 147.486,111.268 154.33,104.426 154.33,96.015 L 154.33,84.575 C 154.33,82.469 152.623,80.761 150.517,80.761 z " />
99 <path
100 style="fill:#6d6d70;fill-opacity:1"
101 id="path37"
102 d="M 82.625,77.345 C 82.625,75.247 80.923,73.547 78.826,73.547 L 78.826,81.142 C 80.922,81.142 82.625,79.442 82.625,77.345 z " />
103 <path
104 style="fill:#6d6d70;fill-opacity:1"
105 id="path39"
106 d="M 90.252,69.685 C 92.35,69.685 94.048,67.987 94.048,65.888 L 86.453,65.888 C 86.453,67.986 88.154,69.685 90.252,69.685 z " />
107 <path
108 style="fill:#6d6d70;fill-opacity:1"
109 id="path41"
110 d="M 93.832,77.329 C 93.832,75.223 92.125,73.516 90.018,73.516 L 78.825,73.516 C 74.619,73.516 71.199,70.093 71.199,65.888 C 71.199,61.684 74.619,58.261 78.825,58.261 C 83.032,58.261 86.453,61.684 86.453,65.888 C 86.453,68.904 84.694,71.514 82.149,72.752 L 92.442,72.752 C 93.488,70.689 94.08,68.356 94.08,65.888 C 94.08,57.477 87.237,50.633 78.826,50.633 C 70.415,50.633 63.571,57.477 63.571,65.888 C 63.571,74.3 70.415,81.142 78.826,81.142 L 90.018,81.142 C 92.125,81.142 93.832,79.435 93.832,77.329 z " />
111 <path
112 style="fill:#6d6d70;fill-opacity:1"
113 id="path43"
114 d="M 142.869,77.345 C 142.869,75.247 141.168,73.547 139.07,73.547 L 139.07,81.142 C 141.167,81.142 142.869,79.442 142.869,77.345 z " />
115 <path
116 style="fill:#6d6d70;fill-opacity:1"
117 id="path45"
118 d="M 150.496,69.685 C 152.594,69.685 154.293,67.987 154.293,65.888 L 146.699,65.888 C 146.699,67.986 148.398,69.685 150.496,69.685 z " />
119 <path
120 style="fill:#6d6d70;fill-opacity:1"
121 id="path47"
122 d="M 154.076,77.329 C 154.076,75.223 152.367,73.516 150.262,73.516 L 139.07,73.516 C 134.865,73.516 131.443,70.093 131.443,65.888 C 131.443,61.684 134.865,58.261 139.07,58.261 C 143.275,58.261 146.699,61.684 146.699,65.888 C 146.699,68.904 144.939,71.514 142.392,72.752 L 152.687,72.752 C 153.73,70.689 154.324,68.356 154.324,65.888 C 154.324,57.477 147.48,50.633 139.07,50.633 C 130.66,50.633 123.816,57.477 123.816,65.888 C 123.816,74.3 130.66,81.142 139.07,81.142 L 150.261,81.142 C 152.367,81.142 154.076,79.435 154.076,77.329 z " />
123 </g>
124 <g
125 id="g2126"
126 transform="matrix(0.7679564,0,0,0.7679564,-66.520631,11.42903)"
127 inkscape:export-xdpi="312.71841"
128 inkscape:export-ydpi="312.71841"
129 style="fill:#35992a;fill-opacity:1">
130 <g
131 transform="translate(86.33975,4.23985e-2)"
132 style="fill:#35992a;fill-opacity:1"
133 id="g2114">
134 <g
135 style="fill:#35992a;fill-opacity:1"
136 id="g2116">
137 <path
138 id="path2118"
139 transform="translate(-86.33975,-4.239934e-2)"
140 d="M 89.96875,0.03125 C 87.962748,0.031250001 86.34375,1.6815001 86.34375,3.6875 L 86.34375,17.71875 L 86.34375,19.6875 L 86.34375,28.90625 C 86.343752,39.06825 94.61925,47.34375 104.78125,47.34375 L 113.375,47.34375 L 123.1875,47.34375 L 127.15625,47.34375 C 129.16325,47.343749 130.8125,45.72475 130.8125,43.71875 C 130.8125,41.71275 129.16325,40.09375 127.15625,40.09375 L 123.1875,40.09375 L 123.1875,19.6875 L 123.1875,14.65625 L 123.1875,3.6875 C 123.1875,1.6815 121.5675,0.03125 119.5625,0.03125 C 117.5555,0.031250001 115.9375,1.6815001 115.9375,3.6875 L 115.9375,14.28125 C 115.1185,13.65425 114.26275,13.109 113.34375,12.625 L 113.34375,3.6875 C 113.34475,1.6815 111.6925,0.03125 109.6875,0.03125 C 107.6825,0.031250001 106.0625,1.6815001 106.0625,3.6875 L 106.0625,10.5625 C 105.6305,10.5325 105.22025,10.5 104.78125,10.5 C 104.34125,10.5 103.90075,10.5325 103.46875,10.5625 L 103.46875,3.6875 C 103.46975,1.6815 101.84975,0.03125 99.84375,0.03125 C 97.837749,0.031250001 96.21875,1.6815001 96.21875,3.6875 L 96.21875,12.625 C 95.299754,13.109 94.41375,13.65425 93.59375,14.28125 L 93.59375,3.6875 C 93.59475,1.6815 91.97475,0.03125 89.96875,0.03125 z M 104.78125,14.34375 C 112.80825,14.34375 119.3125,20.87925 119.3125,28.90625 C 119.3125,36.93325 112.80825,43.46875 104.78125,43.46875 C 96.754254,43.46875 90.21875,36.93425 90.21875,28.90625 C 90.218752,20.87825 96.753253,14.34375 104.78125,14.34375 z "
141 style="fill:#35992a;fill-opacity:1" />
142 </g>
143 </g>
144 <path
145 style="fill:#35992a;fill-opacity:1"
146 id="path2122"
147 d="M 112.04875,28.913399 C 112.04875,24.899399 108.78275,21.634399 104.76975,21.634399 C 100.75675,21.634399 97.490753,24.900399 97.490753,28.913399 C 97.490753,32.926399 100.75675,36.192399 104.76975,36.192399 C 108.78275,36.192399 112.04875,32.927399 112.04875,28.913399 z " />
148 </g>
149 </g>
150</svg>
diff --git a/documentation/template/poky-db-pdf.xsl b/documentation/template/poky-db-pdf.xsl
new file mode 100644
index 0000000000..f8a3df103d
--- /dev/null
+++ b/documentation/template/poky-db-pdf.xsl
@@ -0,0 +1,64 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl" />
5
6 <!-- check project-plan.sh for how this is generated, needed to tweak
7 the cover page
8 -->
9 <xsl:include href="/tmp/titlepage.xsl"/>
10
11 <!-- To force a page break in document, i.e per section add a
12 <?hard-pagebreak?> tag.
13 -->
14 <xsl:template match="processing-instruction('hard-pagebreak')">
15 <fo:block break-before='page' />
16 </xsl:template>
17
18 <!--Fix for defualt indent getting TOC all wierd..
19 See http://sources.redhat.com/ml/docbook-apps/2005-q1/msg00455.html
20 FIXME: must be a better fix
21 -->
22 <xsl:param name="body.start.indent" select="'0'"/>
23 <!--<xsl:param name="title.margin.left" select="'0'"/>-->
24
25 <!-- stop long-ish header titles getting wrapped -->
26 <xsl:param name="header.column.widths">1 10 1</xsl:param>
27
28 <!-- customise headers and footers a little -->
29
30 <xsl:template name="head.sep.rule">
31 <xsl:if test="$header.rule != 0">
32 <xsl:attribute name="border-bottom-width">0.5pt</xsl:attribute>
33 <xsl:attribute name="border-bottom-style">solid</xsl:attribute>
34 <xsl:attribute name="border-bottom-color">#999999</xsl:attribute>
35 </xsl:if>
36 </xsl:template>
37
38 <xsl:template name="foot.sep.rule">
39 <xsl:if test="$footer.rule != 0">
40 <xsl:attribute name="border-top-width">0.5pt</xsl:attribute>
41 <xsl:attribute name="border-top-style">solid</xsl:attribute>
42 <xsl:attribute name="border-top-color">#999999</xsl:attribute>
43 </xsl:if>
44 </xsl:template>
45
46 <xsl:attribute-set name="header.content.properties">
47 <xsl:attribute name="color">#999999</xsl:attribute>
48 </xsl:attribute-set>
49
50 <xsl:attribute-set name="footer.content.properties">
51 <xsl:attribute name="color">#999999</xsl:attribute>
52 </xsl:attribute-set>
53
54
55 <!-- general settings -->
56
57 <xsl:param name="fop1.extensions" select="1"></xsl:param>
58 <xsl:param name="paper.type" select="'A4'"></xsl:param>
59 <xsl:param name="section.autolabel" select="1"></xsl:param>
60 <xsl:param name="body.font.family" select="'verasans'"></xsl:param>
61 <xsl:param name="title.font.family" select="'verasans'"></xsl:param>
62 <xsl:param name="monospace.font.family" select="'veramono'"></xsl:param>
63
64</xsl:stylesheet>
diff --git a/documentation/template/poky-ref-manual.png b/documentation/template/poky-ref-manual.png
new file mode 100644
index 0000000000..2085edb467
--- /dev/null
+++ b/documentation/template/poky-ref-manual.png
Binary files differ
diff --git a/documentation/template/poky.svg b/documentation/template/poky.svg
new file mode 100644
index 0000000000..a4ea5e2f45
--- /dev/null
+++ b/documentation/template/poky.svg
@@ -0,0 +1,163 @@
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!-- Created with Inkscape (http://www.inkscape.org/) -->
3<svg
4 xmlns:svg="http://www.w3.org/2000/svg"
5 xmlns="http://www.w3.org/2000/svg"
6 version="1.0"
7 width="158.56076"
8 height="79.284424"
9 viewBox="-40.981 -92.592 300 300"
10 id="svg2"
11 xml:space="preserve">
12<defs
13 id="defs4">
14</defs>
15<path
16 d="M -36.585379,54.412576 L -36.585379,54.421305 L -36.582469,54.421305 L -36.582469,54.243829 C -36.57956,54.302018 -36.585379,54.357297 -36.585379,54.412576 z "
17 style="fill:#6ac7bd"
18 id="path6" />
19<g
20 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
21 style="opacity:0.65"
22 id="g8">
23 <g
24 id="g10">
25 <path
26 d="M 24.482,23.998 L 24.482,23.995 C 10.961,23.994 0,34.955 0,48.476 L 0.001,48.479 L 0.001,48.482 C 0.003,62.001 10.962,72.96 24.482,72.96 L 24.482,72.96 L 0,72.96 L 0,97.442 L 0.003,97.442 C 13.523,97.44 24.482,86.48 24.482,72.961 L 24.485,72.961 C 38.005,72.959 48.963,62 48.963,48.479 L 48.963,48.476 C 48.962,34.957 38.001,23.998 24.482,23.998 z M 24.482,50.928 C 23.13,50.928 22.034,49.832 22.034,48.48 C 22.034,47.128 23.13,46.032 24.482,46.032 C 25.834,46.032 26.93,47.128 26.93,48.48 C 26.93,49.832 25.834,50.928 24.482,50.928 z "
27 style="fill:#ef412a"
28 id="path12" />
29 </g>
30</g>
31<g
32 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
33 style="opacity:0.65"
34 id="g14">
35 <g
36 id="g16">
37 <path
38 d="M 119.96,48.842 C 120.024,47.548 121.086,46.516 122.397,46.516 C 123.707,46.516 124.768,47.548 124.833,48.843 C 137.211,47.62 146.879,37.181 146.879,24.483 L 122.397,24.483 C 122.396,10.961 111.435,0 97.915,0 L 97.915,24.485 C 97.917,37.183 107.584,47.619 119.96,48.842 z M 124.833,49.084 C 124.769,50.379 123.707,51.411 122.397,51.411 L 122.396,51.411 L 122.396,73.444 L 146.878,73.444 L 146.878,73.441 C 146.876,60.745 137.208,50.308 124.833,49.084 z M 119.949,48.963 L 97.915,48.963 L 97.915,73.442 L 97.915,73.442 C 110.613,73.442 121.052,63.774 122.275,51.399 C 120.981,51.334 119.949,50.274 119.949,48.963 z "
39 style="fill:#a9c542"
40 id="path18" />
41 </g>
42</g>
43<g
44 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
45 style="opacity:0.65"
46 id="g20">
47 <g
48 id="g22">
49 <path
50 d="M 168.912,48.967 C 168.912,47.656 169.945,46.596 171.24,46.531 C 170.018,34.152 159.579,24.482 146.879,24.482 L 146.879,48.963 C 146.879,62.484 157.84,73.444 171.361,73.444 L 171.361,51.414 C 170.007,51.415 168.912,50.319 168.912,48.967 z M 195.841,48.978 C 195.841,48.973 195.842,48.969 195.842,48.964 L 195.842,24.482 L 195.838,24.482 C 183.14,24.484 172.702,34.154 171.482,46.531 C 172.776,46.595 173.808,47.656 173.808,48.967 C 173.808,50.278 172.776,51.339 171.481,51.403 C 172.679,63.59 182.814,73.146 195.244,73.445 L 171.361,73.445 L 171.361,97.927 L 171.364,97.927 C 184.879,97.925 195.834,86.973 195.842,73.46 L 195.844,73.46 L 195.844,48.979 L 195.841,48.978 z M 195.832,48.964 L 195.842,48.964 L 195.842,48.978 L 195.832,48.964 z "
51 style="fill:#f9c759"
52 id="path24" />
53 </g>
54</g>
55<g
56 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
57 style="opacity:0.65"
58 id="g26">
59 <g
60 id="g28">
61 <path
62 d="M 70.994,48.479 L 48.962,48.479 L 48.962,48.481 L 70.995,48.481 C 70.995,48.481 70.994,48.48 70.994,48.479 z M 73.44,24.001 L 73.437,24.001 L 73.437,46.032 C 73.439,46.032 73.44,46.032 73.442,46.032 C 74.794,46.032 75.89,47.128 75.89,48.48 C 75.89,49.832 74.794,50.928 73.442,50.928 C 72.091,50.928 70.996,49.834 70.994,48.483 L 48.958,48.483 L 48.958,48.486 C 48.96,62.005 59.919,72.964 73.437,72.964 C 86.955,72.964 97.914,62.005 97.916,48.486 L 97.916,48.483 C 97.916,34.963 86.958,24.003 73.44,24.001 z "
63 style="fill:#6ac7bd"
64 id="path30" />
65 </g>
66</g>
67<g
68 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
69 style="opacity:0.65"
70 id="g32">
71 <g
72 id="g34">
73 <path
74 d="M 24.482,23.998 L 24.482,23.995 C 10.961,23.994 0,34.955 0,48.476 L 22.034,48.476 C 22.036,47.125 23.131,46.031 24.482,46.031 C 25.834,46.031 26.93,47.127 26.93,48.479 C 26.93,49.831 25.834,50.927 24.482,50.927 L 24.482,72.937 C 24.469,59.427 13.514,48.479 0,48.479 L 0,72.96 L 24.481,72.96 L 24.481,72.96 L 0,72.96 L 0,97.442 L 0.003,97.442 C 13.523,97.44 24.482,86.48 24.482,72.961 L 24.485,72.961 C 38.005,72.959 48.963,62 48.963,48.479 L 48.963,48.476 C 48.962,34.957 38.001,23.998 24.482,23.998 z "
75 style="fill:#ef412a"
76 id="path36" />
77 </g>
78</g>
79<g
80 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
81 style="opacity:0.65"
82 id="g38">
83 <g
84 id="g40">
85 <path
86 d="M 122.397,46.516 C 123.707,46.516 124.768,47.548 124.833,48.843 C 137.211,47.62 146.879,37.181 146.879,24.483 L 122.397,24.483 L 122.397,46.516 L 122.397,46.516 z M 97.915,0 L 97.915,24.482 L 122.396,24.482 C 122.396,10.961 111.435,0 97.915,0 z M 122.275,46.528 C 121.052,34.151 110.613,24.482 97.914,24.482 L 97.914,48.964 L 97.914,48.964 L 97.914,73.443 L 97.914,73.443 C 110.612,73.443 121.051,63.775 122.274,51.4 C 120.98,51.335 119.948,50.275 119.948,48.964 C 119.949,47.653 120.98,46.593 122.275,46.528 z M 124.833,49.084 C 124.769,50.379 123.707,51.411 122.397,51.411 L 122.396,51.411 L 122.396,73.444 L 146.878,73.444 L 146.878,73.441 C 146.876,60.745 137.208,50.308 124.833,49.084 z "
87 style="fill:#a9c542"
88 id="path42" />
89 </g>
90</g>
91<g
92 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
93 style="opacity:0.65"
94 id="g44">
95 <g
96 id="g46">
97 <path
98 d="M 173.795,49.1 C 173.724,50.389 172.666,51.415 171.36,51.415 C 170.006,51.415 168.911,50.319 168.911,48.967 C 168.911,47.656 169.944,46.596 171.239,46.531 C 170.017,34.152 159.578,24.482 146.878,24.482 L 146.878,48.963 C 146.878,62.484 157.839,73.444 171.36,73.444 L 171.36,97.926 L 171.363,97.926 C 184.878,97.924 195.833,86.972 195.841,73.459 L 195.842,73.459 L 195.842,73.443 L 195.841,73.443 C 195.833,60.753 186.167,50.322 173.795,49.1 z M 195.838,24.482 C 183.14,24.484 172.702,34.154 171.482,46.531 C 172.775,46.595 173.806,47.655 173.808,48.964 L 195.841,48.964 L 195.841,48.979 C 195.841,48.974 195.842,48.969 195.842,48.964 L 195.842,24.482 L 195.838,24.482 z "
99 style="fill:#f9c759"
100 id="path48" />
101 </g>
102</g>
103<g
104 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
105 style="opacity:0.65"
106 id="g50">
107 <g
108 id="g52">
109 <path
110 d="M 71.007,48.347 C 71.075,47.105 72.062,46.117 73.304,46.046 C 72.509,38.02 67.85,31.133 61.201,27.284 C 57.601,25.2 53.424,24 48.965,24 L 48.962,24 C 48.962,28.46 50.161,32.638 52.245,36.24 C 56.093,42.891 62.98,47.552 71.007,48.347 z M 48.962,48.418 C 48.962,48.438 48.961,48.456 48.961,48.476 L 48.961,48.479 L 48.962,48.479 L 48.962,48.418 z M 70.995,48.482 C 70.995,48.481 70.995,48.481 70.995,48.48 L 48.962,48.48 L 48.962,48.482 L 70.995,48.482 z M 73.44,24.001 L 73.437,24.001 L 73.437,46.032 C 73.439,46.032 73.44,46.032 73.442,46.032 C 74.794,46.032 75.89,47.128 75.89,48.48 C 75.89,49.832 74.794,50.928 73.442,50.928 C 72.091,50.928 70.996,49.834 70.994,48.483 L 48.958,48.483 L 48.958,48.486 C 48.96,62.005 59.919,72.964 73.437,72.964 C 86.955,72.964 97.914,62.005 97.916,48.486 L 97.916,48.483 C 97.916,34.963 86.958,24.003 73.44,24.001 z "
111 style="fill:#6ac7bd"
112 id="path54" />
113 </g>
114</g>
115<g
116 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
117 style="opacity:0.65"
118 id="g56">
119 <g
120 id="g58">
121 <path
122 d="M 24.482,23.998 L 24.482,23.995 C 10.961,23.994 0,34.955 0,48.476 L 22.034,48.476 C 22.036,47.125 23.131,46.031 24.482,46.031 C 25.834,46.031 26.93,47.127 26.93,48.479 C 26.93,49.831 25.834,50.927 24.482,50.927 C 23.171,50.927 22.11,49.894 22.046,48.6 C 9.669,49.824 0.001,60.262 0.001,72.96 L 0,72.96 L 0,97.442 L 0.003,97.442 C 13.523,97.44 24.482,86.48 24.482,72.961 L 24.485,72.961 C 38.005,72.959 48.963,62 48.963,48.479 L 48.963,48.476 C 48.962,34.957 38.001,23.998 24.482,23.998 z "
123 style="fill:#ef412a"
124 id="path60" />
125 </g>
126</g>
127<g
128 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
129 style="opacity:0.65"
130 id="g62">
131 <g
132 id="g64">
133 <path
134 d="M 119.949,48.963 C 119.949,47.611 121.045,46.515 122.397,46.515 C 123.707,46.515 124.768,47.547 124.833,48.842 C 137.211,47.619 146.879,37.18 146.879,24.482 L 122.397,24.482 C 122.396,10.961 111.435,0 97.915,0 L 97.915,24.482 L 122.394,24.482 C 108.874,24.484 97.916,35.444 97.916,48.963 L 97.916,48.963 L 97.916,73.442 L 97.916,73.442 C 110.614,73.442 121.053,63.774 122.276,51.399 C 120.981,51.334 119.949,50.274 119.949,48.963 z M 124.833,49.084 C 124.769,50.379 123.707,51.411 122.397,51.411 L 122.396,51.411 L 122.396,73.444 L 146.878,73.444 L 146.878,73.441 C 146.876,60.745 137.208,50.308 124.833,49.084 z "
135 style="fill:#a9c542"
136 id="path66" />
137 </g>
138</g>
139<g
140 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
141 style="opacity:0.65"
142 id="g68">
143 <g
144 id="g70">
145 <path
146 d="M 195.841,48.979 L 195.835,48.964 L 195.841,48.964 L 195.841,48.979 C 195.841,48.974 195.842,48.969 195.842,48.964 L 195.842,24.482 L 195.838,24.482 C 183.14,24.484 172.702,34.154 171.482,46.531 C 172.776,46.595 173.808,47.656 173.808,48.967 C 173.808,50.319 172.712,51.415 171.361,51.415 C 170.007,51.415 168.912,50.319 168.912,48.967 C 168.912,47.656 169.945,46.596 171.24,46.531 C 170.018,34.152 159.579,24.482 146.879,24.482 L 146.879,48.963 C 146.879,62.484 157.84,73.444 171.361,73.444 L 171.361,97.926 L 171.364,97.926 C 184.883,97.924 195.843,86.963 195.843,73.444 L 171.959,73.444 C 185.203,73.126 195.841,62.299 195.841,48.979 z "
147 style="fill:#f9c759"
148 id="path72" />
149 </g>
150</g>
151<g
152 transform="matrix(2.9094193,0,0,2.9094193,-179.03055,-86.624435)"
153 style="opacity:0.65"
154 id="g74">
155 <g
156 id="g76">
157 <path
158 d="M 73.44,24.001 L 73.437,24.001 C 59.919,24.003 48.96,34.959 48.958,48.476 L 48.958,48.479 L 48.961,48.479 L 48.961,48.481 L 48.957,48.482 L 48.957,48.485 C 48.959,62.004 59.918,72.963 73.436,72.963 C 86.954,72.963 97.913,62.004 97.915,48.485 L 97.915,48.482 C 97.916,34.963 86.958,24.003 73.44,24.001 z M 73.442,50.928 C 72.09,50.928 70.994,49.832 70.994,48.48 C 70.994,47.128 72.09,46.032 73.442,46.032 C 74.794,46.032 75.89,47.128 75.89,48.48 C 75.89,49.832 74.794,50.928 73.442,50.928 z "
159 style="fill:#6ac7bd"
160 id="path78" />
161 </g>
162</g>
163</svg> \ No newline at end of file
diff --git a/documentation/template/titlepage.templates.xml b/documentation/template/titlepage.templates.xml
new file mode 100644
index 0000000000..f53f147002
--- /dev/null
+++ b/documentation/template/titlepage.templates.xml
@@ -0,0 +1,1227 @@
1<!DOCTYPE t:templates [
2<!ENTITY hsize0 "10pt">
3<!ENTITY hsize1 "12pt">
4<!ENTITY hsize2 "14.4pt">
5<!ENTITY hsize3 "17.28pt">
6<!ENTITY hsize4 "20.736pt">
7<!ENTITY hsize5 "24.8832pt">
8<!ENTITY hsize0space "7.5pt"> <!-- 0.75 * hsize0 -->
9<!ENTITY hsize1space "9pt"> <!-- 0.75 * hsize1 -->
10<!ENTITY hsize2space "10.8pt"> <!-- 0.75 * hsize2 -->
11<!ENTITY hsize3space "12.96pt"> <!-- 0.75 * hsize3 -->
12<!ENTITY hsize4space "15.552pt"> <!-- 0.75 * hsize4 -->
13<!ENTITY hsize5space "18.6624pt"> <!-- 0.75 * hsize5 -->
14]>
15<t:templates xmlns:t="http://nwalsh.com/docbook/xsl/template/1.0"
16 xmlns:param="http://nwalsh.com/docbook/xsl/template/1.0/param"
17 xmlns:fo="http://www.w3.org/1999/XSL/Format"
18 xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
19
20<!-- ********************************************************************
21 $Id: titlepage.templates.xml,v 1.23 2003/12/16 00:30:49 bobstayton Exp $
22 ********************************************************************
23
24 This file is part of the DocBook XSL Stylesheet distribution.
25 See ../README or http://docbook.sf.net/ for copyright
26 and other information.
27
28 ******************************************************************** -->
29
30<!-- ==================================================================== -->
31
32<t:titlepage t:element="article" t:wrapper="fo:block"
33 font-family="{$title.fontset}">
34
35 <t:titlepage-content t:side="recto"
36 text-align="center">
37
38 <mediaobject/>
39
40 <title t:named-template="component.title"
41 param:node="ancestor-or-self::article[1]"
42 keep-with-next="always"
43 font-size="&hsize5;"
44 font-weight="bold"/>
45
46 <subtitle param:node="ancestor-or-self::article[1]"
47 keep-with-next="always"
48 font-size="&hsize3;"
49 font-weight="bold"
50 space-after="0.8em"/>
51
52 <corpauthor space-before="0.5em"
53 font-size="&hsize3;"/>
54 <authorgroup space-before="0.5em"
55 font-size="&hsize2;"/>
56 <author space-before="0.5em"
57 font-size="&hsize2;"
58 space-after="0.8em"/>
59
60 <email font-size="&hsize2;"/>
61
62 <othercredit space-before="0.5em"/>
63 <releaseinfo space-before="0.5em"/>
64 <copyright space-before="0.5em"/>
65 <legalnotice text-align="start"
66 margin-left="0.5in"
67 margin-right="0.5in"
68 font-family="{$body.fontset}"/>
69 <pubdate space-before="0.5em"/>
70 <para></para>
71 <revision space-before="0.5em"/>
72 <revhistory space-before="0.5em"/>
73 <abstract space-before="0.5em"
74 text-align="start"
75 margin-left="0.5in"
76 margin-right="0.5in"
77 font-family="{$body.fontset}"/>
78
79 <para></para>
80 </t:titlepage-content>
81
82 <t:titlepage-content t:side="verso">
83 </t:titlepage-content>
84
85 <t:titlepage-separator>
86 </t:titlepage-separator>
87
88 <t:titlepage-before t:side="recto">
89 </t:titlepage-before>
90
91 <t:titlepage-before t:side="verso">
92 </t:titlepage-before>
93</t:titlepage>
94
95<!-- ==================================================================== -->
96
97<t:titlepage t:element="set" t:wrapper="fo:block">
98 <t:titlepage-content t:side="recto">
99 <title
100 t:named-template="division.title"
101 param:node="ancestor-or-self::set[1]"
102 text-align="center"
103 font-size="&hsize5;"
104 space-before="&hsize5space;"
105 font-weight="bold"
106 font-family="{$title.fontset}"/>
107 <subtitle
108 font-family="{$title.fontset}"
109 text-align="center"/>
110 <corpauthor/>
111 <authorgroup/>
112 <author/>
113 <othercredit/>
114 <releaseinfo/>
115 <copyright/>
116 <legalnotice/>
117 <pubdate/>
118 <revision/>
119 <revhistory/>
120 <abstract/>
121 </t:titlepage-content>
122
123 <t:titlepage-content t:side="verso">
124 </t:titlepage-content>
125
126 <t:titlepage-separator>
127 </t:titlepage-separator>
128
129 <t:titlepage-before t:side="recto">
130 </t:titlepage-before>
131
132 <t:titlepage-before t:side="verso">
133 </t:titlepage-before>
134</t:titlepage>
135
136<!-- ==================================================================== -->
137
138 <t:titlepage t:element="book" t:wrapper="fo:block">
139 <t:titlepage-content t:side="recto">
140
141 <mediaobject/>
142
143 <subtitle
144 text-align="center"
145 font-size="&hsize4;"
146 space-before="&hsize4space;"
147 font-family="{$title.fontset}"/>
148 <corpauthor font-size="&hsize3;"
149 keep-with-next="always"
150 space-before="2in"/>
151 <authorgroup space-before="2in"/>
152 <author font-size="&hsize3;"
153 space-before="&hsize2space;"
154 keep-with-next="always"/>
155 </t:titlepage-content>
156
157 <t:titlepage-content t:side="verso">
158 <corpauthor/>
159 <authorgroup t:named-template="verso.authorgroup"/>
160 <author/>
161 <othercredit/>
162 <pubdate space-before="1em"/>
163 <copyright/>
164 <abstract/>
165 <legalnotice font-size="8pt"/>
166 </t:titlepage-content>
167
168 <t:titlepage-separator>
169 <fo:block break-after="page"/>
170 </t:titlepage-separator>
171
172 <t:titlepage-before t:side="recto">
173 </t:titlepage-before>
174
175 <t:titlepage-before t:side="verso">
176 <fo:block break-after="page"/>
177 </t:titlepage-before>
178</t:titlepage>
179
180<!-- ==================================================================== -->
181
182<t:titlepage t:element="part" t:wrapper="fo:block">
183 <t:titlepage-content t:side="recto">
184 <title
185 t:named-template="division.title"
186 param:node="ancestor-or-self::part[1]"
187 text-align="center"
188 font-size="&hsize5;"
189 space-before="&hsize5space;"
190 font-weight="bold"
191 font-family="{$title.fontset}"/>
192 <subtitle
193 text-align="center"
194 font-size="&hsize4;"
195 space-before="&hsize4space;"
196 font-weight='bold'
197 font-style='italic'
198 font-family="{$title.fontset}"/>
199 </t:titlepage-content>
200
201 <t:titlepage-content t:side="verso">
202 </t:titlepage-content>
203
204 <t:titlepage-separator>
205 </t:titlepage-separator>
206
207 <t:titlepage-before t:side="recto">
208 </t:titlepage-before>
209
210 <t:titlepage-before t:side="verso">
211 </t:titlepage-before>
212</t:titlepage>
213
214<t:titlepage t:element="partintro" t:wrapper="fo:block">
215 <t:titlepage-content t:side="recto">
216 <title
217 text-align="center"
218 font-size="&hsize5;"
219 font-weight="bold"
220 space-before="1em"
221 font-family="{$title.fontset}"/>
222 <subtitle
223 text-align="center"
224 font-size="&hsize2;"
225 font-weight="bold"
226 font-style="italic"
227 font-family="{$title.fontset}"/>
228 <corpauthor/>
229 <authorgroup/>
230 <author/>
231 <othercredit/>
232 <releaseinfo/>
233 <copyright/>
234 <legalnotice/>
235 <pubdate/>
236 <revision/>
237 <revhistory/>
238 <abstract/>
239 </t:titlepage-content>
240
241 <t:titlepage-content t:side="verso">
242 </t:titlepage-content>
243
244 <t:titlepage-separator>
245 </t:titlepage-separator>
246
247 <t:titlepage-before t:side="recto">
248 </t:titlepage-before>
249
250 <t:titlepage-before t:side="verso">
251 </t:titlepage-before>
252</t:titlepage>
253
254<!-- ==================================================================== -->
255
256<t:titlepage t:element="reference" t:wrapper="fo:block">
257 <t:titlepage-content t:side="recto">
258 <title
259 t:named-template="division.title"
260 param:node="ancestor-or-self::reference[1]"
261 text-align="center"
262 font-size="&hsize5;"
263 space-before="&hsize5space;"
264 font-weight="bold"
265 font-family="{$title.fontset}"/>
266 <subtitle
267 font-family="{$title.fontset}"
268 text-align="center"/>
269 <corpauthor/>
270 <authorgroup/>
271 <author/>
272 <othercredit/>
273 <releaseinfo/>
274 <copyright/>
275 <legalnotice/>
276 <pubdate/>
277 <revision/>
278 <revhistory/>
279 <abstract/>
280 </t:titlepage-content>
281
282 <t:titlepage-content t:side="verso">
283 </t:titlepage-content>
284
285 <t:titlepage-separator>
286 </t:titlepage-separator>
287
288 <t:titlepage-before t:side="recto">
289 </t:titlepage-before>
290
291 <t:titlepage-before t:side="verso">
292 </t:titlepage-before>
293</t:titlepage>
294
295<!-- ==================================================================== -->
296
297<t:titlepage t:element="refsynopsisdiv" t:wrapper="fo:block">
298 <t:titlepage-content t:side="recto">
299 <title
300 font-family="{$title.fontset}"/>
301 </t:titlepage-content>
302
303 <t:titlepage-content t:side="verso">
304 </t:titlepage-content>
305
306 <t:titlepage-separator>
307 </t:titlepage-separator>
308
309 <t:titlepage-before t:side="recto">
310 </t:titlepage-before>
311
312 <t:titlepage-before t:side="verso">
313 </t:titlepage-before>
314</t:titlepage>
315
316<!-- ==================================================================== -->
317
318<t:titlepage t:element="refsection" t:wrapper="fo:block">
319 <t:titlepage-content t:side="recto">
320 <title
321 font-family="{$title.fontset}"/>
322 </t:titlepage-content>
323
324 <t:titlepage-content t:side="verso">
325 </t:titlepage-content>
326
327 <t:titlepage-separator>
328 </t:titlepage-separator>
329
330 <t:titlepage-before t:side="recto">
331 </t:titlepage-before>
332
333 <t:titlepage-before t:side="verso">
334 </t:titlepage-before>
335</t:titlepage>
336
337<!-- ==================================================================== -->
338
339<t:titlepage t:element="refsect1" t:wrapper="fo:block">
340 <t:titlepage-content t:side="recto">
341 <title
342 font-family="{$title.fontset}"/>
343 </t:titlepage-content>
344
345 <t:titlepage-content t:side="verso">
346 </t:titlepage-content>
347
348 <t:titlepage-separator>
349 </t:titlepage-separator>
350
351 <t:titlepage-before t:side="recto">
352 </t:titlepage-before>
353
354 <t:titlepage-before t:side="verso">
355 </t:titlepage-before>
356</t:titlepage>
357
358<!-- ==================================================================== -->
359
360<t:titlepage t:element="refsect2" t:wrapper="fo:block">
361 <t:titlepage-content t:side="recto">
362 <title
363 font-family="{$title.fontset}"/>
364 </t:titlepage-content>
365
366 <t:titlepage-content t:side="verso">
367 </t:titlepage-content>
368
369 <t:titlepage-separator>
370 </t:titlepage-separator>
371
372 <t:titlepage-before t:side="recto">
373 </t:titlepage-before>
374
375 <t:titlepage-before t:side="verso">
376 </t:titlepage-before>
377</t:titlepage>
378
379<!-- ==================================================================== -->
380
381<t:titlepage t:element="refsect3" t:wrapper="fo:block">
382 <t:titlepage-content t:side="recto">
383 <title
384 font-family="{$title.fontset}"/>
385 </t:titlepage-content>
386
387 <t:titlepage-content t:side="verso">
388 </t:titlepage-content>
389
390 <t:titlepage-separator>
391 </t:titlepage-separator>
392
393 <t:titlepage-before t:side="recto">
394 </t:titlepage-before>
395
396 <t:titlepage-before t:side="verso">
397 </t:titlepage-before>
398</t:titlepage>
399
400<!-- ==================================================================== -->
401
402 <t:titlepage t:element="dedication" t:wrapper="fo:block">
403 <t:titlepage-content t:side="recto">
404 <title
405 t:force="1"
406 t:named-template="component.title"
407 param:node="ancestor-or-self::dedication[1]"
408 margin-left="{$title.margin.left}"
409 font-size="&hsize5;"
410 font-family="{$title.fontset}"
411 font-weight="bold"/>
412 <subtitle
413 font-family="{$title.fontset}"/>
414 </t:titlepage-content>
415
416 <t:titlepage-content t:side="verso">
417 </t:titlepage-content>
418
419 <t:titlepage-separator>
420 </t:titlepage-separator>
421
422 <t:titlepage-before t:side="recto">
423 </t:titlepage-before>
424
425 <t:titlepage-before t:side="verso">
426 </t:titlepage-before>
427</t:titlepage>
428
429<!-- ==================================================================== -->
430
431 <t:titlepage t:element="preface" t:wrapper="fo:block">
432 <t:titlepage-content t:side="recto">
433 <title
434 t:force="1"
435 t:named-template="component.title"
436 param:node="ancestor-or-self::preface[1]"
437 margin-left="{$title.margin.left}"
438 font-size="&hsize5;"
439 font-family="{$title.fontset}"
440 font-weight="bold"/>
441 <subtitle
442 font-family="{$title.fontset}"/>
443 <corpauthor/>
444 <authorgroup/>
445 <author/>
446 <othercredit/>
447 <releaseinfo/>
448 <copyright/>
449 <legalnotice/>
450 <pubdate/>
451 <revision/>
452 <revhistory/>
453 <abstract/>
454 </t:titlepage-content>
455
456 <t:titlepage-content t:side="verso">
457 </t:titlepage-content>
458
459 <t:titlepage-separator>
460 </t:titlepage-separator>
461
462 <t:titlepage-before t:side="recto">
463 </t:titlepage-before>
464
465 <t:titlepage-before t:side="verso">
466 </t:titlepage-before>
467</t:titlepage>
468
469<!-- ==================================================================== -->
470
471 <t:titlepage t:element="chapter" t:wrapper="fo:block"
472 font-family="{$title.fontset}">
473 <t:titlepage-content t:side="recto" margin-left="{$title.margin.left}">
474 <title t:named-template="component.title"
475 param:node="ancestor-or-self::chapter[1]"
476 font-size="&hsize5;"
477 font-weight="bold"/>
478
479 <subtitle space-before="0.5em"
480 font-style="italic"
481 font-size="&hsize2;"
482 font-weight="bold"/>
483
484 <corpauthor space-before="0.5em"
485 space-after="0.5em"
486 font-size="&hsize2;"/>
487
488 <authorgroup space-before="0.5em"
489 space-after="0.5em"
490 font-size="&hsize2;"/>
491
492 <author space-before="0.5em"
493 space-after="0.5em"
494 font-size="&hsize2;"/>
495
496 <othercredit/>
497 <releaseinfo/>
498 <copyright/>
499 <legalnotice/>
500 <pubdate/>
501 <revision/>
502 <revhistory/>
503 <abstract/>
504 </t:titlepage-content>
505
506 <t:titlepage-content t:side="verso">
507 </t:titlepage-content>
508
509 <t:titlepage-separator>
510 </t:titlepage-separator>
511
512 <t:titlepage-before t:side="recto">
513 </t:titlepage-before>
514
515 <t:titlepage-before t:side="verso">
516 </t:titlepage-before>
517</t:titlepage>
518
519<!-- ==================================================================== -->
520
521 <t:titlepage t:element="appendix" t:wrapper="fo:block">
522 <t:titlepage-content t:side="recto">
523 <title
524 t:named-template="component.title"
525 param:node="ancestor-or-self::appendix[1]"
526 margin-left="{$title.margin.left}"
527 font-size="&hsize5;"
528 font-weight="bold"
529 font-family="{$title.fontset}"/>
530 <subtitle
531 font-family="{$title.fontset}"/>
532 <corpauthor/>
533 <authorgroup/>
534 <author/>
535 <othercredit/>
536 <releaseinfo/>
537 <copyright/>
538 <legalnotice/>
539 <pubdate/>
540 <revision/>
541 <revhistory/>
542 <abstract/>
543 </t:titlepage-content>
544
545 <t:titlepage-content t:side="verso">
546 </t:titlepage-content>
547
548 <t:titlepage-separator>
549 </t:titlepage-separator>
550
551 <t:titlepage-before t:side="recto">
552 </t:titlepage-before>
553
554 <t:titlepage-before t:side="verso">
555 </t:titlepage-before>
556</t:titlepage>
557
558<!-- ==================================================================== -->
559
560<t:titlepage t:element="section" t:wrapper="fo:block">
561 <t:titlepage-content t:side="recto">
562 <title
563 margin-left="{$title.margin.left}"
564 font-family="{$title.fontset}"/>
565 <subtitle
566 font-family="{$title.fontset}"/>
567 <corpauthor/>
568 <authorgroup/>
569 <author/>
570 <othercredit/>
571 <releaseinfo/>
572 <copyright/>
573 <legalnotice/>
574 <pubdate/>
575 <revision/>
576 <revhistory/>
577 <abstract/>
578 </t:titlepage-content>
579
580 <t:titlepage-content t:side="verso">
581 </t:titlepage-content>
582
583 <t:titlepage-separator>
584 </t:titlepage-separator>
585
586 <t:titlepage-before t:side="recto">
587 </t:titlepage-before>
588
589 <t:titlepage-before t:side="verso">
590 </t:titlepage-before>
591</t:titlepage>
592
593<t:titlepage t:element="sect1" t:wrapper="fo:block">
594 <t:titlepage-content t:side="recto">
595 <title
596 margin-left="{$title.margin.left}"
597 font-family="{$title.fontset}"/>
598 <subtitle
599 font-family="{$title.fontset}"/>
600 <corpauthor/>
601 <authorgroup/>
602 <author/>
603 <othercredit/>
604 <releaseinfo/>
605 <copyright/>
606 <legalnotice/>
607 <pubdate/>
608 <revision/>
609 <revhistory/>
610 <abstract/>
611 </t:titlepage-content>
612
613 <t:titlepage-content t:side="verso">
614 </t:titlepage-content>
615
616 <t:titlepage-separator>
617 </t:titlepage-separator>
618
619 <t:titlepage-before t:side="recto">
620 </t:titlepage-before>
621
622 <t:titlepage-before t:side="verso">
623 </t:titlepage-before>
624</t:titlepage>
625
626<t:titlepage t:element="sect2" t:wrapper="fo:block">
627 <t:titlepage-content t:side="recto">
628 <title
629 margin-left="{$title.margin.left}"
630 font-family="{$title.fontset}"/>
631 <subtitle
632 font-family="{$title.fontset}"/>
633 <corpauthor/>
634 <authorgroup/>
635 <author/>
636 <othercredit/>
637 <releaseinfo/>
638 <copyright/>
639 <legalnotice/>
640 <pubdate/>
641 <revision/>
642 <revhistory/>
643 <abstract/>
644 </t:titlepage-content>
645
646 <t:titlepage-content t:side="verso">
647 </t:titlepage-content>
648
649 <t:titlepage-separator>
650 </t:titlepage-separator>
651
652 <t:titlepage-before t:side="recto">
653 </t:titlepage-before>
654
655 <t:titlepage-before t:side="verso">
656 </t:titlepage-before>
657</t:titlepage>
658
659<t:titlepage t:element="sect3" t:wrapper="fo:block">
660 <t:titlepage-content t:side="recto">
661 <title
662 margin-left="{$title.margin.left}"
663 font-family="{$title.fontset}"/>
664 <subtitle
665 font-family="{$title.fontset}"/>
666 <corpauthor/>
667 <authorgroup/>
668 <author/>
669 <othercredit/>
670 <releaseinfo/>
671 <copyright/>
672 <legalnotice/>
673 <pubdate/>
674 <revision/>
675 <revhistory/>
676 <abstract/>
677 </t:titlepage-content>
678
679 <t:titlepage-content t:side="verso">
680 </t:titlepage-content>
681
682 <t:titlepage-separator>
683 </t:titlepage-separator>
684
685 <t:titlepage-before t:side="recto">
686 </t:titlepage-before>
687
688 <t:titlepage-before t:side="verso">
689 </t:titlepage-before>
690</t:titlepage>
691
692<t:titlepage t:element="sect4" t:wrapper="fo:block">
693 <t:titlepage-content t:side="recto">
694 <title
695 margin-left="{$title.margin.left}"
696 font-family="{$title.fontset}"/>
697 <subtitle
698 font-family="{$title.fontset}"/>
699 <corpauthor/>
700 <authorgroup/>
701 <author/>
702 <othercredit/>
703 <releaseinfo/>
704 <copyright/>
705 <legalnotice/>
706 <pubdate/>
707 <revision/>
708 <revhistory/>
709 <abstract/>
710 </t:titlepage-content>
711
712 <t:titlepage-content t:side="verso">
713 </t:titlepage-content>
714
715 <t:titlepage-separator>
716 </t:titlepage-separator>
717
718 <t:titlepage-before t:side="recto">
719 </t:titlepage-before>
720
721 <t:titlepage-before t:side="verso">
722 </t:titlepage-before>
723</t:titlepage>
724
725<t:titlepage t:element="sect5" t:wrapper="fo:block">
726 <t:titlepage-content t:side="recto">
727 <title
728 margin-left="{$title.margin.left}"
729 font-family="{$title.fontset}"/>
730 <subtitle
731 font-family="{$title.fontset}"/>
732 <corpauthor/>
733 <authorgroup/>
734 <author/>
735 <othercredit/>
736 <releaseinfo/>
737 <copyright/>
738 <legalnotice/>
739 <pubdate/>
740 <revision/>
741 <revhistory/>
742 <abstract/>
743 </t:titlepage-content>
744
745 <t:titlepage-content t:side="verso">
746 </t:titlepage-content>
747
748 <t:titlepage-separator>
749 </t:titlepage-separator>
750
751 <t:titlepage-before t:side="recto">
752 </t:titlepage-before>
753
754 <t:titlepage-before t:side="verso">
755 </t:titlepage-before>
756</t:titlepage>
757
758<t:titlepage t:element="simplesect" t:wrapper="fo:block">
759 <t:titlepage-content t:side="recto">
760 <title
761 margin-left="{$title.margin.left}"
762 font-family="{$title.fontset}"/>
763 <subtitle
764 font-family="{$title.fontset}"/>
765 <corpauthor/>
766 <authorgroup/>
767 <author/>
768 <othercredit/>
769 <releaseinfo/>
770 <copyright/>
771 <legalnotice/>
772 <pubdate/>
773 <revision/>
774 <revhistory/>
775 <abstract/>
776 </t:titlepage-content>
777
778 <t:titlepage-content t:side="verso">
779 </t:titlepage-content>
780
781 <t:titlepage-separator>
782 </t:titlepage-separator>
783
784 <t:titlepage-before t:side="recto">
785 </t:titlepage-before>
786
787 <t:titlepage-before t:side="verso">
788 </t:titlepage-before>
789</t:titlepage>
790
791<!-- ==================================================================== -->
792
793 <t:titlepage t:element="bibliography" t:wrapper="fo:block">
794 <t:titlepage-content t:side="recto">
795 <title
796 t:force="1"
797 t:named-template="component.title"
798 param:node="ancestor-or-self::bibliography[1]"
799 margin-left="{$title.margin.left}"
800 font-size="&hsize5;"
801 font-family="{$title.fontset}"
802 font-weight="bold"/>
803 <subtitle
804 font-family="{$title.fontset}"/>
805 </t:titlepage-content>
806
807 <t:titlepage-content t:side="verso">
808 </t:titlepage-content>
809
810 <t:titlepage-separator>
811 </t:titlepage-separator>
812
813 <t:titlepage-before t:side="recto">
814 </t:titlepage-before>
815
816 <t:titlepage-before t:side="verso">
817 </t:titlepage-before>
818 </t:titlepage>
819
820<!-- ==================================================================== -->
821
822 <t:titlepage t:element="bibliodiv" t:wrapper="fo:block">
823 <t:titlepage-content t:side="recto">
824 <title t:named-template="component.title"
825 param:node="ancestor-or-self::bibliodiv[1]"
826 margin-left="{$title.margin.left}"
827 font-size="&hsize4;"
828 font-family="{$title.fontset}"
829 font-weight="bold"/>
830 <subtitle
831 font-family="{$title.fontset}"/>
832 </t:titlepage-content>
833
834 <t:titlepage-content t:side="verso">
835 </t:titlepage-content>
836
837 <t:titlepage-separator>
838 </t:titlepage-separator>
839
840 <t:titlepage-before t:side="recto">
841 </t:titlepage-before>
842
843 <t:titlepage-before t:side="verso">
844 </t:titlepage-before>
845 </t:titlepage>
846
847<!-- ==================================================================== -->
848
849 <t:titlepage t:element="glossary" t:wrapper="fo:block">
850 <t:titlepage-content t:side="recto">
851 <title
852 t:force="1"
853 t:named-template="component.title"
854 param:node="ancestor-or-self::glossary[1]"
855 margin-left="{$title.margin.left}"
856 font-size="&hsize5;"
857 font-family="{$title.fontset}"
858 font-weight="bold"/>
859 <subtitle
860 font-family="{$title.fontset}"/>
861 </t:titlepage-content>
862
863 <t:titlepage-content t:side="verso">
864 </t:titlepage-content>
865
866 <t:titlepage-separator>
867 </t:titlepage-separator>
868
869 <t:titlepage-before t:side="recto">
870 </t:titlepage-before>
871
872 <t:titlepage-before t:side="verso">
873 </t:titlepage-before>
874 </t:titlepage>
875
876<!-- ==================================================================== -->
877
878 <t:titlepage t:element="glossdiv" t:wrapper="fo:block">
879 <t:titlepage-content t:side="recto">
880 <title t:named-template="component.title"
881 param:node="ancestor-or-self::glossdiv[1]"
882 margin-left="{$title.margin.left}"
883 font-size="&hsize4;"
884 font-family="{$title.fontset}"
885 font-weight="bold"/>
886 <subtitle
887 font-family="{$title.fontset}"/>
888 </t:titlepage-content>
889
890 <t:titlepage-content t:side="verso">
891 </t:titlepage-content>
892
893 <t:titlepage-separator>
894 </t:titlepage-separator>
895
896 <t:titlepage-before t:side="recto">
897 </t:titlepage-before>
898
899 <t:titlepage-before t:side="verso">
900 </t:titlepage-before>
901 </t:titlepage>
902
903<!-- ==================================================================== -->
904
905 <t:titlepage t:element="index" t:wrapper="fo:block">
906 <t:titlepage-content t:side="recto">
907 <title
908 t:force="1"
909 t:named-template="component.title"
910 param:node="ancestor-or-self::index[1]"
911 param:pagewide="1"
912 margin-left="0pt"
913 font-size="&hsize5;"
914 font-family="{$title.fontset}"
915 font-weight="bold"/>
916 <subtitle
917 font-family="{$title.fontset}"/>
918 </t:titlepage-content>
919
920 <t:titlepage-content t:side="verso">
921 </t:titlepage-content>
922
923 <t:titlepage-separator>
924 </t:titlepage-separator>
925
926 <t:titlepage-before t:side="recto">
927 </t:titlepage-before>
928
929 <t:titlepage-before t:side="verso">
930 </t:titlepage-before>
931 </t:titlepage>
932
933<!-- ==================================================================== -->
934
935 <!-- The indexdiv.title template is used so that manual and -->
936 <!-- automatically generated indexdiv titles get the same -->
937 <!-- formatting. -->
938
939 <t:titlepage t:element="indexdiv" t:wrapper="fo:block">
940 <t:titlepage-content t:side="recto">
941 <title t:force="1"
942 t:named-template="indexdiv.title"
943 param:title="title"/>
944 <subtitle
945 font-family="{$title.fontset}"/>
946 </t:titlepage-content>
947
948 <t:titlepage-content t:side="verso">
949 </t:titlepage-content>
950
951 <t:titlepage-separator>
952 </t:titlepage-separator>
953
954 <t:titlepage-before t:side="recto">
955 </t:titlepage-before>
956
957 <t:titlepage-before t:side="verso">
958 </t:titlepage-before>
959 </t:titlepage>
960
961<!-- ==================================================================== -->
962
963 <t:titlepage t:element="setindex" t:wrapper="fo:block">
964 <t:titlepage-content t:side="recto">
965 <title
966 t:force="1"
967 t:named-template="component.title"
968 param:node="ancestor-or-self::setindex[1]"
969 param:pagewide="1"
970 margin-left="0pt"
971 font-size="&hsize5;"
972 font-family="{$title.fontset}"
973 font-weight="bold"/>
974 <subtitle
975 font-family="{$title.fontset}"/>
976 </t:titlepage-content>
977
978 <t:titlepage-content t:side="verso">
979 </t:titlepage-content>
980
981 <t:titlepage-separator>
982 </t:titlepage-separator>
983
984 <t:titlepage-before t:side="recto">
985 </t:titlepage-before>
986
987 <t:titlepage-before t:side="verso">
988 </t:titlepage-before>
989 </t:titlepage>
990
991<!-- ==================================================================== -->
992
993 <t:titlepage t:element="colophon" t:wrapper="fo:block">
994 <t:titlepage-content t:side="recto">
995 <title
996 t:force="1"
997 t:named-template="component.title"
998 param:node="ancestor-or-self::colophon[1]"
999 margin-left="{$title.margin.left}"
1000 font-size="&hsize5;"
1001 font-family="{$title.fontset}"
1002 font-weight="bold"/>
1003 <subtitle
1004 font-family="{$title.fontset}"/>
1005 </t:titlepage-content>
1006
1007 <t:titlepage-content t:side="verso">
1008 </t:titlepage-content>
1009
1010 <t:titlepage-separator>
1011 </t:titlepage-separator>
1012
1013 <t:titlepage-before t:side="recto">
1014 </t:titlepage-before>
1015
1016 <t:titlepage-before t:side="verso">
1017 </t:titlepage-before>
1018</t:titlepage>
1019
1020<!-- ==================================================================== -->
1021
1022 <t:titlepage t:element="table.of.contents" t:wrapper="fo:block">
1023 <t:titlepage-content t:side="recto">
1024 <title
1025 t:force="1"
1026 t:named-template="gentext"
1027 param:key="'TableofContents'"
1028 space-before.minimum="1em"
1029 space-before.optimum="1.5em"
1030 space-before.maximum="2em"
1031 space-after="0.5em"
1032 margin-left="{$title.margin.left}"
1033 font-size="&hsize3;"
1034 font-weight="bold"
1035 font-family="{$title.fontset}"/>
1036 </t:titlepage-content>
1037
1038 <t:titlepage-content t:side="verso">
1039 </t:titlepage-content>
1040
1041 <t:titlepage-separator>
1042 </t:titlepage-separator>
1043
1044 <t:titlepage-before t:side="recto">
1045 </t:titlepage-before>
1046
1047 <t:titlepage-before t:side="verso">
1048 </t:titlepage-before>
1049 </t:titlepage>
1050
1051 <t:titlepage t:element="list.of.tables" t:wrapper="fo:block">
1052 <t:titlepage-content t:side="recto">
1053 <title
1054 t:force="1"
1055 t:named-template="gentext"
1056 param:key="'ListofTables'"
1057 space-before.minimum="1em"
1058 space-before.optimum="1.5em"
1059 space-before.maximum="2em"
1060 space-after="0.5em"
1061 margin-left="{$title.margin.left}"
1062 font-size="&hsize3;"
1063 font-weight="bold"
1064 font-family="{$title.fontset}"/>
1065 </t:titlepage-content>
1066
1067 <t:titlepage-content t:side="verso">
1068 </t:titlepage-content>
1069
1070 <t:titlepage-separator>
1071 </t:titlepage-separator>
1072
1073 <t:titlepage-before t:side="recto">
1074 </t:titlepage-before>
1075
1076 <t:titlepage-before t:side="verso">
1077 </t:titlepage-before>
1078 </t:titlepage>
1079
1080 <t:titlepage t:element="list.of.figures" t:wrapper="fo:block">
1081 <t:titlepage-content t:side="recto">
1082 <title
1083 t:force="1"
1084 t:named-template="gentext"
1085 param:key="'ListofFigures'"
1086 space-before.minimum="1em"
1087 space-before.optimum="1.5em"
1088 space-before.maximum="2em"
1089 space-after="0.5em"
1090 margin-left="{$title.margin.left}"
1091 font-size="&hsize3;"
1092 font-weight="bold"
1093 font-family="{$title.fontset}"/>
1094 </t:titlepage-content>
1095
1096 <t:titlepage-content t:side="verso">
1097 </t:titlepage-content>
1098
1099 <t:titlepage-separator>
1100 </t:titlepage-separator>
1101
1102 <t:titlepage-before t:side="recto">
1103 </t:titlepage-before>
1104
1105 <t:titlepage-before t:side="verso">
1106 </t:titlepage-before>
1107 </t:titlepage>
1108
1109 <t:titlepage t:element="list.of.examples" t:wrapper="fo:block">
1110 <t:titlepage-content t:side="recto">
1111 <title
1112 t:force="1"
1113 t:named-template="gentext"
1114 param:key="'ListofExamples'"
1115 space-before.minimum="1em"
1116 space-before.optimum="1.5em"
1117 space-before.maximum="2em"
1118 space-after="0.5em"
1119 margin-left="{$title.margin.left}"
1120 font-size="&hsize3;"
1121 font-weight="bold"
1122 font-family="{$title.fontset}"/>
1123 </t:titlepage-content>
1124
1125 <t:titlepage-content t:side="verso">
1126 </t:titlepage-content>
1127
1128 <t:titlepage-separator>
1129 </t:titlepage-separator>
1130
1131 <t:titlepage-before t:side="recto">
1132 </t:titlepage-before>
1133
1134 <t:titlepage-before t:side="verso">
1135 </t:titlepage-before>
1136 </t:titlepage>
1137
1138 <t:titlepage t:element="list.of.equations" t:wrapper="fo:block">
1139 <t:titlepage-content t:side="recto">
1140 <title
1141 t:force="1"
1142 t:named-template="gentext"
1143 param:key="'ListofEquations'"
1144 space-before.minimum="1em"
1145 space-before.optimum="1.5em"
1146 space-before.maximum="2em"
1147 space-after="0.5em"
1148 margin-left="{$title.margin.left}"
1149 font-size="&hsize3;"
1150 font-weight="bold"
1151 font-family="{$title.fontset}"/>
1152 </t:titlepage-content>
1153
1154 <t:titlepage-content t:side="verso">
1155 </t:titlepage-content>
1156
1157 <t:titlepage-separator>
1158 </t:titlepage-separator>
1159
1160 <t:titlepage-before t:side="recto">
1161 </t:titlepage-before>
1162
1163 <t:titlepage-before t:side="verso">
1164 </t:titlepage-before>
1165 </t:titlepage>
1166
1167 <t:titlepage t:element="list.of.procedures" t:wrapper="fo:block">
1168 <t:titlepage-content t:side="recto">
1169 <title
1170 t:force="1"
1171 t:named-template="gentext"
1172 param:key="'ListofProcedures'"
1173 space-before.minimum="1em"
1174 space-before.optimum="1.5em"
1175 space-before.maximum="2em"
1176 space-after="0.5em"
1177 margin-left="{$title.margin.left}"
1178 font-size="&hsize3;"
1179 font-weight="bold"
1180 font-family="{$title.fontset}"/>
1181 </t:titlepage-content>
1182
1183 <t:titlepage-content t:side="verso">
1184 </t:titlepage-content>
1185
1186 <t:titlepage-separator>
1187 </t:titlepage-separator>
1188
1189 <t:titlepage-before t:side="recto">
1190 </t:titlepage-before>
1191
1192 <t:titlepage-before t:side="verso">
1193 </t:titlepage-before>
1194 </t:titlepage>
1195
1196 <t:titlepage t:element="list.of.unknowns" t:wrapper="fo:block">
1197 <t:titlepage-content t:side="recto">
1198 <title
1199 t:force="1"
1200 t:named-template="gentext"
1201 param:key="'ListofUnknown'"
1202 space-before.minimum="1em"
1203 space-before.optimum="1.5em"
1204 space-before.maximum="2em"
1205 space-after="0.5em"
1206 margin-left="{$title.margin.left}"
1207 font-size="&hsize3;"
1208 font-weight="bold"
1209 font-family="{$title.fontset}"/>
1210 </t:titlepage-content>
1211
1212 <t:titlepage-content t:side="verso">
1213 </t:titlepage-content>
1214
1215 <t:titlepage-separator>
1216 </t:titlepage-separator>
1217
1218 <t:titlepage-before t:side="recto">
1219 </t:titlepage-before>
1220
1221 <t:titlepage-before t:side="verso">
1222 </t:titlepage-before>
1223 </t:titlepage>
1224
1225<!-- ==================================================================== -->
1226
1227</t:templates>
diff --git a/documentation/template/yocto-project-qs.png b/documentation/template/yocto-project-qs.png
new file mode 100644
index 0000000000..333442e0d6
--- /dev/null
+++ b/documentation/template/yocto-project-qs.png
Binary files differ
diff --git a/documentation/tools/eclipse-help.sed b/documentation/tools/eclipse-help.sed
new file mode 100644
index 0000000000..38690bc938
--- /dev/null
+++ b/documentation/tools/eclipse-help.sed
@@ -0,0 +1,18 @@
1# Processes poky-ref-manual and yocto-project-qs manual (<word>-<word>-<word> style)
2# For example:
3# "ulink" href="http://www.yoctoproject.org/docs/1.3/poky-ref-manual/poky-ref-manual.html#faq"
4# -> "link" href="../poky-ref-manual/faq.html"
5s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g
6
7# Processes all other manuals (<word>-<word> style)
8# For example:
9# "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html#faq"
10# -> "link" href="../kernel-manual/faq.html"
11s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html#\([^\"]*\)\"/\"link\" href=\"\.\.\/\1\/\2.html\"/g
12
13# Process cases where just an external manual is referenced without an id anchor
14# For example:
15# "ulink" href="http://www.yoctoproject.org/docs/1.3/kernel-manual/kernel-manual.html
16# -> "link" href="../kernel-manual/index.html"
17s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*-[a-z]*\)\/[a-z]*-[a-z]*-[a-z]*.html\"/\"link\" href=\"\.\.\/\1\/index.html\"/g
18s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/[^\/]*\/\([a-z]*-[a-z]*\)\/[a-z]*-[a-z]*.html\"/\"link\" href=\"\.\.\/\1\/index.html\"/g
diff --git a/documentation/tools/mega-manual.sed b/documentation/tools/mega-manual.sed
new file mode 100644
index 0000000000..d3142ec60d
--- /dev/null
+++ b/documentation/tools/mega-manual.sed
@@ -0,0 +1,13 @@
1# Processes ref-manual and yocto-project-qs manual (<word>-<word>-<word> style)
2s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/[a-z]*-[a-z]*-[a-z]*\/[a-z]*-[a-z]*-[a-z]*.html#/\"link\" href=\"#/g
3
4# Processes all other manuals (<word>-<word> style)
5s/\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/[a-z]*-[a-z]*\/[a-z]*-[a-z]*.html#/\"link\" href=\"#/g
6
7# Process cases where just an external manual is referenced without an id anchor
8s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/yocto-project-qs\/yocto-project-qs.html\" target=\"_top\">Yocto Project Quick Start<\/a>/Yocto Project Quick Start/g
9s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/dev-manual\/dev-manual.html\" target=\"_top\">Yocto Project Development Manual<\/a>/Yocto Project Development Manual/g
10s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/adt-manual\/adt-manual.html\" target=\"_top\">Yocto Project Application Developer's Guide<\/a>/Yocto Project Application Developer's Guide/g
11s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/bsp-guide\/bsp-guide.html\" target=\"_top\">Yocto Project Board Support Package (BSP) Developer's Guide<\/a>/Yocto Project Board Support Package (BSP) Developer's Guide/g
12s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/kernel-dev\/kernel-dev.html\" target=\"_top\">Yocto Project Linux Kernel Development Manual<\/a>/Yocto Project Linux Kernel Development Manual/g
13s/<a class=\"ulink\" href=\"http:\/\/www.yoctoproject.org\/docs\/1.5.1\/ref-manual\/ref-manual.html\" target=\"_top\">Yocto Project Reference Manual<\/a>/Yocto Project Reference Manual/g
diff --git a/documentation/tools/poky-docbook-to-pdf b/documentation/tools/poky-docbook-to-pdf
new file mode 100755
index 0000000000..f55fd278af
--- /dev/null
+++ b/documentation/tools/poky-docbook-to-pdf
@@ -0,0 +1,51 @@
1#!/bin/sh
2
3if [ -z "$1" -o -z "$2" ]; then
4 echo "usage: [-v] $0 <docbook file> <templatedir>"
5 echo
6 echo "*NOTE* you need xsltproc, fop and nwalsh docbook stylesheets"
7 echo " installed for this to work!"
8 echo
9 exit 0
10fi
11
12FO=`echo $1 | sed s/.xml/.fo/` || exit 1
13PDF=`echo $1 | sed s/.xml/.pdf/` || exit 1
14TEMPLATEDIR=$2
15
16##
17# These URI should be rewritten by your distribution's xml catalog to
18# match your localy installed XSL stylesheets.
19XSL_BASE_URI="http://docbook.sourceforge.net/release/xsl/current"
20
21# Creates a temporary XSL stylesheet based on titlepage.xsl
22xsltproc -o /tmp/titlepage.xsl \
23 --xinclude \
24 $XSL_BASE_URI/template/titlepage.xsl \
25 $TEMPLATEDIR/titlepage.templates.xml || exit 1
26
27# Creates the file needed for FOP
28xsltproc --xinclude \
29 --stringparam hyphenate false \
30 --stringparam formal.title.placement "figure after" \
31 --stringparam ulink.show 1 \
32 --stringparam body.font.master 9 \
33 --stringparam title.font.master 11 \
34 --stringparam draft.watermark.image "$TEMPLATEDIR/draft.png" \
35 --stringparam chapter.autolabel 1 \
36 --stringparam appendix.autolabel A \
37 --stringparam section.autolabel 1 \
38 --stringparam section.label.includes.component.label 1 \
39 --output $FO \
40 $TEMPLATEDIR/poky-db-pdf.xsl \
41 $1 || exit 1
42
43# Invokes the Java version of FOP. Uses the additional configuration file common/fop-config.xml
44fop -c $TEMPLATEDIR/fop-config.xml -fo $FO -pdf $PDF || exit 1
45
46rm -f $FO
47rm -f /tmp/titlepage.xsl
48
49echo
50echo " #### Success! $PDF ready. ####"
51echo
diff --git a/documentation/yocto-project-qs/figures/building-an-image.png b/documentation/yocto-project-qs/figures/building-an-image.png
new file mode 100755
index 0000000000..1fbea5ab00
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/building-an-image.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/using-a-pre-built-image.png b/documentation/yocto-project-qs/figures/using-a-pre-built-image.png
new file mode 100644
index 0000000000..b03130d123
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/using-a-pre-built-image.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/yocto-environment.png b/documentation/yocto-project-qs/figures/yocto-environment.png
new file mode 100644
index 0000000000..82b7a55a35
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/yocto-environment.png
Binary files differ
diff --git a/documentation/yocto-project-qs/figures/yocto-project-transp.png b/documentation/yocto-project-qs/figures/yocto-project-transp.png
new file mode 100755
index 0000000000..31d2b147fd
--- /dev/null
+++ b/documentation/yocto-project-qs/figures/yocto-project-transp.png
Binary files differ
diff --git a/documentation/yocto-project-qs/qs-style.css b/documentation/yocto-project-qs/qs-style.css
new file mode 100644
index 0000000000..234e432a74
--- /dev/null
+++ b/documentation/yocto-project-qs/qs-style.css
@@ -0,0 +1,979 @@
1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3
4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org
6
7 Customised for Poky by
8 Matthew Allum / mallum@o-hand.com
9
10 Thanks to:
11 Liam R. E. Quin
12 William Skaggs
13 Jakub Steiner
14
15 Structure
16 ---------
17
18 The stylesheet is divided into the following sections:
19
20 Positioning
21 Margins, paddings, width, font-size, clearing.
22 Decorations
23 Borders, style
24 Colors
25 Colors
26 Graphics
27 Graphical backgrounds
28 Nasty IE tweaks
29 Workarounds needed to make it work in internet explorer,
30 currently makes the stylesheet non validating, but up until
31 this point it is validating.
32 Mozilla extensions
33 Transparency for footer
34 Rounded corners on boxes
35
36*/
37
38
39 /*************** /
40 / Positioning /
41/ ***************/
42
43body {
44 font-family: Verdana, Sans, sans-serif;
45
46 min-width: 640px;
47 width: 80%;
48 margin: 0em auto;
49 padding: 2em 5em 5em 5em;
50 color: #333;
51}
52
53h1,h2,h3,h4,h5,h6,h7 {
54 font-family: Arial, Sans;
55 color: #00557D;
56 clear: both;
57}
58
59h1 {
60 font-size: 2em;
61 text-align: left;
62 padding: 0em 0em 0em 0em;
63 margin: 2em 0em 0em 0em;
64}
65
66h2.subtitle {
67 margin: 0.10em 0em 3.0em 0em;
68 padding: 0em 0em 0em 0em;
69 font-size: 1.8em;
70 padding-left: 20%;
71 font-weight: normal;
72 font-style: italic;
73}
74
75h2 {
76 margin: 2em 0em 0.66em 0em;
77 padding: 0.5em 0em 0em 0em;
78 font-size: 1.5em;
79 font-weight: bold;
80}
81
82h3.subtitle {
83 margin: 0em 0em 1em 0em;
84 padding: 0em 0em 0em 0em;
85 font-size: 142.14%;
86 text-align: right;
87}
88
89h3 {
90 margin: 1em 0em 0.5em 0em;
91 padding: 1em 0em 0em 0em;
92 font-size: 140%;
93 font-weight: bold;
94}
95
96h4 {
97 margin: 1em 0em 0.5em 0em;
98 padding: 1em 0em 0em 0em;
99 font-size: 120%;
100 font-weight: bold;
101}
102
103h5 {
104 margin: 1em 0em 0.5em 0em;
105 padding: 1em 0em 0em 0em;
106 font-size: 110%;
107 font-weight: bold;
108}
109
110h6 {
111 margin: 1em 0em 0em 0em;
112 padding: 1em 0em 0em 0em;
113 font-size: 110%;
114 font-weight: bold;
115}
116
117.authorgroup {
118 background-color: transparent;
119 background-repeat: no-repeat;
120 padding-top: 256px;
121 background-image: url("../figures/yocto-project-bw.png");
122 background-position: top;
123 margin-top: -256px;
124 padding-right: 50px;
125 margin-left: 50px;
126 text-align: center;
127 width: 600px;
128}
129
130h3.author {
131 margin: 0em 0me 0em 0em;
132 padding: 0em 0em 0em 0em;
133 font-weight: normal;
134 font-size: 100%;
135 color: #333;
136 clear: both;
137}
138
139.author tt.email {
140 font-size: 66%;
141}
142
143.titlepage hr {
144 width: 0em;
145 clear: both;
146}
147
148.revhistory {
149 padding-top: 2em;
150 clear: both;
151}
152
153.toc,
154.list-of-tables,
155.list-of-examples,
156.list-of-figures {
157 padding: 1.33em 0em 2.5em 0em;
158 color: #00557D;
159}
160
161.toc p,
162.list-of-tables p,
163.list-of-figures p,
164.list-of-examples p {
165 padding: 0em 0em 0em 0em;
166 padding: 0em 0em 0.3em;
167 margin: 1.5em 0em 0em 0em;
168}
169
170.toc p b,
171.list-of-tables p b,
172.list-of-figures p b,
173.list-of-examples p b{
174 font-size: 100.0%;
175 font-weight: bold;
176}
177
178.toc dl,
179.list-of-tables dl,
180.list-of-figures dl,
181.list-of-examples dl {
182 margin: 0em 0em 0.5em 0em;
183 padding: 0em 0em 0em 0em;
184}
185
186.toc dt {
187 margin: 0em 0em 0em 0em;
188 padding: 0em 0em 0em 0em;
189}
190
191.toc dd {
192 margin: 0em 0em 0em 2.6em;
193 padding: 0em 0em 0em 0em;
194}
195
196div.glossary dl,
197div.variablelist dl {
198}
199
200.glossary dl dt,
201.variablelist dl dt,
202.variablelist dl dt span.term {
203 font-weight: normal;
204 width: 20em;
205 text-align: right;
206}
207
208.variablelist dl dt {
209 margin-top: 0.5em;
210}
211
212.glossary dl dd,
213.variablelist dl dd {
214 margin-top: -1em;
215 margin-left: 25.5em;
216}
217
218.glossary dd p,
219.variablelist dd p {
220 margin-top: 0em;
221 margin-bottom: 1em;
222}
223
224
225div.calloutlist table td {
226 padding: 0em 0em 0em 0em;
227 margin: 0em 0em 0em 0em;
228}
229
230div.calloutlist table td p {
231 margin-top: 0em;
232 margin-bottom: 1em;
233}
234
235div p.copyright {
236 text-align: left;
237}
238
239div.legalnotice p.legalnotice-title {
240 margin-bottom: 0em;
241}
242
243p {
244 line-height: 1.5em;
245 margin-top: 0em;
246
247}
248
249dl {
250 padding-top: 0em;
251}
252
253hr {
254 border: solid 1px;
255}
256
257
258.mediaobject,
259.mediaobjectco {
260 text-align: center;
261}
262
263img {
264 border: none;
265}
266
267ul {
268 padding: 0em 0em 0em 1.5em;
269}
270
271ul li {
272 padding: 0em 0em 0em 0em;
273}
274
275ul li p {
276 text-align: left;
277}
278
279table {
280 width :100%;
281}
282
283th {
284 padding: 0.25em;
285 text-align: left;
286 font-weight: normal;
287 vertical-align: top;
288}
289
290td {
291 padding: 0.25em;
292 vertical-align: top;
293}
294
295p a[id] {
296 margin: 0px;
297 padding: 0px;
298 display: inline;
299 background-image: none;
300}
301
302a {
303 text-decoration: underline;
304 color: #444;
305}
306
307pre {
308 overflow: auto;
309}
310
311a:hover {
312 text-decoration: underline;
313 /*font-weight: bold;*/
314}
315
316
317div.informalfigure,
318div.informalexample,
319div.informaltable,
320div.figure,
321div.table,
322div.example {
323 margin: 1em 0em;
324 padding: 1em;
325 page-break-inside: avoid;
326}
327
328
329div.informalfigure p.title b,
330div.informalexample p.title b,
331div.informaltable p.title b,
332div.figure p.title b,
333div.example p.title b,
334div.table p.title b{
335 padding-top: 0em;
336 margin-top: 0em;
337 font-size: 100%;
338 font-weight: normal;
339}
340
341.mediaobject .caption,
342.mediaobject .caption p {
343 text-align: center;
344 font-size: 80%;
345 padding-top: 0.5em;
346 padding-bottom: 0.5em;
347}
348
349.epigraph {
350 padding-left: 55%;
351 margin-bottom: 1em;
352}
353
354.epigraph p {
355 text-align: left;
356}
357
358.epigraph .quote {
359 font-style: italic;
360}
361.epigraph .attribution {
362 font-style: normal;
363 text-align: right;
364}
365
366span.application {
367 font-style: italic;
368}
369
370.programlisting {
371 font-family: monospace;
372 font-size: 80%;
373 white-space: pre;
374 margin: 1.33em 0em;
375 padding: 1.33em;
376}
377
378.tip,
379.warning,
380.caution,
381.note {
382 margin-top: 1em;
383 margin-bottom: 1em;
384
385}
386
387/* force full width of table within div */
388.tip table,
389.warning table,
390.caution table,
391.note table {
392 border: none;
393 width: 100%;
394}
395
396
397.tip table th,
398.warning table th,
399.caution table th,
400.note table th {
401 padding: 0.8em 0.0em 0.0em 0.0em;
402 margin : 0em 0em 0em 0em;
403}
404
405.tip p,
406.warning p,
407.caution p,
408.note p {
409 margin-top: 0.5em;
410 margin-bottom: 0.5em;
411 padding-right: 1em;
412 text-align: left;
413}
414
415.acronym {
416 text-transform: uppercase;
417}
418
419b.keycap,
420.keycap {
421 padding: 0.09em 0.3em;
422 margin: 0em;
423}
424
425.itemizedlist li {
426 clear: none;
427}
428
429.filename {
430 font-size: medium;
431 font-family: Courier, monospace;
432}
433
434
435div.navheader, div.heading{
436 position: absolute;
437 left: 0em;
438 top: 0em;
439 width: 100%;
440 background-color: #cdf;
441 width: 100%;
442}
443
444div.navfooter, div.footing{
445 position: fixed;
446 left: 0em;
447 bottom: 0em;
448 background-color: #eee;
449 width: 100%;
450}
451
452
453div.navheader td,
454div.navfooter td {
455 font-size: 66%;
456}
457
458div.navheader table th {
459 /*font-family: Georgia, Times, serif;*/
460 /*font-size: x-large;*/
461 font-size: 80%;
462}
463
464div.navheader table {
465 border-left: 0em;
466 border-right: 0em;
467 border-top: 0em;
468 width: 100%;
469}
470
471div.navfooter table {
472 border-left: 0em;
473 border-right: 0em;
474 border-bottom: 0em;
475 width: 100%;
476}
477
478div.navheader table td a,
479div.navfooter table td a {
480 color: #777;
481 text-decoration: none;
482}
483
484/* normal text in the footer */
485div.navfooter table td {
486 color: black;
487}
488
489div.navheader table td a:visited,
490div.navfooter table td a:visited {
491 color: #444;
492}
493
494
495/* links in header and footer */
496div.navheader table td a:hover,
497div.navfooter table td a:hover {
498 text-decoration: underline;
499 background-color: transparent;
500 color: #33a;
501}
502
503div.navheader hr,
504div.navfooter hr {
505 display: none;
506}
507
508
509.qandaset tr.question td p {
510 margin: 0em 0em 1em 0em;
511 padding: 0em 0em 0em 0em;
512}
513
514.qandaset tr.answer td p {
515 margin: 0em 0em 1em 0em;
516 padding: 0em 0em 0em 0em;
517}
518.answer td {
519 padding-bottom: 1.5em;
520}
521
522.emphasis {
523 font-weight: bold;
524}
525
526
527 /************* /
528 / decorations /
529/ *************/
530
531.titlepage {
532}
533
534.part .title {
535}
536
537.subtitle {
538 border: none;
539}
540
541/*
542h1 {
543 border: none;
544}
545
546h2 {
547 border-top: solid 0.2em;
548 border-bottom: solid 0.06em;
549}
550
551h3 {
552 border-top: 0em;
553 border-bottom: solid 0.06em;
554}
555
556h4 {
557 border: 0em;
558 border-bottom: solid 0.06em;
559}
560
561h5 {
562 border: 0em;
563}
564*/
565
566.programlisting {
567 border: solid 1px;
568}
569
570div.figure,
571div.table,
572div.informalfigure,
573div.informaltable,
574div.informalexample,
575div.example {
576 border: 1px solid;
577}
578
579
580
581.tip,
582.warning,
583.caution,
584.note {
585 border: 1px solid;
586}
587
588.tip table th,
589.warning table th,
590.caution table th,
591.note table th {
592 border-bottom: 1px solid;
593}
594
595.question td {
596 border-top: 1px solid black;
597}
598
599.answer {
600}
601
602
603b.keycap,
604.keycap {
605 border: 1px solid;
606}
607
608
609div.navheader, div.heading{
610 border-bottom: 1px solid;
611}
612
613
614div.navfooter, div.footing{
615 border-top: 1px solid;
616}
617
618 /********* /
619 / colors /
620/ *********/
621
622body {
623 color: #333;
624 background: white;
625}
626
627a {
628 background: transparent;
629}
630
631a:hover {
632 background-color: #dedede;
633}
634
635
636h1,
637h2,
638h3,
639h4,
640h5,
641h6,
642h7,
643h8 {
644 background-color: transparent;
645}
646
647hr {
648 border-color: #aaa;
649}
650
651
652.tip, .warning, .caution, .note {
653 border-color: #fff;
654}
655
656
657.tip table th,
658.warning table th,
659.caution table th,
660.note table th {
661 border-bottom-color: #fff;
662}
663
664
665.warning {
666 background-color: #f0f0f2;
667}
668
669.caution {
670 background-color: #f0f0f2;
671}
672
673.tip {
674 background-color: #f0f0f2;
675}
676
677.note {
678 background-color: #f0f0f2;
679}
680
681.glossary dl dt,
682.variablelist dl dt,
683.variablelist dl dt span.term {
684 color: #044;
685}
686
687div.figure,
688div.table,
689div.example,
690div.informalfigure,
691div.informaltable,
692div.informalexample {
693 border-color: #aaa;
694}
695
696pre.programlisting {
697 color: black;
698 background-color: #fff;
699 border-color: #aaa;
700 border-width: 2px;
701}
702
703.guimenu,
704.guilabel,
705.guimenuitem {
706 background-color: #eee;
707}
708
709
710b.keycap,
711.keycap {
712 background-color: #eee;
713 border-color: #999;
714}
715
716
717div.navheader {
718 border-color: black;
719}
720
721
722div.navfooter {
723 border-color: black;
724}
725
726
727 /*********** /
728 / graphics /
729/ ***********/
730
731/*
732body {
733 background-image: url("images/body_bg.jpg");
734 background-attachment: fixed;
735}
736
737.navheader,
738.note,
739.tip {
740 background-image: url("images/note_bg.jpg");
741 background-attachment: fixed;
742}
743
744.warning,
745.caution {
746 background-image: url("images/warning_bg.jpg");
747 background-attachment: fixed;
748}
749
750.figure,
751.informalfigure,
752.example,
753.informalexample,
754.table,
755.informaltable {
756 background-image: url("images/figure_bg.jpg");
757 background-attachment: fixed;
758}
759
760*/
761h1,
762h2,
763h3,
764h4,
765h5,
766h6,
767h7{
768}
769
770/*
771Example of how to stick an image as part of the title.
772
773div.article .titlepage .title
774{
775 background-image: url("figures/white-on-black.png");
776 background-position: center;
777 background-repeat: repeat-x;
778}
779*/
780
781div.preface .titlepage .title,
782div.colophon .title,
783div.chapter .titlepage .title,
784div.article .titlepage .title
785{
786}
787
788div.section div.section .titlepage .title,
789div.sect2 .titlepage .title {
790 background: none;
791}
792
793
794h1.title {
795 background-color: transparent;
796 background-image: url("figures/yocto-project-bw.png");
797 background-repeat: no-repeat;
798 height: 256px;
799 text-indent: -9000px;
800 overflow:hidden;
801}
802
803h2.subtitle {
804 background-color: transparent;
805 text-indent: -9000px;
806 overflow:hidden;
807 width: 0px;
808 display: none;
809}
810
811 /*************************************** /
812 / pippin.gimp.org specific alterations /
813/ ***************************************/
814
815/*
816div.heading, div.navheader {
817 color: #777;
818 font-size: 80%;
819 padding: 0;
820 margin: 0;
821 text-align: left;
822 position: absolute;
823 top: 0px;
824 left: 0px;
825 width: 100%;
826 height: 50px;
827 background: url('/gfx/heading_bg.png') transparent;
828 background-repeat: repeat-x;
829 background-attachment: fixed;
830 border: none;
831}
832
833div.heading a {
834 color: #444;
835}
836
837div.footing, div.navfooter {
838 border: none;
839 color: #ddd;
840 font-size: 80%;
841 text-align:right;
842
843 width: 100%;
844 padding-top: 10px;
845 position: absolute;
846 bottom: 0px;
847 left: 0px;
848
849 background: url('/gfx/footing_bg.png') transparent;
850}
851*/
852
853
854
855 /****************** /
856 / nasty ie tweaks /
857/ ******************/
858
859/*
860div.heading, div.navheader {
861 width:expression(document.body.clientWidth + "px");
862}
863
864div.footing, div.navfooter {
865 width:expression(document.body.clientWidth + "px");
866 margin-left:expression("-5em");
867}
868body {
869 padding:expression("4em 5em 0em 5em");
870}
871*/
872
873 /**************************************** /
874 / mozilla vendor specific css extensions /
875/ ****************************************/
876/*
877div.navfooter, div.footing{
878 -moz-opacity: 0.8em;
879}
880
881div.figure,
882div.table,
883div.informalfigure,
884div.informaltable,
885div.informalexample,
886div.example,
887.tip,
888.warning,
889.caution,
890.note {
891 -moz-border-radius: 0.5em;
892}
893
894b.keycap,
895.keycap {
896 -moz-border-radius: 0.3em;
897}
898*/
899
900table tr td table tr td {
901 display: none;
902}
903
904
905hr {
906 display: none;
907}
908
909table {
910 border: 0em;
911}
912
913 .photo {
914 float: right;
915 margin-left: 1.5em;
916 margin-bottom: 1.5em;
917 margin-top: 0em;
918 max-width: 17em;
919 border: 1px solid gray;
920 padding: 3px;
921 background: white;
922}
923 .seperator {
924 padding-top: 2em;
925 clear: both;
926 }
927
928 #validators {
929 margin-top: 5em;
930 text-align: right;
931 color: #777;
932 }
933 @media print {
934 body {
935 font-size: 8pt;
936 }
937 .noprint {
938 display: none;
939 }
940 }
941
942
943.tip,
944.note {
945 background: #f0f0f2;
946 color: #333;
947 padding: 20px;
948 margin: 20px;
949}
950
951.tip h3,
952.note h3 {
953 padding: 0em;
954 margin: 0em;
955 font-size: 2em;
956 font-weight: bold;
957 color: #333;
958}
959
960.tip a,
961.note a {
962 color: #333;
963 text-decoration: underline;
964}
965
966.footnote {
967 font-size: small;
968 color: #333;
969}
970
971/* Changes the announcement text */
972.tip h3,
973.warning h3,
974.caution h3,
975.note h3 {
976 font-size:large;
977 color: #00557D;
978}
979
diff --git a/documentation/yocto-project-qs/yocto-project-qs-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl
new file mode 100644
index 0000000000..bd53ecb0f6
--- /dev/null
+++ b/documentation/yocto-project-qs/yocto-project-qs-customization.xsl
@@ -0,0 +1,9 @@
1<?xml version='1.0'?>
2<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0">
3
4 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" />
5 <xsl:import href="yocto-project-qs-titlepage.xsl"/>
6
7 <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
8 <xsl:param name="html.stylesheet" select="'qs-style.css'" />
9</xsl:stylesheet>
diff --git a/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl b/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl
new file mode 100644
index 0000000000..f8f8930f27
--- /dev/null
+++ b/documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl
@@ -0,0 +1,25 @@
1<?xml version='1.0'?>
2<xsl:stylesheet
3 xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
4 xmlns="http://www.w3.org/1999/xhtml"
5 xmlns:fo="http://www.w3.org/1999/XSL/Format"
6 version="1.0">
7
8 <xsl:import
9 href="http://docbook.sourceforge.net/release/xsl/current/eclipse/eclipse3.xsl" />
10 <xsl:import href="yocto-project-qs-titlepage.xsl"/>
11
12 <xsl:param name="chunker.output.indent" select="'yes'"/>
13 <xsl:param name="chunk.quietly" select="1"/>
14 <xsl:param name="use.id.as.filename" select="1"/>
15 <xsl:param name="ulink.target" select="'_self'" />
16 <xsl:param name="base.dir" select="'html/yocto-project-qs/'"/>
17 <xsl:param name="chunk.section.depth" select="0"/>
18 <xsl:param name="html.stylesheet" select="'../book.css'"/>
19 <xsl:param name="eclipse.manifest" select="0"/>
20 <xsl:param name="create.plugin.xml" select="0"/>
21 <xsl:param name="suppress.navigation" select="1"/>
22 <xsl:param name="generate.index" select="0"/>
23 <xsl:param name="generate.toc" select="'article nop'"></xsl:param>
24 <xsl:param name="html.stylesheet" select="'style.css'" />
25</xsl:stylesheet>
diff --git a/documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl b/documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl
new file mode 100644
index 0000000000..a435ac77ab
--- /dev/null
+++ b/documentation/yocto-project-qs/yocto-project-qs-titlepage.xsl
@@ -0,0 +1,3820 @@
1<?xml version="1.0"?>
2
3<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:exsl="http://exslt.org/common" version="1.0" exclude-result-prefixes="exsl">
4
5<!-- This stylesheet was created by template/titlepage.xsl-->
6
7<xsl:template name="article.titlepage.recto">
8 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/abstract"/>
9 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/abstract"/>
10 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/abstract"/>
11 <xsl:choose>
12 <xsl:when test="articleinfo/title">
13 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/title"/>
14 </xsl:when>
15 <xsl:when test="artheader/title">
16 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/title"/>
17 </xsl:when>
18 <xsl:when test="info/title">
19 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/title"/>
20 </xsl:when>
21 <xsl:when test="title">
22 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="title"/>
23 </xsl:when>
24 </xsl:choose>
25
26 <xsl:choose>
27 <xsl:when test="articleinfo/subtitle">
28 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/subtitle"/>
29 </xsl:when>
30 <xsl:when test="artheader/subtitle">
31 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/subtitle"/>
32 </xsl:when>
33 <xsl:when test="info/subtitle">
34 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/subtitle"/>
35 </xsl:when>
36 <xsl:when test="subtitle">
37 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="subtitle"/>
38 </xsl:when>
39 </xsl:choose>
40
41 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/corpauthor"/>
42 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/corpauthor"/>
43 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/corpauthor"/>
44 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/authorgroup"/>
45 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/authorgroup"/>
46 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/authorgroup"/>
47 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/author"/>
48 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/author"/>
49 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/author"/>
50 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/othercredit"/>
51 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/othercredit"/>
52 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/othercredit"/>
53 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/releaseinfo"/>
54 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/releaseinfo"/>
55 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/releaseinfo"/>
56 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/copyright"/>
57 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/copyright"/>
58 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/copyright"/>
59 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/legalnotice"/>
60 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/legalnotice"/>
61 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/legalnotice"/>
62 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/pubdate"/>
63 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/pubdate"/>
64 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/pubdate"/>
65 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/revision"/>
66 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/revision"/>
67 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/revision"/>
68 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="articleinfo/revhistory"/>
69 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="artheader/revhistory"/>
70 <xsl:apply-templates mode="article.titlepage.recto.auto.mode" select="info/revhistory"/>
71</xsl:template>
72
73<xsl:template name="article.titlepage.verso">
74</xsl:template>
75
76<xsl:template name="article.titlepage.separator"><hr/>
77</xsl:template>
78
79<xsl:template name="article.titlepage.before.recto">
80</xsl:template>
81
82<xsl:template name="article.titlepage.before.verso">
83</xsl:template>
84
85<xsl:template name="article.titlepage">
86 <div class="titlepage">
87 <xsl:variable name="recto.content">
88 <xsl:call-template name="article.titlepage.before.recto"/>
89 <xsl:call-template name="article.titlepage.recto"/>
90 </xsl:variable>
91 <xsl:variable name="recto.elements.count">
92 <xsl:choose>
93 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
94 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
95 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
96 <xsl:otherwise>1</xsl:otherwise>
97 </xsl:choose>
98 </xsl:variable>
99 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
100 <div><xsl:copy-of select="$recto.content"/></div>
101 </xsl:if>
102 <xsl:variable name="verso.content">
103 <xsl:call-template name="article.titlepage.before.verso"/>
104 <xsl:call-template name="article.titlepage.verso"/>
105 </xsl:variable>
106 <xsl:variable name="verso.elements.count">
107 <xsl:choose>
108 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
109 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
110 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
111 <xsl:otherwise>1</xsl:otherwise>
112 </xsl:choose>
113 </xsl:variable>
114 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
115 <div><xsl:copy-of select="$verso.content"/></div>
116 </xsl:if>
117 <xsl:call-template name="article.titlepage.separator"/>
118 </div>
119</xsl:template>
120
121<xsl:template match="*" mode="article.titlepage.recto.mode">
122 <!-- if an element isn't found in this mode, -->
123 <!-- try the generic titlepage.mode -->
124 <xsl:apply-templates select="." mode="titlepage.mode"/>
125</xsl:template>
126
127<xsl:template match="*" mode="article.titlepage.verso.mode">
128 <!-- if an element isn't found in this mode, -->
129 <!-- try the generic titlepage.mode -->
130 <xsl:apply-templates select="." mode="titlepage.mode"/>
131</xsl:template>
132
133<xsl:template match="abstract" mode="article.titlepage.recto.auto.mode">
134<div xsl:use-attribute-sets="article.titlepage.recto.style">
135 <xsl:call-template name="anchor"/>
136 <xsl:apply-templates/>
137<!-- orignally generated content -->
138<!-- <xsl:apply-templates select="." mode="article.titlepage.recto.mode"/> -->
139</div>
140</xsl:template>
141
142<xsl:template match="title" mode="article.titlepage.recto.auto.mode">
143<div xsl:use-attribute-sets="article.titlepage.recto.style">
144<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
145</div>
146</xsl:template>
147
148<xsl:template match="subtitle" mode="article.titlepage.recto.auto.mode">
149<div xsl:use-attribute-sets="article.titlepage.recto.style">
150<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
151</div>
152</xsl:template>
153
154<xsl:template match="corpauthor" mode="article.titlepage.recto.auto.mode">
155<div xsl:use-attribute-sets="article.titlepage.recto.style">
156<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
157</div>
158</xsl:template>
159
160<xsl:template match="authorgroup" mode="article.titlepage.recto.auto.mode">
161<div xsl:use-attribute-sets="article.titlepage.recto.style">
162<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
163</div>
164</xsl:template>
165
166<xsl:template match="author" mode="article.titlepage.recto.auto.mode">
167<div xsl:use-attribute-sets="article.titlepage.recto.style">
168<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
169</div>
170</xsl:template>
171
172<xsl:template match="othercredit" mode="article.titlepage.recto.auto.mode">
173<div xsl:use-attribute-sets="article.titlepage.recto.style">
174<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
175</div>
176</xsl:template>
177
178<xsl:template match="releaseinfo" mode="article.titlepage.recto.auto.mode">
179<div xsl:use-attribute-sets="article.titlepage.recto.style">
180<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
181</div>
182</xsl:template>
183
184<xsl:template match="copyright" mode="article.titlepage.recto.auto.mode">
185<div xsl:use-attribute-sets="article.titlepage.recto.style">
186<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
187</div>
188</xsl:template>
189
190<xsl:template match="legalnotice" mode="article.titlepage.recto.auto.mode">
191<div xsl:use-attribute-sets="article.titlepage.recto.style">
192<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
193</div>
194</xsl:template>
195
196<xsl:template match="pubdate" mode="article.titlepage.recto.auto.mode">
197<div xsl:use-attribute-sets="article.titlepage.recto.style">
198<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
199</div>
200</xsl:template>
201
202<xsl:template match="revision" mode="article.titlepage.recto.auto.mode">
203<div xsl:use-attribute-sets="article.titlepage.recto.style">
204<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
205</div>
206</xsl:template>
207
208<xsl:template match="revhistory" mode="article.titlepage.recto.auto.mode">
209<div xsl:use-attribute-sets="article.titlepage.recto.style">
210<xsl:apply-templates select="." mode="article.titlepage.recto.mode"/>
211</div>
212</xsl:template>
213
214<xsl:template name="set.titlepage.recto">
215 <xsl:choose>
216 <xsl:when test="setinfo/title">
217 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/title"/>
218 </xsl:when>
219 <xsl:when test="info/title">
220 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/title"/>
221 </xsl:when>
222 <xsl:when test="title">
223 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="title"/>
224 </xsl:when>
225 </xsl:choose>
226
227 <xsl:choose>
228 <xsl:when test="setinfo/subtitle">
229 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/subtitle"/>
230 </xsl:when>
231 <xsl:when test="info/subtitle">
232 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/subtitle"/>
233 </xsl:when>
234 <xsl:when test="subtitle">
235 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="subtitle"/>
236 </xsl:when>
237 </xsl:choose>
238
239 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/corpauthor"/>
240 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/corpauthor"/>
241 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/authorgroup"/>
242 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/authorgroup"/>
243 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/author"/>
244 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/author"/>
245 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/othercredit"/>
246 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/othercredit"/>
247 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/releaseinfo"/>
248 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/releaseinfo"/>
249 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/copyright"/>
250 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/copyright"/>
251 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/legalnotice"/>
252 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/legalnotice"/>
253 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/pubdate"/>
254 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/pubdate"/>
255 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/revision"/>
256 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/revision"/>
257 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/revhistory"/>
258 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/revhistory"/>
259 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="setinfo/abstract"/>
260 <xsl:apply-templates mode="set.titlepage.recto.auto.mode" select="info/abstract"/>
261</xsl:template>
262
263<xsl:template name="set.titlepage.verso">
264</xsl:template>
265
266<xsl:template name="set.titlepage.separator"><hr/>
267</xsl:template>
268
269<xsl:template name="set.titlepage.before.recto">
270</xsl:template>
271
272<xsl:template name="set.titlepage.before.verso">
273</xsl:template>
274
275<xsl:template name="set.titlepage">
276 <div class="titlepage">
277 <xsl:variable name="recto.content">
278 <xsl:call-template name="set.titlepage.before.recto"/>
279 <xsl:call-template name="set.titlepage.recto"/>
280 </xsl:variable>
281 <xsl:variable name="recto.elements.count">
282 <xsl:choose>
283 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
284 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
285 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
286 <xsl:otherwise>1</xsl:otherwise>
287 </xsl:choose>
288 </xsl:variable>
289 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
290 <div><xsl:copy-of select="$recto.content"/></div>
291 </xsl:if>
292 <xsl:variable name="verso.content">
293 <xsl:call-template name="set.titlepage.before.verso"/>
294 <xsl:call-template name="set.titlepage.verso"/>
295 </xsl:variable>
296 <xsl:variable name="verso.elements.count">
297 <xsl:choose>
298 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
299 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
300 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
301 <xsl:otherwise>1</xsl:otherwise>
302 </xsl:choose>
303 </xsl:variable>
304 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
305 <div><xsl:copy-of select="$verso.content"/></div>
306 </xsl:if>
307 <xsl:call-template name="set.titlepage.separator"/>
308 </div>
309</xsl:template>
310
311<xsl:template match="*" mode="set.titlepage.recto.mode">
312 <!-- if an element isn't found in this mode, -->
313 <!-- try the generic titlepage.mode -->
314 <xsl:apply-templates select="." mode="titlepage.mode"/>
315</xsl:template>
316
317<xsl:template match="*" mode="set.titlepage.verso.mode">
318 <!-- if an element isn't found in this mode, -->
319 <!-- try the generic titlepage.mode -->
320 <xsl:apply-templates select="." mode="titlepage.mode"/>
321</xsl:template>
322
323<xsl:template match="title" mode="set.titlepage.recto.auto.mode">
324<div xsl:use-attribute-sets="set.titlepage.recto.style">
325<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
326</div>
327</xsl:template>
328
329<xsl:template match="subtitle" mode="set.titlepage.recto.auto.mode">
330<div xsl:use-attribute-sets="set.titlepage.recto.style">
331<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
332</div>
333</xsl:template>
334
335<xsl:template match="corpauthor" mode="set.titlepage.recto.auto.mode">
336<div xsl:use-attribute-sets="set.titlepage.recto.style">
337<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
338</div>
339</xsl:template>
340
341<xsl:template match="authorgroup" mode="set.titlepage.recto.auto.mode">
342<div xsl:use-attribute-sets="set.titlepage.recto.style">
343<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
344</div>
345</xsl:template>
346
347<xsl:template match="author" mode="set.titlepage.recto.auto.mode">
348<div xsl:use-attribute-sets="set.titlepage.recto.style">
349<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
350</div>
351</xsl:template>
352
353<xsl:template match="othercredit" mode="set.titlepage.recto.auto.mode">
354<div xsl:use-attribute-sets="set.titlepage.recto.style">
355<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
356</div>
357</xsl:template>
358
359<xsl:template match="releaseinfo" mode="set.titlepage.recto.auto.mode">
360<div xsl:use-attribute-sets="set.titlepage.recto.style">
361<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
362</div>
363</xsl:template>
364
365<xsl:template match="copyright" mode="set.titlepage.recto.auto.mode">
366<div xsl:use-attribute-sets="set.titlepage.recto.style">
367<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
368</div>
369</xsl:template>
370
371<xsl:template match="legalnotice" mode="set.titlepage.recto.auto.mode">
372<div xsl:use-attribute-sets="set.titlepage.recto.style">
373<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
374</div>
375</xsl:template>
376
377<xsl:template match="pubdate" mode="set.titlepage.recto.auto.mode">
378<div xsl:use-attribute-sets="set.titlepage.recto.style">
379<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
380</div>
381</xsl:template>
382
383<xsl:template match="revision" mode="set.titlepage.recto.auto.mode">
384<div xsl:use-attribute-sets="set.titlepage.recto.style">
385<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
386</div>
387</xsl:template>
388
389<xsl:template match="revhistory" mode="set.titlepage.recto.auto.mode">
390<div xsl:use-attribute-sets="set.titlepage.recto.style">
391<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
392</div>
393</xsl:template>
394
395<xsl:template match="abstract" mode="set.titlepage.recto.auto.mode">
396<div xsl:use-attribute-sets="set.titlepage.recto.style">
397<xsl:apply-templates select="." mode="set.titlepage.recto.mode"/>
398</div>
399</xsl:template>
400
401<xsl:template name="book.titlepage.recto">
402 <xsl:choose>
403 <xsl:when test="bookinfo/title">
404 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/title"/>
405 </xsl:when>
406 <xsl:when test="info/title">
407 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/title"/>
408 </xsl:when>
409 <xsl:when test="title">
410 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="title"/>
411 </xsl:when>
412 </xsl:choose>
413
414 <xsl:choose>
415 <xsl:when test="bookinfo/subtitle">
416 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/subtitle"/>
417 </xsl:when>
418 <xsl:when test="info/subtitle">
419 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/subtitle"/>
420 </xsl:when>
421 <xsl:when test="subtitle">
422 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="subtitle"/>
423 </xsl:when>
424 </xsl:choose>
425
426 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/corpauthor"/>
427 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/corpauthor"/>
428 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/authorgroup"/>
429 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/authorgroup"/>
430 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/author"/>
431 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/author"/>
432 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/othercredit"/>
433 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/othercredit"/>
434 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/releaseinfo"/>
435 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/releaseinfo"/>
436 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/copyright"/>
437 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/copyright"/>
438 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/legalnotice"/>
439 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/legalnotice"/>
440 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/pubdate"/>
441 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/pubdate"/>
442 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/revision"/>
443 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/revision"/>
444 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/revhistory"/>
445 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/revhistory"/>
446 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/abstract"/>
447 <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/abstract"/>
448</xsl:template>
449
450<xsl:template name="book.titlepage.verso">
451</xsl:template>
452
453<xsl:template name="book.titlepage.separator"><hr/>
454</xsl:template>
455
456<xsl:template name="book.titlepage.before.recto">
457</xsl:template>
458
459<xsl:template name="book.titlepage.before.verso">
460</xsl:template>
461
462<xsl:template name="book.titlepage">
463 <div class="titlepage">
464 <xsl:variable name="recto.content">
465 <xsl:call-template name="book.titlepage.before.recto"/>
466 <xsl:call-template name="book.titlepage.recto"/>
467 </xsl:variable>
468 <xsl:variable name="recto.elements.count">
469 <xsl:choose>
470 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
471 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
472 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
473 <xsl:otherwise>1</xsl:otherwise>
474 </xsl:choose>
475 </xsl:variable>
476 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
477 <div><xsl:copy-of select="$recto.content"/></div>
478 </xsl:if>
479 <xsl:variable name="verso.content">
480 <xsl:call-template name="book.titlepage.before.verso"/>
481 <xsl:call-template name="book.titlepage.verso"/>
482 </xsl:variable>
483 <xsl:variable name="verso.elements.count">
484 <xsl:choose>
485 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
486 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
487 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
488 <xsl:otherwise>1</xsl:otherwise>
489 </xsl:choose>
490 </xsl:variable>
491 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
492 <div><xsl:copy-of select="$verso.content"/></div>
493 </xsl:if>
494 <xsl:call-template name="book.titlepage.separator"/>
495 </div>
496</xsl:template>
497
498<xsl:template match="*" mode="book.titlepage.recto.mode">
499 <!-- if an element isn't found in this mode, -->
500 <!-- try the generic titlepage.mode -->
501 <xsl:apply-templates select="." mode="titlepage.mode"/>
502</xsl:template>
503
504<xsl:template match="*" mode="book.titlepage.verso.mode">
505 <!-- if an element isn't found in this mode, -->
506 <!-- try the generic titlepage.mode -->
507 <xsl:apply-templates select="." mode="titlepage.mode"/>
508</xsl:template>
509
510<xsl:template match="title" mode="book.titlepage.recto.auto.mode">
511<div xsl:use-attribute-sets="book.titlepage.recto.style">
512<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
513</div>
514</xsl:template>
515
516<xsl:template match="subtitle" mode="book.titlepage.recto.auto.mode">
517<div xsl:use-attribute-sets="book.titlepage.recto.style">
518<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
519</div>
520</xsl:template>
521
522<xsl:template match="corpauthor" mode="book.titlepage.recto.auto.mode">
523<div xsl:use-attribute-sets="book.titlepage.recto.style">
524<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
525</div>
526</xsl:template>
527
528<xsl:template match="authorgroup" mode="book.titlepage.recto.auto.mode">
529<div xsl:use-attribute-sets="book.titlepage.recto.style">
530<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
531</div>
532</xsl:template>
533
534<xsl:template match="author" mode="book.titlepage.recto.auto.mode">
535<div xsl:use-attribute-sets="book.titlepage.recto.style">
536<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
537</div>
538</xsl:template>
539
540<xsl:template match="othercredit" mode="book.titlepage.recto.auto.mode">
541<div xsl:use-attribute-sets="book.titlepage.recto.style">
542<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
543</div>
544</xsl:template>
545
546<xsl:template match="releaseinfo" mode="book.titlepage.recto.auto.mode">
547<div xsl:use-attribute-sets="book.titlepage.recto.style">
548<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
549</div>
550</xsl:template>
551
552<xsl:template match="copyright" mode="book.titlepage.recto.auto.mode">
553<div xsl:use-attribute-sets="book.titlepage.recto.style">
554<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
555</div>
556</xsl:template>
557
558<xsl:template match="legalnotice" mode="book.titlepage.recto.auto.mode">
559<div xsl:use-attribute-sets="book.titlepage.recto.style">
560<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
561</div>
562</xsl:template>
563
564<xsl:template match="pubdate" mode="book.titlepage.recto.auto.mode">
565<div xsl:use-attribute-sets="book.titlepage.recto.style">
566<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
567</div>
568</xsl:template>
569
570<xsl:template match="revision" mode="book.titlepage.recto.auto.mode">
571<div xsl:use-attribute-sets="book.titlepage.recto.style">
572<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
573</div>
574</xsl:template>
575
576<xsl:template match="revhistory" mode="book.titlepage.recto.auto.mode">
577<div xsl:use-attribute-sets="book.titlepage.recto.style">
578<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
579</div>
580</xsl:template>
581
582<xsl:template match="abstract" mode="book.titlepage.recto.auto.mode">
583<div xsl:use-attribute-sets="book.titlepage.recto.style">
584<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/>
585</div>
586</xsl:template>
587
588<xsl:template name="part.titlepage.recto">
589 <div xsl:use-attribute-sets="part.titlepage.recto.style">
590<xsl:call-template name="division.title">
591<xsl:with-param name="node" select="ancestor-or-self::part[1]"/>
592</xsl:call-template></div>
593 <xsl:choose>
594 <xsl:when test="partinfo/subtitle">
595 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/subtitle"/>
596 </xsl:when>
597 <xsl:when test="docinfo/subtitle">
598 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
599 </xsl:when>
600 <xsl:when test="info/subtitle">
601 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/subtitle"/>
602 </xsl:when>
603 <xsl:when test="subtitle">
604 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="subtitle"/>
605 </xsl:when>
606 </xsl:choose>
607
608 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/corpauthor"/>
609 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
610 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/corpauthor"/>
611 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/authorgroup"/>
612 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
613 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/authorgroup"/>
614 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/author"/>
615 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/author"/>
616 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/author"/>
617 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/othercredit"/>
618 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
619 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/othercredit"/>
620 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/releaseinfo"/>
621 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
622 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/releaseinfo"/>
623 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/copyright"/>
624 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/copyright"/>
625 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/copyright"/>
626 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/legalnotice"/>
627 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
628 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/legalnotice"/>
629 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/pubdate"/>
630 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
631 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/pubdate"/>
632 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/revision"/>
633 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/revision"/>
634 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/revision"/>
635 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/revhistory"/>
636 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
637 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/revhistory"/>
638 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="partinfo/abstract"/>
639 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="docinfo/abstract"/>
640 <xsl:apply-templates mode="part.titlepage.recto.auto.mode" select="info/abstract"/>
641</xsl:template>
642
643<xsl:template name="part.titlepage.verso">
644</xsl:template>
645
646<xsl:template name="part.titlepage.separator">
647</xsl:template>
648
649<xsl:template name="part.titlepage.before.recto">
650</xsl:template>
651
652<xsl:template name="part.titlepage.before.verso">
653</xsl:template>
654
655<xsl:template name="part.titlepage">
656 <div class="titlepage">
657 <xsl:variable name="recto.content">
658 <xsl:call-template name="part.titlepage.before.recto"/>
659 <xsl:call-template name="part.titlepage.recto"/>
660 </xsl:variable>
661 <xsl:variable name="recto.elements.count">
662 <xsl:choose>
663 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
664 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
665 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
666 <xsl:otherwise>1</xsl:otherwise>
667 </xsl:choose>
668 </xsl:variable>
669 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
670 <div><xsl:copy-of select="$recto.content"/></div>
671 </xsl:if>
672 <xsl:variable name="verso.content">
673 <xsl:call-template name="part.titlepage.before.verso"/>
674 <xsl:call-template name="part.titlepage.verso"/>
675 </xsl:variable>
676 <xsl:variable name="verso.elements.count">
677 <xsl:choose>
678 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
679 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
680 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
681 <xsl:otherwise>1</xsl:otherwise>
682 </xsl:choose>
683 </xsl:variable>
684 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
685 <div><xsl:copy-of select="$verso.content"/></div>
686 </xsl:if>
687 <xsl:call-template name="part.titlepage.separator"/>
688 </div>
689</xsl:template>
690
691<xsl:template match="*" mode="part.titlepage.recto.mode">
692 <!-- if an element isn't found in this mode, -->
693 <!-- try the generic titlepage.mode -->
694 <xsl:apply-templates select="." mode="titlepage.mode"/>
695</xsl:template>
696
697<xsl:template match="*" mode="part.titlepage.verso.mode">
698 <!-- if an element isn't found in this mode, -->
699 <!-- try the generic titlepage.mode -->
700 <xsl:apply-templates select="." mode="titlepage.mode"/>
701</xsl:template>
702
703<xsl:template match="subtitle" mode="part.titlepage.recto.auto.mode">
704<div xsl:use-attribute-sets="part.titlepage.recto.style">
705<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
706</div>
707</xsl:template>
708
709<xsl:template match="corpauthor" mode="part.titlepage.recto.auto.mode">
710<div xsl:use-attribute-sets="part.titlepage.recto.style">
711<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
712</div>
713</xsl:template>
714
715<xsl:template match="authorgroup" mode="part.titlepage.recto.auto.mode">
716<div xsl:use-attribute-sets="part.titlepage.recto.style">
717<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
718</div>
719</xsl:template>
720
721<xsl:template match="author" mode="part.titlepage.recto.auto.mode">
722<div xsl:use-attribute-sets="part.titlepage.recto.style">
723<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
724</div>
725</xsl:template>
726
727<xsl:template match="othercredit" mode="part.titlepage.recto.auto.mode">
728<div xsl:use-attribute-sets="part.titlepage.recto.style">
729<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
730</div>
731</xsl:template>
732
733<xsl:template match="releaseinfo" mode="part.titlepage.recto.auto.mode">
734<div xsl:use-attribute-sets="part.titlepage.recto.style">
735<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
736</div>
737</xsl:template>
738
739<xsl:template match="copyright" mode="part.titlepage.recto.auto.mode">
740<div xsl:use-attribute-sets="part.titlepage.recto.style">
741<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
742</div>
743</xsl:template>
744
745<xsl:template match="legalnotice" mode="part.titlepage.recto.auto.mode">
746<div xsl:use-attribute-sets="part.titlepage.recto.style">
747<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
748</div>
749</xsl:template>
750
751<xsl:template match="pubdate" mode="part.titlepage.recto.auto.mode">
752<div xsl:use-attribute-sets="part.titlepage.recto.style">
753<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
754</div>
755</xsl:template>
756
757<xsl:template match="revision" mode="part.titlepage.recto.auto.mode">
758<div xsl:use-attribute-sets="part.titlepage.recto.style">
759<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
760</div>
761</xsl:template>
762
763<xsl:template match="revhistory" mode="part.titlepage.recto.auto.mode">
764<div xsl:use-attribute-sets="part.titlepage.recto.style">
765<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
766</div>
767</xsl:template>
768
769<xsl:template match="abstract" mode="part.titlepage.recto.auto.mode">
770<div xsl:use-attribute-sets="part.titlepage.recto.style">
771<xsl:apply-templates select="." mode="part.titlepage.recto.mode"/>
772</div>
773</xsl:template>
774
775<xsl:template name="partintro.titlepage.recto">
776 <xsl:choose>
777 <xsl:when test="partintroinfo/title">
778 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/title"/>
779 </xsl:when>
780 <xsl:when test="docinfo/title">
781 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/title"/>
782 </xsl:when>
783 <xsl:when test="info/title">
784 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/title"/>
785 </xsl:when>
786 <xsl:when test="title">
787 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="title"/>
788 </xsl:when>
789 </xsl:choose>
790
791 <xsl:choose>
792 <xsl:when test="partintroinfo/subtitle">
793 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/subtitle"/>
794 </xsl:when>
795 <xsl:when test="docinfo/subtitle">
796 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
797 </xsl:when>
798 <xsl:when test="info/subtitle">
799 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/subtitle"/>
800 </xsl:when>
801 <xsl:when test="subtitle">
802 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="subtitle"/>
803 </xsl:when>
804 </xsl:choose>
805
806 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/corpauthor"/>
807 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
808 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/corpauthor"/>
809 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/authorgroup"/>
810 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
811 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/authorgroup"/>
812 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/author"/>
813 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/author"/>
814 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/author"/>
815 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/othercredit"/>
816 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
817 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/othercredit"/>
818 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/releaseinfo"/>
819 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
820 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/releaseinfo"/>
821 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/copyright"/>
822 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/copyright"/>
823 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/copyright"/>
824 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/legalnotice"/>
825 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
826 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/legalnotice"/>
827 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/pubdate"/>
828 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
829 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/pubdate"/>
830 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/revision"/>
831 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/revision"/>
832 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/revision"/>
833 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/revhistory"/>
834 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
835 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/revhistory"/>
836 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="partintroinfo/abstract"/>
837 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="docinfo/abstract"/>
838 <xsl:apply-templates mode="partintro.titlepage.recto.auto.mode" select="info/abstract"/>
839</xsl:template>
840
841<xsl:template name="partintro.titlepage.verso">
842</xsl:template>
843
844<xsl:template name="partintro.titlepage.separator">
845</xsl:template>
846
847<xsl:template name="partintro.titlepage.before.recto">
848</xsl:template>
849
850<xsl:template name="partintro.titlepage.before.verso">
851</xsl:template>
852
853<xsl:template name="partintro.titlepage">
854 <div>
855 <xsl:variable name="recto.content">
856 <xsl:call-template name="partintro.titlepage.before.recto"/>
857 <xsl:call-template name="partintro.titlepage.recto"/>
858 </xsl:variable>
859 <xsl:variable name="recto.elements.count">
860 <xsl:choose>
861 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
862 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
863 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
864 <xsl:otherwise>1</xsl:otherwise>
865 </xsl:choose>
866 </xsl:variable>
867 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
868 <div><xsl:copy-of select="$recto.content"/></div>
869 </xsl:if>
870 <xsl:variable name="verso.content">
871 <xsl:call-template name="partintro.titlepage.before.verso"/>
872 <xsl:call-template name="partintro.titlepage.verso"/>
873 </xsl:variable>
874 <xsl:variable name="verso.elements.count">
875 <xsl:choose>
876 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
877 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
878 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
879 <xsl:otherwise>1</xsl:otherwise>
880 </xsl:choose>
881 </xsl:variable>
882 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
883 <div><xsl:copy-of select="$verso.content"/></div>
884 </xsl:if>
885 <xsl:call-template name="partintro.titlepage.separator"/>
886 </div>
887</xsl:template>
888
889<xsl:template match="*" mode="partintro.titlepage.recto.mode">
890 <!-- if an element isn't found in this mode, -->
891 <!-- try the generic titlepage.mode -->
892 <xsl:apply-templates select="." mode="titlepage.mode"/>
893</xsl:template>
894
895<xsl:template match="*" mode="partintro.titlepage.verso.mode">
896 <!-- if an element isn't found in this mode, -->
897 <!-- try the generic titlepage.mode -->
898 <xsl:apply-templates select="." mode="titlepage.mode"/>
899</xsl:template>
900
901<xsl:template match="title" mode="partintro.titlepage.recto.auto.mode">
902<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
903<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
904</div>
905</xsl:template>
906
907<xsl:template match="subtitle" mode="partintro.titlepage.recto.auto.mode">
908<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
909<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
910</div>
911</xsl:template>
912
913<xsl:template match="corpauthor" mode="partintro.titlepage.recto.auto.mode">
914<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
915<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
916</div>
917</xsl:template>
918
919<xsl:template match="authorgroup" mode="partintro.titlepage.recto.auto.mode">
920<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
921<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
922</div>
923</xsl:template>
924
925<xsl:template match="author" mode="partintro.titlepage.recto.auto.mode">
926<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
927<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
928</div>
929</xsl:template>
930
931<xsl:template match="othercredit" mode="partintro.titlepage.recto.auto.mode">
932<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
933<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
934</div>
935</xsl:template>
936
937<xsl:template match="releaseinfo" mode="partintro.titlepage.recto.auto.mode">
938<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
939<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
940</div>
941</xsl:template>
942
943<xsl:template match="copyright" mode="partintro.titlepage.recto.auto.mode">
944<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
945<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
946</div>
947</xsl:template>
948
949<xsl:template match="legalnotice" mode="partintro.titlepage.recto.auto.mode">
950<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
951<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
952</div>
953</xsl:template>
954
955<xsl:template match="pubdate" mode="partintro.titlepage.recto.auto.mode">
956<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
957<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
958</div>
959</xsl:template>
960
961<xsl:template match="revision" mode="partintro.titlepage.recto.auto.mode">
962<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
963<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
964</div>
965</xsl:template>
966
967<xsl:template match="revhistory" mode="partintro.titlepage.recto.auto.mode">
968<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
969<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
970</div>
971</xsl:template>
972
973<xsl:template match="abstract" mode="partintro.titlepage.recto.auto.mode">
974<div xsl:use-attribute-sets="partintro.titlepage.recto.style">
975<xsl:apply-templates select="." mode="partintro.titlepage.recto.mode"/>
976</div>
977</xsl:template>
978
979<xsl:template name="reference.titlepage.recto">
980 <xsl:choose>
981 <xsl:when test="referenceinfo/title">
982 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/title"/>
983 </xsl:when>
984 <xsl:when test="docinfo/title">
985 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/title"/>
986 </xsl:when>
987 <xsl:when test="info/title">
988 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/title"/>
989 </xsl:when>
990 <xsl:when test="title">
991 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="title"/>
992 </xsl:when>
993 </xsl:choose>
994
995 <xsl:choose>
996 <xsl:when test="referenceinfo/subtitle">
997 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/subtitle"/>
998 </xsl:when>
999 <xsl:when test="docinfo/subtitle">
1000 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
1001 </xsl:when>
1002 <xsl:when test="info/subtitle">
1003 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/subtitle"/>
1004 </xsl:when>
1005 <xsl:when test="subtitle">
1006 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="subtitle"/>
1007 </xsl:when>
1008 </xsl:choose>
1009
1010 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/corpauthor"/>
1011 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
1012 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/corpauthor"/>
1013 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/authorgroup"/>
1014 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
1015 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/authorgroup"/>
1016 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/author"/>
1017 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/author"/>
1018 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/author"/>
1019 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/othercredit"/>
1020 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
1021 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/othercredit"/>
1022 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/releaseinfo"/>
1023 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
1024 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/releaseinfo"/>
1025 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/copyright"/>
1026 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/copyright"/>
1027 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/copyright"/>
1028 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/legalnotice"/>
1029 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
1030 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/legalnotice"/>
1031 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/pubdate"/>
1032 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
1033 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/pubdate"/>
1034 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/revision"/>
1035 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/revision"/>
1036 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/revision"/>
1037 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/revhistory"/>
1038 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
1039 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/revhistory"/>
1040 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="referenceinfo/abstract"/>
1041 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="docinfo/abstract"/>
1042 <xsl:apply-templates mode="reference.titlepage.recto.auto.mode" select="info/abstract"/>
1043</xsl:template>
1044
1045<xsl:template name="reference.titlepage.verso">
1046</xsl:template>
1047
1048<xsl:template name="reference.titlepage.separator"><hr/>
1049</xsl:template>
1050
1051<xsl:template name="reference.titlepage.before.recto">
1052</xsl:template>
1053
1054<xsl:template name="reference.titlepage.before.verso">
1055</xsl:template>
1056
1057<xsl:template name="reference.titlepage">
1058 <div class="titlepage">
1059 <xsl:variable name="recto.content">
1060 <xsl:call-template name="reference.titlepage.before.recto"/>
1061 <xsl:call-template name="reference.titlepage.recto"/>
1062 </xsl:variable>
1063 <xsl:variable name="recto.elements.count">
1064 <xsl:choose>
1065 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1066 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1067 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1068 <xsl:otherwise>1</xsl:otherwise>
1069 </xsl:choose>
1070 </xsl:variable>
1071 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1072 <div><xsl:copy-of select="$recto.content"/></div>
1073 </xsl:if>
1074 <xsl:variable name="verso.content">
1075 <xsl:call-template name="reference.titlepage.before.verso"/>
1076 <xsl:call-template name="reference.titlepage.verso"/>
1077 </xsl:variable>
1078 <xsl:variable name="verso.elements.count">
1079 <xsl:choose>
1080 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1081 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1082 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1083 <xsl:otherwise>1</xsl:otherwise>
1084 </xsl:choose>
1085 </xsl:variable>
1086 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1087 <div><xsl:copy-of select="$verso.content"/></div>
1088 </xsl:if>
1089 <xsl:call-template name="reference.titlepage.separator"/>
1090 </div>
1091</xsl:template>
1092
1093<xsl:template match="*" mode="reference.titlepage.recto.mode">
1094 <!-- if an element isn't found in this mode, -->
1095 <!-- try the generic titlepage.mode -->
1096 <xsl:apply-templates select="." mode="titlepage.mode"/>
1097</xsl:template>
1098
1099<xsl:template match="*" mode="reference.titlepage.verso.mode">
1100 <!-- if an element isn't found in this mode, -->
1101 <!-- try the generic titlepage.mode -->
1102 <xsl:apply-templates select="." mode="titlepage.mode"/>
1103</xsl:template>
1104
1105<xsl:template match="title" mode="reference.titlepage.recto.auto.mode">
1106<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1107<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1108</div>
1109</xsl:template>
1110
1111<xsl:template match="subtitle" mode="reference.titlepage.recto.auto.mode">
1112<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1113<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1114</div>
1115</xsl:template>
1116
1117<xsl:template match="corpauthor" mode="reference.titlepage.recto.auto.mode">
1118<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1119<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1120</div>
1121</xsl:template>
1122
1123<xsl:template match="authorgroup" mode="reference.titlepage.recto.auto.mode">
1124<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1125<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1126</div>
1127</xsl:template>
1128
1129<xsl:template match="author" mode="reference.titlepage.recto.auto.mode">
1130<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1131<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1132</div>
1133</xsl:template>
1134
1135<xsl:template match="othercredit" mode="reference.titlepage.recto.auto.mode">
1136<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1137<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1138</div>
1139</xsl:template>
1140
1141<xsl:template match="releaseinfo" mode="reference.titlepage.recto.auto.mode">
1142<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1143<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1144</div>
1145</xsl:template>
1146
1147<xsl:template match="copyright" mode="reference.titlepage.recto.auto.mode">
1148<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1149<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1150</div>
1151</xsl:template>
1152
1153<xsl:template match="legalnotice" mode="reference.titlepage.recto.auto.mode">
1154<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1155<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1156</div>
1157</xsl:template>
1158
1159<xsl:template match="pubdate" mode="reference.titlepage.recto.auto.mode">
1160<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1161<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1162</div>
1163</xsl:template>
1164
1165<xsl:template match="revision" mode="reference.titlepage.recto.auto.mode">
1166<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1167<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1168</div>
1169</xsl:template>
1170
1171<xsl:template match="revhistory" mode="reference.titlepage.recto.auto.mode">
1172<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1173<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1174</div>
1175</xsl:template>
1176
1177<xsl:template match="abstract" mode="reference.titlepage.recto.auto.mode">
1178<div xsl:use-attribute-sets="reference.titlepage.recto.style">
1179<xsl:apply-templates select="." mode="reference.titlepage.recto.mode"/>
1180</div>
1181</xsl:template>
1182
1183<xsl:template name="refentry.titlepage.recto">
1184</xsl:template>
1185
1186<xsl:template name="refentry.titlepage.verso">
1187</xsl:template>
1188
1189<xsl:template name="refentry.titlepage.separator">
1190</xsl:template>
1191
1192<xsl:template name="refentry.titlepage.before.recto">
1193</xsl:template>
1194
1195<xsl:template name="refentry.titlepage.before.verso">
1196</xsl:template>
1197
1198<xsl:template name="refentry.titlepage">
1199 <div class="titlepage">
1200 <xsl:variable name="recto.content">
1201 <xsl:call-template name="refentry.titlepage.before.recto"/>
1202 <xsl:call-template name="refentry.titlepage.recto"/>
1203 </xsl:variable>
1204 <xsl:variable name="recto.elements.count">
1205 <xsl:choose>
1206 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1207 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1208 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1209 <xsl:otherwise>1</xsl:otherwise>
1210 </xsl:choose>
1211 </xsl:variable>
1212 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1213 <div><xsl:copy-of select="$recto.content"/></div>
1214 </xsl:if>
1215 <xsl:variable name="verso.content">
1216 <xsl:call-template name="refentry.titlepage.before.verso"/>
1217 <xsl:call-template name="refentry.titlepage.verso"/>
1218 </xsl:variable>
1219 <xsl:variable name="verso.elements.count">
1220 <xsl:choose>
1221 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1222 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1223 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1224 <xsl:otherwise>1</xsl:otherwise>
1225 </xsl:choose>
1226 </xsl:variable>
1227 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1228 <div><xsl:copy-of select="$verso.content"/></div>
1229 </xsl:if>
1230 <xsl:call-template name="refentry.titlepage.separator"/>
1231 </div>
1232</xsl:template>
1233
1234<xsl:template match="*" mode="refentry.titlepage.recto.mode">
1235 <!-- if an element isn't found in this mode, -->
1236 <!-- try the generic titlepage.mode -->
1237 <xsl:apply-templates select="." mode="titlepage.mode"/>
1238</xsl:template>
1239
1240<xsl:template match="*" mode="refentry.titlepage.verso.mode">
1241 <!-- if an element isn't found in this mode, -->
1242 <!-- try the generic titlepage.mode -->
1243 <xsl:apply-templates select="." mode="titlepage.mode"/>
1244</xsl:template>
1245
1246<xsl:template name="dedication.titlepage.recto">
1247 <div xsl:use-attribute-sets="dedication.titlepage.recto.style">
1248<xsl:call-template name="component.title">
1249<xsl:with-param name="node" select="ancestor-or-self::dedication[1]"/>
1250</xsl:call-template></div>
1251 <xsl:choose>
1252 <xsl:when test="dedicationinfo/subtitle">
1253 <xsl:apply-templates mode="dedication.titlepage.recto.auto.mode" select="dedicationinfo/subtitle"/>
1254 </xsl:when>
1255 <xsl:when test="docinfo/subtitle">
1256 <xsl:apply-templates mode="dedication.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
1257 </xsl:when>
1258 <xsl:when test="info/subtitle">
1259 <xsl:apply-templates mode="dedication.titlepage.recto.auto.mode" select="info/subtitle"/>
1260 </xsl:when>
1261 <xsl:when test="subtitle">
1262 <xsl:apply-templates mode="dedication.titlepage.recto.auto.mode" select="subtitle"/>
1263 </xsl:when>
1264 </xsl:choose>
1265
1266</xsl:template>
1267
1268<xsl:template name="dedication.titlepage.verso">
1269</xsl:template>
1270
1271<xsl:template name="dedication.titlepage.separator">
1272</xsl:template>
1273
1274<xsl:template name="dedication.titlepage.before.recto">
1275</xsl:template>
1276
1277<xsl:template name="dedication.titlepage.before.verso">
1278</xsl:template>
1279
1280<xsl:template name="dedication.titlepage">
1281 <div class="titlepage">
1282 <xsl:variable name="recto.content">
1283 <xsl:call-template name="dedication.titlepage.before.recto"/>
1284 <xsl:call-template name="dedication.titlepage.recto"/>
1285 </xsl:variable>
1286 <xsl:variable name="recto.elements.count">
1287 <xsl:choose>
1288 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1289 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1290 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1291 <xsl:otherwise>1</xsl:otherwise>
1292 </xsl:choose>
1293 </xsl:variable>
1294 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1295 <div><xsl:copy-of select="$recto.content"/></div>
1296 </xsl:if>
1297 <xsl:variable name="verso.content">
1298 <xsl:call-template name="dedication.titlepage.before.verso"/>
1299 <xsl:call-template name="dedication.titlepage.verso"/>
1300 </xsl:variable>
1301 <xsl:variable name="verso.elements.count">
1302 <xsl:choose>
1303 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1304 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1305 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1306 <xsl:otherwise>1</xsl:otherwise>
1307 </xsl:choose>
1308 </xsl:variable>
1309 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1310 <div><xsl:copy-of select="$verso.content"/></div>
1311 </xsl:if>
1312 <xsl:call-template name="dedication.titlepage.separator"/>
1313 </div>
1314</xsl:template>
1315
1316<xsl:template match="*" mode="dedication.titlepage.recto.mode">
1317 <!-- if an element isn't found in this mode, -->
1318 <!-- try the generic titlepage.mode -->
1319 <xsl:apply-templates select="." mode="titlepage.mode"/>
1320</xsl:template>
1321
1322<xsl:template match="*" mode="dedication.titlepage.verso.mode">
1323 <!-- if an element isn't found in this mode, -->
1324 <!-- try the generic titlepage.mode -->
1325 <xsl:apply-templates select="." mode="titlepage.mode"/>
1326</xsl:template>
1327
1328<xsl:template match="subtitle" mode="dedication.titlepage.recto.auto.mode">
1329<div xsl:use-attribute-sets="dedication.titlepage.recto.style">
1330<xsl:apply-templates select="." mode="dedication.titlepage.recto.mode"/>
1331</div>
1332</xsl:template>
1333
1334<xsl:template name="acknowledgements.titlepage.recto">
1335 <div xsl:use-attribute-sets="acknowledgements.titlepage.recto.style">
1336<xsl:call-template name="component.title">
1337<xsl:with-param name="node" select="ancestor-or-self::acknowledgements[1]"/>
1338</xsl:call-template></div>
1339 <xsl:choose>
1340 <xsl:when test="acknowledgementsinfo/subtitle">
1341 <xsl:apply-templates mode="acknowledgements.titlepage.recto.auto.mode" select="acknowledgementsinfo/subtitle"/>
1342 </xsl:when>
1343 <xsl:when test="docinfo/subtitle">
1344 <xsl:apply-templates mode="acknowledgements.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
1345 </xsl:when>
1346 <xsl:when test="info/subtitle">
1347 <xsl:apply-templates mode="acknowledgements.titlepage.recto.auto.mode" select="info/subtitle"/>
1348 </xsl:when>
1349 <xsl:when test="subtitle">
1350 <xsl:apply-templates mode="acknowledgements.titlepage.recto.auto.mode" select="subtitle"/>
1351 </xsl:when>
1352 </xsl:choose>
1353
1354</xsl:template>
1355
1356<xsl:template name="acknowledgements.titlepage.verso">
1357</xsl:template>
1358
1359<xsl:template name="acknowledgements.titlepage.separator">
1360</xsl:template>
1361
1362<xsl:template name="acknowledgements.titlepage.before.recto">
1363</xsl:template>
1364
1365<xsl:template name="acknowledgements.titlepage.before.verso">
1366</xsl:template>
1367
1368<xsl:template name="acknowledgements.titlepage">
1369 <div class="titlepage">
1370 <xsl:variable name="recto.content">
1371 <xsl:call-template name="acknowledgements.titlepage.before.recto"/>
1372 <xsl:call-template name="acknowledgements.titlepage.recto"/>
1373 </xsl:variable>
1374 <xsl:variable name="recto.elements.count">
1375 <xsl:choose>
1376 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1377 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1378 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1379 <xsl:otherwise>1</xsl:otherwise>
1380 </xsl:choose>
1381 </xsl:variable>
1382 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1383 <div><xsl:copy-of select="$recto.content"/></div>
1384 </xsl:if>
1385 <xsl:variable name="verso.content">
1386 <xsl:call-template name="acknowledgements.titlepage.before.verso"/>
1387 <xsl:call-template name="acknowledgements.titlepage.verso"/>
1388 </xsl:variable>
1389 <xsl:variable name="verso.elements.count">
1390 <xsl:choose>
1391 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1392 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1393 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1394 <xsl:otherwise>1</xsl:otherwise>
1395 </xsl:choose>
1396 </xsl:variable>
1397 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1398 <div><xsl:copy-of select="$verso.content"/></div>
1399 </xsl:if>
1400 <xsl:call-template name="acknowledgements.titlepage.separator"/>
1401 </div>
1402</xsl:template>
1403
1404<xsl:template match="*" mode="acknowledgements.titlepage.recto.mode">
1405 <!-- if an element isn't found in this mode, -->
1406 <!-- try the generic titlepage.mode -->
1407 <xsl:apply-templates select="." mode="titlepage.mode"/>
1408</xsl:template>
1409
1410<xsl:template match="*" mode="acknowledgements.titlepage.verso.mode">
1411 <!-- if an element isn't found in this mode, -->
1412 <!-- try the generic titlepage.mode -->
1413 <xsl:apply-templates select="." mode="titlepage.mode"/>
1414</xsl:template>
1415
1416<xsl:template match="subtitle" mode="acknowledgements.titlepage.recto.auto.mode">
1417<div xsl:use-attribute-sets="acknowledgements.titlepage.recto.style">
1418<xsl:apply-templates select="." mode="acknowledgements.titlepage.recto.mode"/>
1419</div>
1420</xsl:template>
1421
1422<xsl:template name="preface.titlepage.recto">
1423 <xsl:choose>
1424 <xsl:when test="prefaceinfo/title">
1425 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/title"/>
1426 </xsl:when>
1427 <xsl:when test="docinfo/title">
1428 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/title"/>
1429 </xsl:when>
1430 <xsl:when test="info/title">
1431 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/title"/>
1432 </xsl:when>
1433 <xsl:when test="title">
1434 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="title"/>
1435 </xsl:when>
1436 </xsl:choose>
1437
1438 <xsl:choose>
1439 <xsl:when test="prefaceinfo/subtitle">
1440 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/subtitle"/>
1441 </xsl:when>
1442 <xsl:when test="docinfo/subtitle">
1443 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
1444 </xsl:when>
1445 <xsl:when test="info/subtitle">
1446 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/subtitle"/>
1447 </xsl:when>
1448 <xsl:when test="subtitle">
1449 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="subtitle"/>
1450 </xsl:when>
1451 </xsl:choose>
1452
1453 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/corpauthor"/>
1454 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
1455 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/corpauthor"/>
1456 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/authorgroup"/>
1457 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
1458 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/authorgroup"/>
1459 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/author"/>
1460 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/author"/>
1461 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/author"/>
1462 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/othercredit"/>
1463 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
1464 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/othercredit"/>
1465 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/releaseinfo"/>
1466 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
1467 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/releaseinfo"/>
1468 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/copyright"/>
1469 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/copyright"/>
1470 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/copyright"/>
1471 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/legalnotice"/>
1472 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
1473 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/legalnotice"/>
1474 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/pubdate"/>
1475 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
1476 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/pubdate"/>
1477 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/revision"/>
1478 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/revision"/>
1479 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/revision"/>
1480 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/revhistory"/>
1481 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
1482 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/revhistory"/>
1483 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="prefaceinfo/abstract"/>
1484 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="docinfo/abstract"/>
1485 <xsl:apply-templates mode="preface.titlepage.recto.auto.mode" select="info/abstract"/>
1486</xsl:template>
1487
1488<xsl:template name="preface.titlepage.verso">
1489</xsl:template>
1490
1491<xsl:template name="preface.titlepage.separator">
1492</xsl:template>
1493
1494<xsl:template name="preface.titlepage.before.recto">
1495</xsl:template>
1496
1497<xsl:template name="preface.titlepage.before.verso">
1498</xsl:template>
1499
1500<xsl:template name="preface.titlepage">
1501 <div class="titlepage">
1502 <xsl:variable name="recto.content">
1503 <xsl:call-template name="preface.titlepage.before.recto"/>
1504 <xsl:call-template name="preface.titlepage.recto"/>
1505 </xsl:variable>
1506 <xsl:variable name="recto.elements.count">
1507 <xsl:choose>
1508 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1509 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1510 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1511 <xsl:otherwise>1</xsl:otherwise>
1512 </xsl:choose>
1513 </xsl:variable>
1514 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1515 <div><xsl:copy-of select="$recto.content"/></div>
1516 </xsl:if>
1517 <xsl:variable name="verso.content">
1518 <xsl:call-template name="preface.titlepage.before.verso"/>
1519 <xsl:call-template name="preface.titlepage.verso"/>
1520 </xsl:variable>
1521 <xsl:variable name="verso.elements.count">
1522 <xsl:choose>
1523 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1524 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1525 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1526 <xsl:otherwise>1</xsl:otherwise>
1527 </xsl:choose>
1528 </xsl:variable>
1529 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1530 <div><xsl:copy-of select="$verso.content"/></div>
1531 </xsl:if>
1532 <xsl:call-template name="preface.titlepage.separator"/>
1533 </div>
1534</xsl:template>
1535
1536<xsl:template match="*" mode="preface.titlepage.recto.mode">
1537 <!-- if an element isn't found in this mode, -->
1538 <!-- try the generic titlepage.mode -->
1539 <xsl:apply-templates select="." mode="titlepage.mode"/>
1540</xsl:template>
1541
1542<xsl:template match="*" mode="preface.titlepage.verso.mode">
1543 <!-- if an element isn't found in this mode, -->
1544 <!-- try the generic titlepage.mode -->
1545 <xsl:apply-templates select="." mode="titlepage.mode"/>
1546</xsl:template>
1547
1548<xsl:template match="title" mode="preface.titlepage.recto.auto.mode">
1549<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1550<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1551</div>
1552</xsl:template>
1553
1554<xsl:template match="subtitle" mode="preface.titlepage.recto.auto.mode">
1555<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1556<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1557</div>
1558</xsl:template>
1559
1560<xsl:template match="corpauthor" mode="preface.titlepage.recto.auto.mode">
1561<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1562<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1563</div>
1564</xsl:template>
1565
1566<xsl:template match="authorgroup" mode="preface.titlepage.recto.auto.mode">
1567<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1568<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1569</div>
1570</xsl:template>
1571
1572<xsl:template match="author" mode="preface.titlepage.recto.auto.mode">
1573<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1574<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1575</div>
1576</xsl:template>
1577
1578<xsl:template match="othercredit" mode="preface.titlepage.recto.auto.mode">
1579<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1580<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1581</div>
1582</xsl:template>
1583
1584<xsl:template match="releaseinfo" mode="preface.titlepage.recto.auto.mode">
1585<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1586<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1587</div>
1588</xsl:template>
1589
1590<xsl:template match="copyright" mode="preface.titlepage.recto.auto.mode">
1591<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1592<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1593</div>
1594</xsl:template>
1595
1596<xsl:template match="legalnotice" mode="preface.titlepage.recto.auto.mode">
1597<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1598<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1599</div>
1600</xsl:template>
1601
1602<xsl:template match="pubdate" mode="preface.titlepage.recto.auto.mode">
1603<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1604<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1605</div>
1606</xsl:template>
1607
1608<xsl:template match="revision" mode="preface.titlepage.recto.auto.mode">
1609<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1610<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1611</div>
1612</xsl:template>
1613
1614<xsl:template match="revhistory" mode="preface.titlepage.recto.auto.mode">
1615<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1616<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1617</div>
1618</xsl:template>
1619
1620<xsl:template match="abstract" mode="preface.titlepage.recto.auto.mode">
1621<div xsl:use-attribute-sets="preface.titlepage.recto.style">
1622<xsl:apply-templates select="." mode="preface.titlepage.recto.mode"/>
1623</div>
1624</xsl:template>
1625
1626<xsl:template name="chapter.titlepage.recto">
1627 <xsl:choose>
1628 <xsl:when test="chapterinfo/title">
1629 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/title"/>
1630 </xsl:when>
1631 <xsl:when test="docinfo/title">
1632 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/title"/>
1633 </xsl:when>
1634 <xsl:when test="info/title">
1635 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/title"/>
1636 </xsl:when>
1637 <xsl:when test="title">
1638 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="title"/>
1639 </xsl:when>
1640 </xsl:choose>
1641
1642 <xsl:choose>
1643 <xsl:when test="chapterinfo/subtitle">
1644 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/subtitle"/>
1645 </xsl:when>
1646 <xsl:when test="docinfo/subtitle">
1647 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
1648 </xsl:when>
1649 <xsl:when test="info/subtitle">
1650 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/subtitle"/>
1651 </xsl:when>
1652 <xsl:when test="subtitle">
1653 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="subtitle"/>
1654 </xsl:when>
1655 </xsl:choose>
1656
1657 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/corpauthor"/>
1658 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
1659 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/corpauthor"/>
1660 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/authorgroup"/>
1661 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
1662 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/authorgroup"/>
1663 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/author"/>
1664 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/author"/>
1665 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/author"/>
1666 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/othercredit"/>
1667 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
1668 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/othercredit"/>
1669 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/releaseinfo"/>
1670 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
1671 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/releaseinfo"/>
1672 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/copyright"/>
1673 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/copyright"/>
1674 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/copyright"/>
1675 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/legalnotice"/>
1676 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
1677 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/legalnotice"/>
1678 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/pubdate"/>
1679 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
1680 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/pubdate"/>
1681 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/revision"/>
1682 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/revision"/>
1683 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/revision"/>
1684 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/revhistory"/>
1685 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
1686 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/revhistory"/>
1687 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="chapterinfo/abstract"/>
1688 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="docinfo/abstract"/>
1689 <xsl:apply-templates mode="chapter.titlepage.recto.auto.mode" select="info/abstract"/>
1690</xsl:template>
1691
1692<xsl:template name="chapter.titlepage.verso">
1693</xsl:template>
1694
1695<xsl:template name="chapter.titlepage.separator">
1696</xsl:template>
1697
1698<xsl:template name="chapter.titlepage.before.recto">
1699</xsl:template>
1700
1701<xsl:template name="chapter.titlepage.before.verso">
1702</xsl:template>
1703
1704<xsl:template name="chapter.titlepage">
1705 <div class="titlepage">
1706 <xsl:variable name="recto.content">
1707 <xsl:call-template name="chapter.titlepage.before.recto"/>
1708 <xsl:call-template name="chapter.titlepage.recto"/>
1709 </xsl:variable>
1710 <xsl:variable name="recto.elements.count">
1711 <xsl:choose>
1712 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1713 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1714 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1715 <xsl:otherwise>1</xsl:otherwise>
1716 </xsl:choose>
1717 </xsl:variable>
1718 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1719 <div><xsl:copy-of select="$recto.content"/></div>
1720 </xsl:if>
1721 <xsl:variable name="verso.content">
1722 <xsl:call-template name="chapter.titlepage.before.verso"/>
1723 <xsl:call-template name="chapter.titlepage.verso"/>
1724 </xsl:variable>
1725 <xsl:variable name="verso.elements.count">
1726 <xsl:choose>
1727 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1728 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1729 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1730 <xsl:otherwise>1</xsl:otherwise>
1731 </xsl:choose>
1732 </xsl:variable>
1733 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1734 <div><xsl:copy-of select="$verso.content"/></div>
1735 </xsl:if>
1736 <xsl:call-template name="chapter.titlepage.separator"/>
1737 </div>
1738</xsl:template>
1739
1740<xsl:template match="*" mode="chapter.titlepage.recto.mode">
1741 <!-- if an element isn't found in this mode, -->
1742 <!-- try the generic titlepage.mode -->
1743 <xsl:apply-templates select="." mode="titlepage.mode"/>
1744</xsl:template>
1745
1746<xsl:template match="*" mode="chapter.titlepage.verso.mode">
1747 <!-- if an element isn't found in this mode, -->
1748 <!-- try the generic titlepage.mode -->
1749 <xsl:apply-templates select="." mode="titlepage.mode"/>
1750</xsl:template>
1751
1752<xsl:template match="title" mode="chapter.titlepage.recto.auto.mode">
1753<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1754<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1755</div>
1756</xsl:template>
1757
1758<xsl:template match="subtitle" mode="chapter.titlepage.recto.auto.mode">
1759<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1760<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1761</div>
1762</xsl:template>
1763
1764<xsl:template match="corpauthor" mode="chapter.titlepage.recto.auto.mode">
1765<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1766<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1767</div>
1768</xsl:template>
1769
1770<xsl:template match="authorgroup" mode="chapter.titlepage.recto.auto.mode">
1771<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1772<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1773</div>
1774</xsl:template>
1775
1776<xsl:template match="author" mode="chapter.titlepage.recto.auto.mode">
1777<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1778<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1779</div>
1780</xsl:template>
1781
1782<xsl:template match="othercredit" mode="chapter.titlepage.recto.auto.mode">
1783<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1784<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1785</div>
1786</xsl:template>
1787
1788<xsl:template match="releaseinfo" mode="chapter.titlepage.recto.auto.mode">
1789<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1790<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1791</div>
1792</xsl:template>
1793
1794<xsl:template match="copyright" mode="chapter.titlepage.recto.auto.mode">
1795<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1796<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1797</div>
1798</xsl:template>
1799
1800<xsl:template match="legalnotice" mode="chapter.titlepage.recto.auto.mode">
1801<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1802<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1803</div>
1804</xsl:template>
1805
1806<xsl:template match="pubdate" mode="chapter.titlepage.recto.auto.mode">
1807<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1808<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1809</div>
1810</xsl:template>
1811
1812<xsl:template match="revision" mode="chapter.titlepage.recto.auto.mode">
1813<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1814<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1815</div>
1816</xsl:template>
1817
1818<xsl:template match="revhistory" mode="chapter.titlepage.recto.auto.mode">
1819<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1820<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1821</div>
1822</xsl:template>
1823
1824<xsl:template match="abstract" mode="chapter.titlepage.recto.auto.mode">
1825<div xsl:use-attribute-sets="chapter.titlepage.recto.style">
1826<xsl:apply-templates select="." mode="chapter.titlepage.recto.mode"/>
1827</div>
1828</xsl:template>
1829
1830<xsl:template name="appendix.titlepage.recto">
1831 <xsl:choose>
1832 <xsl:when test="appendixinfo/title">
1833 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/title"/>
1834 </xsl:when>
1835 <xsl:when test="docinfo/title">
1836 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/title"/>
1837 </xsl:when>
1838 <xsl:when test="info/title">
1839 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/title"/>
1840 </xsl:when>
1841 <xsl:when test="title">
1842 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="title"/>
1843 </xsl:when>
1844 </xsl:choose>
1845
1846 <xsl:choose>
1847 <xsl:when test="appendixinfo/subtitle">
1848 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/subtitle"/>
1849 </xsl:when>
1850 <xsl:when test="docinfo/subtitle">
1851 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
1852 </xsl:when>
1853 <xsl:when test="info/subtitle">
1854 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/subtitle"/>
1855 </xsl:when>
1856 <xsl:when test="subtitle">
1857 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="subtitle"/>
1858 </xsl:when>
1859 </xsl:choose>
1860
1861 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/corpauthor"/>
1862 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
1863 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/corpauthor"/>
1864 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/authorgroup"/>
1865 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
1866 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/authorgroup"/>
1867 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/author"/>
1868 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/author"/>
1869 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/author"/>
1870 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/othercredit"/>
1871 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
1872 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/othercredit"/>
1873 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/releaseinfo"/>
1874 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
1875 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/releaseinfo"/>
1876 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/copyright"/>
1877 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/copyright"/>
1878 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/copyright"/>
1879 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/legalnotice"/>
1880 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
1881 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/legalnotice"/>
1882 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/pubdate"/>
1883 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
1884 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/pubdate"/>
1885 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/revision"/>
1886 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/revision"/>
1887 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/revision"/>
1888 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/revhistory"/>
1889 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
1890 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/revhistory"/>
1891 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="appendixinfo/abstract"/>
1892 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="docinfo/abstract"/>
1893 <xsl:apply-templates mode="appendix.titlepage.recto.auto.mode" select="info/abstract"/>
1894</xsl:template>
1895
1896<xsl:template name="appendix.titlepage.verso">
1897</xsl:template>
1898
1899<xsl:template name="appendix.titlepage.separator">
1900</xsl:template>
1901
1902<xsl:template name="appendix.titlepage.before.recto">
1903</xsl:template>
1904
1905<xsl:template name="appendix.titlepage.before.verso">
1906</xsl:template>
1907
1908<xsl:template name="appendix.titlepage">
1909 <div class="titlepage">
1910 <xsl:variable name="recto.content">
1911 <xsl:call-template name="appendix.titlepage.before.recto"/>
1912 <xsl:call-template name="appendix.titlepage.recto"/>
1913 </xsl:variable>
1914 <xsl:variable name="recto.elements.count">
1915 <xsl:choose>
1916 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1917 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1918 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
1919 <xsl:otherwise>1</xsl:otherwise>
1920 </xsl:choose>
1921 </xsl:variable>
1922 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
1923 <div><xsl:copy-of select="$recto.content"/></div>
1924 </xsl:if>
1925 <xsl:variable name="verso.content">
1926 <xsl:call-template name="appendix.titlepage.before.verso"/>
1927 <xsl:call-template name="appendix.titlepage.verso"/>
1928 </xsl:variable>
1929 <xsl:variable name="verso.elements.count">
1930 <xsl:choose>
1931 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1932 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
1933 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
1934 <xsl:otherwise>1</xsl:otherwise>
1935 </xsl:choose>
1936 </xsl:variable>
1937 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
1938 <div><xsl:copy-of select="$verso.content"/></div>
1939 </xsl:if>
1940 <xsl:call-template name="appendix.titlepage.separator"/>
1941 </div>
1942</xsl:template>
1943
1944<xsl:template match="*" mode="appendix.titlepage.recto.mode">
1945 <!-- if an element isn't found in this mode, -->
1946 <!-- try the generic titlepage.mode -->
1947 <xsl:apply-templates select="." mode="titlepage.mode"/>
1948</xsl:template>
1949
1950<xsl:template match="*" mode="appendix.titlepage.verso.mode">
1951 <!-- if an element isn't found in this mode, -->
1952 <!-- try the generic titlepage.mode -->
1953 <xsl:apply-templates select="." mode="titlepage.mode"/>
1954</xsl:template>
1955
1956<xsl:template match="title" mode="appendix.titlepage.recto.auto.mode">
1957<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1958<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1959</div>
1960</xsl:template>
1961
1962<xsl:template match="subtitle" mode="appendix.titlepage.recto.auto.mode">
1963<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1964<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1965</div>
1966</xsl:template>
1967
1968<xsl:template match="corpauthor" mode="appendix.titlepage.recto.auto.mode">
1969<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1970<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1971</div>
1972</xsl:template>
1973
1974<xsl:template match="authorgroup" mode="appendix.titlepage.recto.auto.mode">
1975<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1976<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1977</div>
1978</xsl:template>
1979
1980<xsl:template match="author" mode="appendix.titlepage.recto.auto.mode">
1981<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1982<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1983</div>
1984</xsl:template>
1985
1986<xsl:template match="othercredit" mode="appendix.titlepage.recto.auto.mode">
1987<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1988<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1989</div>
1990</xsl:template>
1991
1992<xsl:template match="releaseinfo" mode="appendix.titlepage.recto.auto.mode">
1993<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
1994<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
1995</div>
1996</xsl:template>
1997
1998<xsl:template match="copyright" mode="appendix.titlepage.recto.auto.mode">
1999<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
2000<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
2001</div>
2002</xsl:template>
2003
2004<xsl:template match="legalnotice" mode="appendix.titlepage.recto.auto.mode">
2005<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
2006<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
2007</div>
2008</xsl:template>
2009
2010<xsl:template match="pubdate" mode="appendix.titlepage.recto.auto.mode">
2011<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
2012<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
2013</div>
2014</xsl:template>
2015
2016<xsl:template match="revision" mode="appendix.titlepage.recto.auto.mode">
2017<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
2018<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
2019</div>
2020</xsl:template>
2021
2022<xsl:template match="revhistory" mode="appendix.titlepage.recto.auto.mode">
2023<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
2024<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
2025</div>
2026</xsl:template>
2027
2028<xsl:template match="abstract" mode="appendix.titlepage.recto.auto.mode">
2029<div xsl:use-attribute-sets="appendix.titlepage.recto.style">
2030<xsl:apply-templates select="." mode="appendix.titlepage.recto.mode"/>
2031</div>
2032</xsl:template>
2033
2034<xsl:template name="section.titlepage.recto">
2035 <xsl:choose>
2036 <xsl:when test="sectioninfo/title">
2037 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/title"/>
2038 </xsl:when>
2039 <xsl:when test="info/title">
2040 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/title"/>
2041 </xsl:when>
2042 <xsl:when test="title">
2043 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="title"/>
2044 </xsl:when>
2045 </xsl:choose>
2046
2047 <xsl:choose>
2048 <xsl:when test="sectioninfo/subtitle">
2049 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/subtitle"/>
2050 </xsl:when>
2051 <xsl:when test="info/subtitle">
2052 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/subtitle"/>
2053 </xsl:when>
2054 <xsl:when test="subtitle">
2055 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="subtitle"/>
2056 </xsl:when>
2057 </xsl:choose>
2058
2059 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/corpauthor"/>
2060 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/corpauthor"/>
2061 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/authorgroup"/>
2062 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/authorgroup"/>
2063 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/author"/>
2064 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/author"/>
2065 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/othercredit"/>
2066 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/othercredit"/>
2067 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/releaseinfo"/>
2068 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/releaseinfo"/>
2069 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/copyright"/>
2070 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/copyright"/>
2071 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/legalnotice"/>
2072 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/legalnotice"/>
2073 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/pubdate"/>
2074 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/pubdate"/>
2075 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/revision"/>
2076 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/revision"/>
2077 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/revhistory"/>
2078 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/revhistory"/>
2079 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="sectioninfo/abstract"/>
2080 <xsl:apply-templates mode="section.titlepage.recto.auto.mode" select="info/abstract"/>
2081</xsl:template>
2082
2083<xsl:template name="section.titlepage.verso">
2084</xsl:template>
2085
2086<xsl:template name="section.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
2087</xsl:template>
2088
2089<xsl:template name="section.titlepage.before.recto">
2090</xsl:template>
2091
2092<xsl:template name="section.titlepage.before.verso">
2093</xsl:template>
2094
2095<xsl:template name="section.titlepage">
2096 <div class="titlepage">
2097 <xsl:variable name="recto.content">
2098 <xsl:call-template name="section.titlepage.before.recto"/>
2099 <xsl:call-template name="section.titlepage.recto"/>
2100 </xsl:variable>
2101 <xsl:variable name="recto.elements.count">
2102 <xsl:choose>
2103 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2104 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2105 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2106 <xsl:otherwise>1</xsl:otherwise>
2107 </xsl:choose>
2108 </xsl:variable>
2109 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
2110 <div><xsl:copy-of select="$recto.content"/></div>
2111 </xsl:if>
2112 <xsl:variable name="verso.content">
2113 <xsl:call-template name="section.titlepage.before.verso"/>
2114 <xsl:call-template name="section.titlepage.verso"/>
2115 </xsl:variable>
2116 <xsl:variable name="verso.elements.count">
2117 <xsl:choose>
2118 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2119 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2120 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2121 <xsl:otherwise>1</xsl:otherwise>
2122 </xsl:choose>
2123 </xsl:variable>
2124 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
2125 <div><xsl:copy-of select="$verso.content"/></div>
2126 </xsl:if>
2127 <xsl:call-template name="section.titlepage.separator"/>
2128 </div>
2129</xsl:template>
2130
2131<xsl:template match="*" mode="section.titlepage.recto.mode">
2132 <!-- if an element isn't found in this mode, -->
2133 <!-- try the generic titlepage.mode -->
2134 <xsl:apply-templates select="." mode="titlepage.mode"/>
2135</xsl:template>
2136
2137<xsl:template match="*" mode="section.titlepage.verso.mode">
2138 <!-- if an element isn't found in this mode, -->
2139 <!-- try the generic titlepage.mode -->
2140 <xsl:apply-templates select="." mode="titlepage.mode"/>
2141</xsl:template>
2142
2143<xsl:template match="title" mode="section.titlepage.recto.auto.mode">
2144<div xsl:use-attribute-sets="section.titlepage.recto.style">
2145<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2146</div>
2147</xsl:template>
2148
2149<xsl:template match="subtitle" mode="section.titlepage.recto.auto.mode">
2150<div xsl:use-attribute-sets="section.titlepage.recto.style">
2151<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2152</div>
2153</xsl:template>
2154
2155<xsl:template match="corpauthor" mode="section.titlepage.recto.auto.mode">
2156<div xsl:use-attribute-sets="section.titlepage.recto.style">
2157<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2158</div>
2159</xsl:template>
2160
2161<xsl:template match="authorgroup" mode="section.titlepage.recto.auto.mode">
2162<div xsl:use-attribute-sets="section.titlepage.recto.style">
2163<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2164</div>
2165</xsl:template>
2166
2167<xsl:template match="author" mode="section.titlepage.recto.auto.mode">
2168<div xsl:use-attribute-sets="section.titlepage.recto.style">
2169<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2170</div>
2171</xsl:template>
2172
2173<xsl:template match="othercredit" mode="section.titlepage.recto.auto.mode">
2174<div xsl:use-attribute-sets="section.titlepage.recto.style">
2175<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2176</div>
2177</xsl:template>
2178
2179<xsl:template match="releaseinfo" mode="section.titlepage.recto.auto.mode">
2180<div xsl:use-attribute-sets="section.titlepage.recto.style">
2181<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2182</div>
2183</xsl:template>
2184
2185<xsl:template match="copyright" mode="section.titlepage.recto.auto.mode">
2186<div xsl:use-attribute-sets="section.titlepage.recto.style">
2187<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2188</div>
2189</xsl:template>
2190
2191<xsl:template match="legalnotice" mode="section.titlepage.recto.auto.mode">
2192<div xsl:use-attribute-sets="section.titlepage.recto.style">
2193<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2194</div>
2195</xsl:template>
2196
2197<xsl:template match="pubdate" mode="section.titlepage.recto.auto.mode">
2198<div xsl:use-attribute-sets="section.titlepage.recto.style">
2199<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2200</div>
2201</xsl:template>
2202
2203<xsl:template match="revision" mode="section.titlepage.recto.auto.mode">
2204<div xsl:use-attribute-sets="section.titlepage.recto.style">
2205<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2206</div>
2207</xsl:template>
2208
2209<xsl:template match="revhistory" mode="section.titlepage.recto.auto.mode">
2210<div xsl:use-attribute-sets="section.titlepage.recto.style">
2211<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2212</div>
2213</xsl:template>
2214
2215<xsl:template match="abstract" mode="section.titlepage.recto.auto.mode">
2216<div xsl:use-attribute-sets="section.titlepage.recto.style">
2217<xsl:apply-templates select="." mode="section.titlepage.recto.mode"/>
2218</div>
2219</xsl:template>
2220
2221<xsl:template name="sect1.titlepage.recto">
2222 <xsl:choose>
2223 <xsl:when test="sect1info/title">
2224 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/title"/>
2225 </xsl:when>
2226 <xsl:when test="info/title">
2227 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/title"/>
2228 </xsl:when>
2229 <xsl:when test="title">
2230 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="title"/>
2231 </xsl:when>
2232 </xsl:choose>
2233
2234 <xsl:choose>
2235 <xsl:when test="sect1info/subtitle">
2236 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/subtitle"/>
2237 </xsl:when>
2238 <xsl:when test="info/subtitle">
2239 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/subtitle"/>
2240 </xsl:when>
2241 <xsl:when test="subtitle">
2242 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="subtitle"/>
2243 </xsl:when>
2244 </xsl:choose>
2245
2246 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/corpauthor"/>
2247 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/corpauthor"/>
2248 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/authorgroup"/>
2249 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/authorgroup"/>
2250 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/author"/>
2251 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/author"/>
2252 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/othercredit"/>
2253 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/othercredit"/>
2254 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/releaseinfo"/>
2255 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/releaseinfo"/>
2256 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/copyright"/>
2257 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/copyright"/>
2258 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/legalnotice"/>
2259 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/legalnotice"/>
2260 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/pubdate"/>
2261 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/pubdate"/>
2262 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/revision"/>
2263 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/revision"/>
2264 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/revhistory"/>
2265 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/revhistory"/>
2266 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="sect1info/abstract"/>
2267 <xsl:apply-templates mode="sect1.titlepage.recto.auto.mode" select="info/abstract"/>
2268</xsl:template>
2269
2270<xsl:template name="sect1.titlepage.verso">
2271</xsl:template>
2272
2273<xsl:template name="sect1.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
2274</xsl:template>
2275
2276<xsl:template name="sect1.titlepage.before.recto">
2277</xsl:template>
2278
2279<xsl:template name="sect1.titlepage.before.verso">
2280</xsl:template>
2281
2282<xsl:template name="sect1.titlepage">
2283 <div class="titlepage">
2284 <xsl:variable name="recto.content">
2285 <xsl:call-template name="sect1.titlepage.before.recto"/>
2286 <xsl:call-template name="sect1.titlepage.recto"/>
2287 </xsl:variable>
2288 <xsl:variable name="recto.elements.count">
2289 <xsl:choose>
2290 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2291 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2292 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2293 <xsl:otherwise>1</xsl:otherwise>
2294 </xsl:choose>
2295 </xsl:variable>
2296 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
2297 <div><xsl:copy-of select="$recto.content"/></div>
2298 </xsl:if>
2299 <xsl:variable name="verso.content">
2300 <xsl:call-template name="sect1.titlepage.before.verso"/>
2301 <xsl:call-template name="sect1.titlepage.verso"/>
2302 </xsl:variable>
2303 <xsl:variable name="verso.elements.count">
2304 <xsl:choose>
2305 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2306 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2307 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2308 <xsl:otherwise>1</xsl:otherwise>
2309 </xsl:choose>
2310 </xsl:variable>
2311 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
2312 <div><xsl:copy-of select="$verso.content"/></div>
2313 </xsl:if>
2314 <xsl:call-template name="sect1.titlepage.separator"/>
2315 </div>
2316</xsl:template>
2317
2318<xsl:template match="*" mode="sect1.titlepage.recto.mode">
2319 <!-- if an element isn't found in this mode, -->
2320 <!-- try the generic titlepage.mode -->
2321 <xsl:apply-templates select="." mode="titlepage.mode"/>
2322</xsl:template>
2323
2324<xsl:template match="*" mode="sect1.titlepage.verso.mode">
2325 <!-- if an element isn't found in this mode, -->
2326 <!-- try the generic titlepage.mode -->
2327 <xsl:apply-templates select="." mode="titlepage.mode"/>
2328</xsl:template>
2329
2330<xsl:template match="title" mode="sect1.titlepage.recto.auto.mode">
2331<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2332<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2333</div>
2334</xsl:template>
2335
2336<xsl:template match="subtitle" mode="sect1.titlepage.recto.auto.mode">
2337<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2338<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2339</div>
2340</xsl:template>
2341
2342<xsl:template match="corpauthor" mode="sect1.titlepage.recto.auto.mode">
2343<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2344<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2345</div>
2346</xsl:template>
2347
2348<xsl:template match="authorgroup" mode="sect1.titlepage.recto.auto.mode">
2349<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2350<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2351</div>
2352</xsl:template>
2353
2354<xsl:template match="author" mode="sect1.titlepage.recto.auto.mode">
2355<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2356<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2357</div>
2358</xsl:template>
2359
2360<xsl:template match="othercredit" mode="sect1.titlepage.recto.auto.mode">
2361<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2362<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2363</div>
2364</xsl:template>
2365
2366<xsl:template match="releaseinfo" mode="sect1.titlepage.recto.auto.mode">
2367<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2368<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2369</div>
2370</xsl:template>
2371
2372<xsl:template match="copyright" mode="sect1.titlepage.recto.auto.mode">
2373<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2374<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2375</div>
2376</xsl:template>
2377
2378<xsl:template match="legalnotice" mode="sect1.titlepage.recto.auto.mode">
2379<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2380<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2381</div>
2382</xsl:template>
2383
2384<xsl:template match="pubdate" mode="sect1.titlepage.recto.auto.mode">
2385<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2386<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2387</div>
2388</xsl:template>
2389
2390<xsl:template match="revision" mode="sect1.titlepage.recto.auto.mode">
2391<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2392<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2393</div>
2394</xsl:template>
2395
2396<xsl:template match="revhistory" mode="sect1.titlepage.recto.auto.mode">
2397<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2398<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2399</div>
2400</xsl:template>
2401
2402<xsl:template match="abstract" mode="sect1.titlepage.recto.auto.mode">
2403<div xsl:use-attribute-sets="sect1.titlepage.recto.style">
2404<xsl:apply-templates select="." mode="sect1.titlepage.recto.mode"/>
2405</div>
2406</xsl:template>
2407
2408<xsl:template name="sect2.titlepage.recto">
2409 <xsl:choose>
2410 <xsl:when test="sect2info/title">
2411 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/title"/>
2412 </xsl:when>
2413 <xsl:when test="info/title">
2414 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/title"/>
2415 </xsl:when>
2416 <xsl:when test="title">
2417 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="title"/>
2418 </xsl:when>
2419 </xsl:choose>
2420
2421 <xsl:choose>
2422 <xsl:when test="sect2info/subtitle">
2423 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/subtitle"/>
2424 </xsl:when>
2425 <xsl:when test="info/subtitle">
2426 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/subtitle"/>
2427 </xsl:when>
2428 <xsl:when test="subtitle">
2429 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="subtitle"/>
2430 </xsl:when>
2431 </xsl:choose>
2432
2433 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/corpauthor"/>
2434 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/corpauthor"/>
2435 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/authorgroup"/>
2436 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/authorgroup"/>
2437 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/author"/>
2438 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/author"/>
2439 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/othercredit"/>
2440 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/othercredit"/>
2441 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/releaseinfo"/>
2442 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/releaseinfo"/>
2443 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/copyright"/>
2444 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/copyright"/>
2445 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/legalnotice"/>
2446 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/legalnotice"/>
2447 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/pubdate"/>
2448 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/pubdate"/>
2449 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/revision"/>
2450 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/revision"/>
2451 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/revhistory"/>
2452 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/revhistory"/>
2453 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="sect2info/abstract"/>
2454 <xsl:apply-templates mode="sect2.titlepage.recto.auto.mode" select="info/abstract"/>
2455</xsl:template>
2456
2457<xsl:template name="sect2.titlepage.verso">
2458</xsl:template>
2459
2460<xsl:template name="sect2.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
2461</xsl:template>
2462
2463<xsl:template name="sect2.titlepage.before.recto">
2464</xsl:template>
2465
2466<xsl:template name="sect2.titlepage.before.verso">
2467</xsl:template>
2468
2469<xsl:template name="sect2.titlepage">
2470 <div class="titlepage">
2471 <xsl:variable name="recto.content">
2472 <xsl:call-template name="sect2.titlepage.before.recto"/>
2473 <xsl:call-template name="sect2.titlepage.recto"/>
2474 </xsl:variable>
2475 <xsl:variable name="recto.elements.count">
2476 <xsl:choose>
2477 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2478 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2479 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2480 <xsl:otherwise>1</xsl:otherwise>
2481 </xsl:choose>
2482 </xsl:variable>
2483 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
2484 <div><xsl:copy-of select="$recto.content"/></div>
2485 </xsl:if>
2486 <xsl:variable name="verso.content">
2487 <xsl:call-template name="sect2.titlepage.before.verso"/>
2488 <xsl:call-template name="sect2.titlepage.verso"/>
2489 </xsl:variable>
2490 <xsl:variable name="verso.elements.count">
2491 <xsl:choose>
2492 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2493 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2494 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2495 <xsl:otherwise>1</xsl:otherwise>
2496 </xsl:choose>
2497 </xsl:variable>
2498 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
2499 <div><xsl:copy-of select="$verso.content"/></div>
2500 </xsl:if>
2501 <xsl:call-template name="sect2.titlepage.separator"/>
2502 </div>
2503</xsl:template>
2504
2505<xsl:template match="*" mode="sect2.titlepage.recto.mode">
2506 <!-- if an element isn't found in this mode, -->
2507 <!-- try the generic titlepage.mode -->
2508 <xsl:apply-templates select="." mode="titlepage.mode"/>
2509</xsl:template>
2510
2511<xsl:template match="*" mode="sect2.titlepage.verso.mode">
2512 <!-- if an element isn't found in this mode, -->
2513 <!-- try the generic titlepage.mode -->
2514 <xsl:apply-templates select="." mode="titlepage.mode"/>
2515</xsl:template>
2516
2517<xsl:template match="title" mode="sect2.titlepage.recto.auto.mode">
2518<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2519<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2520</div>
2521</xsl:template>
2522
2523<xsl:template match="subtitle" mode="sect2.titlepage.recto.auto.mode">
2524<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2525<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2526</div>
2527</xsl:template>
2528
2529<xsl:template match="corpauthor" mode="sect2.titlepage.recto.auto.mode">
2530<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2531<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2532</div>
2533</xsl:template>
2534
2535<xsl:template match="authorgroup" mode="sect2.titlepage.recto.auto.mode">
2536<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2537<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2538</div>
2539</xsl:template>
2540
2541<xsl:template match="author" mode="sect2.titlepage.recto.auto.mode">
2542<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2543<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2544</div>
2545</xsl:template>
2546
2547<xsl:template match="othercredit" mode="sect2.titlepage.recto.auto.mode">
2548<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2549<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2550</div>
2551</xsl:template>
2552
2553<xsl:template match="releaseinfo" mode="sect2.titlepage.recto.auto.mode">
2554<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2555<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2556</div>
2557</xsl:template>
2558
2559<xsl:template match="copyright" mode="sect2.titlepage.recto.auto.mode">
2560<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2561<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2562</div>
2563</xsl:template>
2564
2565<xsl:template match="legalnotice" mode="sect2.titlepage.recto.auto.mode">
2566<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2567<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2568</div>
2569</xsl:template>
2570
2571<xsl:template match="pubdate" mode="sect2.titlepage.recto.auto.mode">
2572<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2573<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2574</div>
2575</xsl:template>
2576
2577<xsl:template match="revision" mode="sect2.titlepage.recto.auto.mode">
2578<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2579<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2580</div>
2581</xsl:template>
2582
2583<xsl:template match="revhistory" mode="sect2.titlepage.recto.auto.mode">
2584<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2585<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2586</div>
2587</xsl:template>
2588
2589<xsl:template match="abstract" mode="sect2.titlepage.recto.auto.mode">
2590<div xsl:use-attribute-sets="sect2.titlepage.recto.style">
2591<xsl:apply-templates select="." mode="sect2.titlepage.recto.mode"/>
2592</div>
2593</xsl:template>
2594
2595<xsl:template name="sect3.titlepage.recto">
2596 <xsl:choose>
2597 <xsl:when test="sect3info/title">
2598 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/title"/>
2599 </xsl:when>
2600 <xsl:when test="info/title">
2601 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/title"/>
2602 </xsl:when>
2603 <xsl:when test="title">
2604 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="title"/>
2605 </xsl:when>
2606 </xsl:choose>
2607
2608 <xsl:choose>
2609 <xsl:when test="sect3info/subtitle">
2610 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/subtitle"/>
2611 </xsl:when>
2612 <xsl:when test="info/subtitle">
2613 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/subtitle"/>
2614 </xsl:when>
2615 <xsl:when test="subtitle">
2616 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="subtitle"/>
2617 </xsl:when>
2618 </xsl:choose>
2619
2620 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/corpauthor"/>
2621 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/corpauthor"/>
2622 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/authorgroup"/>
2623 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/authorgroup"/>
2624 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/author"/>
2625 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/author"/>
2626 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/othercredit"/>
2627 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/othercredit"/>
2628 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/releaseinfo"/>
2629 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/releaseinfo"/>
2630 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/copyright"/>
2631 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/copyright"/>
2632 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/legalnotice"/>
2633 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/legalnotice"/>
2634 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/pubdate"/>
2635 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/pubdate"/>
2636 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/revision"/>
2637 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/revision"/>
2638 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/revhistory"/>
2639 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/revhistory"/>
2640 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="sect3info/abstract"/>
2641 <xsl:apply-templates mode="sect3.titlepage.recto.auto.mode" select="info/abstract"/>
2642</xsl:template>
2643
2644<xsl:template name="sect3.titlepage.verso">
2645</xsl:template>
2646
2647<xsl:template name="sect3.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
2648</xsl:template>
2649
2650<xsl:template name="sect3.titlepage.before.recto">
2651</xsl:template>
2652
2653<xsl:template name="sect3.titlepage.before.verso">
2654</xsl:template>
2655
2656<xsl:template name="sect3.titlepage">
2657 <div class="titlepage">
2658 <xsl:variable name="recto.content">
2659 <xsl:call-template name="sect3.titlepage.before.recto"/>
2660 <xsl:call-template name="sect3.titlepage.recto"/>
2661 </xsl:variable>
2662 <xsl:variable name="recto.elements.count">
2663 <xsl:choose>
2664 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2665 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2666 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2667 <xsl:otherwise>1</xsl:otherwise>
2668 </xsl:choose>
2669 </xsl:variable>
2670 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
2671 <div><xsl:copy-of select="$recto.content"/></div>
2672 </xsl:if>
2673 <xsl:variable name="verso.content">
2674 <xsl:call-template name="sect3.titlepage.before.verso"/>
2675 <xsl:call-template name="sect3.titlepage.verso"/>
2676 </xsl:variable>
2677 <xsl:variable name="verso.elements.count">
2678 <xsl:choose>
2679 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2680 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2681 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2682 <xsl:otherwise>1</xsl:otherwise>
2683 </xsl:choose>
2684 </xsl:variable>
2685 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
2686 <div><xsl:copy-of select="$verso.content"/></div>
2687 </xsl:if>
2688 <xsl:call-template name="sect3.titlepage.separator"/>
2689 </div>
2690</xsl:template>
2691
2692<xsl:template match="*" mode="sect3.titlepage.recto.mode">
2693 <!-- if an element isn't found in this mode, -->
2694 <!-- try the generic titlepage.mode -->
2695 <xsl:apply-templates select="." mode="titlepage.mode"/>
2696</xsl:template>
2697
2698<xsl:template match="*" mode="sect3.titlepage.verso.mode">
2699 <!-- if an element isn't found in this mode, -->
2700 <!-- try the generic titlepage.mode -->
2701 <xsl:apply-templates select="." mode="titlepage.mode"/>
2702</xsl:template>
2703
2704<xsl:template match="title" mode="sect3.titlepage.recto.auto.mode">
2705<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2706<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2707</div>
2708</xsl:template>
2709
2710<xsl:template match="subtitle" mode="sect3.titlepage.recto.auto.mode">
2711<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2712<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2713</div>
2714</xsl:template>
2715
2716<xsl:template match="corpauthor" mode="sect3.titlepage.recto.auto.mode">
2717<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2718<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2719</div>
2720</xsl:template>
2721
2722<xsl:template match="authorgroup" mode="sect3.titlepage.recto.auto.mode">
2723<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2724<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2725</div>
2726</xsl:template>
2727
2728<xsl:template match="author" mode="sect3.titlepage.recto.auto.mode">
2729<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2730<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2731</div>
2732</xsl:template>
2733
2734<xsl:template match="othercredit" mode="sect3.titlepage.recto.auto.mode">
2735<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2736<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2737</div>
2738</xsl:template>
2739
2740<xsl:template match="releaseinfo" mode="sect3.titlepage.recto.auto.mode">
2741<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2742<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2743</div>
2744</xsl:template>
2745
2746<xsl:template match="copyright" mode="sect3.titlepage.recto.auto.mode">
2747<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2748<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2749</div>
2750</xsl:template>
2751
2752<xsl:template match="legalnotice" mode="sect3.titlepage.recto.auto.mode">
2753<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2754<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2755</div>
2756</xsl:template>
2757
2758<xsl:template match="pubdate" mode="sect3.titlepage.recto.auto.mode">
2759<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2760<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2761</div>
2762</xsl:template>
2763
2764<xsl:template match="revision" mode="sect3.titlepage.recto.auto.mode">
2765<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2766<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2767</div>
2768</xsl:template>
2769
2770<xsl:template match="revhistory" mode="sect3.titlepage.recto.auto.mode">
2771<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2772<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2773</div>
2774</xsl:template>
2775
2776<xsl:template match="abstract" mode="sect3.titlepage.recto.auto.mode">
2777<div xsl:use-attribute-sets="sect3.titlepage.recto.style">
2778<xsl:apply-templates select="." mode="sect3.titlepage.recto.mode"/>
2779</div>
2780</xsl:template>
2781
2782<xsl:template name="sect4.titlepage.recto">
2783 <xsl:choose>
2784 <xsl:when test="sect4info/title">
2785 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/title"/>
2786 </xsl:when>
2787 <xsl:when test="info/title">
2788 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/title"/>
2789 </xsl:when>
2790 <xsl:when test="title">
2791 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="title"/>
2792 </xsl:when>
2793 </xsl:choose>
2794
2795 <xsl:choose>
2796 <xsl:when test="sect4info/subtitle">
2797 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/subtitle"/>
2798 </xsl:when>
2799 <xsl:when test="info/subtitle">
2800 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/subtitle"/>
2801 </xsl:when>
2802 <xsl:when test="subtitle">
2803 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="subtitle"/>
2804 </xsl:when>
2805 </xsl:choose>
2806
2807 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/corpauthor"/>
2808 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/corpauthor"/>
2809 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/authorgroup"/>
2810 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/authorgroup"/>
2811 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/author"/>
2812 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/author"/>
2813 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/othercredit"/>
2814 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/othercredit"/>
2815 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/releaseinfo"/>
2816 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/releaseinfo"/>
2817 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/copyright"/>
2818 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/copyright"/>
2819 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/legalnotice"/>
2820 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/legalnotice"/>
2821 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/pubdate"/>
2822 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/pubdate"/>
2823 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/revision"/>
2824 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/revision"/>
2825 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/revhistory"/>
2826 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/revhistory"/>
2827 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="sect4info/abstract"/>
2828 <xsl:apply-templates mode="sect4.titlepage.recto.auto.mode" select="info/abstract"/>
2829</xsl:template>
2830
2831<xsl:template name="sect4.titlepage.verso">
2832</xsl:template>
2833
2834<xsl:template name="sect4.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
2835</xsl:template>
2836
2837<xsl:template name="sect4.titlepage.before.recto">
2838</xsl:template>
2839
2840<xsl:template name="sect4.titlepage.before.verso">
2841</xsl:template>
2842
2843<xsl:template name="sect4.titlepage">
2844 <div class="titlepage">
2845 <xsl:variable name="recto.content">
2846 <xsl:call-template name="sect4.titlepage.before.recto"/>
2847 <xsl:call-template name="sect4.titlepage.recto"/>
2848 </xsl:variable>
2849 <xsl:variable name="recto.elements.count">
2850 <xsl:choose>
2851 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2852 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2853 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
2854 <xsl:otherwise>1</xsl:otherwise>
2855 </xsl:choose>
2856 </xsl:variable>
2857 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
2858 <div><xsl:copy-of select="$recto.content"/></div>
2859 </xsl:if>
2860 <xsl:variable name="verso.content">
2861 <xsl:call-template name="sect4.titlepage.before.verso"/>
2862 <xsl:call-template name="sect4.titlepage.verso"/>
2863 </xsl:variable>
2864 <xsl:variable name="verso.elements.count">
2865 <xsl:choose>
2866 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2867 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
2868 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
2869 <xsl:otherwise>1</xsl:otherwise>
2870 </xsl:choose>
2871 </xsl:variable>
2872 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
2873 <div><xsl:copy-of select="$verso.content"/></div>
2874 </xsl:if>
2875 <xsl:call-template name="sect4.titlepage.separator"/>
2876 </div>
2877</xsl:template>
2878
2879<xsl:template match="*" mode="sect4.titlepage.recto.mode">
2880 <!-- if an element isn't found in this mode, -->
2881 <!-- try the generic titlepage.mode -->
2882 <xsl:apply-templates select="." mode="titlepage.mode"/>
2883</xsl:template>
2884
2885<xsl:template match="*" mode="sect4.titlepage.verso.mode">
2886 <!-- if an element isn't found in this mode, -->
2887 <!-- try the generic titlepage.mode -->
2888 <xsl:apply-templates select="." mode="titlepage.mode"/>
2889</xsl:template>
2890
2891<xsl:template match="title" mode="sect4.titlepage.recto.auto.mode">
2892<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2893<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2894</div>
2895</xsl:template>
2896
2897<xsl:template match="subtitle" mode="sect4.titlepage.recto.auto.mode">
2898<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2899<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2900</div>
2901</xsl:template>
2902
2903<xsl:template match="corpauthor" mode="sect4.titlepage.recto.auto.mode">
2904<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2905<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2906</div>
2907</xsl:template>
2908
2909<xsl:template match="authorgroup" mode="sect4.titlepage.recto.auto.mode">
2910<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2911<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2912</div>
2913</xsl:template>
2914
2915<xsl:template match="author" mode="sect4.titlepage.recto.auto.mode">
2916<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2917<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2918</div>
2919</xsl:template>
2920
2921<xsl:template match="othercredit" mode="sect4.titlepage.recto.auto.mode">
2922<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2923<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2924</div>
2925</xsl:template>
2926
2927<xsl:template match="releaseinfo" mode="sect4.titlepage.recto.auto.mode">
2928<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2929<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2930</div>
2931</xsl:template>
2932
2933<xsl:template match="copyright" mode="sect4.titlepage.recto.auto.mode">
2934<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2935<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2936</div>
2937</xsl:template>
2938
2939<xsl:template match="legalnotice" mode="sect4.titlepage.recto.auto.mode">
2940<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2941<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2942</div>
2943</xsl:template>
2944
2945<xsl:template match="pubdate" mode="sect4.titlepage.recto.auto.mode">
2946<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2947<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2948</div>
2949</xsl:template>
2950
2951<xsl:template match="revision" mode="sect4.titlepage.recto.auto.mode">
2952<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2953<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2954</div>
2955</xsl:template>
2956
2957<xsl:template match="revhistory" mode="sect4.titlepage.recto.auto.mode">
2958<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2959<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2960</div>
2961</xsl:template>
2962
2963<xsl:template match="abstract" mode="sect4.titlepage.recto.auto.mode">
2964<div xsl:use-attribute-sets="sect4.titlepage.recto.style">
2965<xsl:apply-templates select="." mode="sect4.titlepage.recto.mode"/>
2966</div>
2967</xsl:template>
2968
2969<xsl:template name="sect5.titlepage.recto">
2970 <xsl:choose>
2971 <xsl:when test="sect5info/title">
2972 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/title"/>
2973 </xsl:when>
2974 <xsl:when test="info/title">
2975 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/title"/>
2976 </xsl:when>
2977 <xsl:when test="title">
2978 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="title"/>
2979 </xsl:when>
2980 </xsl:choose>
2981
2982 <xsl:choose>
2983 <xsl:when test="sect5info/subtitle">
2984 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/subtitle"/>
2985 </xsl:when>
2986 <xsl:when test="info/subtitle">
2987 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/subtitle"/>
2988 </xsl:when>
2989 <xsl:when test="subtitle">
2990 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="subtitle"/>
2991 </xsl:when>
2992 </xsl:choose>
2993
2994 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/corpauthor"/>
2995 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/corpauthor"/>
2996 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/authorgroup"/>
2997 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/authorgroup"/>
2998 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/author"/>
2999 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/author"/>
3000 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/othercredit"/>
3001 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/othercredit"/>
3002 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/releaseinfo"/>
3003 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/releaseinfo"/>
3004 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/copyright"/>
3005 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/copyright"/>
3006 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/legalnotice"/>
3007 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/legalnotice"/>
3008 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/pubdate"/>
3009 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/pubdate"/>
3010 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/revision"/>
3011 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/revision"/>
3012 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/revhistory"/>
3013 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/revhistory"/>
3014 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="sect5info/abstract"/>
3015 <xsl:apply-templates mode="sect5.titlepage.recto.auto.mode" select="info/abstract"/>
3016</xsl:template>
3017
3018<xsl:template name="sect5.titlepage.verso">
3019</xsl:template>
3020
3021<xsl:template name="sect5.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
3022</xsl:template>
3023
3024<xsl:template name="sect5.titlepage.before.recto">
3025</xsl:template>
3026
3027<xsl:template name="sect5.titlepage.before.verso">
3028</xsl:template>
3029
3030<xsl:template name="sect5.titlepage">
3031 <div class="titlepage">
3032 <xsl:variable name="recto.content">
3033 <xsl:call-template name="sect5.titlepage.before.recto"/>
3034 <xsl:call-template name="sect5.titlepage.recto"/>
3035 </xsl:variable>
3036 <xsl:variable name="recto.elements.count">
3037 <xsl:choose>
3038 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3039 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3040 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3041 <xsl:otherwise>1</xsl:otherwise>
3042 </xsl:choose>
3043 </xsl:variable>
3044 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3045 <div><xsl:copy-of select="$recto.content"/></div>
3046 </xsl:if>
3047 <xsl:variable name="verso.content">
3048 <xsl:call-template name="sect5.titlepage.before.verso"/>
3049 <xsl:call-template name="sect5.titlepage.verso"/>
3050 </xsl:variable>
3051 <xsl:variable name="verso.elements.count">
3052 <xsl:choose>
3053 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3054 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3055 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3056 <xsl:otherwise>1</xsl:otherwise>
3057 </xsl:choose>
3058 </xsl:variable>
3059 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3060 <div><xsl:copy-of select="$verso.content"/></div>
3061 </xsl:if>
3062 <xsl:call-template name="sect5.titlepage.separator"/>
3063 </div>
3064</xsl:template>
3065
3066<xsl:template match="*" mode="sect5.titlepage.recto.mode">
3067 <!-- if an element isn't found in this mode, -->
3068 <!-- try the generic titlepage.mode -->
3069 <xsl:apply-templates select="." mode="titlepage.mode"/>
3070</xsl:template>
3071
3072<xsl:template match="*" mode="sect5.titlepage.verso.mode">
3073 <!-- if an element isn't found in this mode, -->
3074 <!-- try the generic titlepage.mode -->
3075 <xsl:apply-templates select="." mode="titlepage.mode"/>
3076</xsl:template>
3077
3078<xsl:template match="title" mode="sect5.titlepage.recto.auto.mode">
3079<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3080<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3081</div>
3082</xsl:template>
3083
3084<xsl:template match="subtitle" mode="sect5.titlepage.recto.auto.mode">
3085<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3086<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3087</div>
3088</xsl:template>
3089
3090<xsl:template match="corpauthor" mode="sect5.titlepage.recto.auto.mode">
3091<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3092<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3093</div>
3094</xsl:template>
3095
3096<xsl:template match="authorgroup" mode="sect5.titlepage.recto.auto.mode">
3097<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3098<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3099</div>
3100</xsl:template>
3101
3102<xsl:template match="author" mode="sect5.titlepage.recto.auto.mode">
3103<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3104<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3105</div>
3106</xsl:template>
3107
3108<xsl:template match="othercredit" mode="sect5.titlepage.recto.auto.mode">
3109<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3110<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3111</div>
3112</xsl:template>
3113
3114<xsl:template match="releaseinfo" mode="sect5.titlepage.recto.auto.mode">
3115<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3116<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3117</div>
3118</xsl:template>
3119
3120<xsl:template match="copyright" mode="sect5.titlepage.recto.auto.mode">
3121<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3122<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3123</div>
3124</xsl:template>
3125
3126<xsl:template match="legalnotice" mode="sect5.titlepage.recto.auto.mode">
3127<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3128<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3129</div>
3130</xsl:template>
3131
3132<xsl:template match="pubdate" mode="sect5.titlepage.recto.auto.mode">
3133<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3134<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3135</div>
3136</xsl:template>
3137
3138<xsl:template match="revision" mode="sect5.titlepage.recto.auto.mode">
3139<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3140<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3141</div>
3142</xsl:template>
3143
3144<xsl:template match="revhistory" mode="sect5.titlepage.recto.auto.mode">
3145<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3146<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3147</div>
3148</xsl:template>
3149
3150<xsl:template match="abstract" mode="sect5.titlepage.recto.auto.mode">
3151<div xsl:use-attribute-sets="sect5.titlepage.recto.style">
3152<xsl:apply-templates select="." mode="sect5.titlepage.recto.mode"/>
3153</div>
3154</xsl:template>
3155
3156<xsl:template name="simplesect.titlepage.recto">
3157 <xsl:choose>
3158 <xsl:when test="simplesectinfo/title">
3159 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/title"/>
3160 </xsl:when>
3161 <xsl:when test="docinfo/title">
3162 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/title"/>
3163 </xsl:when>
3164 <xsl:when test="info/title">
3165 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/title"/>
3166 </xsl:when>
3167 <xsl:when test="title">
3168 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="title"/>
3169 </xsl:when>
3170 </xsl:choose>
3171
3172 <xsl:choose>
3173 <xsl:when test="simplesectinfo/subtitle">
3174 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/subtitle"/>
3175 </xsl:when>
3176 <xsl:when test="docinfo/subtitle">
3177 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
3178 </xsl:when>
3179 <xsl:when test="info/subtitle">
3180 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/subtitle"/>
3181 </xsl:when>
3182 <xsl:when test="subtitle">
3183 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="subtitle"/>
3184 </xsl:when>
3185 </xsl:choose>
3186
3187 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/corpauthor"/>
3188 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/corpauthor"/>
3189 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/corpauthor"/>
3190 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/authorgroup"/>
3191 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/authorgroup"/>
3192 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/authorgroup"/>
3193 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/author"/>
3194 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/author"/>
3195 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/author"/>
3196 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/othercredit"/>
3197 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/othercredit"/>
3198 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/othercredit"/>
3199 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/releaseinfo"/>
3200 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/releaseinfo"/>
3201 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/releaseinfo"/>
3202 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/copyright"/>
3203 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/copyright"/>
3204 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/copyright"/>
3205 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/legalnotice"/>
3206 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/legalnotice"/>
3207 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/legalnotice"/>
3208 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/pubdate"/>
3209 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/pubdate"/>
3210 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/pubdate"/>
3211 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/revision"/>
3212 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/revision"/>
3213 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/revision"/>
3214 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/revhistory"/>
3215 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/revhistory"/>
3216 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/revhistory"/>
3217 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="simplesectinfo/abstract"/>
3218 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="docinfo/abstract"/>
3219 <xsl:apply-templates mode="simplesect.titlepage.recto.auto.mode" select="info/abstract"/>
3220</xsl:template>
3221
3222<xsl:template name="simplesect.titlepage.verso">
3223</xsl:template>
3224
3225<xsl:template name="simplesect.titlepage.separator"><xsl:if test="count(parent::*)='0'"><hr/></xsl:if>
3226</xsl:template>
3227
3228<xsl:template name="simplesect.titlepage.before.recto">
3229</xsl:template>
3230
3231<xsl:template name="simplesect.titlepage.before.verso">
3232</xsl:template>
3233
3234<xsl:template name="simplesect.titlepage">
3235 <div class="titlepage">
3236 <xsl:variable name="recto.content">
3237 <xsl:call-template name="simplesect.titlepage.before.recto"/>
3238 <xsl:call-template name="simplesect.titlepage.recto"/>
3239 </xsl:variable>
3240 <xsl:variable name="recto.elements.count">
3241 <xsl:choose>
3242 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3243 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3244 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3245 <xsl:otherwise>1</xsl:otherwise>
3246 </xsl:choose>
3247 </xsl:variable>
3248 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3249 <div><xsl:copy-of select="$recto.content"/></div>
3250 </xsl:if>
3251 <xsl:variable name="verso.content">
3252 <xsl:call-template name="simplesect.titlepage.before.verso"/>
3253 <xsl:call-template name="simplesect.titlepage.verso"/>
3254 </xsl:variable>
3255 <xsl:variable name="verso.elements.count">
3256 <xsl:choose>
3257 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3258 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3259 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3260 <xsl:otherwise>1</xsl:otherwise>
3261 </xsl:choose>
3262 </xsl:variable>
3263 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3264 <div><xsl:copy-of select="$verso.content"/></div>
3265 </xsl:if>
3266 <xsl:call-template name="simplesect.titlepage.separator"/>
3267 </div>
3268</xsl:template>
3269
3270<xsl:template match="*" mode="simplesect.titlepage.recto.mode">
3271 <!-- if an element isn't found in this mode, -->
3272 <!-- try the generic titlepage.mode -->
3273 <xsl:apply-templates select="." mode="titlepage.mode"/>
3274</xsl:template>
3275
3276<xsl:template match="*" mode="simplesect.titlepage.verso.mode">
3277 <!-- if an element isn't found in this mode, -->
3278 <!-- try the generic titlepage.mode -->
3279 <xsl:apply-templates select="." mode="titlepage.mode"/>
3280</xsl:template>
3281
3282<xsl:template match="title" mode="simplesect.titlepage.recto.auto.mode">
3283<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3284<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3285</div>
3286</xsl:template>
3287
3288<xsl:template match="subtitle" mode="simplesect.titlepage.recto.auto.mode">
3289<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3290<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3291</div>
3292</xsl:template>
3293
3294<xsl:template match="corpauthor" mode="simplesect.titlepage.recto.auto.mode">
3295<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3296<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3297</div>
3298</xsl:template>
3299
3300<xsl:template match="authorgroup" mode="simplesect.titlepage.recto.auto.mode">
3301<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3302<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3303</div>
3304</xsl:template>
3305
3306<xsl:template match="author" mode="simplesect.titlepage.recto.auto.mode">
3307<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3308<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3309</div>
3310</xsl:template>
3311
3312<xsl:template match="othercredit" mode="simplesect.titlepage.recto.auto.mode">
3313<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3314<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3315</div>
3316</xsl:template>
3317
3318<xsl:template match="releaseinfo" mode="simplesect.titlepage.recto.auto.mode">
3319<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3320<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3321</div>
3322</xsl:template>
3323
3324<xsl:template match="copyright" mode="simplesect.titlepage.recto.auto.mode">
3325<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3326<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3327</div>
3328</xsl:template>
3329
3330<xsl:template match="legalnotice" mode="simplesect.titlepage.recto.auto.mode">
3331<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3332<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3333</div>
3334</xsl:template>
3335
3336<xsl:template match="pubdate" mode="simplesect.titlepage.recto.auto.mode">
3337<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3338<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3339</div>
3340</xsl:template>
3341
3342<xsl:template match="revision" mode="simplesect.titlepage.recto.auto.mode">
3343<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3344<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3345</div>
3346</xsl:template>
3347
3348<xsl:template match="revhistory" mode="simplesect.titlepage.recto.auto.mode">
3349<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3350<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3351</div>
3352</xsl:template>
3353
3354<xsl:template match="abstract" mode="simplesect.titlepage.recto.auto.mode">
3355<div xsl:use-attribute-sets="simplesect.titlepage.recto.style">
3356<xsl:apply-templates select="." mode="simplesect.titlepage.recto.mode"/>
3357</div>
3358</xsl:template>
3359
3360<xsl:template name="bibliography.titlepage.recto">
3361 <div xsl:use-attribute-sets="bibliography.titlepage.recto.style">
3362<xsl:call-template name="component.title">
3363<xsl:with-param name="node" select="ancestor-or-self::bibliography[1]"/>
3364</xsl:call-template></div>
3365 <xsl:choose>
3366 <xsl:when test="bibliographyinfo/subtitle">
3367 <xsl:apply-templates mode="bibliography.titlepage.recto.auto.mode" select="bibliographyinfo/subtitle"/>
3368 </xsl:when>
3369 <xsl:when test="docinfo/subtitle">
3370 <xsl:apply-templates mode="bibliography.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
3371 </xsl:when>
3372 <xsl:when test="info/subtitle">
3373 <xsl:apply-templates mode="bibliography.titlepage.recto.auto.mode" select="info/subtitle"/>
3374 </xsl:when>
3375 <xsl:when test="subtitle">
3376 <xsl:apply-templates mode="bibliography.titlepage.recto.auto.mode" select="subtitle"/>
3377 </xsl:when>
3378 </xsl:choose>
3379
3380</xsl:template>
3381
3382<xsl:template name="bibliography.titlepage.verso">
3383</xsl:template>
3384
3385<xsl:template name="bibliography.titlepage.separator">
3386</xsl:template>
3387
3388<xsl:template name="bibliography.titlepage.before.recto">
3389</xsl:template>
3390
3391<xsl:template name="bibliography.titlepage.before.verso">
3392</xsl:template>
3393
3394<xsl:template name="bibliography.titlepage">
3395 <div class="titlepage">
3396 <xsl:variable name="recto.content">
3397 <xsl:call-template name="bibliography.titlepage.before.recto"/>
3398 <xsl:call-template name="bibliography.titlepage.recto"/>
3399 </xsl:variable>
3400 <xsl:variable name="recto.elements.count">
3401 <xsl:choose>
3402 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3403 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3404 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3405 <xsl:otherwise>1</xsl:otherwise>
3406 </xsl:choose>
3407 </xsl:variable>
3408 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3409 <div><xsl:copy-of select="$recto.content"/></div>
3410 </xsl:if>
3411 <xsl:variable name="verso.content">
3412 <xsl:call-template name="bibliography.titlepage.before.verso"/>
3413 <xsl:call-template name="bibliography.titlepage.verso"/>
3414 </xsl:variable>
3415 <xsl:variable name="verso.elements.count">
3416 <xsl:choose>
3417 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3418 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3419 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3420 <xsl:otherwise>1</xsl:otherwise>
3421 </xsl:choose>
3422 </xsl:variable>
3423 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3424 <div><xsl:copy-of select="$verso.content"/></div>
3425 </xsl:if>
3426 <xsl:call-template name="bibliography.titlepage.separator"/>
3427 </div>
3428</xsl:template>
3429
3430<xsl:template match="*" mode="bibliography.titlepage.recto.mode">
3431 <!-- if an element isn't found in this mode, -->
3432 <!-- try the generic titlepage.mode -->
3433 <xsl:apply-templates select="." mode="titlepage.mode"/>
3434</xsl:template>
3435
3436<xsl:template match="*" mode="bibliography.titlepage.verso.mode">
3437 <!-- if an element isn't found in this mode, -->
3438 <!-- try the generic titlepage.mode -->
3439 <xsl:apply-templates select="." mode="titlepage.mode"/>
3440</xsl:template>
3441
3442<xsl:template match="subtitle" mode="bibliography.titlepage.recto.auto.mode">
3443<div xsl:use-attribute-sets="bibliography.titlepage.recto.style">
3444<xsl:apply-templates select="." mode="bibliography.titlepage.recto.mode"/>
3445</div>
3446</xsl:template>
3447
3448<xsl:template name="glossary.titlepage.recto">
3449 <div xsl:use-attribute-sets="glossary.titlepage.recto.style">
3450<xsl:call-template name="component.title">
3451<xsl:with-param name="node" select="ancestor-or-self::glossary[1]"/>
3452</xsl:call-template></div>
3453 <xsl:choose>
3454 <xsl:when test="glossaryinfo/subtitle">
3455 <xsl:apply-templates mode="glossary.titlepage.recto.auto.mode" select="glossaryinfo/subtitle"/>
3456 </xsl:when>
3457 <xsl:when test="docinfo/subtitle">
3458 <xsl:apply-templates mode="glossary.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
3459 </xsl:when>
3460 <xsl:when test="info/subtitle">
3461 <xsl:apply-templates mode="glossary.titlepage.recto.auto.mode" select="info/subtitle"/>
3462 </xsl:when>
3463 <xsl:when test="subtitle">
3464 <xsl:apply-templates mode="glossary.titlepage.recto.auto.mode" select="subtitle"/>
3465 </xsl:when>
3466 </xsl:choose>
3467
3468</xsl:template>
3469
3470<xsl:template name="glossary.titlepage.verso">
3471</xsl:template>
3472
3473<xsl:template name="glossary.titlepage.separator">
3474</xsl:template>
3475
3476<xsl:template name="glossary.titlepage.before.recto">
3477</xsl:template>
3478
3479<xsl:template name="glossary.titlepage.before.verso">
3480</xsl:template>
3481
3482<xsl:template name="glossary.titlepage">
3483 <div class="titlepage">
3484 <xsl:variable name="recto.content">
3485 <xsl:call-template name="glossary.titlepage.before.recto"/>
3486 <xsl:call-template name="glossary.titlepage.recto"/>
3487 </xsl:variable>
3488 <xsl:variable name="recto.elements.count">
3489 <xsl:choose>
3490 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3491 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3492 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3493 <xsl:otherwise>1</xsl:otherwise>
3494 </xsl:choose>
3495 </xsl:variable>
3496 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3497 <div><xsl:copy-of select="$recto.content"/></div>
3498 </xsl:if>
3499 <xsl:variable name="verso.content">
3500 <xsl:call-template name="glossary.titlepage.before.verso"/>
3501 <xsl:call-template name="glossary.titlepage.verso"/>
3502 </xsl:variable>
3503 <xsl:variable name="verso.elements.count">
3504 <xsl:choose>
3505 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3506 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3507 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3508 <xsl:otherwise>1</xsl:otherwise>
3509 </xsl:choose>
3510 </xsl:variable>
3511 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3512 <div><xsl:copy-of select="$verso.content"/></div>
3513 </xsl:if>
3514 <xsl:call-template name="glossary.titlepage.separator"/>
3515 </div>
3516</xsl:template>
3517
3518<xsl:template match="*" mode="glossary.titlepage.recto.mode">
3519 <!-- if an element isn't found in this mode, -->
3520 <!-- try the generic titlepage.mode -->
3521 <xsl:apply-templates select="." mode="titlepage.mode"/>
3522</xsl:template>
3523
3524<xsl:template match="*" mode="glossary.titlepage.verso.mode">
3525 <!-- if an element isn't found in this mode, -->
3526 <!-- try the generic titlepage.mode -->
3527 <xsl:apply-templates select="." mode="titlepage.mode"/>
3528</xsl:template>
3529
3530<xsl:template match="subtitle" mode="glossary.titlepage.recto.auto.mode">
3531<div xsl:use-attribute-sets="glossary.titlepage.recto.style">
3532<xsl:apply-templates select="." mode="glossary.titlepage.recto.mode"/>
3533</div>
3534</xsl:template>
3535
3536<xsl:template name="index.titlepage.recto">
3537 <div xsl:use-attribute-sets="index.titlepage.recto.style">
3538<xsl:call-template name="component.title">
3539<xsl:with-param name="node" select="ancestor-or-self::index[1]"/>
3540</xsl:call-template></div>
3541 <xsl:choose>
3542 <xsl:when test="indexinfo/subtitle">
3543 <xsl:apply-templates mode="index.titlepage.recto.auto.mode" select="indexinfo/subtitle"/>
3544 </xsl:when>
3545 <xsl:when test="docinfo/subtitle">
3546 <xsl:apply-templates mode="index.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
3547 </xsl:when>
3548 <xsl:when test="info/subtitle">
3549 <xsl:apply-templates mode="index.titlepage.recto.auto.mode" select="info/subtitle"/>
3550 </xsl:when>
3551 <xsl:when test="subtitle">
3552 <xsl:apply-templates mode="index.titlepage.recto.auto.mode" select="subtitle"/>
3553 </xsl:when>
3554 </xsl:choose>
3555
3556</xsl:template>
3557
3558<xsl:template name="index.titlepage.verso">
3559</xsl:template>
3560
3561<xsl:template name="index.titlepage.separator">
3562</xsl:template>
3563
3564<xsl:template name="index.titlepage.before.recto">
3565</xsl:template>
3566
3567<xsl:template name="index.titlepage.before.verso">
3568</xsl:template>
3569
3570<xsl:template name="index.titlepage">
3571 <div class="titlepage">
3572 <xsl:variable name="recto.content">
3573 <xsl:call-template name="index.titlepage.before.recto"/>
3574 <xsl:call-template name="index.titlepage.recto"/>
3575 </xsl:variable>
3576 <xsl:variable name="recto.elements.count">
3577 <xsl:choose>
3578 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3579 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3580 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3581 <xsl:otherwise>1</xsl:otherwise>
3582 </xsl:choose>
3583 </xsl:variable>
3584 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3585 <div><xsl:copy-of select="$recto.content"/></div>
3586 </xsl:if>
3587 <xsl:variable name="verso.content">
3588 <xsl:call-template name="index.titlepage.before.verso"/>
3589 <xsl:call-template name="index.titlepage.verso"/>
3590 </xsl:variable>
3591 <xsl:variable name="verso.elements.count">
3592 <xsl:choose>
3593 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3594 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3595 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3596 <xsl:otherwise>1</xsl:otherwise>
3597 </xsl:choose>
3598 </xsl:variable>
3599 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3600 <div><xsl:copy-of select="$verso.content"/></div>
3601 </xsl:if>
3602 <xsl:call-template name="index.titlepage.separator"/>
3603 </div>
3604</xsl:template>
3605
3606<xsl:template match="*" mode="index.titlepage.recto.mode">
3607 <!-- if an element isn't found in this mode, -->
3608 <!-- try the generic titlepage.mode -->
3609 <xsl:apply-templates select="." mode="titlepage.mode"/>
3610</xsl:template>
3611
3612<xsl:template match="*" mode="index.titlepage.verso.mode">
3613 <!-- if an element isn't found in this mode, -->
3614 <!-- try the generic titlepage.mode -->
3615 <xsl:apply-templates select="." mode="titlepage.mode"/>
3616</xsl:template>
3617
3618<xsl:template match="subtitle" mode="index.titlepage.recto.auto.mode">
3619<div xsl:use-attribute-sets="index.titlepage.recto.style">
3620<xsl:apply-templates select="." mode="index.titlepage.recto.mode"/>
3621</div>
3622</xsl:template>
3623
3624<xsl:template name="setindex.titlepage.recto">
3625 <div xsl:use-attribute-sets="setindex.titlepage.recto.style">
3626<xsl:call-template name="component.title">
3627<xsl:with-param name="node" select="ancestor-or-self::setindex[1]"/>
3628</xsl:call-template></div>
3629 <xsl:choose>
3630 <xsl:when test="setindexinfo/subtitle">
3631 <xsl:apply-templates mode="setindex.titlepage.recto.auto.mode" select="setindexinfo/subtitle"/>
3632 </xsl:when>
3633 <xsl:when test="docinfo/subtitle">
3634 <xsl:apply-templates mode="setindex.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
3635 </xsl:when>
3636 <xsl:when test="info/subtitle">
3637 <xsl:apply-templates mode="setindex.titlepage.recto.auto.mode" select="info/subtitle"/>
3638 </xsl:when>
3639 <xsl:when test="subtitle">
3640 <xsl:apply-templates mode="setindex.titlepage.recto.auto.mode" select="subtitle"/>
3641 </xsl:when>
3642 </xsl:choose>
3643
3644</xsl:template>
3645
3646<xsl:template name="setindex.titlepage.verso">
3647</xsl:template>
3648
3649<xsl:template name="setindex.titlepage.separator">
3650</xsl:template>
3651
3652<xsl:template name="setindex.titlepage.before.recto">
3653</xsl:template>
3654
3655<xsl:template name="setindex.titlepage.before.verso">
3656</xsl:template>
3657
3658<xsl:template name="setindex.titlepage">
3659 <div class="titlepage">
3660 <xsl:variable name="recto.content">
3661 <xsl:call-template name="setindex.titlepage.before.recto"/>
3662 <xsl:call-template name="setindex.titlepage.recto"/>
3663 </xsl:variable>
3664 <xsl:variable name="recto.elements.count">
3665 <xsl:choose>
3666 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3667 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3668 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3669 <xsl:otherwise>1</xsl:otherwise>
3670 </xsl:choose>
3671 </xsl:variable>
3672 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3673 <div><xsl:copy-of select="$recto.content"/></div>
3674 </xsl:if>
3675 <xsl:variable name="verso.content">
3676 <xsl:call-template name="setindex.titlepage.before.verso"/>
3677 <xsl:call-template name="setindex.titlepage.verso"/>
3678 </xsl:variable>
3679 <xsl:variable name="verso.elements.count">
3680 <xsl:choose>
3681 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3682 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3683 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3684 <xsl:otherwise>1</xsl:otherwise>
3685 </xsl:choose>
3686 </xsl:variable>
3687 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3688 <div><xsl:copy-of select="$verso.content"/></div>
3689 </xsl:if>
3690 <xsl:call-template name="setindex.titlepage.separator"/>
3691 </div>
3692</xsl:template>
3693
3694<xsl:template match="*" mode="setindex.titlepage.recto.mode">
3695 <!-- if an element isn't found in this mode, -->
3696 <!-- try the generic titlepage.mode -->
3697 <xsl:apply-templates select="." mode="titlepage.mode"/>
3698</xsl:template>
3699
3700<xsl:template match="*" mode="setindex.titlepage.verso.mode">
3701 <!-- if an element isn't found in this mode, -->
3702 <!-- try the generic titlepage.mode -->
3703 <xsl:apply-templates select="." mode="titlepage.mode"/>
3704</xsl:template>
3705
3706<xsl:template match="subtitle" mode="setindex.titlepage.recto.auto.mode">
3707<div xsl:use-attribute-sets="setindex.titlepage.recto.style">
3708<xsl:apply-templates select="." mode="setindex.titlepage.recto.mode"/>
3709</div>
3710</xsl:template>
3711
3712<xsl:template name="sidebar.titlepage.recto">
3713 <xsl:choose>
3714 <xsl:when test="sidebarinfo/title">
3715 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="sidebarinfo/title"/>
3716 </xsl:when>
3717 <xsl:when test="docinfo/title">
3718 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="docinfo/title"/>
3719 </xsl:when>
3720 <xsl:when test="info/title">
3721 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="info/title"/>
3722 </xsl:when>
3723 <xsl:when test="title">
3724 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="title"/>
3725 </xsl:when>
3726 </xsl:choose>
3727
3728 <xsl:choose>
3729 <xsl:when test="sidebarinfo/subtitle">
3730 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="sidebarinfo/subtitle"/>
3731 </xsl:when>
3732 <xsl:when test="docinfo/subtitle">
3733 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="docinfo/subtitle"/>
3734 </xsl:when>
3735 <xsl:when test="info/subtitle">
3736 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="info/subtitle"/>
3737 </xsl:when>
3738 <xsl:when test="subtitle">
3739 <xsl:apply-templates mode="sidebar.titlepage.recto.auto.mode" select="subtitle"/>
3740 </xsl:when>
3741 </xsl:choose>
3742
3743</xsl:template>
3744
3745<xsl:template name="sidebar.titlepage.verso">
3746</xsl:template>
3747
3748<xsl:template name="sidebar.titlepage.separator">
3749</xsl:template>
3750
3751<xsl:template name="sidebar.titlepage.before.recto">
3752</xsl:template>
3753
3754<xsl:template name="sidebar.titlepage.before.verso">
3755</xsl:template>
3756
3757<xsl:template name="sidebar.titlepage">
3758 <div class="titlepage">
3759 <xsl:variable name="recto.content">
3760 <xsl:call-template name="sidebar.titlepage.before.recto"/>
3761 <xsl:call-template name="sidebar.titlepage.recto"/>
3762 </xsl:variable>
3763 <xsl:variable name="recto.elements.count">
3764 <xsl:choose>
3765 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3766 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3767 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when>
3768 <xsl:otherwise>1</xsl:otherwise>
3769 </xsl:choose>
3770 </xsl:variable>
3771 <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count &gt; 0)">
3772 <div><xsl:copy-of select="$recto.content"/></div>
3773 </xsl:if>
3774 <xsl:variable name="verso.content">
3775 <xsl:call-template name="sidebar.titlepage.before.verso"/>
3776 <xsl:call-template name="sidebar.titlepage.verso"/>
3777 </xsl:variable>
3778 <xsl:variable name="verso.elements.count">
3779 <xsl:choose>
3780 <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3781 <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')">
3782 <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when>
3783 <xsl:otherwise>1</xsl:otherwise>
3784 </xsl:choose>
3785 </xsl:variable>
3786 <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count &gt; 0)">
3787 <div><xsl:copy-of select="$verso.content"/></div>
3788 </xsl:if>
3789 <xsl:call-template name="sidebar.titlepage.separator"/>
3790 </div>
3791</xsl:template>
3792
3793<xsl:template match="*" mode="sidebar.titlepage.recto.mode">
3794 <!-- if an element isn't found in this mode, -->
3795 <!-- try the generic titlepage.mode -->
3796 <xsl:apply-templates select="." mode="titlepage.mode"/>
3797</xsl:template>
3798
3799<xsl:template match="*" mode="sidebar.titlepage.verso.mode">
3800 <!-- if an element isn't found in this mode, -->
3801 <!-- try the generic titlepage.mode -->
3802 <xsl:apply-templates select="." mode="titlepage.mode"/>
3803</xsl:template>
3804
3805<xsl:template match="title" mode="sidebar.titlepage.recto.auto.mode">
3806<div xsl:use-attribute-sets="sidebar.titlepage.recto.style">
3807<xsl:call-template name="formal.object.heading">
3808<xsl:with-param name="object" select="ancestor-or-self::sidebar[1]"/>
3809</xsl:call-template>
3810</div>
3811</xsl:template>
3812
3813<xsl:template match="subtitle" mode="sidebar.titlepage.recto.auto.mode">
3814<div xsl:use-attribute-sets="sidebar.titlepage.recto.style">
3815<xsl:apply-templates select="." mode="sidebar.titlepage.recto.mode"/>
3816</div>
3817</xsl:template>
3818
3819</xsl:stylesheet>
3820
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
new file mode 100644
index 0000000000..3d6f98d5d5
--- /dev/null
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -0,0 +1,963 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<article id='intro'>
6 <articleinfo>
7 <title>Yocto Project Quick Start</title>
8
9 <copyright>
10 <year>&COPYRIGHT_YEAR;</year>
11 <holder>Linux Foundation</holder>
12 </copyright>
13
14 <legalnotice>
15 <para>
16 Permission is granted to copy, distribute and/or modify this document under
17 the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
18 </para>
19 <note>
20 For the latest version of this manual associated with this
21 Yocto Project release, see the
22 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>
23 from the Yocto Project website.
24 </note>
25 </legalnotice>
26
27
28 <abstract>
29 <imagedata fileref="figures/yocto-project-transp.png"
30 width="6in" depth="1in"
31 align="right" scale="25" />
32 </abstract>
33 </articleinfo>
34
35<section id='welcome'>
36 <title>Welcome!</title>
37 <para>
38 Welcome to the Yocto Project!
39 The Yocto Project is an open-source collaboration project focused on embedded Linux
40 developers.
41 Among other things, the Yocto Project uses a build system based on the Poky project
42 to construct complete Linux images.
43 The Poky project, in turn, draws from and contributes back to the OpenEmbedded project.
44 </para>
45
46 <para>
47 If you don't have a system that runs Linux and you want to give the Yocto Project a test run,
48 you might consider using the Yocto Project Build Appliance.
49 The Build Appliance allows you to build and boot a custom embedded Linux image with the Yocto
50 Project using a non-Linux development system.
51 See the <ulink url='http://www.yoctoproject.org/documentation/build-appliance'>Yocto
52 Project Build Appliance</ulink> for more information.
53 </para>
54
55 <para>
56 On the other hand, if you know all about open-source development, Linux development environments,
57 Git source repositories and the like and you just want some quick information that lets you try out
58 the Yocto Project on your Linux system, skip right to the
59 "<link linkend='super-user'>Super User</link>" section at the end of this quick start.
60 </para>
61
62 <para>
63 For the rest of you, this short document will give you some basic information about the environment and
64 let you experience it in its simplest form.
65 After reading this document, you will have a basic understanding of what the Yocto Project is
66 and how to use some of its core components.
67 This document steps you through a simple example showing you how to build a small image
68 and run it using the Quick EMUlator (QEMU emulator).
69 </para>
70
71 <para>
72 For more detailed information on the Yocto Project, you should check out these resources:
73 <itemizedlist>
74 <listitem><para><emphasis>Website:</emphasis> The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>
75 provides the latest builds, breaking news, full development documentation, and a rich Yocto
76 Project Development Community into which you can tap.
77 </para></listitem>
78 <listitem><para><emphasis>FAQs:</emphasis> Lists commonly asked Yocto Project questions and answers.
79 You can find two FAQs: <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink> on
80 a wiki, and the
81 "<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink>" chapter in
82 the Yocto Project Reference Manual.
83 </para></listitem>
84 <listitem><para><emphasis>Developer Screencast:</emphasis> The
85 <ulink url='http://vimeo.com/36450321'>Getting Started with the Yocto Project - New
86 Developer Screencast Tutorial</ulink> provides a 30-minute video for the user
87 new to the Yocto Project but familiar with Linux build systems.</para></listitem>
88 </itemizedlist>
89 </para>
90</section>
91
92<section id='yp-intro'>
93 <title>Introducing the Yocto Project Development Environment</title>
94 <para>
95 The Yocto Project through the OpenEmbedded build system provides an open source development
96 environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of
97 platforms including x86-64 and emulated ones.
98 You can use components from the Yocto Project to design, develop, build, debug, simulate,
99 and test the complete software stack using Linux, the X Window System, GNOME Mobile-based
100 application frameworks, and Qt frameworks.
101 </para>
102
103 <mediaobject>
104 <imageobject>
105 <imagedata fileref="figures/yocto-environment.png"
106 format="PNG" align='center' scalefit='1' width="100%"/>
107 </imageobject>
108 <caption>
109 <para>The Yocto Project Development Environment</para>
110 </caption>
111 </mediaobject>
112
113 <para>
114 Here are some highlights for the Yocto Project:
115 </para>
116
117 <itemizedlist>
118 <listitem>
119 <para>Provides a recent Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para>
120 </listitem>
121 <listitem>
122 <para>Makes available system components such as X11, GTK+, Qt, Clutter, and SDL
123 (among others) so you can create a rich user experience on devices
124 that have display hardware.
125 For devices that don't have a display or where you wish to use alternative UI
126 frameworks, these components need not be installed.</para>
127 </listitem>
128 <listitem>
129 <para>Creates a focused and stable core compatible with the OpenEmbedded
130 project with which you can easily and reliably build and develop.</para>
131 </listitem>
132 <listitem>
133 <para>Fully supports a wide range of hardware and device emulation through the QEMU
134 Emulator.</para>
135 </listitem>
136 </itemizedlist>
137
138 <para>
139 The Yocto Project can generate images for many kinds of devices.
140 However, the standard example machines target QEMU full-system emulation for x86, x86-64, ARM, MIPS,
141 and PPC-based architectures as well as specific hardware such as the
142 <trademark class='registered'>Intel</trademark> Desktop Board DH55TC.
143 Because an image developed with the Yocto Project can boot inside a QEMU emulator, the
144 development environment works nicely as a test platform for developing embedded software.
145 </para>
146
147 <para>
148 Another important Yocto Project feature is the Sato reference User Interface.
149 This optional GNOME mobile-based UI, which is intended for devices with
150 restricted screen sizes, sits neatly on top of a device using the
151 GNOME Mobile Stack and provides a well-defined user experience.
152 Implemented in its own layer, it makes it clear to developers how they can implement
153 their own user interface on top of a Linux image created with the Yocto Project.
154 </para>
155</section>
156
157<section id='yp-resources'>
158 <title>What You Need and How You Get It</title>
159
160 <para>
161 You need these things to develop in the Yocto Project environment:
162 </para>
163
164 <itemizedlist>
165 <listitem>
166 <para>A host system running a supported Linux distribution
167 (i.e. recent releases of Fedora, openSUSE, CentOS, Debian,
168 and Ubuntu).
169 If the host system supports multiple cores and threads, you can configure the
170 Yocto Project build system to decrease the time needed to build images
171 significantly.
172 </para>
173 </listitem>
174 <listitem>
175 <para>The right packages.</para>
176 </listitem>
177 <listitem>
178 <para>A release of the Yocto Project.</para>
179 </listitem>
180 </itemizedlist>
181
182 <section id='the-linux-distro'>
183 <title>The Linux Distribution</title>
184
185 <para>
186 The Yocto Project team is continually verifying more and more Linux
187 distributions with each release.
188 In general, if you have the current release minus one of the following
189 distributions you should have no problems.
190 <itemizedlist>
191 <listitem><para>Ubuntu</para></listitem>
192 <listitem><para>Fedora</para></listitem>
193 <listitem><para>openSUSE</para></listitem>
194 <listitem><para>CentOS</para></listitem>
195 <listitem><para>Debian</para></listitem>
196 </itemizedlist>
197 For a more detailed list of distributions that support the Yocto Project,
198 see the
199 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section
200 in the Yocto Project Reference Manual.
201 </para>
202 <para>
203 The OpenEmbedded build system should be able to run on any modern
204 distribution that has the following versions for Git, tar, and
205 Python.
206 <itemizedlist>
207 <listitem><para>Git 1.7.5 or greater</para></listitem>
208 <listitem><para>tar 1.24 or greater</para></listitem>
209 <listitem><para>Python 2.7.3 or greater excluding Python
210 3.x, which is not supported.</para></listitem>
211 </itemizedlist>
212 Earlier releases of Python are known to not work and the system
213 does not support Python 3 at this time.
214 If your system does not meet any of these three listed
215 version requirements, you can
216 take steps to prepare the system so that you can still use the build
217 system.
218 See the
219 "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</ulink>"
220 section in the Yocto Project Reference Manual for information.
221 </para>
222 <para>
223 This document assumes you are running one of the previously noted
224 distributions on your Linux-based host systems.
225 </para>
226 <note>
227 <para>
228 If you attempt to use a distribution not in the above list,
229 you may or may not have success.
230 Yocto Project releases are tested against the stable Linux
231 distributions listed in the
232 "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>"
233 section of the Yocto Project Reference Manual.
234 Refer to
235 <ulink url='&OE_HOME_URL;/index.php?title=OEandYourDistro'>OE and Your Distro</ulink> and
236 <ulink url='&OE_HOME_URL;/index.php?title=Required_software'>Required Software</ulink>
237 for information for information about dependencies and
238 requirements.
239 If you encounter problems, please go to
240 <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink>
241 and submit a bug.
242 We are interested in hearing about your experience.
243 </para>
244 </note>
245 </section>
246
247 <section id='packages'>
248 <title>The Packages</title>
249
250 <para>
251 Packages and package installation vary depending on your development system
252 and on your intent.
253 For example, if you want to build an image that can run
254 on QEMU in graphical mode (a minimal, basic build
255 requirement), then the number of packages is different than if you want to
256 build an image on a headless system or build out the Yocto Project
257 documentation set.
258 Collectively, the number of required packages is large
259 if you want to be able to cover all cases.
260 <note>In general, you need to have root access and then install the
261 required packages.
262 Thus, the commands in the following section may or may not work
263 depending on whether or not your Linux distribution has
264 <filename>sudo</filename> installed.</note>
265 </para>
266
267 <para>
268 The next few sections list, by supported Linux Distributions, the required
269 packages needed to build an image that runs on QEMU in graphical mode
270 (e.g. essential plus graphics support).
271 </para>
272
273 <para>
274 For lists of required packages for other scenarios, see the
275 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
276 section in the Yocto Project Reference Manual.
277 </para>
278
279 <section id='ubuntu'>
280 <title>Ubuntu and Debian</title>
281
282 <para>
283 The essential and graphical support packages you need for a
284 supported Ubuntu or Debian distribution are shown in the
285 following command:
286 <literallayout class='monospaced'>
287 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm
288 </literallayout>
289 </para>
290 </section>
291
292 <section id='fedora'>
293 <title>Fedora</title>
294
295 <para>
296 The essential and graphical packages you need for a supported
297 Fedora distribution are shown in the following command:
298 <literallayout class='monospaced'>
299 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
300 </literallayout>
301 </para>
302 </section>
303
304 <section id='opensuse'>
305 <title>OpenSUSE</title>
306
307 <para>
308 The essential and graphical packages you need for a supported
309 OpenSUSE distribution are shown in the following command:
310 <literallayout class='monospaced'>
311 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm
312 </literallayout>
313 </para>
314 </section>
315
316 <section id='centos'>
317 <title>CentOS</title>
318
319 <para>
320 The essential and graphical packages you need for a supported
321 CentOS distribution are shown in the following command:
322 <literallayout class='monospaced'>
323 $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
324 </literallayout>
325 <note>Depending on the CentOS version you are using, other requirements
326 and dependencies might exist.
327 For details, you should look at the CentOS sections on the
328 <ulink url='https://wiki.yoctoproject.org/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink>
329 wiki page.</note>
330 </para>
331 </section>
332 </section>
333
334 <section id='releases'>
335 <title>Yocto Project Release</title>
336
337 <para>
338 You can download the latest Yocto Project release by going to the
339 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>
340 clicking "Downloads" in the navigation pane to the left to view all
341 available Yocto Project releases.
342 Current and archived releases are available for download to the
343 right.
344 Nightly and developmental builds are also maintained at
345 <ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
346 However, for this document a released version of Yocto Project is used.
347 </para>
348
349 <para>
350 You can also get the Yocto Project files you need by setting up (cloning in Git terms)
351 a local copy of the <filename>poky</filename> Git repository on your host development
352 system.
353 Doing so allows you to contribute back to the Yocto Project project.
354 For information on how to get set up using this method, see the
355 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
356 Project Release</ulink>" item in the Yocto Project Development Manual.
357 </para>
358 </section>
359</section>
360
361<section id='test-run'>
362 <title>A Quick Test Run</title>
363
364 <para>
365 Now that you have your system requirements in order, you can give the Yocto Project a try.
366 This section presents some steps that let you do the following:
367 </para>
368
369 <itemizedlist>
370 <listitem>
371 <para>Build an image and run it in the QEMU emulator</para>
372 </listitem>
373 <listitem>
374 <para>Use a pre-built image and run it in the QEMU emulator</para>
375 </listitem>
376 </itemizedlist>
377
378 <section id='building-image'>
379 <title>Building an Image</title>
380
381 <para>
382 In the development environment you will need to build an image whenever you change hardware
383 support, add or change system libraries, or add or change services that have dependencies.
384 </para>
385
386 <mediaobject>
387 <imageobject>
388 <imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/>
389 </imageobject>
390 <caption>
391 <para>Building an Image</para>
392 </caption>
393 </mediaobject>
394
395 <para>
396 Use the following commands to build your image.
397 The OpenEmbedded build process creates an entire Linux distribution, including the toolchain,
398 from source.
399 </para>
400
401 <note><para>
402 The build process using Sato currently consumes about 50GB of disk space.
403 To allow for variations in the build process and for future package expansion, we
404 recommend having at least 100GB of free disk space.
405 </para></note>
406
407 <note><para>
408 By default, the build process searches for source code using a pre-determined order
409 through a set of locations.
410 If you encounter problems with the build process finding and downloading source code, see the
411 "<ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>How does the OpenEmbedded build system obtain source code and will it work behind my
412 firewall or proxy server?</ulink>" in the Yocto Project Reference Manual.
413 </para></note>
414
415 <para>
416 <literallayout class='monospaced'>
417 $ wget &YOCTO_POKY_DL_URL;
418 $ tar xjf &YOCTO_POKY;.tar.bz2
419 $ cd &YOCTO_POKY;
420 $ source &OE_INIT_FILE;
421 </literallayout>
422 </para>
423
424 <tip><para>
425 To help conserve disk space during builds, you can add the following statement
426 to your project's configuration file, which for this example
427 is <filename>&YOCTO_POKY;/build/conf/local.conf</filename>.
428 Adding this statement deletes the work directory used for building a package
429 once the package is built.
430 <literallayout class='monospaced'>
431 INHERIT += "rm_work"
432 </literallayout>
433 </para></tip>
434
435 <itemizedlist>
436 <listitem><para>In the previous example, the first command retrieves the Yocto Project
437 release tarball from the source repositories using the
438 <filename>wget</filename> command.
439 Alternatively, you can go to the
440 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website's</ulink>
441 "Downloads" page to retrieve the tarball.</para></listitem>
442 <listitem><para>The second command extracts the files from the tarball and places
443 them into a directory named <filename>&YOCTO_POKY;</filename> in the current
444 directory.</para></listitem>
445 <listitem><para>The third and fourth commands change the working directory to the
446 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
447 and run the Yocto Project
448 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
449 environment setup script.
450 Running this script defines OpenEmbedded build environment settings needed to
451 complete the build.
452 The script also creates the
453 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
454 which is <filename>build</filename> in this case and is located in the
455 Source Directory.
456 After the script runs, your current working directory is set
457 to the Build Directory.
458 Later, when the build completes, the Build Directory contains all the files
459 created during the build.
460 <note>
461 For information on running a memory-resident BitBake, see
462 the
463 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
464 setup script.
465 </note></para></listitem>
466 </itemizedlist>
467 <para>
468 Take some time to examine your <filename>local.conf</filename> file
469 in your project's configuration directory, which is found in the Build Directory.
470 The defaults in that file should work fine.
471 However, there are some variables of interest at which you might look.
472 </para>
473
474 <para>
475 By default, the target architecture for the build is <filename>qemux86</filename>,
476 which produces an image that can be used in the QEMU emulator and is targeted at an
477 <trademark class='registered'>Intel</trademark> 32-bit based architecture.
478 To change this default, edit the value of the
479 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
480 variable in the configuration file before launching the build.
481 </para>
482
483 <para>
484 Another couple of variables of interest are the
485 <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the
486 <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables.
487 By default, these variables are commented out.
488 However, if you have a multi-core CPU you might want to uncomment
489 the lines and set both variables equal to twice the number of your
490 host's processor cores.
491 Setting these variables can significantly shorten your build time.
492 </para>
493
494 <para>
495 Another consideration before you build is the package manager used when creating
496 the image.
497 By default, the OpenEmbedded build system uses the RPM package manager.
498 You can control this configuration by using the
499 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
500 For additional package manager selection information, see the
501 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
502 section in the Yocto Project Reference Manual.
503 </para>
504
505 <para>
506 Continue with the following command to build an OS image for the target, which is
507 <filename>core-image-sato</filename> in this example.
508 For information on the <filename>-k</filename> option use the
509 <filename>bitbake --help</filename> command or see the
510 "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in
511 the Yocto Project Reference Manual.
512 <literallayout class='monospaced'>
513 $ bitbake -k core-image-sato
514 </literallayout>
515 <note><para>
516 BitBake requires Python 2.6 or 2.7. For more information on this requirement,
517 see the
518 <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in the Yocto Project Reference
519 Manual.
520 </para></note>
521 The final command runs the image:
522 <literallayout class='monospaced'>
523 $ runqemu qemux86
524 </literallayout>
525 <note><para>
526 Depending on the number of processors and cores, the amount or RAM, the speed of your
527 Internet connection and other factors, the build process could take several hours the first
528 time you run it.
529 Subsequent builds run much faster since parts of the build are cached.
530 </para></note>
531 </para>
532 </section>
533
534 <section id='using-pre-built'>
535 <title>Using Pre-Built Binaries and QEMU</title>
536
537 <para>
538 If hardware, libraries and services are stable, you can get started by using a pre-built binary
539 of the filesystem image, kernel, and toolchain and run it using the QEMU emulator.
540 This scenario is useful for developing application software.
541 </para>
542
543 <mediaobject>
544 <imageobject>
545 <imagedata fileref="figures/using-a-pre-built-image.png" format="PNG" align='center' scalefit='1'/>
546 </imageobject>
547 <caption>
548 <para>Using a Pre-Built Image</para>
549 </caption>
550 </mediaobject>
551
552 <para>
553 For this scenario, you need to do several things:
554 </para>
555
556 <itemizedlist>
557 <listitem><para>Install the appropriate stand-alone toolchain tarball.</para></listitem>
558 <listitem><para>Download the pre-built image that will boot with QEMU.
559 You need to be sure to get the QEMU image that matches your target machine’s
560 architecture (e.g. x86, ARM, etc.).</para></listitem>
561 <listitem><para>Download the filesystem image for your target machine's architecture.
562 </para></listitem>
563 <listitem><para>Set up the environment to emulate the hardware and then start the QEMU emulator.
564 </para></listitem>
565 </itemizedlist>
566
567 <section id='installing-the-toolchain'>
568 <title>Installing the Toolchain</title>
569
570 <para>
571 You can download a tarball installer, which includes the
572 pre-built toolchain, the <filename>runqemu</filename>
573 script, and support files from the appropriate directory under
574 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>.
575 Toolchains are available for 32-bit and 64-bit x86 development
576 systems from the <filename>i686</filename> and
577 <filename>x86_64</filename> directories, respectively.
578 The toolchains the Yocto Project provides are based off the
579 <filename>core-image-sato</filename> image and contain
580 libraries appropriate for developing against that image.
581 Each type of development system supports five or more target
582 architectures.
583 </para>
584
585 <para>
586 The names of the tarball installer scripts are such that a
587 string representing the host system appears first in the
588 filename and then is immediately followed by a string
589 that represents the target architecture.
590 </para>
591
592 <literallayout class='monospaced'>
593 poky-eglibc-&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>image_type</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;-toolchain-&lt;<emphasis>release_version</emphasis>&gt;.sh
594
595 Where:
596 &lt;<emphasis>host_system</emphasis>&gt; is a string representing your development system:
597
598 i686 or x86_64.
599
600 &lt;<emphasis>image_type</emphasis>&gt; is a string representing the image you wish to
601 develop a Software Development Toolkit (SDK) for use against.
602 The Yocto Project builds toolchain installers using the
603 following BitBake command:
604
605 bitbake core-image-sato -c do_populatesdk core-image-sato
606
607 &lt;<emphasis>arch</emphasis>&gt; is a string representing the tuned target architecture:
608
609 i586, x86_64, powerpc, mips, armv7a or armv5te
610
611 &lt;<emphasis>release_version</emphasis>&gt; is a string representing the release number of the
612 Yocto Project:
613
614 &DISTRO;, &DISTRO;+snapshot
615 </literallayout>
616
617 <para>
618 For example, the following toolchain installer is for a 64-bit
619 development host system and a i586-tuned target architecture
620 based off the SDK for <filename>core-image-sato</filename>:
621 <literallayout class='monospaced'>
622 poky-eglibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
623 </literallayout>
624 </para>
625
626 <para>
627 Toolchains are self-contained and by default are installed into
628 <filename>/opt/poky</filename>.
629 However, when you run the toolchain installer, you can choose an
630 installation directory.
631 </para>
632
633 <para>
634 The following command shows how to run the installer given a toolchain tarball
635 for a 64-bit x86 development host system and a 32-bit x86 target architecture.
636 You must change the permissions on the toolchain
637 installer script so that it is executable.
638 </para>
639
640 <para>
641 The example assumes the toolchain installer is located in <filename>~/Downloads/</filename>.
642 <note>
643 If you do not have write permissions for the directory into which you are installing
644 the toolchain, the toolchain installer notifies you and exits.
645 Be sure you have write permissions in the directory and run the installer again.
646 </note>
647 </para>
648
649 <para>
650 <literallayout class='monospaced'>
651 $ ~/Downloads/poky-eglibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
652 </literallayout>
653 </para>
654
655 <para>
656 For more information on how to install tarballs, see the
657 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and
658 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Build Directory</ulink>" sections in the Yocto Project Application Developer's Guide.
659 </para>
660 </section>
661
662 <section id='downloading-the-pre-built-linux-kernel'>
663 <title>Downloading the Pre-Built Linux Kernel</title>
664
665 <para>
666 You can download the pre-built Linux kernel suitable for running in the QEMU emulator from
667 <ulink url='&YOCTO_QEMU_DL_URL;'></ulink>.
668 Be sure to use the kernel that matches the architecture you want to simulate.
669 Download areas exist for the five supported machine architectures:
670 <filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>,
671 <filename>qemux86</filename>, and <filename>qemux86-64</filename>.
672 </para>
673
674 <para>
675 Most kernel files have one of the following forms:
676 <literallayout class='monospaced'>
677 *zImage-qemu&lt;<emphasis>arch</emphasis>&gt;.bin
678 vmlinux-qemu&lt;<emphasis>arch</emphasis>&gt;.bin
679
680 Where:
681 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
682 x86, x86-64, ppc, mips, or arm.
683 </literallayout>
684 </para>
685
686 <para>
687 You can learn more about downloading a Yocto Project kernel in the
688 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink>"
689 bulleted item in the Yocto Project Development Manual.
690 </para>
691 </section>
692
693 <section id='downloading-the-filesystem'>
694 <title>Downloading the Filesystem</title>
695
696 <para>
697 You can also download the filesystem image suitable for your target architecture from
698 <ulink url='&YOCTO_QEMU_DL_URL;'></ulink>.
699 Again, be sure to use the filesystem that matches the architecture you want
700 to simulate.
701 </para>
702
703 <para>
704 The filesystem image has two tarball forms: <filename>ext3</filename> and
705 <filename>tar</filename>.
706 You must use the <filename>ext3</filename> form when booting an image using the
707 QEMU emulator.
708 The <filename>tar</filename> form can be flattened out in your host development system
709 and used for build purposes with the Yocto Project.
710 <literallayout class='monospaced'>
711 core-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.ext3
712 core-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.tar.bz2
713
714 Where:
715 &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile:
716 lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato,
717 sato-dev, or sato-sdk. For information on these types of image
718 profiles, see the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in the Yocto Project
719 Reference Manual.
720
721 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
722 x86, x86-64, ppc, mips, or arm.
723 </literallayout>
724 </para>
725 </section>
726
727 <section id='setting-up-the-environment-and-starting-the-qemu-emulator'>
728 <title>Setting Up the Environment and Starting the QEMU Emulator</title>
729
730 <para>
731 Before you start the QEMU emulator, you need to set up the emulation environment.
732 The following command form sets up the emulation environment.
733 <literallayout class='monospaced'>
734 $ source &YOCTO_ADTPATH_DIR;/environment-setup-&lt;<emphasis>arch</emphasis>&gt;-poky-linux-&lt;<emphasis>if</emphasis>&gt;
735
736 Where:
737 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
738 i586, x86_64, ppc603e, mips, or armv5te.
739
740 &lt;<emphasis>if</emphasis>&gt; is a string representing an embedded application binary interface.
741 Not all setup scripts include this string.
742 </literallayout>
743 </para>
744
745 <para>
746 Finally, this command form invokes the QEMU emulator
747 <literallayout class='monospaced'>
748 $ runqemu &lt;<emphasis>qemuarch</emphasis>&gt; &lt;<emphasis>kernel-image</emphasis>&gt; &lt;<emphasis>filesystem-image</emphasis>&gt;
749
750 Where:
751 &lt;<emphasis>qemuarch</emphasis>&gt; is a string representing the target architecture: qemux86, qemux86-64,
752 qemuppc, qemumips, or qemuarm.
753
754 &lt;<emphasis>kernel-image</emphasis>&gt; is the architecture-specific kernel image.
755
756 &lt;<emphasis>filesystem-image</emphasis>&gt; is the .ext3 filesystem image.
757
758 </literallayout>
759 </para>
760
761 <para>
762 Continuing with the example, the following two commands setup the emulation
763 environment and launch QEMU.
764 This example assumes the root filesystem (<filename>.ext3</filename> file) and
765 the pre-built kernel image file both reside in your home directory.
766 The kernel and filesystem are for a 32-bit target architecture.
767 <literallayout class='monospaced'>
768 $ cd $HOME
769 $ source &YOCTO_ADTPATH_DIR;/environment-setup-i586-poky-linux
770 $ runqemu qemux86 bzImage-qemux86.bin \
771 core-image-sato-qemux86.ext3
772 </literallayout>
773 </para>
774
775 <para>
776 The environment in which QEMU launches varies depending on the filesystem image and on the
777 target architecture.
778 For example, if you source the environment for the ARM target
779 architecture and then boot the minimal QEMU image, the emulator comes up in a new
780 shell in command-line mode.
781 However, if you boot the SDK image, QEMU comes up with a GUI.
782 <note>Booting the PPC image results in QEMU launching in the same shell in
783 command-line mode.</note>
784 </para>
785 </section>
786 </section>
787</section>
788
789<section id='super-user'>
790 <title>Super User
791</title>
792
793 <para>
794 This section
795 <footnote>
796 <para>
797 Kudos and thanks to Robert P. J. Day of
798 <ulink url='http://www.crashcourse.ca'>CrashCourse</ulink> for providing the basis
799 for this "expert" section with information from one of his
800 <ulink url='http://www.crashcourse.ca/wiki/index.php/Yocto_Project_Quick_Start'>wiki</ulink>
801 pages.
802 </para>
803 </footnote>
804 gives you a minimal description of how to use the Yocto Project to build images
805 for a BeagleBoard xM starting from scratch.
806 The steps were performed on a 64-bit Ubuntu 10.04 system.
807 </para>
808
809 <section id='getting-yocto'>
810 <title>Getting the Yocto Project</title>
811
812 <para>
813 Set up your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
814 one of two ways:
815 <itemizedlist>
816 <listitem><para><emphasis>Tarball:</emphasis>
817 Use if you want the latest stable release:
818 <literallayout class='monospaced'>
819 $ wget &YOCTO_RELEASE_DL_URL;/&YOCTO_POKY_TARBALL;
820 $ tar xvjf &YOCTO_POKY_TARBALL;
821 </literallayout></para></listitem>
822 <listitem><para><emphasis>Git Repository:</emphasis>
823 Use if you want to work with cutting edge development content:
824 <literallayout class='monospaced'>
825 $ git clone git://git.yoctoproject.org/poky
826 </literallayout></para></listitem>
827 </itemizedlist>
828 The remainder of the section assumes the Git repository method.
829 </para>
830 </section>
831
832 <section id='setting-up-your-host'>
833 <title>Setting Up Your Host</title>
834
835 <para>
836 You need some packages for everything to work.
837 Rather than duplicate them here, look at the "<link linkend='packages'>The Packages</link>"
838 section earlier in this quick start.
839 </para>
840 </section>
841
842 <section id='initializing-the-build-environment'>
843 <title>Initializing the Build Environment</title>
844
845 <para>
846 From the parent directory your
847 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
848 initialize your environment and provide a meaningful
849 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
850 name:
851 <literallayout class='monospaced'>
852 $ source poky/&OE_INIT_FILE; mybuilds
853 </literallayout>
854 At this point, the <filename>mybuilds</filename> directory has been created for you
855 and it is now your current working directory.
856 If you don't provide your own directory name it defaults to <filename>build</filename>,
857 which is inside the Source Directory.
858 </para>
859 </section>
860
861 <section id='configuring-the-local.conf-file'>
862 <title>Configuring the local.conf File</title>
863
864 <para>
865 Initializing the build environment creates a <filename>conf/local.conf</filename> configuration file
866 in the Build Directory.
867 You need to manually edit this file to specify the machine you are building and to optimize
868 your build time.
869 Here are the minimal changes to make:
870 <literallayout class='monospaced'>
871 BB_NUMBER_THREADS = "8"
872 PARALLEL_MAKE = "-j 8"
873 MACHINE ?= "beagleboard"
874 </literallayout>
875 Briefly, set <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>
876 and <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to
877 twice your host processor's number of cores.
878 </para>
879
880 <para>
881 A good deal that goes into a Yocto Project build is simply
882 downloading all of the source tarballs.
883 Maybe you have been working with another build system
884 (OpenEmbedded or Angstrom) for which you have built up a sizable
885 directory of source tarballs.
886 Or, perhaps someone else has such a directory for which you have
887 read access.
888 If so, you can save time by adding statements to your
889 configuration file so that the build process checks local
890 directories first for existing tarballs before checking the
891 Internet.
892 Here is an efficient way to set it up in your
893 <filename>local.conf</filename> file:
894 <literallayout class='monospaced'>
895 SOURCE_MIRROR_URL ?= "file:///home/you/your-download-dir/"
896 INHERIT += "own-mirrors"
897 BB_GENERATE_MIRROR_TARBALLS = "1"
898 # BB_NO_NETWORK = "1"
899 </literallayout>
900 </para>
901
902 <para>
903 In the previous example, the
904 <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink>
905 variable causes the OpenEmbedded build system to generate tarballs
906 of the Git repositories and store them in the
907 <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink>
908 directory.
909 Due to performance reasons, generating and storing these tarballs
910 is not the build system's default behavior.
911 </para>
912
913 <para>
914 You can also use the
915 <ulink url='&YOCTO_DOCS_REF_URL;#var-PREMIRRORS'><filename>PREMIRRORS</filename></ulink>
916 variable.
917 For an example, see the variable's glossary entry in the
918 Yocto Project Reference Manual.
919 </para>
920 </section>
921
922 <section id='building-the-image'>
923 <title>Building the Image</title>
924
925 <para>
926 At this point, you need to select an image to build for the BeagleBoard xM.
927 If this is your first build using the Yocto Project, you should try the smallest and simplest
928 image:
929 <literallayout class='monospaced'>
930 $ bitbake core-image-minimal
931 </literallayout>
932 Now you just wait for the build to finish.
933 </para>
934
935 <para>
936 Here are some variations on the build process that could be helpful:
937 <itemizedlist>
938 <listitem><para>Fetch all the necessary sources without starting the build:
939 <literallayout class='monospaced'>
940 $ bitbake -c fetchall core-image-minimal
941 </literallayout>
942 This variation guarantees that you have all the sources for that BitBake target
943 should you disconnect from the net and want to do the build later offline.
944 </para></listitem>
945 <listitem><para>Specify to continue the build even if BitBake encounters an error.
946 By default, BitBake aborts the build when it encounters an error.
947 This command keeps a faulty build going:
948 <literallayout class='monospaced'>
949 $ bitbake -k core-image-minimal
950 </literallayout></para></listitem>
951 </itemizedlist>
952 </para>
953
954 <para>
955 Once you have your image, you can take steps to load and boot it on the target hardware.
956 </para>
957 </section>
958</section>
959
960</article>
961<!--
962vim: expandtab tw=80 ts=4
963-->