Browse Source

dev-manual: Various small edits to Chapter 3.

Replaced angled bracket items for user-supplied variables
with the <replaceable></replaceable> tags.

(From yocto-docs rev: 393af6c0cfbfc0f3921bc1eb1fdbd3dd734f51ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark 10 years ago
parent
commit
1ab0c8fb8c
1 changed files with 7 additions and 7 deletions
  1. 7 7
      documentation/dev-manual/dev-manual-newbie.xml

+ 7 - 7
documentation/dev-manual/dev-manual-newbie.xml

@@ -661,8 +661,8 @@
                     Application Developer's Guide</ulink>.
                 </para></listitem>
             <listitem><para><emphasis>Image:</emphasis>
-                An image is the result produced when BitBake processes a given
-                collection of recipes and related Metadata.
+                An image is an artifact of the BitBake build process given
+                a collection of recipes and related Metadata.
                 Images are the binary output that run on specific hardware or
                 QEMU and are used for specific use-cases.
                 For a list of the supported image types that the Yocto Project provides, see the
@@ -1401,7 +1401,7 @@
                 following command to bring up a short list of all commits
                 against a specific file:
                 <literallayout class='monospaced'>
-     git shortlog -- &lt;filename&gt;
+     git shortlog -- <replaceable>filename</replaceable>
                 </literallayout>
                 Just provide the name of the file for which you are interested.
                 The information returned is not ordered by history but does
@@ -1521,12 +1521,12 @@
                 bug references - any commit that addresses a specific bug should
                 use the following form for the detailed description:
                 <literallayout class='monospaced'>
-     Fixes [YOCTO #&lt;bug-id&gt;]
+     Fixes [YOCTO #<replaceable>bug-id</replaceable>]
 
-     &lt;detailed description of change&gt;
+     <replaceable>detailed description of change</replaceable>
                 </literallayout></para></listitem>
-                Where &lt;bug-id&gt; is replaced with the specific bug ID from
-                the Yocto Project Bugzilla instance.
+                Where <replaceable>bug-id</replaceable> is replaced with the
+                specific bug ID from the Yocto Project Bugzilla instance.
         </itemizedlist>
     </para>