summaryrefslogtreecommitdiffstats
path: root/specs/spf-2.0/substvars.mdwn
blob: c872e31925c80289e5f0799c8da35e9777333975 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Variable Names [substvars-name]
===============================

Variable names may only consist of uppercase and lowercase Latin letters,
digits, and hyphens.  Names must be at least one character long.  (A regular
expression for this is `[A-Za-z0-9-]+`.)


Variable Substitutions [substvars-exp]
======================================

Variable substitutions are performed on certain binary control field values, as
explained in $[sectlink][fields-bin].

The format for variable substitutions is as follows:

    ${<var-name>}

`<var-name>` is the name of the variable.


Special Variables [substvars-defined]
=====================================

The following substitution variables shall be set:

  * `Source-Version`

    The source package version, as given in the most recent entry of the change
    log.  See $[sectlink][src-ver] for the syntax of source package version
    identifiers.

  * `Binary-Version`

    The binary package version, as given in the most recent entry of the change
    log.  See $[sectlink][src-ver] for the syntax of source package version
    identifiers.

  * `Host-Arch`

    The distribution architecture string of the host system.

  * `Host-Plat`

    The application platform of the host system.


Defining Substitution Variables [substvars-custom]
==================================================

Substitution variables may be defined in a file called `substvars`.  See
$[sectlink][control] for the format of this file.

Names must conform to the requirements outlined in $[sectlink][substvars-name].
Values may be comprised of multiple lines, and empty lines at the beginning and
end of each substitution variable value shall be removed.