aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-07-11 10:46:17 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-07-11 10:46:17 +0200
commit3d8cd06cf98438a3ca4299d0ba77c84c029102a0 (patch)
treec718d6029a739ef03f59dc63e6c113eff9a2671c /doc
parente766f0c30a33dedd2d49783780f79f994a063ac4 (diff)
Specify 'project' package manifest value
Diffstat (limited to 'doc')
-rw-r--r--doc/manual.cli19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index 3f05aa0..ccd1498 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -494,6 +494,7 @@ sections.
\
name: <name>
version: <version>
+[project]: <name>
[priority]: <priority> [; <comment>]
summary: <text>
license: <licenses> [; <comment>]
@@ -541,6 +542,24 @@ format description. Note that the version case is preserved for display, in
file names, etc.
+\h2#manifest-package-project|\c{project}|
+
+\
+[project]: <name>
+\
+
+The project this package belongs to. The project name has the same
+restrictions as the package name (see \l{#package-name Package Name} for
+details) and its case is preserved for display, in directory names, etc. If
+unspecified, then the project name is assumed to be the same as the package
+name.
+
+Projects are used to group related packages together in order to help with
+organization and discovery in repositories. For example, packages \c{hello},
+\c{libhello}, and \c{libhello2} could all belong to project \c{hello}. By
+convention, projects of library packages are named without the \c{lib} prefix.
+
+
\h2#manifest-package-|\c{priority}|
\