chiark / gitweb /
README: Fix docs for `edits`, which is not automatic
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 21 Jun 2021 11:42:52 +0000 (12:42 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Mon, 21 Jun 2021 11:42:52 +0000 (12:42 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index 81d94e7caab01b81e1d7f14b7986196de6a84823..3269cde5389ab62a00d4b70d74e2b7c347664360 100644 (file)
--- a/README.md
+++ b/README.md
@@ -367,7 +367,7 @@ WASM="wasm32-unknown-unknown"
 
     * `lock_update`: cargo will want to update `Cargo.lock`.  (The `-u` and `-U` options override this.)
     * `online`: this subcommand makes no sense to run offline.  (The `-o` and `-O` options, and the configuration, can override this.)
-    * `edits`: The purpose of this subcommand is to edit the source tree.  Enables `--edit-sources` mode.
+    * `edits`: The purpose of this subcommand is to edit the source tree.  Produces warning if `--edit-sources` mode not specified.
     * `!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.