Some more documentation.

git-svn-id: svn://svn.code.sf.net/p/sc2/code/trunk@1094 8092fc87-c524-0410-9efc-e669fe64eaf9
This commit is contained in:
meep-eep
2003-08-10 17:39:05 +00:00
parent 30977ade42
commit 8eb9d67850
+34 -7
View File
@@ -13,8 +13,34 @@ Some of the most important differences between this system and autoconf:
- it builds faster, mostly because libtool isn't used. - it builds faster, mostly because libtool isn't used.
The menu The files
-------- ---------
These are the files in the directory with the build script.
Of these files only build.config should be modified for a specific build.
For unknown dependancies, additions to config_proginfo might need to be
made. The other files should not be modified.
Only build.sh is to be called directly.
ansi ansi colour definitions.
build.config configuration options for the program to build.
It contains the description of the configuration
menu, and specifies the dependancies.
The format of the menu description is listed briefly
below.
build.sh the sh script that is to be called for configuration,
building, and installation.
build_functions auxiliary functions to build.sh for building.
config_functions auxiliary functions to build.sh for configuration.
config_proginfo contains descriptions of dependancies.
The information in this file is used in particular for
detecting if those libraries and other external programs
are present.
menu_functions auxiliary functions to build.sh for menus.
The menu (from build.config)
----------------------------
There are three types of menu items. There are three types of menu items.
@@ -79,11 +105,11 @@ There are three types of menu items.
The current value, either 'CHECKED' or 'UNCHECKED'. The current value, either 'CHECKED' or 'UNCHECKED'.
- CHECK_${NAME}_FIXED (optional) - CHECK_${NAME}_FIXED (optional)
A string that evaluates to 0 if this checkbox may not be changed. A string that evaluates to 0 if this checkbox may not be changed.
Program info
------------ Program info (from config_proginfo)
-----------------------------------
Information about programs used should be supplied in the following form: Information about programs used should be supplied in the following form:
- PROG_${PROGRAM}_NAME - PROG_${PROGRAM}_NAME
@@ -107,8 +133,8 @@ Information about programs used should be supplied in the following form:
<empty> if the program hasn't been verified to be present <empty> if the program hasn't been verified to be present
Library info Library info (from config_proginfo)
------------ -----------------------------------
Information about libraries used should be supplied in the following form: Information about libraries used should be supplied in the following form:
- LIB_${LIB}_NAME - LIB_${LIB}_NAME
@@ -132,3 +158,4 @@ Information about libraries used should be supplied in the following form:
1 if the library has been verified to be not present 1 if the library has been verified to be not present
<empty> if the library hasn't been verified to be present <empty> if the library hasn't been verified to be present