Changes between Version 8 and Version 9 of BepFile

Timestamp:

01/15/08 11:25:14 (7 years ago)

Author:

brecht

Comment:

--

BepFile

@@ -3 +3 @@
 == Introduction ==
 
-A .bep file is a ''recipe'' that BePorter uses to fetch, patch, build and install a software package. It is an ASCII file that contains a list of keys with corresponding (lists of) values.
+A .bep file is a ''recipe'' that BePorter uses to fetch, patch, build and install a software package. It is an ASCII file that contains a list of keys with corresponding (lists of) values. Next to being a recipe for BePorter, it may also give specific information on how to build a particular application on BeOS (see below).
 
 == Syntax ==
+
+=== Comments ===
+
+It is possible to insert comments in the BepFile.
+ * the comment should be on a line of it's own
+ * the comment should be preceded with a hash (#)
+ * there may be whitespace preceding the '#'
 
 === Key types ===
@@ -73 +80 @@
 ||{{{INSTALL}}}||list of shell commands to execute in order to install the port||shell||shell commands||no||-||
 
-Inside the BUILD and INSTALL scripts, it is possible to distinguish between the different BeOS platforms using the {{{BEPORTS_PLATFORM}}} environment variable. It can be one of {{{R5}}}, {{{BONE}}} or {{{HAIKU}}}.
+BUILD and INSTALL scripts are plain bash shell scripts. It is possible to do conditional execution or even loops. For example, it is possible to distinguish between the different BeOS platforms using the {{{BEPORTS_PLATFORM}}} environment variable. It can be one of {{{R5}}}, {{{BONE}}} or {{{HAIKU}}}. BePorter detects which BeOS platform it is running on and set the {{{BEPORTS_PLATFORM}}} variable accordingly.
 
-An example of a build script is shown below. 
+An example of a build script is shown below. Notice that it is possible to add comments using a {{{#}}}. It is highly recommended to document anything special you might do inside a BUILD or INSTALL script. This might help people when they are porting other applications.
 {{{
 BUILD {
         cd xyz-1.0.0
         if [ "$BEPORTS_PLATFORM" = "BONE" ] ; then
-                export EXTRA_CONFARGS="--enable-debug"  # there are still some problems on BONE
+                export EXTRA_CONFARGS="--enable-debug"  # some problems on BONE because of ...
         else
                 export EXTRA_CONFARGS=""
@@ -89 +96 @@
 }}}
 
-When a key is not listed in the BepFile, BePorter assumes the default value, or an empty string/list (if no default value is specified above).
+When a key is not listed in the BepFile, BePorter assumes the default value, or an empty string/list (when no default value is specified above).
 
 Note: It is possible that the names and/or the use of these keys may change as BePorter evolves. Keys may also be added and removed. When BePorter gets a release, the key set shall be frozen.
-
-It is possible to insert '''comments''' in the BepFile.
- * the comment should be on a line of it's own
- * the comment should be preceded with a hash (#)
- * there may be whitespace preceding the '#'