[oe-commits] org.oe.documentation usermanual: The image_ipkg class is now just the image class. Update

lenehan commit openembedded-commits at lists.openembedded.org
Wed May 2 11:49:17 UTC 2007


usermanual: The image_ipkg class is now just the image class. Update
all references. Modify description to include details about how it
can potentially support other packaging types now. Probably needs a
more detailed check to see if anything else changed.

Author: lenehan at openembedded.org
Branch: org.openembedded.documentation
Revision: 207bcfd27aafba24c48bf064b8ecc2d95be4e6e9
ViewMTN: http://monotone.openembedded.org/revision.psp?id=207bcfd27aafba24c48bf064b8ecc2d95be4e6e9
Files:
1
usermanual/reference/class_image_ipkg.xml
usermanual/reference/class_image.xml
usermanual/reference/class_rootfs_ipkg.xml
usermanual/reference/fakeroot.xml
usermanual/reference/image_types.xml
usermanual/usermanual.xml
Diffs:

#
# mt diff -r76b9cce3001c5c6f955a6a5d0df273dd118313cb -r207bcfd27aafba24c48bf064b8ecc2d95be4e6e9
#
# 
# 
# rename "usermanual/reference/class_image_ipkg.xml"
#     to "usermanual/reference/class_image.xml"
# 
# patch "usermanual/reference/class_image.xml"
#  from [fb0b0fa4af6b540555de49693513cd67819bf438]
#    to [9f70be2bfeda405f006dc804a6db6c9107e02a4b]
# 
# patch "usermanual/reference/class_rootfs_ipkg.xml"
#  from [3515bfe9e3ea87b2b64f8b745046dc634d9fe88e]
#    to [0ea1173f0b68e639d0b311190c8081e55f9171b3]
# 
# patch "usermanual/reference/fakeroot.xml"
#  from [f196de2fdd0e094314c24ad8c165cc336b67d299]
#    to [70de811d39b0372ca3de195cb6d97b920cb44152]
# 
# patch "usermanual/reference/image_types.xml"
#  from [ed3cb74d87bd8f6242a745224035dbc144bc6969]
#    to [1a65f6d91fd0f9c2f30129ebeabfacbe9d3219c3]
# 
# patch "usermanual/usermanual.xml"
#  from [4a9323c7357d8b5a246acae93eb0ad6260b6491d]
#    to [030cc8dea218beda51a1ac2c1569e422b08ccbd6]
# 
============================================================
--- usermanual/reference/class_image_ipkg.xml	fb0b0fa4af6b540555de49693513cd67819bf438
+++ usermanual/reference/class_image.xml	9f70be2bfeda405f006dc804a6db6c9107e02a4b
@@ -1,25 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<section id="image_ipkg_class" xreflabel="image_ipkg class">
-  <title>image_ipkg class</title>
+<section id="image_class" xreflabel="image class">
+  <title>image class</title>
 
-  <para>The image_ipkg class is used to generate filesystem images containing
-  a root filesystem, as generated by the <xref linkend="rootfs_ipkg_class" />,
-  for use on the target device. This could be a <emphasis>jffs2</emphasis>
-  image which is to be written directly into the flash on the target device
-  for example. In addition this class also configures the ipkg feeds (where to
-  get updates from) and is able to generate multiple different image
-  types.</para>
+  <para>The image class is used to generate filesystem images containing a
+  root filesystem, as generated by the rootfs class for the package type, such
+  as <xref linkend="rootfs_ipkg_class" />, for use on the target device. This
+  could be a <emphasis>jffs2</emphasis> image which is to be written directly
+  into the flash on the target device for example. In addition this class also
+  configures the ipkg feeds (where to get updates from) and is able to
+  generate multiple different image types.</para>
 
   <para>Summary of the actions performed by the
   <emphasis>image_ipkg</emphasis> class:</para>
 
   <orderedlist>
     <listitem>
-      <para>Inherits the <xref linkend="rootfs_ipkg_class" /> in order to
-      bring in the functionality required to generate a root filesystem image.
-      The root filesystem image is generate from a set of ipkg packages, and
-      then the required images are generated using the contents of the root
-      filesystem;</para>
+      <para>Inherits the rootfs class for the appropriate package type,
+      typically <xref linkend="rootfs_ipkg_class" />, in order to bring in the
+      functionality required to generate a root filesystem image. The root
+      filesystem image is generate from a set of of packages (typically .ipkg
+      packages), and then the required images are generated using the contents
+      of the root filesystem;</para>
     </listitem>
 
     <listitem>
============================================================
--- usermanual/reference/class_rootfs_ipkg.xml	3515bfe9e3ea87b2b64f8b745046dc634d9fe88e
+++ usermanual/reference/class_rootfs_ipkg.xml	0ea1173f0b68e639d0b311190c8081e55f9171b3
@@ -8,8 +8,8 @@
   the root filesystem of the target device.</para>
 
   <para>This class is normally not used directly, but instead used from the
-  <xref linkend="image_ipkg_class" /> which creates images from a set of
-  <command>.ipkg</command> files.</para>
+  <xref linkend="image_class" /> which creates images from a set of package 
+  (typically <command>.ipkg</command>) files.</para>
 
   <para>Summary of actions performed by the <emphasis>rootfs_ipkg</emphasis>
   class:</para>
@@ -210,6 +210,6 @@
 
   <para>The class also provides a function <command>real_do_rootfs</command>
   which is executed without <xref linkend="fakeroot" /> and therefore can be
-  used from other classes, such as <xref linkend="image_ipkg_class" />, that
+  used from other classes, such as <xref linkend="image_class" />, that
   are already running under the control of <xref linkend="fakeroot" />.</para>
 </section>
============================================================
--- usermanual/reference/fakeroot.xml	f196de2fdd0e094314c24ad8c165cc336b67d299
+++ usermanual/reference/fakeroot.xml	70de811d39b0372ca3de195cb6d97b920cb44152
@@ -5,7 +5,7 @@
   <para>The fakeroot program is designed to allow non-root users to perform
   actions that would normally require root privileges as part of the package
   generation process. It is used by the <xref linkend="rootfs_ipkg_class" />
-  for root filesystem creation and by the <xref linkend="image_ipkg_class" />
+  for root filesystem creation and by the <xref linkend="image_class" />
   for the creation of filesystem images. Some recipes also use fakeroot to
   assist with parts of the package installation (usually) or building where
   root privligeses are expected by the package.</para>
@@ -32,7 +32,7 @@ mknod: `hdc': Operation not permitted</s
     the command will fail, telling is that we do not have permission to create
     device nodes:<screen>~%&gt; mknod hdc b 22 0
 mknod: `hdc': Operation not permitted</screen>Yet the <xref
-    linkend="image_ipkg_class" /> is able to create device nodes and include
+    linkend="image_class" /> is able to create device nodes and include
     them in the final images, all without the need to have root
     privileges.</para>
 
============================================================
--- usermanual/reference/image_types.xml	ed3cb74d87bd8f6242a745224035dbc144bc6969
+++ usermanual/reference/image_types.xml	1a65f6d91fd0f9c2f30129ebeabfacbe9d3219c3
@@ -7,7 +7,7 @@
   several variables which can be used to control the type of output images and
   the settings for those images, such as endianess or compression ratios. This
   section details the available images and the variables that effect them. See
-  the <xref linkend="image_ipkg_class" /> section for details on how image
+  the <xref linkend="image_class" /> section for details on how image
   generation is configured.</para>
 
   <para>The final root file system will consist of all of the files located in
============================================================
--- usermanual/usermanual.xml	4a9323c7357d8b5a246acae93eb0ad6260b6491d
+++ usermanual/usermanual.xml	030cc8dea218beda51a1ac2c1569e422b08ccbd6
@@ -13,7 +13,7 @@
 <!ENTITY dirs-staging SYSTEM "reference/dirs_staging.xml">
 <!ENTITY class-distutils SYSTEM "reference/class_distutils.xml">
 <!ENTITY fakeroot SYSTEM "reference/fakeroot.xml">
-<!ENTITY class-image_ipkg SYSTEM "reference/class_image_ipkg.xml">
+<!ENTITY class-image SYSTEM "reference/class_image.xml">
 <!ENTITY image-types SYSTEM "reference/image_types.xml">
 <!ENTITY class-pkgconfig SYSTEM "reference/class_pkgconfig.xml">
 <!ENTITY class-rootfs_ipkg SYSTEM "reference/class_rootfs_ipkg.xml">
@@ -857,7 +857,7 @@ NOTE: Couldn't find shared library provi
 
     &fakeroot;
 
-    &class-image_ipkg;
+    &class-image;
 
     &image-types;
 






More information about the Openembedded-commits mailing list