Changes between Version 10 and Version 11 of BepFile
- Timestamp:
- 11/13/09 12:29:16 (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
BepFile
v10 v11 3 3 == Introduction == 4 4 5 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).5 A .bep file is a ''recipe'' that haikuporter 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 haikuporter, it may also give specific information on how to build a particular application on BeOS (see below). 6 6 7 7 == Syntax == … … 61 61 * the line of the key label ends with an opening brace '{', with nothing following it (except for whitespace) 62 62 * each line is indented by whitespace (tabs or spaces) 63 * the closing brace '}' is on on a sep erate line, preceded by whitespace63 * the closing brace '}' is on on a separate line, preceded by whitespace 64 64 * the lines between the braces are interpreted as a shell script (bash); hence, it is possible to use conditional execution and insert comments using '#' (see below) 65 65 66 66 === List of keys === 67 67 68 The following keys are currently supported in BePorter:68 The following keys are currently supported in haikuporter: 69 69 70 70 ||Key||Description||Type||Syntax||Mandatory||Default|| … … 72 72 ||{{{HOMEPAGE}}}||URI pointing to the official homepage of the software package||single||URI||yes||-|| 73 73 ||{{{SRC_URI}}}||(a list of) URI(s) pointing to the source code archive of the software package||single, list||URI||yes||-|| 74 ||{{{REVISION}}}||indicates the BePort revision||single||integer ({{{1}}}, {{{2}}}, {{{3}}}, ...)||yes||-|| 75 ||{{{STATUS_R5}}}||indicates the status of this port on BeOS R5||single||status ({{{untested}}}, {{{unstable}}}, {{{stable}}})||no||{{{untested}}}|| 76 ||{{{STATUS_BONE}}}||indicates the status of this port on BeOS BONE/Dano and Zeta||single||status ({{{untested}}}, {{{unstable}}}, {{{stable}}})||no||{{{untested}}}|| 74 ||{{{REVISION}}}||indicates the HaikuPort revision||single||integer ({{{1}}}, {{{2}}}, {{{3}}}, ...)||yes||-|| 77 75 ||{{{STATUS_HAIKU}}}||indicates the status of this port on Haiku||single||status ({{{untested}}}, {{{unstable}}}, {{{stable}}})||no||{{{untested}}}|| 78 ||{{{DEPEND}}}||(list of) ! BePort(s) this port depends upon||single, list||{{{category/portname >= portversion}}}||no||-||76 ||{{{DEPEND}}}||(list of) !HaikuPort(s) this port depends upon||single, list||{{{category/portname >= portversion}}}||no||-|| 79 77 ||{{{BUILD}}}||list of shell commands (script) to execute in order to build the port||shell||shell commands||no||-|| 80 78 ||{{{INSTALL}}}||list of shell commands to execute in order to install the port||shell||shell commands||no||-|| 79 ||{{{DISTRO}}}||list of shell commands to execute in order to install to a DESTDIR||shell||shell commands||no||-|| 81 80 82 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.81 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}}}. Haikuporter detects which BeOS platform it is running on and set the {{{BEPORTS_PLATFORM}}} variable accordingly. 83 82 84 83 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. … … 96 95 }}} 97 96 98 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).97 When a key is not listed in the BepFile, haikuporter assumes the default value, or an empty string/list (when no default value is specified above). 99 98 100 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.99 Note: It is possible that the names and/or the use of these keys may change as haikuporter evolves. Keys may also be added and removed. When haikuporter gets a release, the key set shall be frozen.
