Mercurial > vanilla

annotate README.info.md @ 188:33ca74ae7386

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
lib/isl: initial import, closes #1392
author David Demelier <markand@malikania.fr>
date Mon, 18 Mar 2019 20:54:56 +0100
parents e8fb94b9551d
children
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)
42
e8fb94b9551d vanilla: add README.licenses.md
David Demelier <markand@malikania.fr>
parents: 33
diff changeset
12 - PKGLICENSE: software license (see README.licenses.md)
33
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - PKGSUMMARY: a short summary
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 - PKGDOWNLOAD: a space separated list of files to download
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 Dependencies
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
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 Package dependencies are filled in the *PKGDEPENDS* variables. Dependencies are
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 specified using the full directory name to the missing package.
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 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
23
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 Example:
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ```sh
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 PKGDEPENDS="dev/cmake:build libzlib"
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
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 Options
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
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 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
34 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
35 in the *PKGOPTIONS* variable.
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 Example:
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 ```sh
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 PKGOPTIONS="PULSEAUDIO BLUETOOTH"
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
924e6892e7ec vanilla: add README.info.md
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 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
44 own if it already exists.