[arch-releng] [PATCH] Simplify, Englishify and fix some documentation
Gerardo Exequiel Pozzi
vmlinuz386 at yahoo.com.ar
Sat Jun 18 11:50:06 EDT 2011
On 06/18/2011 12:33 PM, Dieter Plaetinck wrote:
> Signed-off-by: Dieter Plaetinck<dieter at plaetinck.be>
> ---
> README | 50 +++++++++++++++++++++++++-------------------------
> 1 files changed, 25 insertions(+), 25 deletions(-)
>
> diff --git a/README b/README
> index 7f64874..dee3a50 100644
> --- a/README
> +++ b/README
> @@ -3,19 +3,19 @@ INDEX
>
> * Image types generated by mkarchiso.
> * File format for aitab.
> -* Why /isolinux directory and /arch/boot/syslinux/ ?
> -* Steps to build the most basic Arch Linux live medium. (configs/baseline)
> -* Steps to build official Arch Linux live medium images. (configs/releng)
> +* Why the /isolinux and /arch/boot/syslinux directories?
> +* Building the most basic Arch Linux live media. (configs/baseline)
> +* Building official Arch Linux live media. (configs/releng)
>
>
>
> *** Image types generated by mkarchiso.
>
> -* image-name.sfs SquashFS filesystem image with all files directly on it.
> +* image-name.sfs SquashFS image with all files directly on it.
> * image-name.fs.sfs SquashFS with only one file inside (image-name.fs),
> - that is an image of some type of filesystem
> + which is an image of some type of filesystem
> (ext4, ext3, ext2, xfs), all files reside on it.
> -* image-name.fs Like with image-name.fs.sfs but without SquashFS.
> +* image-name.fs Like image-name.fs.sfs but without SquashFS.
> (For testing purposes only. The option copytoram
> for archiso hook does not have any effect on these images)
>
> @@ -23,9 +23,9 @@ INDEX
>
> *** File format for aitab.
>
> -The file aitab maintains information about the filesystems images that
> -must be created by mkarchiso and mounted at initramfs stage from archiso hook.
> -It consists of some fields that set the behaviour of images in this order:
> +The aitab file holds information about the filesystems images that must be
> +created by mkarchiso and mounted at initramfs stage from the archiso hook.
> +It consists of some fields which define the behaviour of images.
>
> #<img> <mnt> <arch> <sfs_comp> <fs_type> <fs_size>
>
> @@ -33,9 +33,9 @@ It consists of some fields that set the behaviour of images in this order:
> <mnt> Mount point.
> <arch> Architecture { i686 | x86_64 | any }.
> <sfs_comp> SquashFS compression type { gzip | lzo | xz }.
> - A special value of "none" can be used, no SquashFS is used.
> + A special value of "none" denotes no usage of SquashFS.
> <fs_type> Set the filesystem type of the image { ext4 | ext3 | ext2 | xfs }.
> - A special value of "none" can be used, no filesystem is used.
> + A special value of "none" denotes no usage of a filesystem.
> In that case all files are pushed directly to SquashFS filesystem.
> <fs_size> An absolute value of file system image size in MiB.
> (example: 100, 1000, 4096, etc)
> @@ -48,26 +48,26 @@ Note: Some combinations are invalid, example: sfs_comp=none and fs_type=none
>
>
>
> -*** Why /isolinux and /arch/boot/syslinux ?
> +*** Why the /isolinux and /arch/boot/syslinux directories?
>
> -Under /isolinux directory only files needed for ISOLINUX boot loader
> -module of SYSLINUX are present. ISOLINUX can not find config files on
> +The /isolinux directory holds files needed for the ISOLINUX boot loader
> +module of SYSLINUX. ISOLINUX can not find config files on
> /arch/boot/syslinux, like other boot loaders modules (EXTLINUX, SYSLINUX, etc).
> -When make your custom boot-pendrive, just need to copy /arch directory to it.
> -/isolinux/isolinux.cfg just load /arch/boot/syslinux/syslinux.cfg
> +When make your custom boot-pendrive, you need to copy /arch directory to it.
> +/isolinux/isolinux.cfg just holds /arch/boot/syslinux/syslinux.cfg
>
>
>
> -*** Steps to build the most basic Arch Linux live medium. (configs/baseline)
> +*** Building the most basic Arch Linux live media. (configs/baseline)
>
> -* First install devtools if needed, this is for use mkarchroot.
> +* First install devtools if needed, mkarchroot needs it.
> [host] # pacman -S devtools
>
> * Create a chroot to work on it.
> (prefix with linux32 if you want to build a 32 bits enviroment under 64 bits)
> [host] # mkarchroot /tmp/chroot base
>
> -* Enter on it. (prefix with linux32 if needed).
> +* Enter it. (prefix with linux32 if needed).
> [host] # mkarchroot -r bash /tmp/chroot
>
> * Create a loopback device.
> @@ -94,12 +94,12 @@ When make your custom boot-pendrive, just need to copy /arch directory to it.
> * Exit from chroot.
> [chroot] # exit
>
> -Note: If you want to customize, just see the directory configs/releng
> -that is used to build official images with much more things.
> +Note: If you want to customize, just see the configs/releng directory which is
> +used to build official images with much more things.
>
>
>
> -*** Steps to build official Arch Linux live medium images (configs/baseline)
> +*** Building official Arch Linux live media. (configs/releng)
>
> Note: These steps should be done with 64 bits support.
>
> @@ -119,7 +119,7 @@ echo 'Server = MIRROR/archlinux/$repo/os/$arch'>> /etc/pacman.d/mirrorlist
> pacman -S squashfs-tools syslinux devtools cdrkit make mkinitcpio-nfs-utils nbd --noconfirm --needed
> exit
>
> -* Create a shared directory for both chroot enviroments with archiso.
> +* Create a shared directory which archiso can access from both chroot enviroments.
>
> mkdir /tmp/shared
> cd /tmp/shared
> @@ -128,7 +128,7 @@ cd
> mount --bind /tmp/shared /tmp/chroot32/tmp
> mount --bind /tmp/shared /tmp/chroot64/tmp
>
> -* Enter in 32 bits chroot enviroment, install mkarchiso,
> +* Enter 32 bits chroot enviroment, install mkarchiso,
> then build core and netinstall single images.
>
> linux32 mkarchroot -r bash /tmp/chroot32
> @@ -138,7 +138,7 @@ make install-program
> cd ../configs/releng/
> ./build.sh all_iso_single
>
> -* Enter in 64 bits chroot enviroment, install mkarchiso,
> +* Enter 64 bits chroot enviroment, install mkarchiso,
> then build core and netinstall single images.
>
> mkarchroot -r bash /tmp/chroot64
Many thanks! Applied and squashed with "the big commit".
--
Gerardo Exequiel Pozzi
\cos^2\alpha + \sin^2\alpha = 1
More information about the arch-releng
mailing list