aboutsummaryrefslogtreecommitdiff
path: root/doc/manual.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2017-08-01 15:29:24 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2017-08-01 15:29:24 +0200
commitb7b30102882f0a85c169a0eb4944a8f1c344c9e1 (patch)
treef5c66e392bed3e3fcdc06941519ffc0a66b63c82 /doc/manual.cli
parentb810a034499e1cdc27e03714721b4de085da6d3a (diff)
Add version, project.summary, project.url built-in variables
Extract them from manifest in the version module. Use them when generating the pkg-config's .pc files.
Diffstat (limited to 'doc/manual.cli')
-rw-r--r--doc/manual.cli10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index f89fa23..62290e0 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -502,6 +502,16 @@ as the following build system variables (which can be used in the buildfiles):
[uint64] version.revision # 3
\
+As a convenience, the \c{version} module also extract the \c{summary} and
+\c{url} manifest values and sets them as the following build system variables
+(this additional information is used, for example, when generating the
+\c{pkg-config} files):
+
+\
+[string] project.summary
+[string] project.url
+\
+
If the version is the latest snapshot (that is, it's in the \c{.z} form), then
the \c{version} module extracts the snapshot information from the version
control system used by the project. Currently only \c{git} is supported with