Changes between Version 2 and Version 3 of HaikuPorterForPM/BuildRecipes

Timestamp:

06/11/13 13:46:19 (2 years ago)

Author:

zooey

Comment:

--

HaikuPorterForPM/BuildRecipes

@@ -146 +146 @@
 === Environment Variables ===
 
-...TODO...
+These are the global (i.e. one instance per port) environment variables recognized by !HaikuPorter:
+
+==== BUILD_PACKAGE_ACTIVATION_PHASE ====
+- '''Type:''' String - one of ['BUILD', 'TEST' or 'INSTALL']
+- '''Purpose:''' Tell !HaikuPorter in which build phase the [wiki:HaikuPorterForPM/PortsAndPackages#TheBuildPackages build package(s)] should be activated. By default, this happens just before the `BUILD` phase, but if a port depends on being able to execute its own binaries during the build (`autoconf` is an example), this must happen at a later phase (usually `INSTALL`).
+- '''Required:''' No
+- '''Default:''' 'BUILD'
+
+==== DISABLE_SOURCE_PACKAGE ====
+- '''Type:''' YesNo - one of ['yes', 'true', 'no', 'false'], case insensitive
+- '''Purpose:''' Normally, !HaikuPorter creates a source package for every port. This option can be used to disable the creation of that source package.
+- '''Required:''' No
+- '''Default:''' 'no'
+
+==== HOMEPAGE ====
+- '''Type:''' List of URLs, one per line
+- '''Purpose:''' Specify one or more websites that are homepages for this port.
+- '''Required:''' Yes
+- '''Default:''' None
+
+==== MESSAGE ====
+- '''Type:''' String
+- '''Purpose:''' Specifies a message to be shown and acknowledged by the user (i.e. packager) before this port will be built.
+- '''Required:''' No
+- '''Default:''' None
+
+==== REVISION ====
+- '''Type:''' Positive Integer
+- '''Purpose:''' Defines the revision of the build recipe (which is an addition to the version of the port). Whenever something is changed in the recipe that has an effect on the built packages (basically everytime the build recipe is changed), this number has to be incremented. Additionally, whenever a patch files is changed, this number has to be incremented, too.
+- '''Required:''' Yes
+- '''Default:''' 1
+
+The following set of environment variables exists for each defined source archive, the first set of variables is named like shown here, the second set gets a `_2` suffix, the third a `_3` suffix and so on. 
+
+Note: 
+  most ports only have one source archive, so they don't need the additional sets.
+
+==== CHECKSUM_MD5 ====
+- '''Type:''' MD5-checksum
+- '''Purpose:''' Defines the MD5-checksum that shall be used by !HaikuPorter for validating the downloaded source archive.
+- '''Required:''' Yes, unless the port does not use a source archive (for instance when the sources are fetched from a version control repository).
+- '''Default:''' None
+
+==== PATCHES (deprecated) ====
+- '''Type:''' String
+- '''Purpose:''' Specify one or more patch files to be applied to the sources of this port. This is deprecated in favour of making use of the implicit git repository that is created for ports using a source archive (and the corresponding patchset).
+- '''Required:''' No
+- '''Default:''' None
+
+==== SOURCE_DIR ====
+- '''Type:''' String
+- '''Purpose:''' Specify the sub-directory where the sources are after the source archive has been unpacked. Most ports should use `'$portVersionedName'`, as that seems to be the most popular way of archiving the sources.
+- '''Required:''' No
+- '''Default:''' None
+
+==== SOURCE_EXPORT_SUBDIR ====
+- '''Type:''' String
+- '''Purpose:''' Tells !HaikuPorter to only export the given sub-directory into the source package. This can be useful if a port pulls in a large source archive but only uses a subdirectory of that itself. An example are the current build recipes for `binutils` and `gcc`.
+- '''Required:''' No
+- '''Default:''' None
+
+==== SRC_FILENAME ====
+- '''Type:''' String
+- '''Purpose:''' Can be used to specify a local filename for the source archive. This is useful if the URLs from where the source is fetched doesn't provide a proper filename (e.g. `http://sw.example.org/cool-stuff-1.3/download`).
+- '''Required:''' No
+- '''Default:''' None
+
+==== SRC_URI ====
+- '''Type:''' String
+- '''Purpose:''' Specify one or more URIs for downloading the respective source archive from. SRC_URI can provide more than one URIs (one per line), all of which are expected to provide exactly the same file. If a port requires more than one source archives, it has to provide the URIs for the second archive in SRC_URI_2.
+- '''Required:''' Yes
+- '''Default:''' None
+- '''URI-Types:''' The following URI-types are supported:
+ - '''!http://''', '''!https://''' and '''!ftp://''': Download of source archive via `wget`
+ - '''!bzr://''': Download via checkout of Bazaar repository.
+ - '''!cvs://''': Download via checkout of CVS repository.
+ - '''!fossil://''': Download via cloning of Fossil repository.
+ - '''!git://''': Download via cloning of Git repository.
+ - '''!hg://''', '''!hg+...://''': Download via cloning of Mercurial repository.
+ - '''!svn://''', '''!svn+...://''': Download via checkout of Subversion repository.
+
+Finally, there is a set of output variables that can be set per-package. A sibling package can be defined by extending one of these variables with `_<packageSuffix>`. If for instance you set `SUMMAY_devel='Development files for foo'` in the `foo`-recipe, a sibling package `foo_devel` will be created alongside of the base package named `foo`.
+
+This is the set of per-package variables:
+
+... TODO ...
 
 === Shell Functions ===