development/cargo
development/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo synced 2024-10-30 13:14:35 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
16650 commits 79 branches 102 tags 98 MiB
Rust 95.3%
Roff 4.3%
JavaScript 0.2%
Shell 0.1%
Find a file
bors 6283793853 Auto merge of #13422 - epage:profile, r=weihanglo 
fix(compiler): Clarify Finished message

### What does this PR try to resolve?

As highlighted on [zulip](https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/cargo.20build.20default.20profile/near/418316528), many users think "Rust is slow" because of the `dev` profile.

While a perfect solution is still being worked out, this attempts what will hopefully be smaller, incremental step that hopefully maintains balance of the different needs.

We are changing the message from:
```
Finished dev [unoptimized + debuginfo] target(s) in [..]s
```
to
```
Finished `dev` profile [unoptimized + debuginfo] target(s) in [..]s
```
where `dev profile` is a link to [the Cargo book](https://doc.rust-lang.org/cargo/reference/profiles.html#profiles).

The intent is
- Clarify what `dev` even means
  - Add `profile` to give it context
  - Quote it to highlight this is something mutable
- Make the profile content stand out on hover by being a link
- Help people learn more by following the link

For now, this leaves the profile description alone.

### How should we test and review this PR?

### Additional information
2024-02-09 04:01:52 +00:00
.cargo chore: remove xtask-unpublished 2023-08-01 22:54:41 +01:00
.github chore(ci): enable m1 runner 2024-01-31 11:43:03 -05:00
benches chore: Remove rust-version from private packages 2024-01-18 15:24:25 -06:00
ci ci: big ⚠️ to ensure the CNAME file is always there 2023-10-18 21:31:10 -04:00
crates Auto merge of #13424 - weihanglo:fix-13016, r=epage 2024-02-09 03:21:05 +00:00
credential chore(deps): update msrv (1 version) to v1.76.0 2024-02-08 14:32:51 +00:00
src fix(compiler): Link people to more info about profiles 2024-02-08 14:01:40 -06:00
tests fix(compiler): Clarify we're showing a profile name 2024-02-08 14:01:39 -06: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 Add a windows manifest file 2023-12-07 14:24:58 +00:00
Cargo.lock chore(deps): update msrv (1 version) to v1.76.0 2024-02-08 14:32:51 +00:00
Cargo.toml chore(deps): update msrv (1 version) to v1.76.0 2024-02-08 14:32:51 +00:00
CHANGELOG.md docs(changelog): Remove panic entry 2024-02-05 09:47:57 -06:00
clippy.toml chore: Communicate motivation for AtomucU64 2023-11-16 12:34:02 -06:00
CODE_OF_CONDUCT.md Add CoC 2023-01-25 10:18:15 +00:00
CONTRIBUTING.md docs: remove review capacity notice 2023-10-18 13:24:09 -04:00
deny.toml Fix some typos 2023-09-24 23:10:07 +08: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 refactor(schemas): Pull out cargo-util-schemas crate 2023-12-15 13:22:25 -06:00
README.md doc: point to nightly cargo doc 2023-06-07 10:13:05 +01:00
triagebot.toml chore: remove A-errors auto label 2024-01-03 15:06:48 -05:00
windows.manifest.xml Add a windows manifest file 2023-12-07 14:24:58 +00: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.