From 69ea616585e829f0f58afba87704f029f2a2053a Mon Sep 17 00:00:00 2001 From: sterschi Date: Mon, 8 Dec 2025 09:54:10 -0800 Subject: [PATCH] explain what vend means in cargo-vendor command documentation Existing definition is self referential and it was not clear to my what "vend" meant. Updated #Name description to provide better meanings and provide rationale why you would want vendoring (to enable offline builds) in the Description --- src/doc/src/commands/cargo-vendor.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/doc/src/commands/cargo-vendor.md b/src/doc/src/commands/cargo-vendor.md index 255ab54d292..e7597f6cd1e 100644 --- a/src/doc/src/commands/cargo-vendor.md +++ b/src/doc/src/commands/cargo-vendor.md @@ -2,7 +2,7 @@ ## NAME -cargo-vendor --- Vendor all dependencies locally +cargo-vendor --- Vendor all dependencies locally by copying their source code into your project repository. ## SYNOPSIS @@ -10,11 +10,13 @@ cargo-vendor --- Vendor all dependencies locally ## DESCRIPTION -This cargo subcommand will vendor all crates.io and git dependencies for a -project into the specified directory at ``. After this command completes -the vendor directory specified by `` will contain all remote sources from -dependencies specified. Additional manifests beyond the default one can be -specified with the `-s` option. +This cargo subcommand will vendor all crates.io and git dependencies for a project +into the specified directory at ``. This enables building the project in offline +or restricted network environments. + +After this command completes the vendor directory specified by `` will contain all +remote sources from dependencies specified. Additional manifests beyond the default one +can be specified with the `-s` option. The configuration necessary to use the vendored sources would be printed to stdout after `cargo vendor` completes the vendoring process.