Weihang Lo [Thu, 27 Jan 2022 09:58:06 +0000 (17:58 +0800)]
Normalize `--path` to install bin outside current workspace
For `Workspace::find_root`, `cargo_util::path::PathAncestors` won't do
path normalization while walking back the ancestors. The responsibility
lies in the caller. Thus, `cargo install` should normalize its `--path`
argument before passing in `SourceId::for_path` and `Workspace::new`.
`Config::reload_rooted_at` is not affected because cargo always starts
searching and merging configs from where it is invoked.
bors [Tue, 25 Jan 2022 15:50:45 +0000 (15:50 +0000)]
Auto merge of #10323 - ehuss:local-git-info, r=alexcrichton
Use local git info for version.
#10178 caused an unintended change where cargo is being built twice in rust-lang/rust's CI. It is being built once as a CLI, and a second time for RLS. The cause is the `CFG_COMMIT_HASH` environment variable changes between those two builds (it is set for the tool being built).
The solution here is to grab the git information from cargo's own build script. This is guaranteed to always be in the `src/tools/cargo` directory for both tools.
This should help save a minute or two in the dist builders.
bors [Tue, 25 Jan 2022 04:48:08 +0000 (04:48 +0000)]
Auto merge of #10324 - ehuss:fix-doc-undocumented-dep, r=alexcrichton
Fix documenting with undocumented dependencies.
#10201 introduced a bug where dependencies that have `doc=false` weren't being built at all when running `cargo doc` if the project did not have any binaries. That means the rmeta file was missing, and the `--extern` flag was not being passed to rustdoc.
The solution is to ensure the `rmeta` file gets generated, but only skip generating the `CompileMode::Doc` unit for undocumented dependencies.
bors [Thu, 20 Jan 2022 15:07:43 +0000 (15:07 +0000)]
Auto merge of #10305 - weihanglo:issue-10268, r=alexcrichton
do not compile test for bins flagged as `test = false`
### What does this PR try to resolve?
Fixes #10268
#6683 introduced a behavior that compiles all bin targets, but for bins with `test = false` they shouldn't be compiled with `--test` as testbins.
### How should we test and review this PR?
In the first commit of this PR, I refines the test `test_filtered_excludes_compiling_examples` to reflect the current wrong behavior (test passed). The following two commits correct the behavior and the test accordingly. The last few commits encapsulate scattered target selection logic into functions on `CompileFilter`.
bors [Thu, 20 Jan 2022 03:56:18 +0000 (03:56 +0000)]
Auto merge of #10086 - epage:toml, r=ehuss
Port cargo from toml-rs to toml_edit
Benefits:
- A TOML 1.0 compliant parser
- Unblock future work
- Have `cargo init` add the current crate to the workspace, rather
than error
- #5586: Upstream `cargo-add`
TODO
- [x] Analyze performance and address regressions
- [x] Identify and resolve incompatibiies
- [x] Resolve remaining test failures, see
https://github.com/ordian/toml_edit/labels/cargo
- [x] ~~Switch the code from https://github.com/rust-lang/cargo/pull/10176 to only parse once~~ (this PR is being merged first)
bors [Wed, 19 Jan 2022 17:09:36 +0000 (17:09 +0000)]
Auto merge of #10306 - eholk:git-default-branch, r=alexcrichton
Fix new::git_default_branch with different default
The test `new::git_default_branch` would fail if the current user had already configured a different default branch.
This patch changes the test to first write a `.gitconfig` file with the default branch set to master. This puts us in a state where we still have the old default, and then the subsequent change to the config file will make sure that config changes are still respected.
Eric Holk [Tue, 18 Jan 2022 22:51:21 +0000 (14:51 -0800)]
Fix new::git_default_branch with different default
The test new::git_default_branch would fail if the current user had
already configured a different default branch.
This patch changes the test to first write a .gitconfig file with the
default branch set to master. This puts us in a state where we still
have the old default, and then the subsequent change to the config file
will make sure that config changes are still respected.
bors [Tue, 18 Jan 2022 16:34:43 +0000 (16:34 +0000)]
Auto merge of #10300 - ehuss:list-help, r=alexcrichton
Include `help` in `--list`
This adds the `help` subcommand to the `--list` output. It previously was not included because `help` is handled differently from built-in subcommands.
bors [Tue, 18 Jan 2022 15:15:28 +0000 (15:15 +0000)]
Auto merge of #10296 - ehuss:downgrade-log, r=alexcrichton
Downgrade some log messages.
This lowers the log level of several "info" messages. I find that these can be quite noisy when using log messages, and I don't think need to be such a high log level.
bors [Fri, 14 Jan 2022 00:21:19 +0000 (00:21 +0000)]
Auto merge of #10291 - calebcartwright:cargo-fmt-check, r=ehuss
use new cargo fmt option
As of v1.58, cargo fmt now supports the --check flag directly. Updating it here (and in a few other r-l repos) both because it's more succinct and so more people will see/become aware
bors [Thu, 13 Jan 2022 23:38:53 +0000 (23:38 +0000)]
Auto merge of #10287 - Nilstrieb:docs-semver-check-run-fail, r=ehuss
Add `run-fail` to semver-check for docs
I encountered this missing feature in #10276 and therefore added it here in this separate PR.
If the breaking change does not involve a compilation error but a change in runtime behaviour, you can add `run-fail` to the codeblock. The "before" code must return exit code 0, and the "after" code must be nonzero (like a panic).
Example case that I tested (ignore the trailing dot, it's for github markdown to not hate me)
```
```rust,ignore,run-fail
// MAJOR CHANGE
///////////////////////////////////////////////////////////
// Before
pub fn foo() {}
///////////////////////////////////////////////////////////
// After
pub fn foo() {
panic!("hey!");
}
///////////////////////////////////////////////////////////
// Example usage that will break.
fn main() {
updated_crate::foo();
}
```.
```
bors [Thu, 13 Jan 2022 22:42:26 +0000 (22:42 +0000)]
Auto merge of #10290 - maxwase:is_symlink_stabilized, r=Eh2406
Use `is_symlink()` method
I've came across this comment
```rust
// Replace with std implementation when stabilized, see
// https://github.com/rust-lang/rust/issues/85748
```
and fixed this due to the method stabilization in 1.58
Ed Page [Tue, 2 Nov 2021 00:18:32 +0000 (19:18 -0500)]
Port cargo from toml-rs to toml_edit
Benefits:
- A TOML 1.0 compliant parser
- Unblock future work
- Have `cargo init` add the current crate to the workspace, rather
than error
- #5586: Upstream `cargo-add`
Nilstrieb [Wed, 12 Jan 2022 19:43:14 +0000 (20:43 +0100)]
docs: add `run-fail` to semver check
if the breaking change does not involve a compilation error but a change in runtime behaviour, you can add `run-fail` to the codeblock. The "before" code must return exit code 0, and the "after" code must be nonzero (like a panic).
bors [Wed, 12 Jan 2022 15:15:09 +0000 (15:15 +0000)]
Auto merge of #10269 - ehuss:stabilized-new-features, r=alexcrichton
Stabilize namespaced and weak dependency features.
This stabilizes the namespaced and weak dependency features. Support is now enabled on crates.io, so this should be ready to go.
As a part of this change, the new feature resolver is now enabled all of the time. This is fairly risky, since there are likely edge cases that haven't been exercised.
NOTE: Projects using `resolver="1"` *should* continue to have the same behavior, the old resolver behavior is emulated.
bors [Tue, 11 Jan 2022 23:47:29 +0000 (23:47 +0000)]
Auto merge of #10265 - epage:clap-port, r=joshtriplett
Port cargo to clap3
### What does this PR try to resolve?
This moves cargo to the latest major version of clap.
This supersedes #10259 and #10262
### How should we test and review this PR?
For testing, I mostly relied on existing tests. I did manually validate that `cargo run <non-escaped command args>` behaved the same between both
```console
$ cargo run release --help
Finished dev [unoptimized + debuginfo] target(s) in 0.22s
Running `target/debug/cargo-release release --help`
cargo-release 0.18.8
...
$ cargo run --manifest-path ../cargo/Cargo.toml -- run release --help
Finished dev [unoptimized + debuginfo] target(s) in 0.05s
Running `/home/epage/src/personal/cargo/target/debug/cargo run release --help`
Finished dev [unoptimized + debuginfo] target(s) in 1.31s
Running `target/debug/cargo-release release --help`
cargo-release 0.18.8
...
```
For reviewing, I split out each deprecation resolution into a separate commit so its easy to focus on more mechanical changes (most of the deprecation fixes) from interesting ones (the port, the `Arg::multiple` deprecation)
### Additional information
- One parser change found by `cargo_config::includes` is that clap 2
would ignore any values after a `=` for flags.
`cargo config --show-origin` is a flag but the test passed `--show-origin=yes` which
happens to give the desired result for that test but is the same as
`--show-origin=no` or `--show-origin=alien-invasion`.
- `ArgMatches` now panics when accessing an undefined argument but clap
takes advantage of that for sharing code across commands that have
different subsets of arguments defined. I've extended clap so we can
"look before you leap" and put the checks at the argument calls to
start off with so its very clear what is tenuously shared. This
allows us to go in either direction in the future, either addressing
how we are sharing between commands or by moving this down into the
extension methods and pretending this clap feature doesn't exist
- On that topic, a test found clap-rs/clap#3263. For now, there is a
hack in clap. Depending on how we fix that in clap for clap 4.0, we
might need to re-address things in cargo.
- `value_of_os` now requires setting `allow_invalid_utf8`, otherwise it
asserts. To help catch this, I updated the argument definitions
associated with lookups reported by:
- `rg 'values?_os' src/`
- `rg 'values?_of_os' src/`
- clap now reports `2` for usage errors, so we had to bypass clap's
`exit` call to keep the same exit code.
- `cargo vendor --sync` did not use `multi_opt` and so it has both
multiple occurrences **and** multiple values. If we want to deprecate
this, we'll need `unstable-grouped` to be stablized (or pin our clap
version) and ensure each group has only 1 value.
Ed Page [Thu, 6 Jan 2022 15:13:24 +0000 (09:13 -0600)]
refactor: Resolve Arg::multiple deprecation
Note: `cargo vendor --sync` did not use `multi_opt` and so it has both
multiple occurrences **and** multiple values. If we want to deprecate
this, we'll need `unstable-grouped` to be stablized (or pin our clap
version) and ensure each group has only 1 value.
Ed Page [Tue, 4 Jan 2022 17:04:50 +0000 (11:04 -0600)]
Upgrade to Clap 3
- One parser change found by `cargo_config::includes` is that clap 2
would ignore any values after a `=` for flags.
`cargo config --show-origin` is a flag but the test passed `--show-origin=yes` which
happens to give the desired result for that test but is the same as
`--show-origin=no` or `--show-origin=alien-invasion`.
- The parser now panics when accessing an undefined attribute but clap
takes advantage of that for sharing code across commands that have
different subsets of arguments defined. I've extended clap so we can
"look before you leap" and put the checks at the argument calls to
start off with so its very clear what is tenuously shared. This
allows us to go in either direction in the future, either addressing
how we are sharing between commands or by moving this down into the
extension methods and pretending this clap feature doesn't exist
- On that topic, a test found clap-rs/clap#3263. For now, there is a
hack in clap. Depending on how we fix that in clap for clap 4.0, we
might need to re-address things in cargo.
- `value_of_os` now requires setting `allow_invalid_utf8`, otherwise it
asserts. To help catch this, I updated the argument definitions
associated with lookups reported by:
- `rg 'values?_os' src/`
- `rg 'values?_of_os' src/`
- clap now reports `2` for usage errors, so we had to bypass clap's
`exit` call to keep the same exit code.
bors [Wed, 5 Jan 2022 22:10:29 +0000 (22:10 +0000)]
Auto merge of #10214 - weihanglo:revert-10188-issue-9528, r=alexcrichton
Be resilient to most IO error and filesystem loop while walking dirs
Let `PathSource::walk` be resilient to most IO errors and filesystem loop.
This PR also
- Add a test validating the resilience against filesystem loop to prevent regression.
- Emit warning when filesystem loop found while walking the filesystem. This is the only way I can think of now to solve #9528
bors [Wed, 5 Jan 2022 19:18:32 +0000 (19:18 +0000)]
Auto merge of #10258 - joshtriplett:unconditional-pipelining, r=alexcrichton
Remove the option to disable pipelining
Cargo has had pipelining enabled by default for a long time, without
issue. Remove support for `build.pipelining = false`. (Continue parsing
the option from the config file, but ignore it.)
<!--
Thanks for submitting a pull request 🎉! Here are some tips for you:
* If this is your first contribution, read "Cargo Contribution Guide":
https://doc.crates.io/contrib/
* Run `cargo fmt --all` to format your code changes.
* Small commits and pull requests are always preferable and easy to review.
* If your idea is large and needs feedback from the community, read how:
https://doc.crates.io/contrib/process/#working-on-large-features
* Cargo takes care of compatibility. Read our design principles:
https://doc.crates.io/contrib/design.html
* When changing help text of cargo commands, follow the steps to generate docs:
https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages
* If your PR is not finished, set it as "draft" PR or add "WIP" in its title.
* It's ok to use the CI resources to test your PR, but please don't abuse them.
### What does this PR try to resolve?
Explain the motivation behind this change.
A clear overview along with an in-depth explanation are helpful.
You can use `Fixes #<issue number>` to associate this PR to an existing issue.
### How should we test and review this PR?
Demonstrate how you test this change and guide reviewers through your PR.
With a smooth review process, a pull request usually gets reviewed quicker.
If you don't know how to write and run your tests, please read the guide:
https://doc.crates.io/contrib/tests
### Additional information
Other information you want to mention in this PR, such as prior arts,
future extensions, an unresolved problem, or a TODO list.
-->
Josh Triplett [Tue, 4 Jan 2022 23:40:33 +0000 (15:40 -0800)]
Remove the option to disable pipelining
Cargo has had pipelining enabled by default for a long time, without
issue. Remove support for `build.pipelining = false`. (Continue parsing
the option from the config file, but ignore it.)
bors [Wed, 5 Jan 2022 15:23:14 +0000 (15:23 +0000)]
Auto merge of #10255 - joshtriplett:unconditional-artifact-timing, r=alexcrichton
Always ask rustc for messages about artifacts, and always process them
Rather than attempt to determine which compilations require metadata and
only ask rustc to emit messages about artifacts for those compilations,
just unconditionally generate and process such messages for all
compilations.
In addition to simplifying code, this also gives us that information for
timing purposes as well, even when not pipelining.
<!--
Thanks for submitting a pull request 🎉! Here are some tips for you:
* If this is your first contribution, read "Cargo Contribution Guide":
https://doc.crates.io/contrib/
* Run `cargo fmt --all` to format your code changes.
* Small commits and pull requests are always preferable and easy to review.
* If your idea is large and needs feedback from the community, read how:
https://doc.crates.io/contrib/process/#working-on-large-features
* Cargo takes care of compatibility. Read our design principles:
https://doc.crates.io/contrib/design.html
* When changing help text of cargo commands, follow the steps to generate docs:
https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages
* If your PR is not finished, set it as "draft" PR or add "WIP" in its title.
* It's ok to use the CI resources to test your PR, but please don't abuse them.
### What does this PR try to resolve?
Explain the motivation behind this change.
A clear overview along with an in-depth explanation are helpful.
You can use `Fixes #<issue number>` to associate this PR to an existing issue.
### How should we test and review this PR?
Demonstrate how you test this change and guide reviewers through your PR.
With a smooth review process, a pull request usually gets reviewed quicker.
If you don't know how to write and run your tests, please read the guide:
https://doc.crates.io/contrib/tests
### Additional information
Other information you want to mention in this PR, such as prior arts,
future extensions, an unresolved problem, or a TODO list.
-->
Weihang Lo [Mon, 20 Dec 2021 18:59:41 +0000 (02:59 +0800)]
Test IO error resilience while walking directories
Remove `build_script::build_script_scan_eacces` test case because cargo
ignores it and returns its path during a `cargo build`. The caller still
has a chance to hit the IO error if they does access it.
Josh Triplett [Tue, 4 Jan 2022 20:33:45 +0000 (12:33 -0800)]
Always ask rustc for messages about artifacts, and always process them
Rather than attempt to determine which compilations require metadata and
only ask rustc to emit messages about artifacts for those compilations,
just unconditionally generate and process such messages for all
compilations.
In addition to simplifying code, this also gives us that information for
timing purposes as well, even when not pipelining.
bors [Tue, 4 Jan 2022 18:39:45 +0000 (18:39 +0000)]
Auto merge of #10254 - joshtriplett:rmeta-required-no-timings, r=alexcrichton
Make rmeta_required no longer depend on whether timing is enabled
This doesn't appear to affect the quality of the timing information at
all.
If there's additional information we need from rustc about what it's
doing at any given time, we could add mechanisms to retrieve that
information, but enabling timing shouldn't force building more than we
otherwise would have.
bors [Tue, 4 Jan 2022 17:59:05 +0000 (17:59 +0000)]
Auto merge of #10218 - weihanglo:pr-template, r=alexcrichton
The first version of pull request template
### What this PR tries to resolve?
We're trying to extract information out off the head of contributors.
Hope this help the review process more friendly for everyone.
### How to test and review this PR?
Copy this template and paste to your GitHub Web UI to see if it renders well.
### Additional information
Kubernetes community has one of the best guide of ["Best Practices for Faster Reviews"].
It describes tips for contributors tocreate a high quality PR. We might want
to create our own one and include it in PR template in the future.
In addition, I don't know how much time it take to update the changelog. I saw
some projects let PR author write down the release note of the PR. This sounds
helpful to take some burden off from maintainers, as well as let contributors
feel more involved. Anyway, it's not in this PR but is good to discuss later.
["Best Practices for Faster Reviews"]: https://github.com/kubernetes/community/blob/9b38b270640009f28d7d8710f74d955e0c374cef/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
Josh Triplett [Tue, 4 Jan 2022 17:21:36 +0000 (09:21 -0800)]
Make rmeta_required no longer depend on whether timing is enabled
This doesn't appear to affect the quality of the timing information at
all.
If there's additional information we need from rustc about what it's
doing at any given time, we could add mechanisms to retrieve that
information, but enabling timing shouldn't force building more than we
otherwise would have.
bors [Sun, 2 Jan 2022 19:38:08 +0000 (19:38 +0000)]
Auto merge of #10248 - ehuss:windows-ssh-agent, r=Eh2406
Update docs for windows ssh-agent.
This updates the documentation for SSH authentication using Windows and ssh-agent.
Per #10237 and https://github.com/rust-lang/rust/pull/92374, Cargo now supports ssh-agent on Windows.
I'm about 80% sure this information is correct based on my reading of the code and testing. The ssh-agent that is part of mingw (or git-for-windows) uses emulated sockets, which are not compatible with traditional Windows-style named pipes.
bors [Fri, 24 Dec 2021 08:33:58 +0000 (08:33 +0000)]
Auto merge of #10224 - MidasLamb:find-closest-capitalization, r=joshtriplett
Make levenshtein distance case insensitive.
When typing in a single character shortcut as a capital, it always
returns `b` as the suggestion as every one-letter abbreviation
is a lev distance 1 away from the capitalized one.
By making the levenshtein distance case insensitive, the case-mismatched
one-letter abbriviation (e.g. `C` to `c`) will be suggested, rather
than `b`
Midas Lambrichts [Tue, 21 Dec 2021 11:56:28 +0000 (12:56 +0100)]
Make levenshtein distance case insensitive.
When typing in a single character shortcut as a capital, it always
returns `b` as the suggestion as every one-letter abbreviation
is a lev distance 1 away from the capitalized one.
By making the levenshtein distance case insensitive, the case-mismatched
one-letter abbriviation (e.g. `C` to `c`) will be suggested, rather
than `b`
bors [Mon, 20 Dec 2021 16:35:00 +0000 (16:35 +0000)]
Auto merge of #10212 - SamMorrowDrums:patch-1, r=alexcrichton
[docs] Adds basic CI yaml for GitHub Actions
Currently there is no documentation for GitHub Actions, so I have attempted to add an Actions Workflow that is equivalent to the other CI snippets in the file. You can view a successful run of this Action in my repo for experimenting with this here: https://github.com/SamMorrowDrums/rust-action-test/actions/runs/1593666172
The Rust code I tested it with is just the boilerplate from `cargo init`.