]> git.proxmox.com Git - cargo.git/commitdiff
Improve the wording of `dl` documentation.
authorMichael Henry <drmikehenry@drmikehenry.com>
Thu, 28 May 2020 20:24:16 +0000 (16:24 -0400)
committerMichael Henry <drmikehenry@drmikehenry.com>
Thu, 28 May 2020 20:24:16 +0000 (16:24 -0400)
src/doc/src/reference/registries.md

index f0148ca67eeade03994fe63f6e63574f4ca6b215..6b49cd0dc05db93fcdda734f8515d22fb39a8471 100644 (file)
@@ -127,12 +127,17 @@ looks like:
 
 The keys are:
 - `dl`: This is the URL for downloading crates listed in the index. The value
-  may have the markers `{crate}` and `{version}` which are replaced with the
-  name and version of the crate to download, or the marker `{prefix}` which is
-  replaced with the crate's prefix, or the marker `{lowerprefix}` which is
-  replaced with the crate's prefix converted to lowercase.  If none of the
-  markers are present, then the value `/{crate}/{version}/download` is appended
-  to the end.  See below for more about crate prefixes.
+  may have the following markers which will be replaced with their
+  corresponding value:
+
+  - `{crate}`: The name of crate.
+  - `{version}`: The crate version.
+  - `{prefix}`: A directory prefix computed from the crate name. For example,
+    a crate named `cargo` has a prefix of `ca/rg`. See below for details.
+  - `{lowerprefix}`: Lowercase variant of `{prefix}`.
+
+  If none of the markers are present, then the value
+  `/{crate}/{version}/download` is appended to the end.
 - `api`: This is the base URL for the web API. This key is optional, but if it
   is not specified, commands such as [`cargo publish`] will not work. The web
   API is described below.