From ee5099a6b4194a1617da1ed7b22bfb315cc8b900 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Tue, 17 Aug 2021 18:07:01 +0100 Subject: [PATCH] README: document trouble with tricky packages, and submodules Signed-off-by: Ian Jackson --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 0df1f94..25122c5 100644 --- a/README.md +++ b/README.md @@ -748,6 +748,19 @@ Limitations and bugs with `Cargo.nail` files which imply overlapping sets of package directories, things will go Badly Wrong. + * Many real-world packages do not support out-of-tree builds + properly. Doing so well is not easy because cargo does not + provide a package with all the path information needed to do a + good job. Also the Rust community's infrastructure and tooling + does not do out-of-tree builds by default. + + If you encounter such a package, `--linkfarm` will often help. + + * git submodules are not supported. In theory this could perhaps be + improved, but it is not trivial because git submodules are badly + broken. If you can, avoid git submodule and use other techniques + instead (e.g., `git subtree`). + Contributing and legal ====================== -- 2.30.2