chiark / gitweb /
README.md: More minor docs updates
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 18 Jun 2020 19:30:40 +0000 (20:30 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Thu, 18 Jun 2020 19:30:40 +0000 (20:30 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index c7f3c75a441704dcf869ad2b2104fac940838add..9891e08313c7f0028205ff44bf74e686712199f2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -191,8 +191,8 @@ Command-line options
        `RPI='arm-unknown-linux-gnueabihf'`.
 
        This option translates to a --target= option to the ultimate
-       command, unless that is a cargo subcommand which would reject
-       it.  `--arch` and `--target` are simply aliases.
+       command, unless that is a cargo subcommand which we know
+       would reject it.  `--arch` and `--target` are simply aliases.
 
   * `-u` | `--cargo-lock-update` | `-U` | `--no-cargo-lock-update`
 
@@ -216,8 +216,8 @@ Command-line options
 
        Default is to add them if we are doing an out-of-tree build,
        unless we are doing the dance to update the `Cargo.lock` (see
-       above) in which case the only relevant files are to be found in
-       the build directory).
+       above) since in that case all the relevant files can be found
+       by cargo in the build directory.
 
        The arguments added are
 
@@ -266,6 +266,7 @@ To control use of alternative Cargo.lock filename, use the section
   * `file = false`: disables this feature
 
   * `file = true`: equivalent to `file = "Cargo.lock.example"`
+    (this is the default).
 
   * `file = <some leafname>`
 
@@ -279,7 +280,8 @@ Running the command
 
 Normally you pass `cargo` as an argument to `nailing-cargo`.  But you
 can also pass `make` or any other command.  You may need to pass
-`--no-cargo-manifest-args` to nailing-cargo.
+`--no-cargo-manifest-args` (aka `-M`) to nailing-cargo, to avoid
+passing options like `--manifest-path` to `make` or whatever.
 
 nailing-cargo passes these environment variables to the build command: