[oe] [PATCH] usermanual: update to new style staging

[Paul Menzel]

Date: Tue, 19 Oct 2010 13:18:27 +0200

Take a look at [1].

[1] http://wiki.openembedded.org/index.php/Legacy_staging

Signed-off-by: Paul Menzel <paulepanter at users.sourceforge.net>
---
Dear OE folks,


this patch is probably a RFC, since I am no native speaker and also do
not know much about this topic. Could you please comment on this topic.
In my opinion reference to legacy staging should be removed from the
manual since most packages have been converted already to new style
staging.


Thanks,

Paul
---
 docs/usermanual/chapters/recipes.xml       |   31 +++++++++++++++++++++------
 docs/usermanual/chapters/usage.xml         |   11 +--------
 docs/usermanual/reference/dirs_staging.xml |   16 ++++++--------
 3 files changed, 33 insertions(+), 25 deletions(-)

diff --git a/docs/usermanual/chapters/recipes.xml b/docs/usermanual/chapters/recipes.xml
index acb0705..0c84179 100644
--- a/docs/usermanual/chapters/recipes.xml
+++ b/docs/usermanual/chapters/recipes.xml
@@ -883,14 +883,31 @@ S = "${WORKDIR}/widgets"</screen></para>
       libraries and headers.</para>
 
       <para>Making the libraries, headers and binaries available for use by
-      other recipes on the host is called staging and is performed by the
-      <emphasis>stage</emphasis> task in the recipe. Any recipes that contain
-      items that are required to build other packages should have a
-      <emphasis>stage</emphasis> task to make sure the items are all correctly
+      other recipes on the host is called staging and is performed automatically
+      derived from task <emphasis>install</emphasis>. Any recipes that contain
+      items that are required additionally to build other packages should have a
+      <emphasis>install_append</emphasis> task to make sure the items are all correctly
       placed into the staging area. The following example from clamav shows the
-      clamav library and header being placed into the staging area:<screen>do_stage () {
-        oe_libinstall -a -so libclamav ${STAGING_LIBDIR}
-        install -m 0644 libclamav/clamav.h ${STAGING_INCDIR}
+      clamav library and header being placed into the staging area:<screen>do_install_append() {
+        install -m 0755 -d ${D}${sysconfdir}/default/volatiles \
+                           ${D}${sysconfdir}/init.d ${D}${docdir}/clamav
+
+        # Save the installed clamd.conf in the doc dir and then install our new one
+        install -m 0755 ${D}${sysconfdir}/clamd.conf ${D}${docdir}/clamav/clamd.conf.example
+        install -m 0755 ${WORKDIR}/clamd.conf ${D}${sysconfdir}/clamd.conf
+
+        # Save the installed freshclam.conf in the doc dir and then install our new one
+        install -m 0755 ${D}${sysconfdir}/freshclam.conf ${D}${docdir}/clamav/freshclam.conf.example
+
+        # Install our config files and init scripts
+        install -m 0755 ${WORKDIR}/freshclam.conf ${D}${sysconfdir}/freshclam.conf
+        install -m 0755 ${WORKDIR}/clamav-daemon.init ${D}${sysconfdir}/init.d/clamav-daemon
+        install -m 0755 ${WORKDIR}/clamav-freshclam.init ${D}${sysconfdir}/init.d/clamav-freshclam
+
+        # We need some /var directories
+        for i in 03_clamav-daemon 03_clamav-freshclam 03_clamav-data; do
+          install -m 0644 ${WORKDIR}/volatiles.$i ${D}${sysconfdir}/default/volatiles/$i
+        done
 }</screen></para>
 
       <para>The following from the p3scan recipe shows the path to the clamav
diff --git a/docs/usermanual/chapters/usage.xml b/docs/usermanual/chapters/usage.xml
index 9703e36..698c374 100644
--- a/docs/usermanual/chapters/usage.xml
+++ b/docs/usermanual/chapters/usage.xml
@@ -228,15 +228,8 @@ tmp/rootfs/proc
 tmp/rootfs/etc  
 tmp/rootfs/home 
 tmp/rootfs/tmp  
-tmp/staging     
-tmp/staging/man 
-tmp/staging/x86_64-linux
-tmp/staging/pkgdata
-tmp/staging/pkgmaps
-tmp/staging/var
-tmp/staging/sh4-linux
-tmp/staging/local
-tmp/staging/etc  
+tmp/sysroots
+tmp/pkgdata
 tmp/deploy
 tmp/deploy/addons
 tmp/deploy/ipk   
diff --git a/docs/usermanual/reference/dirs_staging.xml b/docs/usermanual/reference/dirs_staging.xml
index 25f3685..4d0964f 100644
--- a/docs/usermanual/reference/dirs_staging.xml
+++ b/docs/usermanual/reference/dirs_staging.xml
@@ -28,19 +28,17 @@
     </listitem>
 
     <listitem>
-      <para>In the <emphasis>stage</emphasis> task for libraries to specify
-      where to install the headers and libraries.</para>
+      <para>In the <emphasis>install_append</emphasis> task for libraries to specify
+      where to install the headers and libraries if not done automatically.</para>
     </listitem>
   </orderedlist>
 
   <para>The following example from libpcre shows the installation of the
   libraries and headers from the package into the staging area. Note the use
   of the <emphasis>oe_libinstall</emphasis> helper function for installation
-  of the libraries:<screen>do_stage () {
-    oe_libinstall -a -so libpcre ${STAGING_LIBDIR}
-    oe_libinstall -a -so libpcreposix ${STAGING_LIBDIR}
-    install -m 0644 pcre.h ${STAGING_INCDIR}/
-    install -m 0644 pcreposix.h ${STAGING_INCDIR}/
+  of the libraries:<screen>do_install_append () {
+    install -d ${STAGING_BINDIR}
+    install -m 0755 ${D}${bindir}/pcre-config ${STAGING_BINDIR}/
 }</screen></para>
 
   <para>The following example from the flac recipe shows the location of the
@@ -73,7 +71,7 @@
         <row>
           <entry>STAGING_DIR</entry>
 
-          <entry>${TMPDIR}/staging</entry>
+          <entry>${TMPDIR}/sysroots</entry>
         </row>
 
         <row>
@@ -166,4 +164,4 @@
   <para></para>
 
   <para></para>
-</section>
\ No newline at end of file
+</section>
-- 
1.7.2.3

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part
URL: <http://lists.openembedded.org/pipermail/openembedded-devel/attachments/20101019/6b73b265/attachment-0002.sig>