diff options
| -rw-r--r-- | usermanual/reference/class_image_ipkg.xml | 21 | ||||
| -rw-r--r-- | usermanual/reference/class_pkgconfig.xml | 15 | ||||
| -rw-r--r-- | usermanual/reference/image_types.xml | 35 | ||||
| -rw-r--r-- | usermanual/usermanual.xml | 4 |
4 files changed, 56 insertions, 19 deletions
diff --git a/usermanual/reference/class_image_ipkg.xml b/usermanual/reference/class_image_ipkg.xml index f6dca24114..0b440eba45 100644 --- a/usermanual/reference/class_image_ipkg.xml +++ b/usermanual/reference/class_image_ipkg.xml @@ -2,15 +2,16 @@ <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> diff --git a/usermanual/reference/class_pkgconfig.xml b/usermanual/reference/class_pkgconfig.xml index d4334a063b..3cb5002df5 100644 --- a/usermanual/reference/class_pkgconfig.xml +++ b/usermanual/reference/class_pkgconfig.xml @@ -3,13 +3,14 @@ <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 diff --git a/usermanual/reference/image_types.xml b/usermanual/reference/image_types.xml index 68058bec3e..2efb9b8072 100644 --- a/usermanual/reference/image_types.xml +++ b/usermanual/reference/image_types.xml @@ -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"</screen></para> 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"</screen></para> </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"</screen></para> <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" diff --git a/usermanual/usermanual.xml b/usermanual/usermanual.xml index e97c73e499..637176a3b6 100644 --- a/usermanual/usermanual.xml +++ b/usermanual/usermanual.xml @@ -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 provider for libm.so.6 </section> </chapter> +<!-- Bitbake recipies chapter --> + &chapter-recipes; + <!-- Reference manual. Sorted alphabetically. All entries are pulled in from external files --> <chapter> <title>Reference</title> |