Patchwork [bitbake-devel] Documentation: User manual, chapter 1: Minor tweaks.

login
register
mail settings
Submitter Robert P. J. Day
Date July 7, 2014, 11:53 a.m.
Message ID <alpine.LFD.2.11.1407070749140.6927@localhost>
Download mbox | patch
Permalink /patch/75099/
State New
Headers show

Comments

Robert P. J. Day - July 7, 2014, 11:53 a.m.
Some minor fixes and additions to the first couple sections of the
BitBake User Manual.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  first in what will probably be a series of patches fiddling around
with the bitbake user manual, since i want to use it in an upcoming
yocto course so i might as well add in the stuff i'd be pointing out,
anyway.

  this is for just the first part of chapter 1 -- i'll submit patches
in bite-size pieces rather than trying to do monster patches all at
once. some of this isn't really fixing stuff so much as just my idea
of rewording, but i'll always bundle in stuff like that with actual
corrections.
Rifenbark, Scott M - July 8, 2014, 12:14 p.m.
Applied to contrib area.  Needs merged into bitbake.

Scott

>-----Original Message-----
>From: bitbake-devel-bounces@lists.openembedded.org [mailto:bitbake-
>devel-bounces@lists.openembedded.org] On Behalf Of Robert P. J. Day
>Sent: Monday, July 07, 2014 4:54 AM
>To: BitBake developer list
>Subject: [bitbake-devel] [PATCH] Documentation: User manual, chapter 1:
>Minor tweaks.
>
>
>Some minor fixes and additions to the first couple sections of the BitBake User
>Manual.
>
>Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
>---
>
>  first in what will probably be a series of patches fiddling around with the
>bitbake user manual, since i want to use it in an upcoming yocto course so i
>might as well add in the stuff i'd be pointing out, anyway.
>
>  this is for just the first part of chapter 1 -- i'll submit patches in bite-size
>pieces rather than trying to do monster patches all at once. some of this isn't
>really fixing stuff so much as just my idea of rewording, but i'll always bundle
>in stuff like that with actual corrections.
>
>diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
>b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
>index af2400f..2df30ad 100644
>--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
>+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
>@@ -34,18 +34,19 @@
>             <itemizedlist>
>                 <listitem><para>
>                     BitBake executes tasks according to provided
>-                    metadata that builds up the tasks.
>-                    Metadata is stored in recipe (<filename>.bb</filename>),
>-                    recipe "append" (<filename>.bbappend</filename>),
>-                    configuration (<filename>.conf</filename>), and class
>-                    (<filename>.bbclass</filename>) files and provides
>+                    metadata that builds up the tasks. Metadata is stored in
>+                    recipe (<filename>.bb</filename>) and related
>+                    recipe "append" (<filename>.bbappend</filename>) files,
>+                    configuration (<filename>.conf</filename>) and underlying
>+                    include (<filename>.inc</filename>) files, and class
>+                    (<filename>.bbclass</filename>) files, and provides
>                     BitBake with instructions on what tasks to run and
>                     the dependencies between those tasks.
>                     </para></listitem>
>                 <listitem><para>
>                     BitBake includes a fetcher library for obtaining source
>                     code from various places such as local files, source control
>-                    systems, websites, or local files.
>+                    systems or websites.
>                     </para></listitem>
>                 <listitem><para>
>                     The instructions for each unit to be built (e.g. a piece @@ -56,7
>+57,7 @@
>                     </para></listitem>
>                 <listitem><para>
>                     BitBake includes a client/server abstraction and can
>-                    be used from a command line or used as a service over XMLRPC
>and
>+                    be used from a command line or used as a service
>+ over XML-RPC and
>                     has several different user interfaces.
>                     </para></listitem>
>             </itemizedlist>
>@@ -80,8 +81,10 @@
>             Today, BitBake is the primary basis of the
>             <ulink
>url="http://www.openembedded.org/">OpenEmbedded</ulink>
>             project, which is being used to build and maintain Linux
>-            distributions such as the Angstrom Distribution and which is used
>-            as the build tool for Linux projects such as the Yocto Project.
>+            distributions such as the
>+            <ulink url="http://www.angstrom-distribution.org/">Angstrom
>Distribution</ulink>
>+            and which is used as the build tool for Linux projects such as the
>+            <ulink url="https://www.yoctoproject.org/">Yocto Project</ulink>.
>         </para>
>
>         <para>
>@@ -152,7 +155,7 @@
>                     </para></listitem>
>                 <listitem><para>
>                     Split metadata into layers and allow layers
>-                    to override each other.
>+                    to enhance or override other layers.
>                     </para></listitem>
>                 <listitem><para>
>                     Allow representation of a given set of input variables
>
>--
>
>===========================================================
>=============
>Robert P. J. Day                                 Ottawa, Ontario, CANADA
>                        http://crashcourse.ca
>
>Twitter:                                       http://twitter.com/rpjday
>LinkedIn:                               http://ca.linkedin.com/in/rpjday
>===========================================================
>=============
>--
>_______________________________________________
>bitbake-devel mailing list
>bitbake-devel@lists.openembedded.org
>http://lists.openembedded.org/mailman/listinfo/bitbake-devel

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
index af2400f..2df30ad 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
@@ -34,18 +34,19 @@ 
             <itemizedlist>
                 <listitem><para>
                     BitBake executes tasks according to provided
-                    metadata that builds up the tasks.
-                    Metadata is stored in recipe (<filename>.bb</filename>),
-                    recipe "append" (<filename>.bbappend</filename>),
-                    configuration (<filename>.conf</filename>), and class
-                    (<filename>.bbclass</filename>) files and provides
+                    metadata that builds up the tasks. Metadata is stored in
+                    recipe (<filename>.bb</filename>) and related
+                    recipe "append" (<filename>.bbappend</filename>) files,
+                    configuration (<filename>.conf</filename>) and underlying
+                    include (<filename>.inc</filename>) files, and class
+                    (<filename>.bbclass</filename>) files, and provides
                     BitBake with instructions on what tasks to run and
                     the dependencies between those tasks.
                     </para></listitem>
                 <listitem><para>
                     BitBake includes a fetcher library for obtaining source
                     code from various places such as local files, source control
-                    systems, websites, or local files.
+                    systems or websites.
                     </para></listitem>
                 <listitem><para>
                     The instructions for each unit to be built (e.g. a piece
@@ -56,7 +57,7 @@ 
                     </para></listitem>
                 <listitem><para>
                     BitBake includes a client/server abstraction and can
-                    be used from a command line or used as a service over XMLRPC and
+                    be used from a command line or used as a service over XML-RPC and
                     has several different user interfaces.
                     </para></listitem>
             </itemizedlist>
@@ -80,8 +81,10 @@ 
             Today, BitBake is the primary basis of the
             <ulink url="http://www.openembedded.org/">OpenEmbedded</ulink>
             project, which is being used to build and maintain Linux
-            distributions such as the Angstrom Distribution and which is used
-            as the build tool for Linux projects such as the Yocto Project.
+            distributions such as the
+            <ulink url="http://www.angstrom-distribution.org/">Angstrom Distribution</ulink>
+            and which is used as the build tool for Linux projects such as the
+            <ulink url="https://www.yoctoproject.org/">Yocto Project</ulink>.
         </para>

         <para>
@@ -152,7 +155,7 @@ 
                     </para></listitem>
                 <listitem><para>
                     Split metadata into layers and allow layers
-                    to override each other.
+                    to enhance or override other layers.
                     </para></listitem>
                 <listitem><para>
                     Allow representation of a given set of input variables