docs/packaged-staging.xml: add more structure

1 files changed, 29 insertions, 21 deletions

diff --git a/docs/packaged-staging.xml b/docs/packaged-staging.xml
index b98d9087d7..1cd7e80bc3 100644
--- a/docs/packaged-staging.xml
+++ b/docs/packaged-staging.xml
@@ -26,19 +26,17 @@
 
 <para>First we need to identify three classes of packages:
 <itemizedlist>
-<listitem><para>'native'  - These packages run on the buildsystem (e.g. quilt-native)</para></listitem>
-<listitem><para>'cross'   - These packages run on the buildsystem, but creates things for the target system (e.g gcc-cross)</para></listitem>
-<listitem><para>'regular' - These packages run on the targetsystem (e.g. glibc)</para></listitem>
+	<listitem><para>'native'  - These packages run on the buildsystem (e.g. quilt-native)</para></listitem>
+	<listitem><para>'cross'   - These packages run on the buildsystem, but creates things for the target system (e.g gcc-cross)</para></listitem>
+	<listitem><para>'regular' - These packages run on the targetsystem (e.g. glibc)</para></listitem>
 </itemizedlist>
 </para>
 <para>
 And some terminology:
-
 <itemizedlist>
-<listitem><para>'current metadata' 	- the metadata found in the org.openembedded.dev branch</para></listitem>
-<listitem><para>'the branch' 		- the org.openembedded.packaged-staging branch</para></listitem>
+	<listitem><para>'current metadata' 	- the metadata found in the org.openembedded.dev branch</para></listitem>
+	<listitem><para>'the branch' 		- the org.openembedded.packaged-staging branch</para></listitem>
 </itemizedlist>
-
 </para>
 </chapter>
 
@@ -48,25 +46,23 @@ And some terminology:
                 <listitem><para>Start over from scratch</para></listitem>
                 <listitem><para>Incrementally install and remove packages</para></listitem>
              </itemizedlist>
-

 </para>
+
 <section>

-<title>Start over from scratch</title>
<para>
For each to be built package we will repopulate the staging directory from scratch. The benefits are a clean environment and avoids packages picking stuff up at random. Conflicts when installing packages can only happen when two different providers are trying to install the same file. This can only be a bug of the OpenEmbedded meta data. This approach will not require any conflict handling or resolution

+	<title>Start over from scratch</title>
<para>
For each to be built package we will repopulate the staging directory from scratch. The benefits are a clean environment and avoids packages picking stuff up at random. Conflicts when installing packages can only happen when two different providers are trying to install the same file. This can only be a bug of the OpenEmbedded meta data. This approach will not require any conflict handling or resolution

 </para>
 </section>
 
 <section>
-<title>Incrementally installing packages</title>

<para>In contrast to repopluating the staging area from scratch we install additional dependencies and remove conflicting packages. The installing and removing of packages is assumed to be faster than repopulating from scratch. Once a package completed we could consider removing the non-native depends to avoid a growing staging directory. One issue is with the clean task. We could assume that cleaning a package will remove it from the staging area as well. There is one possible problem with it. Let us assume we want to clean quilt-native, virtually every package DEPENDS on it, we would have to clean the staging area completely. If this is the wished behaviour needs to be discussed. 
+	<title>Incrementally installing packages</title>
<para>In contrast to repopluating the staging area from scratch we install additional dependencies and remove conflicting packages. The installing and removing of packages is assumed to be faster than repopulating from scratch. Once a package completed we could consider removing the non-native depends to avoid a growing staging directory. One issue is with the clean task. We could assume that cleaning a package will remove it from the staging area as well. There is one possible problem with it. Let us assume we want to clean quilt-native, virtually every package DEPENDS on it, we would have to clean the staging area completely. If this is the wished behaviour needs to be discussed. 
 </para>
 </section>
 </chapter>
 
 <chapter>
-<title>Implementation</title>
-
+	<title>Implementation</title>
 <section>
-<title>Rearranging tasks</title>
-
+	<title>Rearranging tasks</title>
 <para>In the current metadata packaging happens after staging:
 <screen>
 ============================================================
@@ -83,10 +79,8 @@ I haven't been able to spot any troubles with this change.
 </section>
 
 <section>
-<title>Keeping track of what regular packages OE generates</title>
-
-<para>OE is able to do debian-style shared lib renaming (fontconfig -> libfontconfig0.ipk) and saves the mappings in staging/pkgmaps. The pkgmaps file is lacking some vital info however. The resulting algo is pretty neat:
-
+	<title>Keeping track of what regular packages OE generates</title>
+<para>OE is able to do debian-style shared lib renaming (fontconfig -> libfontconfig0.ipk) and saves the mappings in staging/pkgmaps. The pkgmaps file is lacking some vital info like versions however. The resulting algo is pretty neat:
 <screen>
 PACKAGEFUNCS += "do_write_ipk_list"
 
@@ -129,10 +123,9 @@ So now OE will spit out a spawnfile for each revision of a recipe, instead of on
 </section>
 
 <section>
-<title>Installing regular packages</title>
+	<title>Installing regular packages</title>
 <para>
 Now we know what OE generates we can install those:
-
 <screen>
 PSTAGE_INSTALL_CMD      = "ipkg-cl install -force-depends -f ${DEPLOY_DIR_PSTAGE}/ipkg.conf -o "
 PSTAGE_UPDATE_CMD       = "ipkg-cl update -f ${DEPLOY_DIR_PSTAGE}/ipkg.conf -o "
@@ -160,11 +153,26 @@ STAGING_BASEDIR         = "${STAGING_LIBDIR}/.."
          oenote "Spawn file not found!"
  fi
 </screen>
-
 </para>
 </section>
 </chapter>
 
+<chapter>
+	<title>Conclusions</title>
+<section>
+	<title>Current state</title>
+<para>
+</para>
+</section>
+
+<section>
+	<title>How to proceed from here</title>
+<para>
+</para>
+</section>
+
+
+</chapter>
 
 </book>