From 0357a3b7b5981bc9b2778e240b16852121bd88c1 Mon Sep 17 00:00:00 2001 From: Jamie Lenehan Date: Thu, 19 Oct 2006 21:24:28 +0000 Subject: usermanual: Since squashfs-lzma has been added, documented it as a supported file system image type. Plus some minor spelling/grammer edits. --- usermanual/reference/class_image_ipkg.xml | 21 ++++++++++--------- usermanual/reference/class_pkgconfig.xml | 15 ++++++------- usermanual/reference/image_types.xml | 35 +++++++++++++++++++++++++++++-- 3 files changed, 52 insertions(+), 19 deletions(-) (limited to 'usermanual/reference') 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 @@
image_ipkg class - The image_ipkg class is used to generate images containing a root - filesystem, as generated by the , for - use on the target device. This could be a jffs2 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. + The image_ipkg class is used to generate filesystem images containing + a root filesystem, as generated by the , + for use on the target device. This could be a jffs2 + 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. - Summary of actions performed by the image_ipkg - class: + Summary of the actions performed by the + image_ipkg class: @@ -209,8 +210,8 @@ Device (/dev) nodes 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 ${BBPATH} so that + nodes. The new method supports multiple device node tables and supports + searching for these tables via the ${BBPATH} so that relative file names may be used. The following example from machine/titan.conf 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 @@ pkgconfig class The pkgconfig class is for packages that install - <pkg>.pc files that provide information about the - build settings for the package via the use of the - pkg-config command. + <pkg>.pc files. These files provide information + about the build settings for the package vwhich are then made available by + the pkg-config command. - 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 stage task. + Since the contents of the .pc 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 stage + task. The actions performed by the pkgconfig class are: @@ -30,7 +31,7 @@ A package is considered to be native if it also inherits the native class. - The class will search in source directory, ${S}, + The class will search the source directory, ${S}, and all it's subdirectories, for files that end in .pc (it will ignore those that end in -uninstalled.pc) 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 @@ 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 section for details on how image generation is configured. @@ -186,6 +186,8 @@ rmdir ${DEPLOY_DIR_IMAGE}/tmp.gz" big and little endian filesystems can be mounted on any platform. + Squashfs uses gzip as its compression method. + IMAGE_CMD_squashfs = "mksquashfs ${IMAGE_ROOTFS} \ ${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.squashfs \ ${EXTRA_IMAGECMD} -noappend" @@ -198,6 +200,33 @@ rmdir ${DEPLOY_DIR_IMAGE}/tmp.gz" + + squashfs-lzma + + + 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. + + Squashfs-lzma uses lzma as its compression method. + + IMAGE_CMD_squashfs-lzma = "mksquashfs-lzma ${IMAGE_ROOTFS} \ + ${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.squashfs \ + ${EXTRA_IMAGECMD} -noappend" + + The EXTRA_IMAGECMD variable for squashfs is + passed to mksquashfs-lzma and by default is used + specify the endianess and block size of the filesystem: + + EXTRA_IMAGECMD_squashfs-lzma = "-le -b 16384" + + + tar @@ -261,7 +290,9 @@ rmdir ${DEPLOY_DIR_IMAGE}/tmp.gz" An example can be found in conf/machine/wrt54.conf where it defines a new image type, squashfs-lzma, for a squashfs filesystem using - lzma compression instead of the standard gzip compression: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):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" -- cgit 1.2.3-korg