[oe-commits] org.oe.documentation usermanual: Since squashfs-lzma has been added, documented it as a supported
lenehan commit
openembedded-commits at lists.openembedded.org
Thu Oct 19 21:32:44 UTC 2006
usermanual: Since squashfs-lzma has been added, documented it as a supported
file system image type. Plus some minor spelling/grammer edits.
Author: lenehan at openembedded.org
Branch: org.openembedded.documentation
Revision: 7fe69e77ca79973b570f2f6613ea4337eab9ad38
ViewMTN: http://monotone.openembedded.org/revision.psp?id=7fe69e77ca79973b570f2f6613ea4337eab9ad38
Files:
1
usermanual/reference/class_image_ipkg.xml
usermanual/reference/class_pkgconfig.xml
usermanual/reference/image_types.xml
usermanual/usermanual.xml
Diffs:
#
# mt diff -r39e2c5efc51a410e92ad485869f942974e1a09c1 -r7fe69e77ca79973b570f2f6613ea4337eab9ad38
#
#
#
# patch "usermanual/reference/class_image_ipkg.xml"
# from [f73264fd4704af9a306824ba2af0bf9432bd2631]
# to [fb0b0fa4af6b540555de49693513cd67819bf438]
#
# patch "usermanual/reference/class_pkgconfig.xml"
# from [7019c79baebb339f73c45065a47f5f843c129ebd]
# to [09ca85de783b70700ce52029ceee8eb6a582ea1b]
#
# patch "usermanual/reference/image_types.xml"
# from [b30ae757616222c06d39cf57ab21405241fec270]
# to [ed3cb74d87bd8f6242a745224035dbc144bc6969]
#
# patch "usermanual/usermanual.xml"
# from [04c08bd4d808557440928c2d58fe5a0ea322c484]
# to [f403bff9d06d26833b1736fad5f634f1fd664e37]
#
============================================================
--- usermanual/reference/class_image_ipkg.xml f73264fd4704af9a306824ba2af0bf9432bd2631
+++ usermanual/reference/class_image_ipkg.xml fb0b0fa4af6b540555de49693513cd67819bf438
@@ -1,16 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<section id="image_ipkg_class" xreflabel="image_ipkg class">
<title>image_ipkg class</title>
- <para>The image_ipkg class is used to generate 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 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_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>Summary of actions performed by the <emphasis>image_ipkg</emphasis>
- class:</para>
+ <para>Summary of the actions performed by the
+ <emphasis>image_ipkg</emphasis> class:</para>
<orderedlist>
<listitem>
@@ -209,8 +210,8 @@
<title>Device (/dev) nodes</title>
<para>There are two variables that can be defined for creating device
- nodes. The newer version supports multiple device node tables and searches
- for the specified files along <command>${BBPATH}</command> so that
+ nodes. The new method supports multiple device node tables and supports
+ searching for these tables via the <command>${BBPATH}</command> so that
relative file names may be used.</para>
<para>The following example from <command>machine/titan.conf</command>
============================================================
--- usermanual/reference/class_pkgconfig.xml 7019c79baebb339f73c45065a47f5f843c129ebd
+++ usermanual/reference/class_pkgconfig.xml 09ca85de783b70700ce52029ceee8eb6a582ea1b
@@ -1,15 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<section id="pkgconfig_class" xreflabel="pkgconfig class">
<title>pkgconfig class</title>
<para>The pkgconfig class is for packages that install
- <command><pkg>.pc</command> files that provide information about the
- build settings for the package via the use of the
- <command>pkg-config</command> command.</para>
+ <command><pkg>.pc</command> files. These files provide information
+ about the build settings for the package vwhich are then made available by
+ the <command>pkg-config</command> command.</para>
- <para>Since the contents of the file is used at build time it is required to
- be copied into the staging area. All the actions performed by the class are
- appended to the <emphasis>stage</emphasis> task.</para>
+ <para>Since the contents of the <command>.pc</command> files are used at
+ build time they need to be installed into the staging area. All the actions
+ performed by this class are appended to the <emphasis>stage</emphasis>
+ task.</para>
<para>The actions performed by the pkgconfig class are:</para>
@@ -30,7 +31,7 @@
<para>A package is considered to be native if it also inherits the native
class.</para>
- <para>The class will search in source directory, <command>${S}</command>,
+ <para>The class will search the source directory, <command>${S}</command>,
and all it's subdirectories, for files that end in <command>.pc</command>
(it will ignore those that end in <command>-uninstalled.pc)</command> and
process them as described above. All that is required to use the class is
============================================================
--- usermanual/reference/image_types.xml b30ae757616222c06d39cf57ab21405241fec270
+++ usermanual/reference/image_types.xml ed3cb74d87bd8f6242a745224035dbc144bc6969
@@ -5,7 +5,7 @@
<para>One of the most commonly used outputs from a build is a filesystem
image containing the root filesystem for the target device. There are
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
+ 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
generation is configured.</para>
@@ -186,6 +186,8 @@ rmdir ${DEPLOY_DIR_IMAGE}/tmp.gz"</scree
big and little endian filesystems can be mounted on any
platform.</para>
+ <para>Squashfs uses gzip as its compression method.</para>
+
<para><screen>IMAGE_CMD_squashfs = "mksquashfs ${IMAGE_ROOTFS} \
${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.squashfs \
${EXTRA_IMAGECMD} -noappend"</screen></para>
@@ -199,6 +201,33 @@ rmdir ${DEPLOY_DIR_IMAGE}/tmp.gz"</scree
</varlistentry>
<varlistentry>
+ <term>squashfs-lzma</term>
+
+ <listitem>
+ <para>Creates a squashfs image using lzma compression instead of
+ gzip which is the standard squashfs compression type. This is a read
+ only compressed filesystem which is used directly with files
+ uncompressed into RAM as they are accessed. Files and filesystems
+ may be up to 2^64 bytes in size, full 32-bit uids and gids are
+ stored, it detects duplicate files and stores only a single copy,
+ all meta-data is compressed and big and little endian filesystems
+ can be mounted on any platform.</para>
+
+ <para>Squashfs-lzma uses lzma as its compression method.</para>
+
+ <para><screen>IMAGE_CMD_squashfs-lzma = "mksquashfs-lzma ${IMAGE_ROOTFS} \
+ ${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.squashfs \
+ ${EXTRA_IMAGECMD} -noappend"</screen></para>
+
+ <para>The <command>EXTRA_IMAGECMD</command> variable for squashfs is
+ passed to <command>mksquashfs-lzma</command> and by default is used
+ specify the endianess and block size of the filesystem:</para>
+
+ <para><screen>EXTRA_IMAGECMD_squashfs-lzma = "-le -b 16384"</screen></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>tar</term>
<listitem>
@@ -261,7 +290,9 @@ rmdir ${DEPLOY_DIR_IMAGE}/tmp.gz"</scree
<para>An example can be found in
<command>conf/machine/wrt54.conf</command> where it defines a new image
type, <emphasis>squashfs-lzma</emphasis>, for a squashfs filesystem using
- lzma compression instead of the standard gzip compression:<screen>IMAGE_DEPENDS_squashfs-lzma = "squashfs-tools-native"
+ lzma compression instead of the standard gzip compression (squashfs-lzma
+ is now a standard type, but the example still serves to show the
+ concept):<screen>IMAGE_DEPENDS_squashfs-lzma = "squashfs-tools-native"
IMAGE_CMD_squashfs-lzma = "mksquashfs-lzma ${IMAGE_ROOTFS} \
${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.squashfs-lzma \
${EXTRA_IMAGECMD} -noappend"
============================================================
--- usermanual/usermanual.xml 04c08bd4d808557440928c2d58fe5a0ea322c484
+++ usermanual/usermanual.xml f403bff9d06d26833b1736fad5f634f1fd664e37
@@ -17,6 +17,7 @@
<!ENTITY var-src-uri SYSTEM "reference/var_src_uri.xml">
<!ENTITY class-update-alternatives SYSTEM "reference/class_update-alternatives.xml">
<!ENTITY class-update-rcd SYSTEM "reference/class_update-rc.d.xml">
+<!ENTITY chapter-recipes SYSTEM "chapters/recipes.xml">
]>
<book>
<bookinfo>
@@ -589,6 +590,9 @@ NOTE: Couldn't find shared library provi
</section>
</chapter>
+<!-- Bitbake recipies chapter -->
+ &chapter-recipes;
+
<!-- Reference manual. Sorted alphabetically. All entries are pulled in from external files -->
<chapter>
<title>Reference</title>
More information about the Openembedded-commits
mailing list