Mercurial > vanilla

annotate README.info.md @ 33:924e6892e7ec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
vanilla: add README.info.md
author David Demelier <markand@malikania.fr>
date Tue, 26 Feb 2019 09:46:16 +0100
parents
children e8fb94b9551d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
33
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 vanilla info files
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 ==================
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 In package directories, you'll find *name.info* files. They contains metadata
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 information about a given package.
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 The following variables are required:
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 - PKGNAME: canonical package name
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 - PKGVERSION: package upstream version
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 - PKGREVISION: vanilla package revision (starts at 1)
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 - PKGSUMMARY: a short summary
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - PKGDOWNLOAD: a space separated list of files to download
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 Dependencies
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 ============
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 Package dependencies are filled in the *PKGDEPENDS* variables. Dependencies are
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 specified using the full directory name to the missing package.
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 If a package is only required at build time, add the ":build" suffix.
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 Example:
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 ```sh
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 PKGDEPENDS="dev/cmake:build libzlib"
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 ```
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 Options
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 =======
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 If a package support options, specify the documentation about those in the
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 README file of the given package. Also add all options as a space separated list
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 in the *PKGOPTIONS* variable.
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 Example:
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 ```sh
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 PKGOPTIONS="PULSEAUDIO BLUETOOTH"
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 ```
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 Also see README.options.md for a list of predefined options. Do not write your
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 own if it already exists.