Skip to content

explain what vend means in cargo-vendor command documentation #16365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sterschi wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −6
Open

explain what vend means in cargo-vendor command documentation #16365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/doc/src/commands/cargo-vendor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@

## NAME

cargo-vendor --- Vendor all dependencies locally
cargo-vendor --- Vendor all dependencies locally by copying their source code into your project repository.
Copy link
Member

@weihanglo weihanglo Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vendor is a common term in package management area that I feel like we don't need to overly explain it.

Other commands also usually don't have such a long summary.


## SYNOPSIS

`cargo vendor` [_options_] [_path_]

## DESCRIPTION

This cargo subcommand will vendor all crates.io and git dependencies for a
project into the specified directory at `<path>`. After this command completes
the vendor directory specified by `<path>` 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 `<path>`. This enables building the project in offline
or restricted network environments.

After this command completes the vendor directory specified by `<path>` 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.
Expand Down
Loading