From 81efa32e342808ea966d25410f29caba7a195d9e Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sun, 21 Jun 2020 19:43:16 +0100 Subject: [PATCH] README.md: Update for actual -u functionality Signed-off-by: Ian Jackson --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 610ed52..c108724 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ subdirs=""" myproject mylibrary """ -$ nailing-cargo generate-lockfile +$ nailing-cargo -u fetch $ nailing-cargo build ``` @@ -275,15 +275,17 @@ Options * `-u` | `--cargo-lock-update` | `-U` | `--no-cargo-lock-update` - Enables, or disables, the dance to allow `Cargo.lock` (or - alternative) to be updated in the source directory. + Allows (or disallows) cargo to update `Cargo.lock` in the source + directory. Without this enabled, nailing-cargo passes `--locked` + to cargo. - With this dance enabled the `Cargo.lock` and `Cargo.toml` are - copied to the build directory along with a skeleton just big - enough to fool cargo. After cargo has run, the resulting - `Cargo.lock` is copied back to the source tree. + With this enabled, in an out-of-tree build the `Cargo.lock` and + `Cargo.toml` are copied to the build directory along with a + skeleton just big enough to fool cargo. After cargo has run, the + resulting `Cargo.lock` is copied back to the source tree. - Default is no update unless the cargo subcommand will want it. + Default is no update unless the whole point of the cargo + subcommand is to update `Cargo.lock`. * `-c` | `-C` -- 2.30.2