aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJamie Lenehan <lenehan@twibble.org>2007-05-02 10:01:08 +0000
committerJamie Lenehan <lenehan@twibble.org>2007-05-02 10:01:08 +0000
commit8572b86970698184c4e1d51bd4f46437963b7bae (patch)
treea86ec45fb86c01c8905ee4686d7a925e4e7caf2f
parenta35403110d02609e837e2c9835566825a5c75574 (diff)
downloadopenembedded-8572b86970698184c4e1d51bd4f46437963b7bae.tar.gz
openembedded-8572b86970698184c4e1d51bd4f46437963b7bae.tar.bz2
openembedded-8572b86970698184c4e1d51bd4f46437963b7bae.zip
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.
-rw-r--r--usermanual/reference/class_image.xml (renamed from usermanual/reference/class_image_ipkg.xml)29
-rw-r--r--usermanual/reference/class_rootfs_ipkg.xml6
-rw-r--r--usermanual/reference/fakeroot.xml4
-rw-r--r--usermanual/reference/image_types.xml2
-rw-r--r--usermanual/usermanual.xml4
5 files changed, 23 insertions, 22 deletions
diff --git a/usermanual/reference/class_image_ipkg.xml b/usermanual/reference/class_image.xml
index 0b440eba45..7d203f888c 100644
--- a/usermanual/reference/class_image_ipkg.xml
+++ b/usermanual/reference/class_image.xml
@@ -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>
diff --git a/usermanual/reference/class_rootfs_ipkg.xml b/usermanual/reference/class_rootfs_ipkg.xml
index 930272ebf9..b60adf8e70 100644
--- a/usermanual/reference/class_rootfs_ipkg.xml
+++ b/usermanual/reference/class_rootfs_ipkg.xml
@@ -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> \ No newline at end of file
diff --git a/usermanual/reference/fakeroot.xml b/usermanual/reference/fakeroot.xml
index 68892fce87..5eb6a48eb0 100644
--- a/usermanual/reference/fakeroot.xml
+++ b/usermanual/reference/fakeroot.xml
@@ -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 @@
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>
diff --git a/usermanual/reference/image_types.xml b/usermanual/reference/image_types.xml
index 2efb9b8072..453f3600fb 100644
--- a/usermanual/reference/image_types.xml
+++ b/usermanual/reference/image_types.xml
@@ -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
diff --git a/usermanual/usermanual.xml b/usermanual/usermanual.xml
index 88d8a408b8..99dc72137b 100644
--- a/usermanual/usermanual.xml
+++ b/usermanual/usermanual.xml
@@ -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 provider for libm.so.6
&fakeroot;
- &class-image_ipkg;
+ &class-image;
&image-types;