From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Fri, 19 Jun 2020 11:00:33 +0000 (+0100)
Subject: README.md: Write ` ` around Cargo.foo filenames
X-Git-Tag: nailing-cargo/1.0.0~159
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=383e000ac859d078fda1ef004b9c35b9932a4e7a;p=nailing-cargo.git

README.md: Write ` ` around Cargo.foo filenames

This was previously not always done consistently.

Reported-by: Mark Wooding <mdw@distorted.org.uk>
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/README.md b/README.md
index 7b79f1d..90c7d99 100644
--- a/README.md
+++ b/README.md
@@ -70,8 +70,8 @@ nailing-cargo temporarily edits all the `Cargo.toml` files in all the
 subdirectories you mention, to refer to each other; then it runs
 cargo; and then it puts everything back.
 
-Telling nailing-cargo how to massage Cargo.toml
------------------------------------------------
+Telling nailing-cargo how to massage `Cargo.toml`
+-------------------------------------------------
 
 To find the subdirectories, and the packages, it looks for `subdirs`
 and `packages` in `Cargo.nail`.
@@ -179,7 +179,7 @@ Command-line options
 
   * `-D`: Increase amount of debugging dump.
 
-  * `-n`: "No action": stop after writing Cargo.toml.nailing~
+  * `-n`: "No action": stop after writing `Cargo.toml.nailing~`
        everywhere, and do not run any build command.
 
   * `-A<arch>` | `--arch=<arch>` | `--target=<arch>`
@@ -196,13 +196,13 @@ Command-line options
 
   * `-u` | `--cargo-lock-update` | `-U` | `--no-cargo-lock-update`
 
-       Enables, or disables, the dance to allow Cargo.lock (or
+       Enables, or disables, the dance to allow `Cargo.lock` (or
        alternative) to be updated in the source directory.
 
-       With this dance enabled the Cargo.lock and Cargo.toml are
+       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.
+       `Cargo.lock` is copied back to the source tree.
 
        This makes no sense with in-tree builds.
 
@@ -260,7 +260,7 @@ only from `Cargo.nail` (see "Limitations and bugs", below).
 Alternative `Cargo.lock` filename
 ---------------------------------
 
-To control use of alternative Cargo.lock filename, use the section
+To control use of alternative `Cargo.lock` filename, use the section
 `[alt_cargolock]`.  Settings here:
 
   * `file = false`: disables this feature
@@ -307,17 +307,17 @@ Limitations and bugs
   * Out of tree builds require a unified filesystem view: eg, different
     users on the same host, NFS, or something.  This could be improved.
 
-    The alternative Cargo.lock filename must currently be a leafname.  I
+    The alternative `Cargo.lock` filename must currently be a leafname.  I
     think fixing this just involves review to check other values work
     properly.
 
-  * The alternative Cargo.lock file must be on same filesystem.  This is
+  * The alternative `Cargo.lock` file must be on same filesystem.  This is
     not so easy to fix; we would want the existing algorithm but a
     fallback for this case.
 
-  * Cargo.nail is unconditionally looked for in the parent directory.
+  * `Cargo.nail` is unconditionally looked for in the parent directory.
     Ideally this should be configurable, and also perhaps be able to
-    combine multiple Cargo.nail files?  Relatedly, although
+    combine multiple `Cargo.nail` files?  Relatedly, although
     nailing-cargo can read multiple config files, it can only handle
     one file specifying directories and packages.