aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2020-02-07 05:51:11 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-02-08 17:41:11 +0000
commitbc84ce7e6542dac1a150b9733411190cff591948 (patch)
tree07b3c0fc6498cd105459dfc436266971bcbfb7df /doc
parent79ada807de0b202c3d568fc4365a1d3f17ba1bce (diff)
downloadbitbake-bc84ce7e6542dac1a150b9733411190cff591948.tar.gz
doc: minor tweaks to ch 1 of BB user manual
Tweaks include: - hyphenation - rewording for brevity or clarification - adding <firstterm> markup where appropriate Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-intro.xml18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
index c87eac524..f5526c053 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
@@ -127,7 +127,7 @@
(e.g. Cygwin, the BSDs, and so forth).
</para></listitem>
<listitem><para>
- Be self contained, rather than tightly
+ Be self-contained, rather than tightly
integrated into the build machine's root
filesystem.
</para></listitem>
@@ -221,6 +221,8 @@
them</para></listitem>
<listitem><para>How to configure and compile the
source code</para></listitem>
+ <listitem><para>How to assemble the generated artifacts into
+ one or more installable packages</para></listitem>
<listitem><para>Where on the target machine to install the
package or packages created</para></listitem>
</itemizedlist>
@@ -229,7 +231,7 @@
<para>
Within the context of BitBake, or any project utilizing BitBake
as its build system, files with the <filename>.bb</filename>
- extension are referred to as recipes.
+ extension are referred to as <firstterm>recipes</firstterm>.
<note>
The term "package" is also commonly used to describe recipes.
However, since the same word is used to describe packaged
@@ -252,9 +254,9 @@
various configuration variables that govern the project's build
process.
These files fall into several areas that define
- machine configuration options, distribution configuration
- options, compiler tuning options, general common
- configuration options, and user configuration options.
+ machine configuration, distribution configuration,
+ possible compiler tuning, general common
+ configuration, and user configuration.
The main configuration file is the sample
<filename>bitbake.conf</filename> file, which is
located within the BitBake source tree
@@ -292,7 +294,7 @@
Layers allow you to isolate different types of
customizations from each other.
While you might find it tempting to keep everything in one layer
- when working on a single project, the more modular you organize
+ when working on a single project, the more modular
your metadata, the easier it is to cope with future changes.
</para>
@@ -300,8 +302,8 @@
To illustrate how you can use layers to keep things modular,
consider customizations you might make to support a specific target machine.
These types of customizations typically reside in a special layer,
- rather than a general layer, called a Board Support Package (BSP)
- Layer.
+ rather than a general layer, called a <firstterm>Board Support Package</firstterm> (BSP)
+ layer.
Furthermore, the machine customizations should be isolated from
recipes and metadata that support a new GUI environment, for
example.