chiark / gitweb /
README.md: Discourage `[packages]' slightly
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 18 Jun 2020 19:23:03 +0000 (20:23 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 18 Jun 2020 19:23:03 +0000 (20:23 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index a4964093e8c9e3df906ad2a7d75714b89906f1e8..c7f3c75a441704dcf869ad2b2104fac940838add 100644 (file)
--- a/README.md
+++ b/README.md
@@ -82,13 +82,13 @@ can be a list of strings (`subdirs = ['myproject','mylibrary']`).  In
 each of these directories `Cargo.toml` will be massaged, and
 the package there will be used for other massaged `Cargo.toml`s
 
-`packages` is a mapping from package names to dictionaries (e.g. in
-`Cargo.nail`, write something like: `[packages.mylibrary]`
-`subdir='mylibrary-test'` or `[packages]` `mylibrary='mylibrary-test'`).
-These override the locations for the specified packages (so you can,
-for example, have multiple trees with the same package in).  The
-`subdir` values are also added to the list of directories where
-`Cargo.toml` should be massaged.
+For more complex cases: `packages` is a mapping from package names to
+strings, or dictionaries (e.g. in `Cargo.nail`, write something like:
+`[packages.mylibrary]` `subdir='mylibrary-test'` or `[packages]`
+`mylibrary='mylibrary-test'`).  These override the locations for the
+specified packages (so you can, for example, have multiple trees with
+the same package in).  The `subdir` values are also added to the list
+of directories where `Cargo.toml` should be massaged.
 
 Out-of-tree builds
 ==================