[bootlin/training-materials updates] master: yocto: slides: always use monospace and lowercase for the bitbake program (19b421db)
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/19b421db08e4d1eaee06b1012286e711271eb7ee
>---------------------------------------------------------------
commit 19b421db08e4d1eaee06b1012286e711271eb7ee
Author: Luca Ceresoli <luca.ceresoli at bootlin.com>
Date: Thu Oct 12 11:08:50 2023 +0200
yocto: slides: always use monospace and lowercase for the bitbake program
Reported-by: rpjday at crashcourse.ca
Signed-off-by: Luca Ceresoli <luca.ceresoli at bootlin.com>
>---------------------------------------------------------------
19b421db08e4d1eaee06b1012286e711271eb7ee
slides/yocto-layer-management/yocto-layer-management.tex | 2 +-
slides/yocto-overview/yocto-overview.tex | 6 +++---
slides/yocto-recipe-advanced/yocto-recipe-advanced.tex | 12 ++++++------
slides/yocto-recipe-basics/yocto-recipe-basics.tex | 8 ++++----
slides/yocto-recipe-extra/yocto-recipe-extra.tex | 8 ++++----
5 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/slides/yocto-layer-management/yocto-layer-management.tex b/slides/yocto-layer-management/yocto-layer-management.tex
index b116a9d2..be0c21b8 100644
--- a/slides/yocto-layer-management/yocto-layer-management.tex
+++ b/slides/yocto-layer-management/yocto-layer-management.tex
@@ -155,7 +155,7 @@ machine:
$ kas build meta-custom/mymachine.yaml
\end{minted}
- \item Or, alternatively, invoke bitbake commands:
+ \item Or, alternatively, invoke \code{bitbake} commands:
\begin{minted}{sh}
$ kas shell /path/to/kas-project.yml -c 'bitbake dosfsutils-native'
diff --git a/slides/yocto-overview/yocto-overview.tex b/slides/yocto-overview/yocto-overview.tex
index b54fa464..ca734fac 100644
--- a/slides/yocto-overview/yocto-overview.tex
+++ b/slides/yocto-overview/yocto-overview.tex
@@ -40,12 +40,12 @@
\begin{columns}
\column{0.6\textwidth}
\begin{itemize}
- \item The main kind of text file parsed by bitbake is {\em recipes},
+ \item The main kind of text file parsed by \code{bitbake} is {\em recipes},
each describing a specific software component
\item Each {\em Recipe} describes how to fetch and build a software
component: e.g. a program, a library or an image
\item They have a specific syntax
- \item bitbake can be asked to build any recipe, building all its
+ \item \code{bitbake} can be asked to build any recipe, building all its
dependencies automatically beforehand
\end{itemize}
\column{0.4\textwidth}
@@ -172,7 +172,7 @@
\begin{frame}
\frametitle{Poky source tree 1/2}
\begin{description}[style=nextline]
- \item[bitbake/] Holds all scripts used by the BitBake command.
+ \item[bitbake/] Holds all scripts used by the \code{bitbake} command.
Usually matches the stable release of the BitBake project.
\item[documentation/] All documentation sources for the Yocto
Project documentation. Can be used to generate nice PDFs.
diff --git a/slides/yocto-recipe-advanced/yocto-recipe-advanced.tex b/slides/yocto-recipe-advanced/yocto-recipe-advanced.tex
index b814725f..3b7a2767 100644
--- a/slides/yocto-recipe-advanced/yocto-recipe-advanced.tex
+++ b/slides/yocto-recipe-advanced/yocto-recipe-advanced.tex
@@ -9,7 +9,7 @@
in third party layers so it is easy to update.
\item But it is sometimes useful to apply a custom patch or add a
configuration file for example.
- \item The BitBake \emph{build engine} allows to modify a recipe by
+ \item The \code{bitbake} \emph{build engine} allows to modify a recipe by
extending it.
\item Multiple extensions can be applied to a recipe.
\end{itemize}
@@ -89,7 +89,7 @@ do_install:append() {
\begin{frame}
\frametitle{Providing virtual packages}
\begin{itemize}
- \item BitBake allows to use virtual names instead of the actual
+ \item \code{bitbake} allows to use virtual names instead of the actual
package name. We saw a use case with \emph{package
variants}.
\item The virtual name is specified through the \code{PROVIDES}
@@ -328,7 +328,7 @@ do_install() {
\item \code{include} and \code{require} can be used in all files,
to insert the content of another file at that location.
\item If the path specified on the \code{include} (or
- \code{require}) path is relative, BitBake will insert the first
+ \code{require}) path is relative, \code{bitbake} will insert the first
file found in \code{BBPATH}.
\item \code{include} does not produce an error when a file cannot
be found, whereas \code{require} raises a parsing error.
@@ -346,7 +346,7 @@ do_install() {
\item For each task, logs are available in the \code{temp}
directory in the work folder of a recipe. This includes both
the actual tasks code that ran and the output of the task.
- \item bitbake can dump the whole environment, including the
+ \item \code{bitbake} can dump the whole environment, including the
variable values and how they were set:
\begin{block}{}
\begin{minted}[fontsize=\tiny]{console}
@@ -400,7 +400,7 @@ BUILDHISTORY_COMMIT = "1"
\begin{frame}
\frametitle{Source fetching}
\begin{itemize}
- \item BitBake will look for files to retrieve at the following
+ \item \code{bitbake} will look for files to retrieve at the following
locations, in order:
\begin{enumerate}
\item \code{DL_DIR} (the local download directory).
@@ -469,7 +469,7 @@ PREMIRRORS:prepend = "\
\item To download all the sources before disabling network access use
\code{bitbake --runall=fetch core-image-minimal}
\end{itemize}
- \item Or restrict BitBake to only download files from the
+ \item Or restrict \code{bitbake} to only download files from the
\code{PREMIRRORS}, using \code{BB_FETCH_PREMIRRORONLY = "1"}
\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 1266ec36..aa0d36ef 100644
--- a/slides/yocto-recipe-basics/yocto-recipe-basics.tex
+++ b/slides/yocto-recipe-basics/yocto-recipe-basics.tex
@@ -17,7 +17,7 @@
compile, install and generate binary packages.
\item It also defines what build or runtime dependencies are
required.
- \item Recipes are parsed by the BitBake build engine.
+ \item Recipes are parsed by the \code{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,
@@ -280,7 +280,7 @@ recipes-kernel/
\begin{frame}
\frametitle{The source locations: tarballs}
\begin{itemize}
- \item When extracting a tarball, BitBake expects to find the
+ \item When extracting a tarball, \code{bitbake} expects to find the
extracted files in a directory named
\code{<application>-<version>}. This is controlled by the
\code{S} variable. If the directory has another name, you must
@@ -338,7 +338,7 @@ LIC_FILES_CHKSUM = \
\begin{itemize}
\item Sometimes a recipe have dependencies on specific versions
of another recipe.
- \item BitBake allows to reflect this by using:
+ \item \code{bitbake} allows to reflect this by using:
\begin{itemize}
\item \code{DEPENDS = "recipe-b (>= 1.2)"}
\item \code{RDEPENDS:${PN} = "recipe-b (>= 1.2)"}
@@ -378,7 +378,7 @@ LIC_FILES_CHKSUM = \
\begin{description}
\item[WORKDIR] the recipe's working directory
\item[S] The directory where the source code is extracted
- \item[B] The directory where bitbake places the objects
+ \item[B] The directory where \code{bitbake} places the objects
generated during the build
\item[D] The destination directory (root directory of where
the files are installed, before creating the image).
diff --git a/slides/yocto-recipe-extra/yocto-recipe-extra.tex b/slides/yocto-recipe-extra/yocto-recipe-extra.tex
index edfda797..4de9fc40 100644
--- a/slides/yocto-recipe-extra/yocto-recipe-extra.tex
+++ b/slides/yocto-recipe-extra/yocto-recipe-extra.tex
@@ -19,7 +19,7 @@
\begin{frame}{Per-recipe sysroot}
\begin{itemize}
- \item Instead of a global sysroot, bitbake implements a {\em
+ \item Instead of a global sysroot, \code{bitbake} implements a {\em
per-recipe sysroot}
\item Before the actual build, each recipe prepares its own sysroot
\begin{itemize}
@@ -74,7 +74,7 @@
keyword.
\item Two modules are automatically imported:
\begin{itemize}
- \item \code{bb}: to access BitBake's internal functions.
+ \item \code{bb}: to access \code{bitbake}'s internal functions.
\item \code{os}: Python's operating system interfaces.
\end{itemize}
\item You can import other modules using the \code{import}
@@ -89,7 +89,7 @@
\frametitle{Accessing the datastore with Python}
\begin{itemize}
\item The \code{d} variable is accessible within Python tasks.
- \item \code{d} represents the BitBake datastore (where variables are
+ \item \code{d} represents the \code{bitbake} datastore (where variables are
stored).
\end{itemize}
\begin{description}
@@ -141,7 +141,7 @@ do_install() {
SRC_URI[md5sum] = "97b2c3fb082241ab5c56ab728522622b"
\end{minted}
\item See
- \href{https://docs.yoctoproject.org/bitbake/2.2/bitbake-user-manual/bitbake-user-manual-metadata.html#variable-flags}{the list of varflags supported by Bitbake}.
+ \href{https://docs.yoctoproject.org/bitbake/2.2/bitbake-user-manual/bitbake-user-manual-metadata.html#variable-flags}{the list of varflags supported by bitbake}.
\item More varflags can be added freely.
\end{itemize}
\end{frame}
More information about the training-materials-updates
mailing list