Changes between Version 19 and Version 20 of Obsolete/MovedToTree/PackageManagement/BuildingPackages

Timestamp:

Jun 10, 2013, 3:48:01 PM (11 years ago)

Author:

bonefish

Comment:

Beginning of haikuporter documentation

Obsolete/MovedToTree/PackageManagement/BuildingPackages

@@ -1 +1 @@
 = Building Packages =
 
-This page provides information regarding the package building process.
+This page provides information regarding the package building process. The first section documents building a package with the low level command `package`. The second section gives details on building packages with the `haikuporter` tool.
 
 
-== Haiku Package Files ==
+== Building a Package with the "package" Command ==
 
-The package file format is in specified in detail in a [wiki:PackageManagement/FileFormat separate document]. This section presents information from the perspective of how to build a package file.
+The package file format is in specified in detail in a [wiki:PackageManagement/FileFormat separate document]. This section presents information from the perspective of how to build a package file with the `package` command.
 
 A hpkg file is an archive file (just like tar or zip files) that additionally contains package meta information in a separate section of the file. When building a hpkg file via the `package` command the meta information must be provided via a `.PackageInfo` file. For convenience the file itself is added to the archive as well and can be extracted later, but it will be ignored by packagefs.
@@ -113 +113 @@
 The revision part of the version string is assigned by the packager (not by the vendor). It allows to uniquely identify updated packages of the same vendor version of a software.
 
-
 === Package File Names ===
 
@@ -120 +119 @@
 file_name       ::= name "-" version "-" architecture ".hpkg"
 }}}
+
+
+== Building a Package with "haikuporter" ==
+
+`haikuporter` is a high level tool for building packages. As input it reads a build recipe file for a certain version of a software (aka port) and produces one or more packages, as declared in the recipe. A recipes specifies package requirements similar to how it is done in an `.PackageInfo` file. When asked to build a port, `haikuporter` resolves the respective dependencies and recursively builds all not-yet-built ports required for the requested port. `haikuporter` itself and a large library of recipe files are hosted at [http://ports.haiku-files.org/ HaikuPorts].
+
+=== The Build Recipe File ===
+
+For a particular version of a port a recipe file specifies what packages shall be built for that port and it provides all required information for that purpose. A recipe file is name according to the pattern "<portname>-<version>.recipe". The <version> component complies to `version_ref`, though without the revision component. The revision is specified in the recipe itself. It is incremented whenever the recipe itself or a Haiku specific patch for the port changes. A recipe file is a shell script. It is sourced (shell lingo for included) by `haikuporter`. It must set several shell variables and functions that are interpreted and used by `haikuporter`. A set of other variables and functions that can be used in the recipe are defined by `haikuporter` before sourcing it.