chiark / gitweb /
README.md: Cross-references
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Sun, 21 Jun 2020 13:25:15 +0000 (14:25 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Sun, 21 Jun 2020 13:25:15 +0000 (14:25 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md

index 20c7104c92a5cf80770bfb2195013ec6062c4be2..035f427b74c7a745623ce227378d0ce1dcaed3fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -112,7 +112,7 @@ containing a list of subdirectory names one per line.  In each of
 these directories `Cargo.toml` will be massaged, and the package there
 will be used for other massaged `Cargo.toml`s.
 
-See "Configuration reference", below, for full details.
+See the [Configuration reference] for full details.
 
 Out-of-tree builds
 ==================
@@ -195,7 +195,7 @@ Usages
 3$ nailing-cargo <nailing-opts> --- [--] <build-command>...
 ```
 Ususally the `--` is not needed.  (It should generally be passed by
-programs which wrap nailing-cargo.  See below.)
+programs which wrap nailing-cargo.  See [Invocation argument disambiguation rules], below.)
 
 In usage 1, nailing-cargo runs `cargo` (from `PATH`).  In the usage 2
 nailing-cargo runs `<cargo>`.  In both these cases it adds its own
@@ -264,7 +264,7 @@ Options
     then in the builtin arch alias list.  The builtin list is
     equivalent to: `[arch]` `RPI='arm-unknown-linux-gnueabihf'`.
 
-  * `-s<subcommand>`
+  * <a name="s_subcommand">`-s<subcommand>`
 
     Behave as if the build command were `cargo <subcommand>`.
     This influences the logic which tries to determine which
@@ -274,7 +274,7 @@ Options
     nailing-cargo knows about `update`, `generate-lockfile` and
     `fetch`; all other subcommands are (silently) treated the same way
     as `build` (ie, no subcommand properties).  See
-    `--subcommand-props`, below, for more detail about how the
+    [`--subcommand-props`](#subcommand_props) for more detail about how the
     subcommand affects nailing-cargo's behaviour.
 
     The default is to use the cargo subcommand found from parsing
@@ -304,7 +304,8 @@ Options
     Whether to allow cargo to make network access.  nailing-cargo
     always passes `--offline` to cargo, unless `--online` is in
     force.  The default value depends on the configuration and the
-    cargo subcommand - see `[misc]` `online` in "Configuration".
+    cargo subcommand - see [`[misc]` `online`](#misc_online),
+    under Configuration.
 
   * `-u` | `--cargo-lock-update` | `-U` | `--no-cargo-lock-update`
 
@@ -320,7 +321,7 @@ Options
 
     Default is no update unless the cargo subcommand will want it.
 
-  * `--subcommand-props=<prop>,...`
+  * <a name="subcommand_props">`--subcommand-props=<prop>,...`
 
     Specify the properties of the subcommand.  This is an
     alternative to `-s<subcmd>`.  The usual properties are:
@@ -493,7 +494,7 @@ other names are not looked up in this alias map.
 `[misc]`: Miscellaneous individual nailing-cargo config
 -------------------------------------------------------
 
- * `online`: boolean, specifying whether to pass `--offline` to cargo
+ * <a name="misc_online">`online`: boolean, specifying whether to pass `--offline` to cargo
    (cargo's default is online mode).  The default is offline, unless
    nailing-cargo can see that the cargo subcommand being invoked is
    one which requires online access (currently, `fetch`), in which
@@ -514,9 +515,9 @@ Limitations and bugs
   * nailing-cargo needs to understand the behaviour of the cargo
     subcommand you are running - especially for out-of-tree builds.
     nailing-cargo only has a short builtin list of commands it knows
-    about (see the `-s` option).  For other commands, you may need to
+    about (see [`-s<subcommand`](#s_subcommand)).  For other commands, you may need to
     add an entry to `@subcmd_propss` in the source, or use
-    `--subcommand-props`.
+    [`--subcommand-props`](#subcommand_props).
 
   * Out of tree builds require a unified filesystem view: eg, different
     users on the same host, NFS, or something.