chiark / gitweb /
Usage message: Mention --edits-sources
[nailing-cargo.git] / README.md
index 2ed760564c52964a76a6335f9e339deabc82e019..3269cde5389ab62a00d4b70d74e2b7c347664360 100644 (file)
--- a/README.md
+++ b/README.md
@@ -367,9 +367,11 @@ 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.
+    * `linkfarm-gitclean`: Make the defaults be `--linkfarm=git` and `--preclean-build=src`.
 
     There are also some properties which should not be needed, but are
     provided for completeness.  Do not use these to solve the problem
@@ -396,9 +398,10 @@ WASM="wasm32-unknown-unknown"
       nailing-cargo thinks cargo is going to update `Cargo.lock`.
 
     * `git`: Make a deep linkfarm, with subdirectories.  Symlink
-      those objects tracked by git.
+      those objects tracked by git.  This is the default for
+      `cargo publish`.
 
-    * `git`: Make a deep linkfarm and symlink every nondirectory found
+    * `full`: Make a deep linkfarm and symlink every nondirectory found
       in the source tree.  This will including all sorts of junk,
       including for example editor backup files.
 
@@ -434,6 +437,13 @@ WASM="wasm32-unknown-unknown"
     lockfile update, controls whether the linkfarm is kept afterwards.
     Overrides the `oot.clean` config option.  (Default: keep.)
 
+  * `--[no-]preclean-build[=no|src|full]`: When doing an out-of-tree
+    build, controls whether the build directory is purged of leftover
+    contents *before* the build is run.  The usual default is `no`.
+    For `cargo publish`, the default is `src`, which deletes
+    everything except the directory `target`.  `full` means to clean
+    out that too.
+
   * `--leave-nailed`: At the end, leave all the `Cargo.toml` files in
     their edited state, rather than (trying to) clean them up.  To
     clean this up later, run `nailing-cargo` again without this option.