diff options
| -rw-r--r-- | distribution/yocto-basic/yocto-workflow.tex | 756 |
1 files changed, 414 insertions, 342 deletions
diff --git a/distribution/yocto-basic/yocto-workflow.tex b/distribution/yocto-basic/yocto-workflow.tex index efa3a52..577a419 100644 --- a/distribution/yocto-basic/yocto-workflow.tex +++ b/distribution/yocto-basic/yocto-workflow.tex @@ -1,96 +1,99 @@ \subsection{Workflow} + \begin{frame}[fragile] -\includegraphics[width=\textwidth]{images/yocto-workflow} +\includegraphics[width=\textwidth]{images/yp-how-it-works-new-diagram.png} \end{frame} \begin{frame}[fragile] -\frametitle{retrieve poky} +\frametitle{Retrieve Poky} \begin{verbatim} -% git clone http://git.yoctoproject.org/git/poky -% cd poky -% git checkout origin/pyro -b pyro -t +$ git clone -b yocto-2.4.2 http://git.yoctoproject.org/git/poky +$ cd poky +$ git checkout -b rocko-schulung \end{verbatim} \end{frame} \begin{frame}[fragile] -\frametitle{prepare environment} +\frametitle{Prepare Environment} \begin{itemize} -\item bitbake is typically not installed into regular search paths -\item the environment of the bash is modified to find the commands -\item non-bash shells are not supported +\item BitBake is typically not installed into regular search paths +\item the environment of the bash shell is modified to find the commands +\item non-bash shells are not supported (!) \end{itemize} \begin{verbatim} -% . ./oe-init-buildenv <builddir> +$ . ./oe-init-buildenv <builddir> \end{verbatim} \begin{itemize} -\item is used to modify the environment and change the CWD to <builddir> -\item ./oe-init-buildenv-memres is used to keep the bitbake-server running +\item is used to modify the environment and change the current working directory to <builddir> \end{itemize} \end{frame} +\subsection{Structure} + \begin{frame} -\frametitle{classes} +\frametitle{Classes} \begin{itemize} \item denoted by the .bbclass extension -\item base.bbclass is automatically included by all other classes and recipes. -\item common tasks and there execution order is defined in base.bbclass -\item tasks can be added, overridden, extended or used by other classes +\item base.bbclass is automatically included by all other classes and recipes +\item common tasks and their execution order is defined in base.bbclass +\item tasks can be added, overridden, extended, or used by other classes \end{itemize} \end{frame} \begin{frame} -\frametitle{recipes} +\frametitle{Recipes} \begin{itemize} -\item a .bb file inherits classes and populates them with data -\item bitbake is used to schedule the tasks defined in a recipe +\item denoted by the .bb extension +\item a recipe inherits classes and populates them with data +\item BitBake is used to execute the tasks defined in a recipe \end{itemize} \end{frame} \begin{frame} -\frametitle{layers} +\frametitle{Layers} \begin{itemize} -\item a folder containing recipes, configs and classes -\item used to isolate different types of customizations from each other -\item e.g. own layer for machine specific stuff, one for own applications +\item a directory containing recipes, configs, and classes +\item used to isolate different types of customization (e.g. own layer for machine specific customization, one for own applications, etc.) \item extend, add, replace or modify recipes \item add or replace class files -\item 'conf/layer.conf' is used to configure the layer -\item are added and ordered via BBLAYERS variable in build/conf/bblayers.conf +\item 'conf/layer.conf' of the layer directory is used to configure that layer +\item layers are added and ordered via BBLAYERS variable in 'conf/bblayers.conf' of build directory \item 'bitbake-layers show-layers' is used to show used layers \end{itemize} \end{frame} \begin{frame} -\frametitle{layers \#2} -layers should be grouped by functionality +\frametitle{Layers \#2} +Layers Should be Grouped by Functionality \begin{itemize} \item custom toolchains (compilers, debuggers, profiling tools) -\item distribution specifications (i.e. meta-yocto) -\item BSP/machine settings (i.e. meta-yocto-bsp) +\item distribution specifications (e.g. meta-poky) +\item BSP/machine settings (e.g. meta-yocto-bsp) \item functional areas (selinux, networking, etc) \item project specific changes -\item a layer is typically organized as a git repository +\item each layer is typically organized as its own git repository \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{directory layout} +\frametitle{Poky Directory Layout} \begin{verbatim} poky ├── bitbake ├── documentation ├── meta +├── meta-poky ├── meta-selftest ├── meta-skeleton -├── meta-yocto ├── meta-yocto-bsp └── scripts \end{verbatim} \end{frame} -\subsection{Variable assignments} +\subsection{Variable Assignments} + \begin{frame} -\frametitle{available operators} +\frametitle{Available Operators} \begin{itemize} \item = \item ?= @@ -98,22 +101,47 @@ poky \item := \item += / =+ \item .= / =. +\item \_prepend / \_append +\item \_remove \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{variable assignment with =} +\frametitle{Assignment Debugging} +\begin{verbatim} +$ echo 'FOO ??= "123"' >> conf/local.conf +$ echo 'FOO ?= "456"' >> conf/local.conf + +$ bitbake -e | grep FOO +# $FOO [2 operations] +FOO="456" +\end{verbatim} +\end{frame} + +\begin{frame}[fragile] +\frametitle{Variable Assignment with =} \begin{verbatim} VAR = "value" \end{verbatim} \begin{itemize} \item normal assignment -\item values need to be surrounded by double quotes +\item values must be surrounded by double quotes +\end{itemize} +\end{frame} + +\begin{frame}[fragile] +\frametitle{Variable Usage} +\begin{verbatim} +VAR2 = "${VAR1}" +\end{verbatim} +\begin{itemize} +\item set VAR2 to the value of VAR1 +\item the curly brackets are required (this is not shell!) \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{early default assignment with ?=} +\frametitle{Early Default Assignment with ?=} \begin{verbatim} VAR ?= "1" VAR ?= "2" @@ -125,7 +153,7 @@ VAR ?= "2" \end{frame} \begin{frame}[fragile] -\frametitle{late default assignment with ??=} +\frametitle{Late Default Assignment with ??=} \begin{verbatim} VAR ??= "1" VAR ??= "2" @@ -137,28 +165,28 @@ VAR ??= "2" \end{frame} \begin{frame}[fragile] -\frametitle{assignment priorities \#1} +\frametitle{Assignment Priorities \#1} \begin{verbatim} -VAR_A ??= "12" -VAR_A ?= "34" +VAR1 ??= "12" +VAR1 ?= "34" -VAR_B ?= "12" -VAR_B ??= "34" +VAR2 ?= "12" +VAR2 ??= "34" \end{verbatim} \begin{itemize} -\item VAR\_A contains "34" -\item VAR\_B contains "12" +\item VAR1 contains "34" +\item VAR2 contains "12" \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{assignment priorities \#2} +\frametitle{Assignment Priorities \#2} \begin{verbatim} VAR ?= "12" VAR ??= "34" VAR = "56" VAR ?= "78" -VAR ??= "78" +VAR ??= "90" \end{verbatim} \begin{itemize} \item VAR contains "56" @@ -166,91 +194,101 @@ VAR ??= "78" \end{frame} \begin{frame}[fragile] -\frametitle{immediate variable expansion with :=} +\frametitle{Immediate Variable Expansion with :=} \begin{verbatim} -VAR_A = "11" -VAR_B = "B:${VAR_A}" -VAR_A = "22" -VAR_C := "C:${VAR_A}" -VAR_A = "33" -echo ${VAR_A} ${VAR_B} ${VAR_C} +VAR1 = "11" +VAR2 = "the value of VAR1 is ${VAR1}" +VAR1 = "22" +VAR3 := "the value of VAR1 is ${VAR1}" +VAR1 = "33" +echo "${VAR1}, ${VAR2}, ${VAR3}" \end{verbatim} \begin{itemize} -\item 33 B:33 C:22 -\item the content of VAR\_C is expanded immediately on assignment -\item the content of VAR\_B is expanded on use +\item output: 33, the value of VAR1 is 33, the value of var1 is 22 +\item the contents of VAR1 and VAR2 are expanded on use +\item the content of VAR3 is recursively expanded immediately on assignment \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{append (+=) or prepend (=+) a variable} +\frametitle{Append (+=) or Prepend (=+) a Variable} \begin{verbatim} -VAR_A = "12" -VAR_A += "34" -VAR_B = "56" -VAR_B =+ "78" +VAR1 = "12" +VAR1 += "34" +VAR2 = "56" +VAR2 =+ "78" \end{verbatim} \begin{itemize} -\item VAR\_A contains "12 34" -\item VAR\_B contains "78 56" -\item there are spaces between the appended values +\item VAR1 contains "12 34" +\item VAR2 contains "78 56" +\item spaces are inserted between the appended values \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{append (.=) or prepend (=.) a variable} +\frametitle{Append (.=) or Prepend (=.) a Variable} \begin{verbatim} -VAR_A = "12" -VAR_A .= "34" -VAR_B = "56" -VAR_B =. "78" +VAR1 = "12" +VAR1 .= "34" +VAR2 = "56" +VAR2 =. "78" \end{verbatim} \begin{itemize} -\item VAR\_A contains "1234" -\item VAR\_B contains "7856" -\item there are no spaces between the appended values +\item VAR1 contains "1234" +\item VAR2 contains "7856" +\item no spaces are inserted between the appended values \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{assignment debugging} +\frametitle{Late Append or Prepend a Variable} \begin{verbatim} -$ echo 'FOO ??= "123"' >> conf/local.conf -$ echo 'FOO ?= "456"' >> conf/local.conf - -$ bitbake -e | grep FOO -# $FOO [2 operations] -FOO="456" +VAR = "34" +VAR_append = "56" +VAR_prepend = "12" +VAR .= "78" \end{verbatim} +\begin{itemize} +\item VAR contains "12347856" +\item no spaces are inserted between the appended values +\item when specified multiple times, each instance is applied +\item the +=/=+ operators can be used to insert spaces before or after the appended value +\item special operators that are applied after all previous operators (including early and late default assignments!) +\end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{prepend/append} +\frametitle{Late Value Removal from a Variable} \begin{verbatim} VAR = "34" -VAR_append = "56" -VAR_prepend = "12" +VAR_remove = "78" +VAR_append += "56" +VAR_append += "78" \end{verbatim} \begin{itemize} -\item VAR contains "123456" -\item there are no spaces between the appended values +\item VAR contains "34 56" +\item specifies a list of values to remove +\item when specified multiple times, each instance is applied +\item whitespace in the variable contents is required to match values +\item special operator that is applied at the very end (even after \_prepend and \_append operators!) \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{overrides} +\frametitle{Overrides} \begin{verbatim} -OVERRIDES="string1:string2" +OVERRIDES = "string1:string2" VAR = "foo" VAR_string1 = "bar" \end{verbatim} \begin{itemize} \item if string1 is listed in OVERRIDES, use "bar" for value of VAR, otherwise use "foo" +\item overrides apply to all operators \end{itemize} \end{frame} \begin{frame}[fragile] -\frametitle{variable flags} +\frametitle{Variable Flags} \begin{verbatim} VAR[some_flag]="foo" \end{verbatim} @@ -268,26 +306,28 @@ B = "2" A2 = "Y" \end{verbatim} \begin{itemize} -\item Key expansion happens just before BitBake expands overrides. -\item A2 contains "X" +\item A2 contains "X" (and a warning is generated) +\item key expansion values can only be debugged with 'bitbake -e' when they are used by the recipe \end{itemize} \end{frame} \subsection{Recipes} + \begin{frame} -\frametitle{typical progressing} +\frametitle{Typical Steps (Tasks)} \begin{enumerate} -\item fetch source files -\item extract sources +\item fetch source archives +\item unpack sources \item patch sources \item configure sources -\item compilation -\item packaging +\item compile sources +\item install binaries +\item package binaries \end{enumerate} \end{frame} \begin{frame}[fragile] -\frametitle{skeleton} +\frametitle{Skeleton} \begin{verbatim} SUMMARY = "short description of the package (1 line)" DESCRIPTION = "a long version of the description of the package" @@ -296,7 +336,7 @@ LICENSE = "LGPLv2.1" LIC_FILES_CHKSUM = "file://COPYING;md5=xxxx \ file://licfile1.txt;beginline=5;endline=29;md5=yyyy \ - file://licfile2.txt;endline=50;md5=zzzz + file://licfile2.txt;endline=50;md5=zzzz" SRC_URI = "file://mysw-1.0.tbz" SRC_URI[md5sum] = "xxx" @@ -309,35 +349,35 @@ inherit autotools \end{frame} \begin{frame} -\frametitle{syntax} -a recipe normaly consists of a human readable description of the project and -references to the open-source project and: +\frametitle{Syntax} +A recipe typically consists of a human readable description of the project, +references to the open-source project, and: \begin{description} \item[LIC*] reference to the used licenses \item[SRC\_URI] list of source files (local or remote) -\item[PV] package-version (retrived from filename name\_version.bb) -\item[PN] package-name (retrived from filename name\_version.bb) +\item[PV] package-version (retrived from filename: name\_version.bb) +\item[PN] package-name (retrived from filename: name\_version.bb) \item[P] ${PN}-${PV} -\item[S] The location in the Build Directory where unpacked recipe source code resides. +\item[S] the location where the unpacked recipe source code resides \item[inherit] use a class (or multiple classes) \end{description} \end{frame} \begin{frame} -\frametitle{the LICENSE variable} -list of source licenses for the recipe: +\frametitle{The LICENSE Variable} +A list of source licenses for the recipe: \begin{itemize} \item do not use spaces within individual license names \item use spaces between license names \item separate license names using | (pipe) when there is a choice between licenses -\item separate license names using \& (AND) if parts of the code are licensed +\item separate license names using \& (and) if parts of the code are licensed with different licenses \item for standard licenses, use the names of the files in meta/files/common-licenses/ or the SPDXLICENSEMAP - \footnote{aps commonly used license names to their SPDX counterparts found in + \footnote{Applications commonly use license names from the SPDX counterparts found in meta/files/common-licenses/. For the default SPDXLICENSEMAP mappings, see the - meta/conf/licenses.conf file} + meta/conf/licenses.conf file.} flag names defined in meta/conf/licenses.conf \item use "CLOSED" for closed source software (LIC\_FILES\_CHKSUM is not needed to be defined then) @@ -345,7 +385,7 @@ list of source licenses for the recipe: \end{frame} \begin{frame} -\frametitle{LIC\_FILE\_CHKSUM variable} +\frametitle{The LIC\_FILE\_CHKSUM Variable} Checksums of the license text in the recipe source code. \vspace{2em} @@ -356,30 +396,29 @@ which gives the developer an opportunity to review any license change. \end{frame} \begin{frame}[fragile] -\frametitle{SRC\_URI variable} +\frametitle{The SRC\_URI Variable} \begin{verbatim} SRC_URI = "<protocol>://<host>/<path>;<OptionA=xxx>;<OptionB=xxx>" \end{verbatim} -multiple urls can be set in a SRC\_URI variable: +Multiple urls can be set in a SRC\_URI variable: \begin{verbatim} SRC_URI = "<url1>;name=url1 <url2>;name=url2" \end{verbatim} -for each url a md5 and sha256 checksum needs to be added: +For each url an MD5 and SHA256 checksum needs to be added: \begin{verbatim} SRC_URI[url1.md5sum] = xxx SRC_URI[url1.sha256sum] = yyy SRC_URI[url2.md5sum] = zzz SRC_URI[url2.sha256sum] = xyz \end{verbatim} -To get these checksums don't specify them and run a build and copy them from -the error message. (Don't use md5sum or sha256sum on the commandline; they -produce a different checksum.) +To get these checksums, you can not specify them and run a build and copy them from +the error message. (For some cases, such as license parts, this may be the easiest way to get the checksums.) \end{frame} \begin{frame}[fragile] -\frametitle{local SRC\_URI (file://)} +\frametitle{Local SRC\_URI Files (file://)} The path is relative to the FILESPATH variable. To modify the FILESPATH use -FILESEXTRAPATH. +FILESEXTRAPATHS. \vspace{2em} @@ -388,30 +427,30 @@ recipe file (.bb) or append file (.bbappend) resides. To find out which paths can be used, it is best practice to use \begin{verbatim} -$ bitbake -e <recipe-name> | grep FILESPATH +$ bitbake -e <recipe-name> | grep '^FILESPATH=' \end{verbatim} \end{frame} \begin{frame} -\frametitle{remote SRC\_URI} +\frametitle{Remote SRC\_URI Files} \begin{description} \item[bzr://]Bazaar revision control repository -\item[git://]Git revision control repository -\item[osc://]OSC (OpenSUSE Build service) revision control repository \item[ccrc://]ClearCase repository -\item[http://]Internet using http -\item[https://]Internet using https -\item[ftp://]Internet using ftp \item[cvs://]CVS revision control repository +\item[ftp://]Internet using FTP +\item[git://]Git revision control repository \item[hg://]Mercurial (hg) revision control repository +\item[http://]Internet using HTTP +\item[https://]Internet using HTTPS +\item[osc://]OSC (OpenSUSE Build service) revision control repository \item[p4://]Perforce (p4) revision control repository -\item[ssh://]secure shell +\item[ssh://]Internet using SSH \item[svn://]Subversion (svn) revision control repository \end{description} \end{frame} \begin{frame} -\frametitle{SRC\_URI patch options} +\frametitle{SRC\_URI Patch Options} \begin{itemize} \item patches are applied in the order they appear in SRC\_URI \item quilt is used to apply the patches @@ -419,37 +458,37 @@ $ bitbake -e <recipe-name> | grep FILESPATH \begin{description} \item[apply=no] apply patch or not; default is yes \item[striplevel=0] striplevel to use when applying a patch; default is 1 -\item[patchdir=\${S}/foo] directory in which the patch should be applied; - default is \${S} +\item[patchdir=\$\{S\}/foo] directory in which the patch should be applied; + default is \$\{S\} \end{description} \end{frame} \begin{frame} -\frametitle{SRC\_URI patch options \#2} +\frametitle{SRC\_URI Patch Options \#2} \begin{description} -\item[mindate] apply patch only if SRCDATE +\item[mindate=] apply patch only if SRCDATE \footnote{The date of the source code used to build the package. This variable applies only if the source was fetched from a - Source Code Manager (SCM)} is equal to or greater than mindate -\item[maxdate] apply patch only if SRCDATE is not later than maxdate -\item[minrev] apply the patch only if SRCREV + Source Code Manager (SCM)} is equal to or greater than the specified date +\item[maxdate=] apply patch only if SRCDATE is not later than the specified date +\item[minrev=] apply the patch only if SRCREV \footnote{The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only} - is equal to or greater than minrev -\item[maxrev] apply patch only if SRCREV is not later than maxrev -\item[rev] apply patch only if SRCREV is equal to rev -\item[notrev] apply patch only if SRCREV is not equal to rev + is equal to or greater than the specified revision +\item[maxrev=] apply patch only if SRCREV is not later than the specified revision +\item[rev=] apply patch only if SRCREV is equal to the specified revision +\item[notrev=] apply patch only if SRCREV is not equal to the specified revision \end{description} \end{frame} \begin{frame} -\frametitle{SRC\_URI options} +\frametitle{SRC\_URI Options} \begin{description} \item[unpack=no] controls if an archive is unpacked; default is yes \item[subdir=bla] places the file (or extracts its contents) into the specified subdirectory of WORKDIR \footnote{${TMPDIR}/work/${MULTIMACH\_TARGET\_SYS}/${PN}/${EXTENDPE}${PV}-${PR}; - eg. poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0} + e.g. /home/devel/poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0} \item[name=mydl] name to be used for association with SRC\_URI checksums when you have more than one file specified in SRC\_URI \item[downloadfilename=my.tar.gz] the filename used when storing the downloaded file @@ -457,8 +496,8 @@ $ bitbake -e <recipe-name> | grep FILESPATH \end{frame} \begin{frame} -\frametitle{inherit} -inherit is used to use the functionality defined in a .bblcass file. Popular +\frametitle{Inheriting Classes} +'inherit' is specified to use the functionality defined in a .bblcass file. Popular predefined classes are: \begin{itemize} \item autotools @@ -467,257 +506,276 @@ predefined classes are: \item distutils / setuptools \item kernel / module \item mime -\item qmake / qmake2 -\item qt4e / qt4x11 +\item pkgconfig \item scons \item systemd -\item u-boot \item vala \end{itemize} \end{frame} \begin{frame} -\frametitle{include} -Includes a complete file +\frametitle{Optionally Including Files} +'include' is specified to include a complete file. \begin{itemize} -\item include examle-defs.inc -\item includes the first file it can find within BBPATH +\item include example-defs.inc +\item includes the first file it can find within BBPATH and THISDIR +\item no error or warning if the file is not found \end{itemize} \end{frame} \begin{frame} -\frametitle{require} -Same as include, but returns an error, if include file not found. +\frametitle{Including Required Files} +'require' is the same as include, but returns an error, if the file is not found. \begin{itemize} -\item includes the first file it can find within BBPATH +\item includes the first file it can find within BBPATH and THISDIR \end{itemize} \end{frame} -\subsection{Append files} -\begin{frame} -\frametitle{basics} -\begin{itemize} -\item are typically used to modify or extend the functionality of the base - recipe -\item it's recommended by the Yocto project to use bbappend files instead - of copying and modyfiing a recipe in an own layer -\end{itemize} -\end{frame} +%\subsection{Classes} +%\begin{frame} +%\frametitle{basics} +%\begin{itemize} +%\item python can be used to write functions +%\item e.g. write your own image generation class +%\end{itemize} +%\end{frame} \begin{frame}[fragile] -\frametitle{naming} -an append file must be named after the base package: -\begin{verbatim} -<base-pn>_<base-pv>.bbappend -\end{verbatim} -\end{frame} - -\subsection{Classes} -\begin{frame} -\frametitle{basics} -\begin{itemize} -\item python can be used to write functions -\item e.g. write your own image generation class -\end{itemize} -\end{frame} - -\subsection{Tasks} -\begin{frame} -\frametitle{basics} +\frametitle{Tasks} \begin{itemize} \item are defined and ordered in classes -\item can be overridden by classes and recipes +\item can be overridden or extended by recipes +\item these are functions that are written in shell or python \end{itemize} -\end{frame} - -\begin{frame} -\frametitle{download \& patch} -\begin{description} -\item [do\_checkuri] validates the SRC\_URI value -\item [do\_checkuriall] validates the SRC\_URI value for all recipes required - to build a target" -\item [do\_fetch] fetches the source code -\item [do\_fetchall] fetches all remote sources required to build a target -\item [do\_unpack] unpacks the source code into a working directory -\item [do\_patch] locates patch files and applies them to the source code -\end{description} -\end{frame} - -\begin{frame} -\frametitle{configure \& compile} -\begin{description} -\item [do\_configure] configures the source by enabling and disabling any - build-time and configuration options for the software being built -\item [do\_configure\_ptest\_base] configures the runtime test suite included - in the software being built -\item [do\_compile] compiles the source in the compilation directory -\item [do\_install] copies files from the compilation directory to a holding - area -\item [do\_populate\_sysroot] copies a subset of files installed by - do\_install into the sysroot in order to make them available to other - recipes -\end{description} -\end{frame} +\begin{verbatim} +do_func1() { + echo "my shell task" +} -\begin{frame} -\frametitle{packaging} -\begin{description} -\item [do\_packagedata] creates package metadata used by the build system to - generate the final packages -\item [do\_package] analyzes the content of the holding area and splits it - into subsets based on available packages and files -\item [do\_package\_write] creates the actual packages and places them in the - Package Feed area -\item [do\_package\_write\_deb] creates the actual DEB packages and places - them in the Package Feed area -\item [do\_package\_write\_ipk] creates the actual IPK packages and places - them in the Package Feed area -\item [do\_package\_write\_rpm] creates the actual RPM packages and places - them in the Package Feed area -\item [do\_package\_write\_tar] creates tar archives for packages and places - them in the Package Feed area -\item [do\_package\_index] creates or updates the index in the Package Feed - area -\end{description} +python do_func2() { + print("my python task") +} +\end{verbatim} \end{frame} -\begin{frame} -\frametitle{deploy} -\begin{description} -\item [do\_rootfs] creates the root filesystem (file and directory structure) - for an image -\item [do\_vmdkimg] creates a .vmdk image for use with VMware and compatible - virtual machine hosts" -\item [do\_deploy] writes deployable output files to the deploy directory -\item [do\_populate\_sdk] creates the file and directory structure for an - installable SDK -\end{description} -\end{frame} +%\begin{frame} +%\frametitle{download \& patch} +%\begin{description} +%\item [do\_checkuri] validates the SRC\_URI value +%\item [do\_checkuriall] validates the SRC\_URI value for all recipes required +% to build a target" +%\item [do\_fetch] fetches the source code +%\item [do\_fetchall] fetches all remote sources required to build a target +%\item [do\_unpack] unpacks the source code into a working directory +%\item [do\_patch] locates patch files and applies them to the source code +%\end{description} +%end{frame} + +%\begin{frame} +%\frametitle{configure \& compile} +%\begin{description} +%\item [do\_configure] configures the source by enabling and disabling any +% build-time and configuration options for the software being built +%\item [do\_configure\_ptest\_base] configures the runtime test suite included +% in the software being built +%\item [do\_compile] compiles the source in the compilation directory +%\item [do\_install] copies files from the compilation directory to a holding +% area +%\item [do\_populate\_sysroot] copies a subset of files installed by +% do\_install into the sysroot in order to make them available to other +% recipes +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{packaging} +%\begin{description} +%\item [do\_packagedata] creates package metadata used by the build system to +% generate the final packages +%\item [do\_package] analyzes the content of the holding area and splits it +% into subsets based on available packages and files +%\item [do\_package\_write] creates the actual packages and places them in the +% Package Feed area +%\item [do\_package\_write\_deb] creates the actual DEB packages and places +% them in the Package Feed area +%\item [do\_package\_write\_ipk] creates the actual IPK packages and places +% them in the Package Feed area +%\item [do\_package\_write\_rpm] creates the actual RPM packages and places +% them in the Package Feed area +%\item [do\_package\_write\_tar] creates tar archives for packages and places +% them in the Package Feed area +%\item [do\_package\_index] creates or updates the index in the Package Feed +% area +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{deploy} +%\begin{description} +%\item [do\_rootfs] creates the root filesystem (file and directory structure) +% for an image +%\item [do\_vmdkimg] creates a .vmdk image for use with VMware and compatible +% virtual machine hosts" +%\item [do\_deploy] writes deployable output files to the deploy directory +%\item [do\_populate\_sdk] creates the file and directory structure for an +% installable SDK +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{cleanup} +%\begin{description} +%\item [do\_clean] removes all output files for a target +%\item [do\_cleanall] removes all output files, shared state cache, and +% downloaded source files for a target +%\item [do\_cleansstate] removes all output files and shared state cache for a +% target +%\item [do\_rm\_work] removes work files after the build system has finished +% with them +%\item [do\_rm\_work\_all] top-level task for removing work files after the +% build system has finished with them +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{kernel} +%\begin{description} +%\item [do\_kernel\_checkout] checks out source/meta branches for a linux-yocto +% style kernel +%\item [do\_validate\_branches] ensures that the source/meta branches are on +% the locations specified by their SRCREV values for a linux-yocto style +% kernel" +%\item [do\_kernel\_configme] assembles the kernel configuration for a +% linux-yocto style kernel +%\item [do\_menuconfig] runs 'make menuconfig' for the kernel +%\item [do\_diffconfig] compares the old and new config files after running +% do\_menuconfig for the kernel +%\item [do\_savedefconfig] creates a minimal Linux kernel configuration file +%\item [do\_kernel\_configcheck] validates the kernel configuration for a +% linux-yocto style kernel +%\item [do\_sizecheck] checks the size of the kernel image against +% KERNEL\_IMAGE\_MAXSIZE (if set) +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{kernel} +%\begin{description} +%\item [do\_compile\_kernelmodules] compiles loadable modules for the Linux +% kernel +%\item [do\_strip] strips unneeded sections out of the Linux kernel image +%\item [do\_kernel\_link\_vmlinux] creates a symbolic link in arch/\$arch/boot +% for vmlinux kernel images +%\item [do\_bundle\_initramfs] combines an initial ramdisk image and kernel +% together to form a single image +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{licenses} +%\begin{description} +%\item [do\_populate\_lic] writes license information for the recipe that is +% collected later when the image is constructed +%\item [do\_spdx] a build stage that takes the source code and scans it on a +% remote FOSSOLOGY server in order to produce an SPDX document +%\end{description} +%\end{frame} + +%\begin{frame} +%\frametitle{special stuff} +%\begin{description} +%\item [do\_uboot\_mkimage] creates a uImage file from the kernel for the +% U-Boot bootloader +%\item [do\_generate\_qt\_config\_file] writes a qt.conf file for building a +% Qt-based application +%\item [do\_devshell] starts a shell with the environment set up for +% development/debugging +%\item [do\_listtasks] lists all defined tasks for a target +%\end{description} +%\end{frame} -\begin{frame} -\frametitle{cleanup} -\begin{description} -\item [do\_clean] removes all output files for a target -\item [do\_cleanall] removes all output files, shared state cache, and - downloaded source files for a target -\item [do\_cleansstate] removes all output files and shared state cache for a - target -\item [do\_rm\_work] removes work files after the build system has finished - with them -\item [do\_rm\_work\_all] top-level task for removing work files after the - build system has finished with them -\end{description} -\end{frame} - -\begin{frame} -\frametitle{kernel} -\begin{description} -\item [do\_kernel\_checkout] checks out source/meta branches for a linux-yocto - style kernel -\item [do\_validate\_branches] ensures that the source/meta branches are on - the locations specified by their SRCREV values for a linux-yocto style - kernel" -\item [do\_kernel\_configme] assembles the kernel configuration for a - linux-yocto style kernel -\item [do\_menuconfig] runs 'make menuconfig' for the kernel -\item [do\_diffconfig] compares the old and new config files after running - do\_menuconfig for the kernel -\item [do\_savedefconfig] creates a minimal Linux kernel configuration file -\item [do\_kernel\_configcheck] validates the kernel configuration for a - linux-yocto style kernel -\item [do\_sizecheck] checks the size of the kernel image against - KERNEL\_IMAGE\_MAXSIZE (if set) -\end{description} +\begin{frame}[fragile] +\frametitle{Extending Tasks} +Existing tasks can be modified directly with \_prepend/\_append + \footnote{The language (shell or python) must match the task function.} or +using prefuncs/postfuncs variable flags. +\begin{verbatim} +do_patch_append() { + print("done patching ${PN}") +} + +do_configure_append() { + echo "done configuring ${PN}" +} + +my_compile_success() { + echo "done compiling ${PN}" +} +do_compile[postfuncs] += "my_compile_success" +\end{verbatim} \end{frame} -\begin{frame} -\frametitle{kernel} -\begin{description} -\item [do\_compile\_kernelmodules] compiles loadable modules for the Linux - kernel -\item [do\_strip] strips unneeded sections out of the Linux kernel image -\item [do\_kernel\_link\_vmlinux] creates a symbolic link in arch/\$arch/boot - for vmlinux kernel images -\item [do\_bundle\_initramfs] combines an initial ramdisk image and kernel - together to form a single image -\end{description} -\end{frame} +\subsection{Extending Recipes} \begin{frame} -\frametitle{licenses} -\begin{description} -\item [do\_populate\_lic] writes license information for the recipe that is - collected later when the image is constructed -\item [do\_spdx] a build stage that takes the source code and scans it on a - remote FOSSOLOGY server in order to produce an SPDX document -\end{description} +\frametitle{Append Files} +\begin{itemize} +\item append files are typically used to modify or extend the functionality + of a base recipe +\item anything can be modified (e.g. variables, functions, tasks) +\item it is recommended by the Yocto project to use append files instead + of copying and modyfiing a recipe in an own layer +\end{itemize} \end{frame} -\begin{frame} -\frametitle{special stuff} -\begin{description} -\item [do\_uboot\_mkimage] creates a uImage file from the kernel for the - U-Boot bootloader -\item [do\_generate\_qt\_config\_file] writes a qt.conf file for building a - Qt-based application -\item [do\_devshell] starts a shell with the environment set up for - development/debugging -\item [do\_listtasks] lists all defined tasks for a target -\end{description} +\begin{frame}[fragile] +\frametitle{Append File Naming} +An append file must be named after the base package: +\begin{verbatim} +<base-pn>_<base-pv>.bbappend +\end{verbatim} +A \% can be used as a wildcard to match any part of the version (e.g. bc\_1.\%.bbappend). \end{frame} \subsection{Machines} + \begin{frame} -\frametitle{basics} -a machine config is used to describe a board +\frametitle{The Machine Config} +A machine config is used to describe a board. \begin{itemize} -\item machine configs are stored in the layers: conf/machine/* -\item settings can be splitted in different include *.inc files -\item e.g. one include for CPU that is used by the SoC inc file, -that is used by the Board .conf file +\item machine configs are stored in the layers: conf/machine/ +\item settings may be split into different include files +\item e.g. one include for the CPU that is used by the SoC include file, +which is used by the machine .conf file \item the include files can be stored in different layers \end{itemize} \end{frame} \begin{frame} -\frametitle{u-boot \& kernel} -\begin{description} -\item [UBOOT\_MACHINE] value passed on the make command line when building a - U-Boot image -\item [UBOOT\_MAKE\_TARGET] target called in the Makefile -\item [UBOOT\_ENTRYPOINT] entry point for the U-Boot image -\item [PREFERRED\_PROVIDER\_virtual/kernel] default kernel -\item [KERNEL\_DEVICETREE] default devicetree -\item [KERNEL\_IMAGETYPE] type of kernel to build for a device, - defaults to 'zImage' -\end{description} -\end{frame} - -\begin{frame} -\frametitle{hardware} +\frametitle{Hardware Settings} \begin{description} \item[SOC\_FAMILY] groups together machines based upon the same family of SOC - (System On Chip) +(System On Chip) \item [MACHINEOVERRIDES] lists overrides specific to the current machine. - By default, this list includes the value of MACHINE. This can be used in - recipes; e.g. MACHINEOVERRIDES =. "mymachine" and in the recipe - SRC\_URI\_append\_mymachine = "file://mymachine-quirk.patch" +By default, this list includes the value of MACHINE. This can be used in +recipes; e.g. MACHINEOVERRIDES =. "mymachine" and in the recipe +SRC\_URI\_append\_mymachine = "file://mymachine-quirk.patch" \item [MACHINE\_FEATURES] list of hardware features the MACHINE supports \footnote{acpi, alsa, apm, bluetooth, ext2, irda, keyboard, pci, pcmcia, - screen, serial, touchscreen, usbgadget, usbhost, wifi} +screen, serial, touchscreen, usbgadget, usbhost, wifi} \item [MACHINE\_EXTRA\_RRECOMMENDS] list of machine-specific packages to - install as part of the image being built that are not essential for booting - the machine. The image being built has no build dependencies on the packages - in this list. +install as part of the image being built that are not essential for booting +the machine. The image being built has no build dependencies on the packages +in this list. \item [SERIAL\_CONSOLE] speed and device for the serial port used to attach - the serial console. This variable is given to the kernel as the 'console' - parameter. After booting occurs, getty is started on that port so remote - login is possible. +the serial console. This variable is given to the kernel as the 'console' +parameter. After booting occurs, getty is started on that port so remote +login is possible. \end{description} \end{frame} \begin{frame} -\frametitle{compiler settings} +\frametitle{Compiler Settings} \begin{description} \item [DEFAULTTUNE] e.g. armv6hf or cortexa8hf-neon, x86-64, \dots \item [TUNE\_FEATURES] e.g. "armv7a vfp neon" @@ -727,12 +785,26 @@ that is used by the Board .conf file \end{frame} \begin{frame} -\frametitle{software} +\frametitle{U-Boot \& Kernel Settings} +\begin{description} +\item [UBOOT\_MACHINE] value passed on the make command line when building a +U-Boot image +\item [UBOOT\_MAKE\_TARGET] target called in the Makefile +\item [UBOOT\_ENTRYPOINT] entry point for the U-Boot image +\item [PREFERRED\_PROVIDER\_virtual/kernel] default kernel +\item [KERNEL\_DEVICETREE] default devicetree +\item [KERNEL\_IMAGETYPE] type of kernel to build for a device, +defaults to 'zImage' +\end{description} +\end{frame} + +\begin{frame} +\frametitle{Software Settings} \begin{description} \item [PREFERRED\_VERSION\_xserver-xorg] compatible xserver version \item [PREFERRED\_PROVIDER\_virtual/kernel] recommended kernel \item [IMAGE\_FSTYPES] formats for the rootfs, e.g. "ext3 tar.bz2" \item [IMAGE\_CLASSES] list of classes that all images should inherit, default - is image\_types, e.g. to hook in own image generation code +is image\_types, e.g. to hook in own image generation code \end{description} \end{frame} |