Changes between Version 2 and Version 3 of BepFile

Timestamp:

08/13/07 08:27:33 (8 years ago)

Author:

brecht

Comment:

--

BepFile

@@ -1 @@
-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. The syntax is as follows. For a key with a '''single value''':
+== 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.
+
+== Syntax ==
+
+=== Key types ===
+
+There are three types of keys in a !BepFile: single-value, list-of-values and shell-commands.
+
+The key label is subject to the following rules:
+ * the key label must be in all capitals and consist only of letters (A-Z) and underscores
+ * there may be no whitespace in front of the key label
+ * there may be whitespace around the '=', but it is not required
+
+==== A key with a '''single value''' ====
 
 {{{
@@ -6 +21 @@
 
 The syntax is subject to the following rules:
- * the key label must be in all capitals and consist only of letters (A-Z) and underscores
- * there may be no whitespace in front of the key label
- * there may be whitespace around the '=', but it is not required
  * the value should be enclosed within double quotes
  * there may be whitespace after the closing quote
 
-For a key with a '''list of values''':
+==== A key with a '''list of values''' ====
 
 {{{
@@ -20 +32 @@
 }}}
 
-The syntax is subject to the rules listed above, plus the following:
+The syntax is subject to the rules listed above for a single value key, plus the following:
  * one value is entered per line, with the first on the line of the key label
  * every value but the first is indented by whitespace (tabs or spaces)
@@ -26 +38 @@
  * the closing double quote is on the same ling as the last value of the list
 
-The following keys are to be currently supported in BePorter:
+
+==== A key with a '''list of shell commands''' ====
+
+{{{
+KEY = {
+       command1
+       command2
+       command3
+      }
+}}}
+
+The syntax is subject to these rules:
+ * the line of the key label end with an opening brace '{', with no command following it
+ * one command is entered per line
+ * every command is indented by whitespace (tabs or spaces)
+ * the closing brace '}' is on on a seperate line, preceded by whitespace
+
+=== List of keys ===
+
+The following keys are currently supported in BePorter:
 
  {{{DESCRIPTION}}}: