From 2ad51c43d46c81b01d295b9847032c28766adb93 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Wed, 4 Mar 2020 07:33:06 +0200 Subject: Add note on using symlinks in multi-package projects to intro --- doc/intro.cli | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/intro.cli b/doc/intro.cli index 2e28cdf..10548a5 100644 --- a/doc/intro.cli +++ b/doc/intro.cli @@ -1841,6 +1841,30 @@ test ../hello-gcc/libhello/tests/basics/exe{driver} test hello/hello/testscript{testscript} ../hello-gcc/hello/hello/exe{hello} \ +\N|A multi-package project could have several files, such as \c{README.md} and +\c{LICENSE}, which, while shared by all the packages, must nevertheless reside +within each package's directory. The recommended way to avoid the duplication +is to use symlinks. For example: + +\ +hello/ +├── .git/ +├── hello/ +│ ├── ... +│ ├── LICENSE -> ../LICENSE +│ └── manifest +├── libhello/ +│ ├── ... +│ ├── LICENSE -> ../LICENSE +│ └── manifest +├── LICENSE +├── packages.manifest +└── repositories.manifest +\ + +See \l{https://build2.org/article/symlinks.xhtml Using Symlinks in \c{build2} +Projects} for details.| + \h#guide-consume-pkg|Package Consumption| -- cgit v1.1