diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2020-03-04 07:33:06 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2020-03-04 07:33:06 +0200 |
| commit | 2ad51c43d46c81b01d295b9847032c28766adb93 (patch) | |
| tree | 7ea36b568762063833f912522253c1126d9ba839 | |
| parent | 1e32e4c7cb74fb3a5e63653b412e7a8b34cd26b9 (diff) | |
Add note on using symlinks in multi-package projects to intro
| -rw-r--r-- | doc/intro.cli | 24 |
1 files changed, 24 insertions, 0 deletions
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| |