development/cargo
development/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo synced 2024-08-28 03:39:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
14987 commits 77 branches 100 tags 91 MiB
Rust 95.2%
Roff 4.4%
JavaScript 0.2%
Shell 0.1%
Find a file
Ed Page dbbc5dd6eb feat(help): Add styling to help output 
Traditionally, cargo has disabled clap's styled help output.  My assumed
reason is that cargo mixes custom help output with auto-generated and
you couldn't previously make it all styled to match.  Clap 4.2 allowed
users to pass in strings styled using ANSI escape codes, allowing us to
pass in styled text that matches clap, unblocking this.  In clap
4.4.1, clap gained the ability for the user to override the style,
allowing us to choose the styling as we wish.

In this PR, I decided to use the new 4.4.1 feature to style clap's
output to match the rest of cargo's output.  Alternatively, we could use
a more subdue style that clap uses by default.  That subdued style was
mostly chosen to be app theme neurtral (since we didn't have theming
support yet) and there were problems with our style and no one stepped
up to fix them (cargo has a style we can match to instead).

I decided to *not* style `Arg::help` messages because
- It might be distracting to have the descriptions lit up like a
  christmas tree
- It is a lot more work

The one exception I made was for `--list` since it is for a
psuedo-command (`...`) and I wanted to intentionally draw attention to
it.
2023-09-01 09:30:20 -05:00
.cargo chore: remove xtask-unpublished 2023-08-01 22:54:41 +01:00
.github Add MSRV validation GitHub Action for cargo-credential 2023-09-05 23:01:53 -05:00
benches feat(resolver): Respect MSRV 2023-08-25 10:42:26 -05:00
ci ci: integrate xtask-bump-check 2023-08-01 22:54:40 +01:00
crates refactor: flatten module path of SourceId 2023-09-07 21:06:35 +08:00
credential Bump cargo-credential-1password to v0.4.0 2023-09-07 13:52:15 -05:00
src feat(help): Add styling to help output 2023-09-01 09:30:20 -05:00
tests fix: don't print _TOKEN suggestion when not applicable 2023-09-07 21:14:50 -05:00
.gitignore chore(xtask): Add xtask skeleton 2023-04-25 02:13:56 -05:00
.ignore chore: Don't show genned docs in ripgrep 2022-08-31 16:13:32 -05:00
build.rs clippy: allow usages of std::env::var family by exceptions 2023-03-17 12:57:21 +00:00
Cargo.lock feat(help): Add styling to help output 2023-09-01 09:30:20 -05:00
Cargo.toml feat(help): Add styling to help output 2023-09-01 09:30:20 -05:00
CHANGELOG.md docs(changelog): Clarify language for Cargo.lock policy 2023-08-30 10:50:49 -05:00
clippy.toml chore: Migrate print-ban from test to clippy 2023-06-09 08:11:49 -05:00
CODE_OF_CONDUCT.md Add CoC 2023-01-25 10:18:15 +00:00
CONTRIBUTING.md Add a notice about review capacity. 2022-03-24 14:18:42 -07:00
deny.toml credential: make gnome-secret built-in as cargo:libsecret 2023-08-17 13:58:18 -05:00
LICENSE-APACHE HTTPS all the things 2019-01-30 15:34:37 -05:00
LICENSE-MIT Remove inaccurate (misattributed) copyright notices 2017-07-26 17:19:24 -07:00
LICENSE-THIRD-PARTY HTTPS all the things 2019-01-30 15:34:37 -05:00
publish.py contrib docs: Add some more detail about how publishing works 2023-07-10 14:15:42 -07:00
README.md doc: point to nightly cargo doc 2023-06-07 10:13:05 +01:00
triagebot.toml chore: update auto-label trigger files 2023-06-20 19:23:21 +01:00

README.md

Cargo

Cargo downloads your Rust project’s dependencies and compiles your project.

To start using Cargo, learn more at The Cargo Book.

To start developing Cargo itself, read the Cargo Contributor Guide.

Code Status

CI

Code documentation: https://doc.rust-lang.org/nightly/nightly-rustc/cargo/

Installing Cargo

Cargo is distributed by default with Rust, so if you've got rustc installed locally you probably also have cargo installed locally.

Compiling from Source

Requirements

Cargo requires the following tools and packages to build:

Other requirements:

The following are optional based on your platform and needs.

  • pkg-config — This is used to help locate system packages, such as libssl headers/libraries. This may not be required in all cases, such as using vendored OpenSSL, or on Windows.

  • OpenSSL — Only needed on Unix-like systems and only if the vendored-openssl Cargo feature is not used.

    This requires the development headers, which can be obtained from the libssl-dev package on Ubuntu or openssl-devel with apk or yum or the openssl package from Homebrew on macOS.

    If using the vendored-openssl Cargo feature, then a static copy of OpenSSL will be built from source instead of using the system OpenSSL. This may require additional tools such as perl and make.

    On macOS, common installation directories from Homebrew, MacPorts, or pkgsrc will be checked. Otherwise it will fall back to pkg-config.

    On Windows, the system-provided Schannel will be used instead.

    LibreSSL is also supported.

Optional system libraries:

The build will automatically use vendored versions of the following libraries. However, if they are provided by the system and can be found with pkg-config, then the system libraries will be used instead:

  • libcurl — Used for network transfers.
  • libgit2 — Used for fetching git dependencies.
  • libssh2 — Used for SSH access to git repositories.
  • libz (aka zlib) — Used for data compression.

It is recommended to use the vendored versions as they are the versions that are tested to work with Cargo.

Compiling

First, you'll want to check out this repository

git clone https://github.com/rust-lang/cargo.git
cd cargo

With cargo already installed, you can simply run:

cargo build --release

Adding new subcommands to Cargo

Cargo is designed to be extensible with new subcommands without having to modify Cargo itself. See the Wiki page for more details and a list of known community-developed subcommands.

Releases

Cargo releases coincide with Rust releases. High level release notes are available as part of Rust's release notes. Detailed release notes are available in this repo at CHANGELOG.md.

Reporting issues

Found a bug? We'd love to know about it!

Please report all issues on the GitHub issue tracker.

Contributing

See the Cargo Contributor Guide for a complete introduction to contributing to Cargo.

License

Cargo is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Third party software

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (https://www.openssl.org/).

In binary form, this product includes software that is licensed under the terms of the GNU General Public License, version 2, with a linking exception, which can be obtained from the upstream repository.

See LICENSE-THIRD-PARTY for details.