New --force, and make lack of -E fail by default

[nailing-cargo.git] / README.md

diff --git a/README.md b/README.md
index b87350dfadc61806ab919d2b5506e16b17cff23f..124d352317c47e98b9bc81b48137661f3a021c77 100644 (file)
--- a/README.md
+++ b/README.md
@@ -280,6 +280,9 @@ Options
   * `-n`: "No action": stop after writing `Cargo.toml.nailing~`
        everywhere, and do not run any build command.
 
+  * `-f` | `--force`: Force going ahead even if problems are likely.
+    (E.g., due to missing `-E` option.)
+
   * `-T<arch>` | `--target=<arch>`
 
     Specify target architecture.
@@ -367,8 +370,8 @@ 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.  Produces warning if `--edit-sources` mode not specified.
-    * `creates`: The purpose of this subcommand is to edit the source tree and create new files in it.  Produces warning if `--edit-sources` (`-E`) mode not specified twice.
+    * `edits`: The purpose of this subcommand is to edit the source tree.  Imples that `--edit-sources` is necessary (unless `--force`).
+    * `creates`: The purpose of this subcommand is to edit the source tree and create new files in it.  Imples that `-EE` (`--edit-sources`, twice) is necessary (unless `--force`).
     * `!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.
@@ -428,7 +431,8 @@ WASM="wasm32-unknown-unknown"
     should use git to review the edits made by the cargo command and
     either stage and commit them, or reject them.
 
-    This is the default mode for `nailing-cargo fmt`.
+    `-E` or `-f` is needed for `nailing-cargo fmt`.  `-EE` or `-f` is
+    needed for `nailing-cargo init`.  (`-E` is never the default.)
 
   * `--just-linkfarm[=shallow|git|full]`: Make the out-of-tree
     linkfarm as if for `--cargo-lock-update`, but do not actually run