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

From bering-uClibc
Revision as of 18:35, 22 February 2011 by Kapeka (Talk | contribs) (genpage.pl)

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


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.

As of February 2011 this is very much a work-in-progress. Davidmbrooke 18:17, 21 February 2011 (UTC)


Important Files and Directories

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

analyse-lrp-package.pl

A Perl script. Recently written by Nitr0man. Assumed to be important.

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 a 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] The companion file packages.conf.


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.

Unclaimed Files

TODO



Prev Up