Difference between revisions of "Bering-uClibc 4.x - Developer Guide - Contents of the buildtool/tools/ Directory"

From bering-uClibc
Jump to: navigation, search
(Created initial skeleton)
 
(Started to populate content)
Line 12: Line 12:
 
The <code class="filename">tools/</code> directory under <code class="filename">buildenv/</code> contains a number of utility scripts and template files used within the [[Bering-uClibc 4.x]] build toolchain.
 
The <code class="filename">tools/</code> directory under <code class="filename">buildenv/</code> 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.
 
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 avoid that situation from recurring, by explaining the purpose of each of the files and directories within <code class="filename">tools/</code>.
+
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.
  
 
As of February 2011 this is very much a work-in-progress. [[User:Davidmbrooke|Davidmbrooke]] 18:17, 21 February 2011 (UTC)
 
As of February 2011 this is very much a work-in-progress. [[User:Davidmbrooke|Davidmbrooke]] 18:17, 21 February 2011 (UTC)
 +
 +
 +
==Important Files and Directories==
 +
The following files and directories are known to be actively used.
 +
 +
===<code class="filename">analyse-lrp-package.pl</code>===
 +
A Perl script. Recently written by [[User:Nitr0man|Nitr0man]]. Assumed to be important.
 +
 +
===<code class="filename">buildall.sh</code>===
 +
A Shell script used by automatically build all of the Packages defined in <code class="filename">sources.cfg</code>, 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 <code class="filename">/tmp/''DD.MM.YYYY''/build.html</code> where ''<tt>DD.MM.YYYY</tt>'' is the build date.
 +
 +
 +
===<code class="filename">image/</code>===
 +
A directory containing further directories with template files used by <code class="filename">buildimage.pl</code>.
 +
 +
===<code class="filename">image/common/</code>===
 +
A directory containing template files common to all of the disk Images generated by <code class="filename">buildimage.pl</code>.
 +
 +
===<code class="filename">image/common/configdb.ser</code>===
 +
An LRP Package file which is used as an initial <code class="filename">configdb.lrp</code> when using a serial (RS-232) console.
 +
It contains a replacement <code class="filename">/etc/inittab</code> which is suitable for serial console access.
 +
 +
===<code class="filename">image/common/leaf.cfg</code>===
 +
The template for every disk Image's <code class="filename">/leaf.cfg</code> file.
 +
It contains search-and-replace strings (such as "<tt>{LRP}</tt>") which are substituted for Image-specific text based on the entries in the Image's <code class="filename">buildimage.cfg</code>.
 +
 +
===<code class="filename">image/common/readme</code>===
 +
The template for every disk Image's <code class="filename">/readme</code> file.
 +
It contains search-and-replace strings (such as "<tt>{VERSION}</tt>") which are substituted for Image-specific text based on the entries in the Image's <code class="filename">buildimage.cfg</code>.
 +
 +
===<code class="filename">image/isolinux/isolinux.cfg</code>===
 +
The template for an ISOLINUX disk Image's <code class="filename">/isolinux/isolinux.cfg</code> file.
 +
 +
===<code class="filename">image/isolinux/isolinux.dpy</code>===
 +
The template for an ISOLINUX disk Image's <code class="filename">/isolinux/isolinux.dpy</code> file.
 +
 +
===<code class="filename">image/syslinux/syslinux.cfg</code>===
 +
The 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 NOT''' being used.
 +
 +
===<code class="filename">image/syslinux/syslinux.dpy</code>===
 +
The template for a SYSLINUX disk Image's <code class="filename">/syslinux/syslinux.dpy</code> file.
 +
 +
===<code class="filename">image/syslinux/syslinux.ser</code>===
 +
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.
 +
 +
 +
==Unclaimed Files==
 +
TODO
  
  

Revision as of 18:02, 22 February 2011

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.


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