[oe-commits] org.oe.documentation usermanual.xml: Reorder chapters, put Getting Started after Intro.

pfalcon commit openembedded-commits at lists.openembedded.org
Sat Dec 22 15:45:57 UTC 2007


usermanual.xml: Reorder chapters, put Getting Started after Intro.
* Of course, user-friendly manuals are written like this:
1. Intro
2. Easy way
3. Details

not like:

1. Intro
2. Lotsa dark and morbid knowledge
3. Now, let's set up it

Author: pfalcon at openembedded.org
Branch: org.openembedded.documentation
Revision: abef3810e6bc9f11fd4035b728b6930d55a84edb
ViewMTN: http://monotone.openembedded.org/revision/info/abef3810e6bc9f11fd4035b728b6930d55a84edb
Files:
1
usermanual/usermanual.xml
Diffs:

#
# mt diff -rf69698721b7c5ab8bf7f0025c9ef266b2204e09f -rabef3810e6bc9f11fd4035b728b6930d55a84edb
#
# 
# 
# patch "usermanual/usermanual.xml"
#  from [81abe6961bd959a1ee3ce68c47ecf70b8eda4d2a]
#    to [2e60849f6d0acdd1926fd2be6fce075dd85da316]
# 
============================================================
--- usermanual/usermanual.xml	81abe6961bd959a1ee3ce68c47ecf70b8eda4d2a
+++ usermanual/usermanual.xml	2e60849f6d0acdd1926fd2be6fce075dd85da316
@@ -57,6 +57,65 @@ OpenEmbedded was created.</para>
 
 
     <chapter>
+        <title>Getting Started</title>
+        <section>
+            <title>Getting <application>BitBake</application></title>
+            <para>The required version of <application>BitBake</application> is changing rapidly. At the time of writing (end of 2007) <application>BitBake</application> 1.8.latest was required.</para>
+            <para>A good method is to get <application>BitBake</application> from the stable Subversion branch.
+            <screen>
+<command>svn</command> co http://svn.berlios.de/svnroot/repos/bitbake/branches/bitbake-1.8
+...
+A   bitbake-1.8/classes/base.bbclass
+U   bitbake-1.8
+At revision 986.
+            </screen>
+            <application>BitBake</application> is checked out now; this completes the first and most critical dependency of OpenEmbedded. Issuing <command>svn</command> <command>update</command> in the <emphasis>bitbake-1.8</emphasis> directory will update <application>BitBake</application> to the latest stable version, but generally it is a good idea to stick with a specific known working version of <application>BitBake</application> until OpenEmbedded asks you to upgrade.
+            </para>
+        </section>
+
+        <section>
+            <title>Getting OpenEmbedded</title>
+            <para>
+The OpenEmbedded metadate has a high rate of development, so it's a good idea to stay up to date.
+You'll need monotone 0.29 or later to get the metadata and stay up to date. Monotone is available in most distributions and has binaries at http://venge.net/monotone/
+
+<screen>	    
+#get the snapshot
+wget http://openembedded.org/snapshots/OE.db.bz2 http://openembedded.org/snapshots/OE.db.bz2.md5
+
+#verify the integrity
+cat OE.db.bz2.md5sum
+md5sum OE.db.bz2
+
+#extract the tarball
+bunzip OE.db.bz2
+
+#check the development branch
+monotone --db=OE.db co -b org.openembedded.dev
+</screen>
+
+           </para>
+        </section>
+
+        <section>
+            <title>Configuring OpenEmbedded</title>
+            <para>This section is a stub, help us by expanding it</para>
+        </section>
+
+        <section>
+            <title>Building Software</title>
+            <para>Once you set up and configured BitBake and OpenEmbedded, you can build software and images like this:
+<screen>
+bitbake &lt;recipe_name&gt;
+</screen>
+	    </para>
+	    
+            <para>This section is a stub, help us by expanding it</para>
+        </section>
+    </chapter>
+
+
+    <chapter>
         <title>Metadata</title>
         <section>
             <title>File Layout</title>
@@ -166,64 +225,6 @@ It's important to use <emphasis>+=</emph
 
 
     <chapter>
-        <title>Getting Started with OpenEmbedded</title>
-        <section>
-            <title>Getting <application>BitBake</application></title>
-            <para>The required version of <application>BitBake</application> is changing rapidly. At the time of writing (end of 2007) <application>BitBake</application> 1.8.latest was required.</para>
-            <para>A good method is to get <application>BitBake</application> from the stable Subversion branch.
-            <screen>
-<command>svn</command> co http://svn.berlios.de/svnroot/repos/bitbake/branches/bitbake-1.8
-...
-A   bitbake-1.8/classes/base.bbclass
-U   bitbake-1.8
-At revision 986.
-            </screen>
-            <application>BitBake</application> is checked out now; this completes the first and most critical dependency of OpenEmbedded. Issuing <command>svn</command> <command>update</command> in the <emphasis>bitbake-1.8</emphasis> directory will update <application>BitBake</application> to the latest stable version, but generally it is a good idea to stick with a specific known working version of <application>BitBake</application> until OpenEmbedded asks you to upgrade.
-            </para>
-        </section>
-
-        <section>
-            <title>Getting OpenEmbedded</title>
-            <para>
-The OpenEmbedded metadate has a high rate of development, so it's a good idea to stay up to date.
-You'll need monotone 0.29 or later to get the metadata and stay up to date. Monotone is available in most distributions and has binaries at http://venge.net/monotone/
-
-<screen>	    
-#get the snapshot
-wget http://openembedded.org/snapshots/OE.db.bz2 http://openembedded.org/snapshots/OE.db.bz2.md5
-
-#verify the integrity
-cat OE.db.bz2.md5sum
-md5sum OE.db.bz2
-
-#extract the tarball
-bunzip OE.db.bz2
-
-#check the development branch
-monotone --db=OE.db co -b org.openembedded.dev
-</screen>
-
-           </para>
-        </section>
-
-        <section>
-            <title>Configuring OpenEmbedded</title>
-            <para>This section is a stub, help us by expanding it</para>
-        </section>
-
-        <section>
-            <title>Building Software</title>
-            <para>Once you set up and configured BitBake and OpenEmbedded, you can build software and images like this:
-<screen>
-bitbake &lt;recipe_name&gt;
-</screen>
-	    </para>
-	    
-            <para>This section is a stub, help us by expanding it</para>
-        </section>
-    </chapter>
-
-    <chapter>
         <title>Special features</title>
         <section>
             <title>Debian package naming <anchor id="debian" /></title>






More information about the Openembedded-commits mailing list