From eaf055f05e2a903e92498311fb8ccce063a77a49 Mon Sep 17 00:00:00 2001 From: jofas Date: Sun, 26 Feb 2023 11:32:00 +0100 Subject: [PATCH] added h3-section headers to description --- src/doc/man/cargo-install.md | 4 ++++ src/doc/man/generated_txt/cargo-install.txt | 2 ++ src/doc/src/commands/cargo-install.md | 4 ++++ src/etc/man/cargo-install.1 | 4 ++-- 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/src/doc/man/cargo-install.md b/src/doc/man/cargo-install.md index 635c06f9839e..14c2296c2281 100644 --- a/src/doc/man/cargo-install.md +++ b/src/doc/man/cargo-install.md @@ -55,6 +55,8 @@ specified by setting the `CARGO_TARGET_DIR` environment variable to a relative path. In particular, this can be useful for caching build artifacts on continuous integration systems. +### Dealing with the Lockfile + By default, the `Cargo.lock` file that is included with the package will be ignored. This means that Cargo will recompute which versions of dependencies to use, possibly using newer versions that have been released since the @@ -69,6 +71,8 @@ not start publishing `Cargo.lock` files until version 1.37, which means packages published with prior versions will not have a `Cargo.lock` file available. +### Configuration Discovery + This command operates on system or user level, not project level. This means that the local [configuration discovery] is ignored. Instead, the configuration discovery begins at `$CARGO_HOME/config.toml`. diff --git a/src/doc/man/generated_txt/cargo-install.txt b/src/doc/man/generated_txt/cargo-install.txt index 847c38a0cb12..a285a1b68901 100644 --- a/src/doc/man/generated_txt/cargo-install.txt +++ b/src/doc/man/generated_txt/cargo-install.txt @@ -65,6 +65,7 @@ DESCRIPTION variable to a relative path. In particular, this can be useful for caching build artifacts on continuous integration systems. + Dealing with the Lockfile By default, the Cargo.lock file that is included with the package will be ignored. This means that Cargo will recompute which versions of dependencies to use, possibly using newer versions that have been @@ -79,6 +80,7 @@ DESCRIPTION Cargo.lock files until version 1.37, which means packages published with prior versions will not have a Cargo.lock file available. + Configuration Discovery This command operates on system or user level, not project level. This means that the local configuration discovery diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md index da0e2f1c2225..1601872ed8b1 100644 --- a/src/doc/src/commands/cargo-install.md +++ b/src/doc/src/commands/cargo-install.md @@ -62,6 +62,8 @@ specified by setting the `CARGO_TARGET_DIR` environment variable to a relative path. In particular, this can be useful for caching build artifacts on continuous integration systems. +### Dealing with the Lockfile + By default, the `Cargo.lock` file that is included with the package will be ignored. This means that Cargo will recompute which versions of dependencies to use, possibly using newer versions that have been released since the @@ -76,6 +78,8 @@ not start publishing `Cargo.lock` files until version 1.37, which means packages published with prior versions will not have a `Cargo.lock` file available. +### Configuration Discovery + This command operates on system or user level, not project level. This means that the local [configuration discovery] is ignored. Instead, the configuration discovery begins at `$CARGO_HOME/config.toml`. diff --git a/src/etc/man/cargo-install.1 b/src/etc/man/cargo-install.1 index f22ef6d6c733..32b2bf4c95a6 100644 --- a/src/etc/man/cargo-install.1 +++ b/src/etc/man/cargo-install.1 @@ -87,7 +87,7 @@ in a temporary target directory. To avoid this, the target directory can be specified by setting the \fBCARGO_TARGET_DIR\fR environment variable to a relative path. In particular, this can be useful for caching build artifacts on continuous integration systems. -.sp +.SS "Dealing with the Lockfile" By default, the \fBCargo.lock\fR file that is included with the package will be ignored. This means that Cargo will recompute which versions of dependencies to use, possibly using newer versions that have been released since the @@ -101,7 +101,7 @@ will not receive any fixes or updates to any dependency. Note that Cargo did not start publishing \fBCargo.lock\fR files until version 1.37, which means packages published with prior versions will not have a \fBCargo.lock\fR file available. -.sp +.SS "Configuration Discovery" This command operates on system or user level, not project level. This means that the local \fIconfiguration discovery\fR is ignored. Instead, the configuration discovery begins at \fB$CARGO_HOME/config.toml\fR\&.