[bootlin/training-materials updates] master: yocto: slides: fix typos, improve wording, add clarifications (38ded23a)
Luca Ceresoli
luca.ceresoli at bootlin.com
Fri Oct 13 12:32:49 CEST 2023
Repository : https://github.com/bootlin/training-materials
On branch : master
Link : https://github.com/bootlin/training-materials/commit/38ded23a5f0b4a0a4f861aec27c93c5005f4b0e6
>---------------------------------------------------------------
commit 38ded23a5f0b4a0a4f861aec27c93c5005f4b0e6
Author: Luca Ceresoli <luca.ceresoli at bootlin.com>
Date: Thu Oct 12 11:06:50 2023 +0200
yocto: slides: fix typos, improve wording, add clarifications
Reported-by: rpjday at crashcourse.ca
Signed-off-by: Luca Ceresoli <luca.ceresoli at bootlin.com>
>---------------------------------------------------------------
38ded23a5f0b4a0a4f861aec27c93c5005f4b0e6
.../buildsystem-principle.dia | 12 ++++++------
slides/yocto-advanced/yocto-advanced.tex | 17 +++++++++--------
slides/yocto-overview/yocto-overview.tex | 16 ++++++++--------
slides/yocto-recipe-basics/yocto-recipe-basics.tex | 14 ++++++++------
4 files changed, 31 insertions(+), 28 deletions(-)
diff --git a/slides/buildroot-yocto-introduction/buildsystem-principle.dia b/slides/buildroot-yocto-introduction/buildsystem-principle.dia
index e330bd80..c6962203 100644
--- a/slides/buildroot-yocto-introduction/buildsystem-principle.dia
+++ b/slides/buildroot-yocto-introduction/buildsystem-principle.dia
@@ -177,13 +177,13 @@
<dia:point val="20.75,6"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="14.6088,4.66008;26.8912,7.33992"/>
+ <dia:rectangle val="14.9863,4.60589;26.5499,7.39411"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Open-source components
-(from http, ftp, git, svn, etc.)#</dia:string>
+(via http, ftp, git, svn, etc.)#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="Latin Modern Sans" style="0" name="Courier"/>
@@ -192,7 +192,7 @@
<dia:real val="1.2347221747040749"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="20.75,5.79997"/>
+ <dia:point val="20.75,5.78191"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000ff"/>
@@ -214,13 +214,13 @@
<dia:point val="20.75,13"/>
</dia:attribute>
<dia:attribute name="obj_bb">
- <dia:rectangle val="14.6088,11.6601;26.8912,14.3399"/>
+ <dia:rectangle val="14.9863,11.6059;26.5499,14.3941"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#In-house components
-(from http, ftp, git, svn, etc.)#</dia:string>
+(via http, ftp, git, svn, etc.)#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="Latin Modern Sans" style="0" name="Courier"/>
@@ -229,7 +229,7 @@
<dia:real val="1.2347221747040749"/>
</dia:attribute>
<dia:attribute name="pos">
- <dia:point val="20.75,12.8"/>
+ <dia:point val="20.75,12.7819"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000ff"/>
diff --git a/slides/yocto-advanced/yocto-advanced.tex b/slides/yocto-advanced/yocto-advanced.tex
index c7c10fbb..8348daf6 100644
--- a/slides/yocto-advanced/yocto-advanced.tex
+++ b/slides/yocto-advanced/yocto-advanced.tex
@@ -13,7 +13,7 @@
\begin{frame}
\frametitle{A little reminder}
\begin{itemize}
- \item A {\em Recipe} describe how to fetch, configure, compile and
+ \item A {\em Recipe} describes how to fetch, configure, compile and
install a software component (application, library, \dots).
\item These tasks can be run independently (if their dependencies
are met).
@@ -45,7 +45,7 @@
\item Files ending in \code{.bb}, \code{.bbappend} and \code{.bbclass}
\end{itemize}
\item Recipes can also access the global scope
- \item All variables can be overridden or modified in
+ \item All variables can be overridden in
\code{$BUILDDIR/conf/local.conf}
\end{itemize}
\end{frame}
@@ -218,7 +218,7 @@ IMAGE_INSTALL = "busybox mtd-utils"
\end{columns}
\end{frame}
-\subsection{Packages variants}
+\subsection{Package variants}
\begin{frame}
\frametitle{Introduction to package variants}
@@ -308,7 +308,7 @@ IMAGE_INSTALL = "busybox mtd-utils"
\code{PACKAGE_EXCLUDE} variable.
\item If you choose to not install a package using this variable
and some other package is dependent on it (i.e. listed in a
- recipe's RDEPENDS variable), the OpenEmbedded build system
+ recipe's \code{RDEPENDS} variable), the OpenEmbedded build system
generates a fatal installation error.
\item This only works with RPM and IPK packages.
\end{itemize}
@@ -327,7 +327,7 @@ IMAGE_INSTALL = "busybox mtd-utils"
\item \code{bitbake ncurses}
\item \code{bitbake ncurses-native}
\end{itemize}
- \item But it can be more precise, with optional options:
+ \item But it can be more precise, with additional options:
\begin{description}
\item[\code{-c <task>}] execute the given task
\item[\code{-s}] list all locally available recipes and their
@@ -371,9 +371,10 @@ IMAGE_INSTALL = "busybox mtd-utils"
\frametitle{shared state cache}
\begin{itemize}
\item BitBake stores the output of each task in a directory, the
- shared state cache. Its location is controlled by the
- \code{SSTATE_DIR} variable.
- \item This cache is use to speed up compilation.
+ shared state cache.
+ \item This cache is used to speed up compilation.
+ \item Its location is defined by the \code{SSTATE_DIR} variable and
+ defaults to \code{build/sstate-cache}.
\item Over time, as you compile more recipes, it can grow quite
big. It is possible to clean old data with:
\begin{block}{}
diff --git a/slides/yocto-overview/yocto-overview.tex b/slides/yocto-overview/yocto-overview.tex
index 1630461c..b54fa464 100644
--- a/slides/yocto-overview/yocto-overview.tex
+++ b/slides/yocto-overview/yocto-overview.tex
@@ -7,8 +7,8 @@
\begin{itemize}
\item The Yocto Project is an open source collaboration project
that allows to build custom embedded Linux-based systems.
- \item It has been initiated by the Linux Foundation in 2010 and is
- still managed by one of its fellows: Richard Purdie.
+ \item Established by the Linux Foundation in 2010 and still managed by
+ one of its fellows: Richard Purdie.
\end{itemize}
\end{frame}
@@ -63,8 +63,8 @@
{\em tasks}
\item Each task performs a specific step in the build
\item Examples: fetch, configure, compile, package
- \item Tasks have dependencies over other tasks (including on tasks of
- other recipes)
+ \item Tasks can depend on other tasks (including on tasks of other
+ recipes)
\end{itemize}
\column{0.4\textwidth}
\begin{center}
@@ -78,8 +78,8 @@
\item The input to \code{bitbake} is collectively called {\em metadata}
\item Metadata includes {\em configuration files}, {\em recipes}, {\em
classes} and {\em include files}
- \item Metadata is organized in {\em layers}, which can be composed
- together to get various components
+ \item Metadata is organized in {\em layers}, which can be composed to
+ get various components
\begin{itemize}
\item A layer is a set of recipes, configurations files and classes
matching a common purpose
@@ -136,8 +136,8 @@
\item The {\em meta-ti-bsp} layer, a set of Texas Instruments
specific recipes.
\end{itemize}
- \item All modifications are made in your own layer.
- Editing Poky or {\em meta-ti} is a \textbf{no-go}!
+ \item All modifications are made in your own layer. Editing Poky or
+ any other third-party layer is a \textbf{no-go}!
\item We will set up this environment in the lab.
\end{itemize}
\end{frame}
diff --git a/slides/yocto-recipe-basics/yocto-recipe-basics.tex b/slides/yocto-recipe-basics/yocto-recipe-basics.tex
index b3a549e4..1266ec36 100644
--- a/slides/yocto-recipe-basics/yocto-recipe-basics.tex
+++ b/slides/yocto-recipe-basics/yocto-recipe-basics.tex
@@ -20,6 +20,9 @@
\item Recipes are parsed by the BitBake build engine.
\item The format of a recipe file name is
\code{<application-name>_<version>.bb}
+ \item The output product of a recipe is a set of binary packages (rpm,
+ deb or ipk): typically \code{<recipename>}, \code{<recipename>-doc},
+ \code{<recipename>-dbg} etc.
\end{itemize}
\end{frame}
@@ -41,11 +44,10 @@
\item To make it easier to write a recipe, some variables are
automatically available:
\begin{description}
- \item[PN] package name, as specified in the recipe file name
- \item[BPN] \code{PN} with prefixes and suffixes removed such
- as \code{nativesdk-}, or \code{-native}
- \item[PV] package version, as specified in the recipe file
- name
+ \item[BPN] recipe name, extracted from the recipe file name
+ \item[PN] \code{BPN} potentially with prefixes or suffixes added
+ such as \code{nativesdk-}, or \code{-native}
+ \item[PV] package version, extracted from the the recipe file name
\item[BP] defined as \code{${BPN}-${PV}}
\end{description}
\item The recipe name and version usually match the upstream ones.
@@ -189,7 +191,7 @@ SRC_URI[patch.md5sum] = "b184acf9eb39df794ffd..."
variable
\item \code{FILESPATH} is a colon-separated list of paths to look for
files
- \item The order matters: when a file is found in a paths, the search
+ \item The order matters: when a file is found in a path, the search
ends
\end{itemize}
\end{frame}
More information about the training-materials-updates
mailing list