Bering-uClibc 4.x - Developer Guide - Contents of the buildtool/tools/ Directory

From bering-uClibc
Jump to: navigation, search
Contents of the buildtool/tools/ Directory
Prev Bering-uClibc 4.x - Developer Guide Next


Introduction

The tools/ directory under buildenv/ contains a number of utility scripts and template files used within the Bering-uClibc 4.x build toolchain. Over time, various obsolete files have been collected in this directory, and none of the developers have been quite sure of their purpose or even whether they are still required. This page is intended to prevent that situation from recurring, by explaining the purpose of each of the files and directories within the tools/ directory.


Important Files and Directories

The following files and directories are known to be actively used.

buildall.sh

A Shell script used by automatically build all of the Packages defined in sources.cfg, taking account of the "<Requires>" definitions in order to build the Packages in the correct order to satisfy dependencies.

Generates an HTML file containing a table showing the success / failure status of the build for each Package, with links to the individual build log files for each Package. The HTML file is called /tmp/DD.MM.YYYY/build.html where DD.MM.YYYY is the build date.

dpatch

A Shell script which processes .dpatch files. These are Debian-specific patch files, sometimes included in Debian "diff" files applied to upstream (orig) source distributions.

Variable $(BT_DPATCH), set in file MasterInclude.mk references this script. That variable is used in mawk/buildtool.mk.

genpage.pl

A Perl script written by Martin Hejl. This script parses the bin directory for packages in git (previously cvs) and generates an HTML file out of the package description, package date, packager plus a changelog for the latest changes (from the commit messages). The result can be used to populate the "Packages" link of the webpage [1].

See also packages.conf.

getdep.sh

A Shell script which is called from initrd/buildtool.mk in order to determine which kernel Modules are "dependencies" for the Modules specified on the command-line.

getdirname.pl

A Perl script which takes the name of a compressed tar file as a command-line argument and reports the name of the first directory level in the tar archive.

This is used extensively within buildtool.mk files to automatically extract the name (including the version number) of the "source" archive, avoiding the need to hard-code the upstream version number in buildtool.mk as well as in buildtool.cfg.

Refer to Bering-uClibc 4.x - Developer Guide - Compiling Source Code for examples of usage. Note that the script is generally called by using variable $(BT_TGZ_GETDIRNAME) which is set in file MasterInclude.mk.

image/

A directory containing further directories with template files used by buildimage.pl.

image/common/

A directory containing template files common to all of the disk Images generated by buildimage.pl.

image/common/configdb.ser

An LRP Package file which is used as an initial configdb.lrp when using a serial (RS-232) console. It contains a replacement /etc/inittab which is suitable for serial console access.

image/common/leaf.cfg

The template for every disk Image's /leaf.cfg file. It contains search-and-replace strings (such as "{LRP}") which are substituted for Image-specific text based on the entries in the Image's buildimage.cfg.

image/common/readme

The template for every disk Image's /readme file. It contains search-and-replace strings (such as "{VERSION}") which are substituted for Image-specific text based on the entries in the Image's buildimage.cfg.

image/isolinux/isolinux.cfg

The template for an ISOLINUX disk Image's /isolinux/isolinux.cfg file.

image/isolinux/isolinux.dpy

The template for an ISOLINUX disk Image's /isolinux/isolinux.dpy file.

image/pxelinux/pxelinux.cfg

The template for a PXELINUX disk Image's /tftpboot/bering-uclibc/4/pxelinux.cfg/default file, used in cases where a serial (RS-232) console IS NOT being used.

image/pxelinux/pxelinux.dpy

The template for a PXELINUX disk Image's /tftpboot/bering-uclibc/4/pxelinux.dpy file.

image/pxelinux/pxelinux.ser

An alternative template template for a PXELINUX disk Image's /tftpboot/bering-uclibc/4/pxelinux.cfg/default file, used in cases where a serial (RS-232) console IS being used.

image/syslinux/syslinux.cfg

The template for a SYSLINUX disk Image's /syslinux/syslinux.cfg file, used in cases where a serial (RS-232) console IS NOT being used.

image/syslinux/syslinux.dpy

The template for a SYSLINUX disk Image's /syslinux/syslinux.dpy file.

image/syslinux/syslinux.ser

An alternative template template for a SYSLINUX disk Image's /syslinux/syslinux.cfg file, used in cases where a serial (RS-232) console IS being used.

packages.conf

This is a configuration file used by genpage.pl.


Files and Directories Believed to be Obsolete

The following files and directories are believed to be obsolete and will be deleted if nobody "claims" them.

analyse-lrp-package.pl

A perl script written by Arne Bernin in the pre-buildtool days to alleviate transition from Bering to Bering-uClibc. Today it does not run, you'll see syntax errors...

Removed for Bering-uClibc 5.2

busybox

Removed for Bering-uClibc 5.2

Busybox-1.00-static.config

Removed for Bering-uClibc 5


compileShellInit

compileShell.sh

createimage.sh

This Shell script was used to build floppy disk Image files for Bering-uClibc 3.x and earlier. It has been replaced by buildimage.pl.

Removed for Bering-uClibc 5.2


fakeroot_0.4.4-9.2.tar.gz

geniso.sh

This Shell script was used to build CD-ROM disk Image files for Bering-uClibc 3.x and earlier. It has been replaced by buildimage.pl.

Removed for Bering-uClibc 5.2


img-minimal

itrace-0.5c.patch

itrace-0.5c.tar.gz

lfs-bootscripts-20100124.tar.bz2

make-patches.sh

Note: Variable $(BT_PATCHTOOL), set in file MasterInclude.mk references this script.

mfstool

mfstool allows you to manipulate Minix filesystem images as a normal (i.e. non-root) user. See mfstool. Today we do not use a minix filesystem any longer.

Removed for Bering-uClibc 5.2

mfstool-0.5-fixed.tgz

Source package for mfstoool. See above.

Removed for Bering-uClibc 5.2

prepareimagefiles.sh

README.itrace

Removed for LEAF Bering-uClibc 5.2

udev-config-20100128.tar.bz2

upx-3.04-i386_linux

Removed for LEAF Bering-uClibc 5

upx-3.04-i386_linux.tar.bz2

This is referenced within kernel/buildtool.mk which unpacks this file into the directory listed above. Suspect this is no longer required. This also explains hidden file .upxunpack

Removed for LEAF Bering-uClibc 5.

Prev Up Next
Retrieved from "http://bering-uclibc.zetam.org/index.php?title=Bering-uClibc_4.x_-_Developer_Guide_-_Contents_of_the_buildtool/tools/_Directory&oldid=2006"