From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Thu, 18 Jun 2020 18:10:26 +0000 (+0100)
Subject: README.md: Various updates
X-Git-Tag: nailing-cargo/1.0.0~174
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=10ec80ae9f1c2d3b94349cb3401a78ba4c870a7c;p=nailing-cargo.git

README.md: Various updates

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/README.md b/README.md
index 28f25dc..a3b30b5 100644
--- a/README.md
+++ b/README.md
@@ -84,7 +84,7 @@ 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'`).
+`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
@@ -296,8 +296,8 @@ Limitations and bugs
     or is interrupted these changes may be left behind; running
     nailing-cargo again should clean up such a mess.  Unfortunately it is
     not possible to fix this bug because the cargo team have deliberately
-    made cargo inflexible.
-    [[issue#6715]](https://github.com/rust-lang/cargo/issues/6715).)
+    made cargo inflexible -
+    [issue#6715](https://github.com/rust-lang/cargo/issues/6715).)
 
   * Out of tree builds require a unified filesystem view: eg, different
     users on the same host, NFS, or something.  This could be improved.
@@ -306,7 +306,7 @@ Limitations and bugs
     think fixing this just involves review to check other values work
     properly.
 
-  * The alternative Cargo.lock file must be on smae filesystem.  This is
+  * The alternative Cargo.lock file must be on same filesystem.  This is
     not so easy to fix; we would want the existing algorithm but a
     fallback for this case.
 
@@ -320,6 +320,13 @@ Limitations and bugs
     plan to do substantial work, please do get in touch with a sketch of
     your proposed changes.
 
+  * nailing-cargo uses a single lockfile alongside your `Cargo.nail`,
+    rather than a more sophisticated scheme involving locking
+    particular directories.  This means that if you run multiple
+    copies of nailing-cargo at once, in different directories, but
+    with `Cargo.nail` files which imply overlapping sets of package
+    directories, things will go Badly Wrong.
+
 Contributing and legal
 ======================