README.md: Document subcommand prop linkfarm-shallow

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

diff --git a/README.md b/README.md
index 2ed760564c52964a76a6335f9e339deabc82e019..1ebddd69ad3aeadf25a7269d2cb3242af5e93b4b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -370,6 +370,7 @@ WASM="wasm32-unknown-unknown"
     * `edits`: The purpose of this subcommand is to edit the source tree.  Enables `--edit-sources` mode.
     * `!target`: cargo would reject `--target=<arch>`; in this case nailing-cargo's `-T` option is ineffective.
     * `!target-dir`: cargo would reject `--target-dir`, so don't pass it.  (Usually we pass `--target-dir=target` when we pass `--manifest-path`, since cargo's default is `target` in the same directory as `Cargo.toml`.)
+    * `linkfarm-shallow`: Make the default be `--linkfarm=shallow`.  This is the default for `miri` and can also be used for other subcommands which do not understandg `--manifest-path` properly.
 
     There are also some properties which should not be needed, but are
     provided for completeness.  Do not use these to solve the problem