Difference between revisions of "Bering-uClibc 4.x - Developer Guide - Contents of the buildtool/tools/ Directory"
(genpage.pl) |
Davidmbrooke (Talk | contribs) (Added remaining files, mostly without any description) |
||
| Line 13: | Line 13: | ||
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. | 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 <code class="filename">tools/</code> directory. | This page is intended to prevent that situation from recurring, by explaining the purpose of each of the files and directories within the <code class="filename">tools/</code> directory. | ||
| − | |||
| − | |||
==Important Files and Directories== | ==Important Files and Directories== | ||
The following files and directories are known to be actively used. | The following files and directories are known to be actively used. | ||
| − | |||
| − | |||
| − | |||
===<code class="filename">buildall.sh</code>=== | ===<code class="filename">buildall.sh</code>=== | ||
| Line 31: | Line 26: | ||
===<code class="filename">genpage.pl</code>=== | ===<code class="filename">genpage.pl</code>=== | ||
A Perl script written by Martin Hejl. | A Perl script written by Martin Hejl. | ||
| − | This script parses the bin directory for packages in git (previously cvs) and generates | + | 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 [http://leaf.sourceforge.net/bering-uclibc/index.php?module=pagemaster&PAGE_user_op=view_page&PAGE_id=13&MMN_position=33:33]. |
| − | + | ||
| + | See also [[Bering-uClibc 4.x - Developer Guide - Contents of the buildtool/tools/ Directory#packages.conf|<code class="filename">packages.conf</code>]]. | ||
| + | |||
| + | ===<code class="filename">getdirname.pl</code>=== | ||
| + | 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 <code class="filename">buildtool.mk</code> 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 <code class="filename">buildtool.mk</code> as well as in <code class="filename">buildtool.cfg</code>. | ||
| + | |||
| + | Refer to [[Bering-uClibc 4.x - Developer Guide - Compiling Source Code]] for examples of usage. | ||
===<code class="filename">image/</code>=== | ===<code class="filename">image/</code>=== | ||
| Line 68: | Line 70: | ||
An alternative template template for a SYSLINUX disk Image's <code class="filename">/syslinux/syslinux.cfg</code> file, used in cases where a serial (RS-232) console '''IS''' being used. | An alternative template template for a SYSLINUX disk Image's <code class="filename">/syslinux/syslinux.cfg</code> file, used in cases where a serial (RS-232) console '''IS''' being used. | ||
| − | == | + | ===<code class="filename">packages.conf</code>=== |
| − | + | This is a configuration file used by [[Bering-uClibc 4.x - Developer Guide - Contents of the buildtool/tools/ Directory#genpage.pl|<code class="filename">genpage.pl</code>]]. | |
| + | |||
| + | |||
| + | ==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. | ||
| + | |||
| + | ===<code class="filename">analyse-lrp-package.pl</code>=== | ||
| + | |||
| + | ===<code class="filename">busybox</code>=== | ||
| + | |||
| + | ===<code class="filename">Busybox-1.00-static.config</code>=== | ||
| + | |||
| + | ===<code class="filename">compileShellInit</code>=== | ||
| + | |||
| + | ===<code class="filename">compileShell.sh</code>=== | ||
| + | |||
| + | ===<code class="filename">createimage.sh</code>=== | ||
| + | This Shell script was used to build floppy disk Image files for [[Bering-uClibc 3.x]] and earlier. | ||
| + | It has been replaced by <code class="filename">buildimage.pl</code>. | ||
| + | |||
| + | ===<code class="filename">dpatch</code>=== | ||
| + | |||
| + | ===<code class="filename">fakeroot_0.4.4-9.2.tar.gz</code>=== | ||
| + | |||
| + | ===<code class="filename">geniso.sh</code>=== | ||
| + | This Shell script was used to build CD-ROM disk Image files for [[Bering-uClibc 3.x]] and earlier. | ||
| + | It has been replaced by <code class="filename">buildimage.pl</code>. | ||
| + | |||
| + | ===<code class="filename">getdep.sh</code>=== | ||
| + | |||
| + | ===<code class="filename">img-minimal</code>=== | ||
| + | |||
| + | ===<code class="filename">itrace-0.5c.patch</code>=== | ||
| + | |||
| + | ===<code class="filename">itrace-0.5c.tar.gz</code>=== | ||
| + | |||
| + | ===<code class="filename">lfs-bootscripts-20100124.tar.bz2</code>=== | ||
| + | |||
| + | ===<code class="filename">make-patches.sh</code>=== | ||
| + | |||
| + | ===<code class="filename">mfstool</code>=== | ||
| + | |||
| + | ===<code class="filename">mfstool-0.5-fixed.tgz</code>=== | ||
| + | |||
| + | ===<code class="filename">prepareimagefiles.sh</code>=== | ||
| + | |||
| + | ===<code class="filename">README.itrace</code>=== | ||
| + | |||
| + | ===<code class="filename">udev-config-20100128.tar.bz2</code>=== | ||
| + | |||
| + | ===<code class="filename">upx-3.04-i386_linux</code>=== | ||
| + | ===<code class="filename">upx-3.04-i386_linux.tar.bz2</code>=== | ||
| + | . | ||
---- | ---- | ||
Revision as of 20:42, 22 February 2011
| Contents of the buildtool/tools/ Directory | ||
|---|---|---|
| Prev | Bering-uClibc 4.x - Developer Guide | |
Contents
- 1 Introduction
- 2 Important Files and Directories
- 2.1 buildall.sh
- 2.2 genpage.pl
- 2.3 getdirname.pl
- 2.4 image/
- 2.5 image/common/
- 2.6 image/common/configdb.ser
- 2.7 image/common/leaf.cfg
- 2.8 image/common/readme
- 2.9 image/isolinux/isolinux.cfg
- 2.10 image/isolinux/isolinux.dpy
- 2.11 image/syslinux/syslinux.cfg
- 2.12 image/syslinux/syslinux.dpy
- 2.13 image/syslinux/syslinux.ser
- 2.14 packages.conf
- 3 Files and Directories Believed to be Obsolete
- 3.1 analyse-lrp-package.pl
- 3.2 busybox
- 3.3 Busybox-1.00-static.config
- 3.4 compileShellInit
- 3.5 compileShell.sh
- 3.6 createimage.sh
- 3.7 dpatch
- 3.8 fakeroot_0.4.4-9.2.tar.gz
- 3.9 geniso.sh
- 3.10 getdep.sh
- 3.11 img-minimal
- 3.12 itrace-0.5c.patch
- 3.13 itrace-0.5c.tar.gz
- 3.14 lfs-bootscripts-20100124.tar.bz2
- 3.15 make-patches.sh
- 3.16 mfstool
- 3.17 mfstool-0.5-fixed.tgz
- 3.18 prepareimagefiles.sh
- 3.19 README.itrace
- 3.20 udev-config-20100128.tar.bz2
- 3.21 upx-3.04-i386_linux
- 3.22 upx-3.04-i386_linux.tar.bz2
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.
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.
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.
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/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
busybox
Busybox-1.00-static.config
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.
dpatch
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.
getdep.sh
img-minimal
itrace-0.5c.patch
itrace-0.5c.tar.gz
lfs-bootscripts-20100124.tar.bz2
make-patches.sh
mfstool
mfstool-0.5-fixed.tgz
prepareimagefiles.sh
README.itrace
udev-config-20100128.tar.bz2
upx-3.04-i386_linux
upx-3.04-i386_linux.tar.bz2
.
| Prev | Up |
