aboutsummaryrefslogtreecommitdiff
path: root/doc/intro.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-07-11 15:10:13 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-07-11 15:10:13 +0200
commite8d61902a18c606677be73ad6cec392d4a6a9b17 (patch)
tree298a5b126804dd0a1c28e918e76cabb2cda456e4 /doc/intro.cli
parent82ea9c873e92f2ef45f3528dd713e51f02ba078c (diff)
Discuss 'project' package manifest value in intro
Diffstat (limited to 'doc/intro.cli')
-rw-r--r--doc/intro.cli20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/intro.cli b/doc/intro.cli
index 290eb09..f429d2c 100644
--- a/doc/intro.cli
+++ b/doc/intro.cli
@@ -1410,6 +1410,26 @@ hello-gcc/
hello-clang/
\
+Let's also edit the generated \c{manifest} file and add the \c{project} value
+(customarily after \c{version}) to indicate that our library belongs to the
+same overall project as our executable:
+
+\
+$ cat libhello/manifest
+: 1
+name: libhello
+version: 0.1.0-a.0.z
+project: hello
+summary: hello library
+...
+\
+
+\N|The \c{project} value is used to group related packages together in order
+to help with their organization and discovery. For example, if later we create
+\c{libhello2} or \c{libhello-extra}, then it would make sense for them to also
+belong to the \c{hello} project. See the \l{bpkg#manifest-package-project
+\c{project}} value documentation for details.|
+
Our two projects will be sharing the same set of build configurations, so
next we initialize \c{libhello} in \c{hello-gcc} and \c{hello-clang}: