NAME
pakfire-makefile - Which Pakfire a makefile needs
DESCRIPTION
The macros that makefiles use come with Pakfire. A makefile that has been written for newer macros fails in ways that are hard to understand when it is built by an older Pakfire, for example by a worker of the build service.
A makefile can therefore say what it needs at least. Pakfire stops as soon as it has read the makefile, no matter whether it builds, lints or packages it, and tells what is missing. A makefile that does not say anything is being read as before.
VARIABLES
- makefile = N
-
The level of the macros and of the syntax that the makefile needs at least, as a whole number. The levels are listed below. There is no mode that makes a newer Pakfire behave like an older one; the level is only a minimum.
- pakfire = VERSION
-
The version of Pakfire that the makefile needs at least, for example 0.9.31. This is the last resort for a makefile that cannot be built without a certain bug fix. If it is possible to describe what is needed as a makefile level, please do that instead.
- features = +NAME -NAME …
-
Features which a makefile turns on or off, separated by spaces. A feature is new or experimental behaviour of Pakfire itself, for example in how it builds or packages, which is not part of a makefile level (yet), so that it can be tried out without changing anything for makefiles that do not ask for it. Features are not about macros, which are going to be required in a different way. Pakfire sets feature_NAME to 1 or 0 (with dashes in the name turned into underscores) for every feature that it knows.
+NAME turns the feature on, and adds pakfire(Feature-NAME) to the build requirements of the package. A Pakfire that does not know the feature stops with a message that says so, and so does anything that solves the requirements, for example to find a builder that is new enough.
-NAME turns off a feature that is on by default. This is only possible for a limited time, see below, and requires nothing: a Pakfire that does not know the feature stops, and so does a Pakfire that does not allow turning it off any more.
Turning the same feature on and off is an error.
FEATURES
A feature goes through these states:
- experimental
-
It is off, and a makefile turns it on with +NAME. What it does may still change. pakfire-builder lint tells that the makefile uses an experimental feature.
- default
-
It is on, and a makefile may turn it off with -NAME for a while. pakfire-builder lint warns about +NAME, because it does nothing.
- deprecated
-
The feature is a part of a makefile level now or is going away. It still works, but pakfire-builder lint warns about it.
- removed
-
The feature does not exist any more. Asking for it is an error. The name is not given to anything else.
Some features cannot be turned off by a makefile at all, for example because they protect the build. Turning them off is an error, no matter whether the makefile is built or linted.
pakfire-builder lint does not stop at the first problem. It warns about features which it does not know, because the makefile may be meant for a newer Pakfire, while building the makefile stops.
There are no features at the moment.
LEVELS
- 1
-
The macros and the syntax as of Pakfire 0.9.30. Every Pakfire that knows about levels supports at least this. Levels are raised whenever a makefile can depend on something that an older Pakfire does not have.
EXAMPLE
name = example version = 1.0
# Needs the macros of level 1 or later, and a Pakfire with a bug fix makefile = 1 pakfire = 0.9.31