Auto merge of #8476 - Rustin-Liu:rustin-patch, r=ehuss

fix: add space to comments

fix: refine test

fix: add space to comments

Auto merge of #8393 - ludumipsum:unstable_flags_in_config, r=alexcrichton

Allow configuring unstable flags via config file

# Summary

This fixes #8127 by mapping the `unstable` key in `.cargo/config` to Z flags.

It should have no impact on stable/beta cargo, and on nightlies it gives folks the ability to configure Z flags for an entire project or workspace. This is meant to make it easier to try things like the [new features resolver](https://github.com/rust-lang/cargo/issues/8088) behavior, mtime-on-use, build-std, or timing reports across a whole project.

I've also included a small (but entirely independent) ergonomics change -- treating dashes and underscores identically in Z flags. That's along for the ride in this PR as the last commit, and is included here because it makes for more idiomatic toml file keys (`print_im_a_teapot = yes` vs `print-im-a-teapot = yes`). Please let me know if y'all would prefer that be in a separate PR, or not happen at all.

# Test Plan

Apologies if I've missed anything -- this is my first cargo contrib and I've tried to hew to the contributing guide. If I've slipped up, please let me know how and I'll fix it.

NB. My linux machine doesn't have multilib set up, so I disabled cross tests.

 * `cargo test` passes for each commit in the stack
 * I formatted each commit in the stack with `rustfmt`
 * New tests are included alongside the relevant change for each change
 * I've validated each test by locally undoing the code change they support and confirming failure.
 * The CLI wins, for both enable and disabling Z flags, as you'd expect.

Keys in `unstable` which do not correspond with a Z flag will trigger an error indicating the invalid flag came from a config file read:

```
Invalid [unstable] entry in Cargo config

Caused by:
  unknown `-Z` flag specified: an-invalid-flag
```

If you'd like to see a test case which isn't represented here, I'm happy to add it. Just let me know.

# Documentation

I've included commits in this stack updating the only docs page that seemed relevant to me, skimming the book -- `unstable.md`.

Fix tests for handling env key overlaps / errors

Add tests verifying overlapping prefixes and defaults

These tests demonstrate the current failure mode around
overlapping env keys and inner structs. To some extent this
is a limitation of mapping on to environment variables with
an underscore as both the namespace separator and the
substitute for dashes in flag names in that the mapping is
not strictly one-to-one.

Auto merge of #8427 - davidtwco:terminal-width, r=ehuss

Add support for rustc's `-Z terminal-width`.

This PR continues the work started in #7315, adding support for rustc's `-Z terminal-width` flag, which is used to trim diagnostic output to fit within the current terminal and was added in rust-lang/rust#63402 (with JSON emitter support in rust-lang/rust#73763).

At the time of writing, rust-lang/rust#73763 isn't in nightly, so the test added in this PR will fail, but it should pass tomorrow (I've confirmed that it works with a local rustc build).

cc @estebank

Auto merge of #8473 - alexcrichton:fix-fingerprint-loc, r=ehuss

Avoid colliding with older Cargo fingerprint changes

The fingerprint format Cargo stores changed recently in a way that
older Cargos cannot understand. Unfortunately though older Cargos are
colliding on some compilation units trying to read the new format and
they're bailing out. This commit fixes this issue by ensuring that the
location for fingerprint metadata is different in older Cargos and newer
Cargos.

Fingerprint metadata is always stored in a location with a hash in the
file name. This hash typically includes the hash of rustc's version
information itself, but for units which don't have a `Metadata` it's a
much simpler hash which is much more likely to collide with other
versions of Cargo. The fix in this commit is to extract the metadata
version that we're hashing to a constant, and then also hash it for
generating a filesystem location to house fingerprint data for a unit
that has no `Metadata`.

Closes #8472
Closes #8298

Avoid colliding with older Cargo fingerprint changes

The fingerprint format Cargo stores changed recently in a way that
older Cargos cannot understand. Unfortunately though older Cargos are
colliding on some compilation units trying to read the new format and
they're bailing out. This commit fixes this issue by ensuring that the
location for fingerprint metadata is different in older Cargos and newer
Cargos.

Fingerprint metadata is always stored in a location with a hash in the
file name. This hash typically includes the hash of rustc's version
information itself, but for units which don't have a `Metadata` it's a
much simpler hash which is much more likely to collide with other
versions of Cargo. The fix in this commit is to extract the metadata
version that we're hashing to a constant, and then also hash it for
generating a filesystem location to house fingerprint data for a unit
that has no `Metadata`.

Closes #8472

Introduce `TtyWidth`

This commit introduces a `TtyWidth` enum which enables better handling
of the tty-width on Windows.

Signed-off-by: David Wood <david@davidtw.co>

fix docs to drop reverted change

fix nightly rustdoc-extern tests

clearer comment on doubleparse of cli flags

Minor test fix (error text comparison)

Serde's errors for missing fields are a lil' different than
the ones from our Deserializer.

Revert workaround and patch Deserializer

This patch changes how ConfigMapAccess iterates k/v pairs when
deserializing structs.

Previously we produced keys for exactly the set of fields needed
for a struct, and errored out in the deserializer if we can't find
anything for that field.

This patch makes us produces keys from the union of two sets:

1. All fields that are both needed for the struct and can be found
   in the environment.
2. All fields in the config table.

This change allows serde's codegen to handle both missing and
unknown fields via the usual derive annotations (default or
deny_unknown_fields respectively)

Auto merge of #8469 - ehuss:long-filename-windows, r=alexcrichton

Disable long_file_names test if not supported on Windows.

This test will fail on Windows if Cargo's target directory is over 80 characters long (as it is in rust's CI).

Disable long_file_names test if not supported on Windows.

Add documentation for `-Z terminal-width`

This commit adds relevant documentation for the `-Z terminal-width`
flag.

Signed-off-by: David Wood <david@davidtw.co>

Make `-Z terminal-width` opt-in.

This commit modifies the parsing of `-Z terminal-width` so that it can
optionally take a value and only uses `accurate_err_width` when the user
does not provide a value - therefore making the emission of `-Z
terminal-width` opt-in.

Signed-off-by: David Wood <david@davidtw.co>

Add support for rustc's `-Z terminal-width`.

This commit adds support for rustc's `-Z terminal-width` flag, which is
used to trim diagnostic output to fit within the current terminal.

Co-authored-by: David Wood <david@davidtw.co>
Signed-off-by: David Wood <david@davidtw.co>

Drop broken test asserting invalid configs error on nightly

The current behavior, with the default-false workaround in place,
is not able to identify extra members of the `unstable` table, so
it can't error on unexpected members.

I'll add this test back in with a Deserializer refactor to clean up
the extra logic added to CliUnstable.

Treat all CliUnstable values as default-false

This is a workaround in case y'all would like to land this change
before I'm able to finish up a Deserializer refactor.

[fixup] use single-line serde annotations

Switch unstable config parsing to serde

Tests are currently failing, looks like there's something in the
Deserializer impl that's forcing field-missing errors even when
the serde `default` annotation is applied.

Revert misfeatures

Per comments on the PR, a couple changes need to be backed out.

Clarify CliUnstable::parse/update_with_table

These masquerade like construction functions, but they're
in-place mutators since they're meant to be used one after
another in a precedence chain.

Update src/doc/src/reference/unstable.md

Co-authored-by: Eric Huss <eric@huss.org>

Allow both dashes and underscores for Z flags

This makes it a little easier to match whatever
the natural formatting is for where you're setting
unstable options -- CLI or config file.

Allow setting unstable options in .cargo/config

Obviously this only works with nightlies and all
that, but if you're e.g. testing resolver v2, want
to always have Ztiming on in your workspace, or
something like that, this makes it easier to do.

Allow populating CliUnstable from a HashMap

This makes it easier to populate unstable
options from configuration files. Might also
help make unstable option tests easier to write.

Auto merge of #8454 - GabrielMajeri:config-option-enum, r=ehuss

Add support for deserializing enums in config files

Implements `deserialize_enum` functionality to allow config options which are Rust enums.

@ehuss The code currently has some `todo!`s because I'm not sure how the custom `Deserializer` is supposed to do error handling.

Fixes #8450

Implement enum config options deserialization

Auto merge of #8453 - sourcefrog:name-length-limit-8452, r=alexcrichton

Write GNU tar files, supporting long names.

Fixes #8452

If I understand the previous bugs correctly, long trees packaged using Cargo with this patch will be misinterpreted by Cargo from before Jan 2016. (Without this patch, they can't be written at all.)

To me that seems like long enough ago that it's safe to land this now.

- [x] Add a test.

Auto merge of #8449 - jyn514:rustdoc, r=ehuss

Don't overwrite existing `rustdoc` args with --document-private-items

Instead, add that flag in addition to any existing flags.

Closes https://github.com/rust-lang/cargo/issues/8445

Auto merge of #8455 - ehuss:rustup-toolchain, r=Eh2406

Add some help about rustup's +toolchain syntax.

This tries to bring more attention to the `+toolchain` syntax from rustup.

Closes #8058

Add some help about rustup's +toolchain syntax.

Auto merge of #8451 - ehuss:metadata-man, r=Eh2406

Update metadata man page.

The man pages needed to be rebuilt after #8323.

Add a test reproducing the issue

Add test for packaging long file names

Write GNU tar files, supporting long names.

Fixes #8452

Update metadata man page.

Use entry API instead of a match

This makes the code easier to read and also avoids looking up the
position in the map twice. The clone of `unit` is very cheap since it is
an Rc.

Use a stable rustdoc option for testing

Don't overwrite existing `rustdoc` args with --document-private-items

Instead, add that flag in addition to any existing flags.

Auto merge of #8446 - ehuss:fix-usize-32, r=alexcrichton

Fix overflow error on 32-bit.

This fails to compile on 32-bit platforms with an overflow error ("attempt to shift right by 32_i32 which would overflow").

I think it would be highly unlikely for any value to be in the billions.  Alternatively it can be rewritten to something like `assert!(val <= u32::MAX as usize);`.

Fix overflow error on 32-bit.

Auto merge of #8378 - jstasiak:backups, r=ehuss

Exclude the target directory from backups using CACHEDIR.TAG

This patch follows the lead of #4386 (which excludes target directories
from Time Machine backups) and is motived by the same reasons listen
in #3884. CACHEDIR.TAG is an OS-independent mechanism supported by Borg,
restic, GNU Tar and other backup/archiving solutions.

See https://bford.info/cachedir/ for more information about the
specification. This has been discussed in Rust Internals earlier this
year[1] and it seems like it's an uncontroversial improvement so I went
ahead with the patch.

One thing I'm wondering is whether this should maybe cover the whole main target directory (right now it applies to `target/debug`, `target/release` etc. but not to target root).

[1] https://internals.rust-lang.org/t/pre-rfc-put-cachedir-tag-into-target/12262/11

Auto merge of #8436 - joshtriplett:zulip, r=alexcrichton

CONTRIBUTING.md: Link to Zulip rather than Discord

Discussed and approved by all members of the Cargo team.

CONTRIBUTING.md: Link to Zulip rather than Discord

Discussed and approved by all members of the Cargo team.

Remove no longer needed cleanup code

Compress two tests into one

Exclude whole target/ from backups

This is following the discussion on GitHub. The doc tests are no longer
necessary because Layout::new() creates CACHEDIR.TAG directly in target
root, no doc-specific code is necessary anymore.

Auto merge of #8433 - giraffate:update_built-in_help_for_features, r=alexcrichton

Update built-in help for features

Fixed #8381.

Exclude target/doc from backups as well

Update built-in help for features

Fixed #8381.

Auto merge of #8432 - rust-lang:dependabot/cargo/core-foundation-0.9.0, r=alexcrichton

Update core-foundation requirement from 0.7.0 to 0.9.0

Updates the requirements on [core-foundation](https://github.com/servo/core-foundation-rs) to permit the latest version.
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/servo/core-foundation-rs/commit/a57ca7f976858f56ab159656703a2857fa947870"><code>a57ca7f</code></a> Major version update for core-foundation-sys and all other dependencies.</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/aa69b91def2137addf61f27fb94077d8318dad4f"><code>aa69b91</code></a> Add missing major version changes.</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/7487580958a60d5a51228bdc211a4f53dfe4b4ca"><code>7487580</code></a> Publish core-foundation-sys 0.7.2.</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/40a787f0e6a2f7b3874f4f1b3a6b9fc5a3a165ff"><code>40a787f</code></a> Auto merge of <a href="https://github-redirect.dependabot.com/servo/core-foundation-rs/issues/397">#397</a> - servo:major-bump, r=jdm</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/56d8b6c161ad3db0adc59853951163658b3e97b1"><code>56d8b6c</code></a> Major version change for core-foundation, core-graphics, io-surface, core-tex...</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/37540073110db955230c67f87e50fb55a9a4447c"><code>3754007</code></a> Auto merge of <a href="https://github-redirect.dependabot.com/servo/core-foundation-rs/issues/395">#395</a> - bryanburgers:timezone-name, r=jdm</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/a4e29832190de6d58bd59ccd52289476689cd995"><code>a4e2983</code></a> Add <code>CFTimeZone::name</code></li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/749c0855ad2764ffcc4fef6fed40670f421ae186"><code>749c085</code></a> Auto merge of <a href="https://github-redirect.dependabot.com/servo/core-foundation-rs/issues/394">#394</a> - anp:releases, r=jdm</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/9c264d290423c10d0801d2acdb66c17ec9f8755c"><code>9c264d2</code></a> Bump core-foundation(-sys) to 0.7.1 for release.</li>
<li><a href="https://github.com/servo/core-foundation-rs/commit/d196c0c4c8641fadcdb4553b77e3491f76a136ff"><code>d196c0c</code></a> Publish core-graphics 0.19.2.</li>
<li>Additional commits viewable in <a href="https://github.com/servo/core-foundation-rs/compare/core-foundation-v0.7.0...core-foundation-v0.9.0">compare view</a></li>
</ul>
</details>
<br />

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Pull request limits (per update run and/or open at any time)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)

</details>

Update core-foundation requirement from 0.7.0 to 0.9.0

Updates the requirements on [core-foundation](https://github.com/servo/core-foundation-rs) to permit the latest version.
- [Release notes](https://github.com/servo/core-foundation-rs/releases)
- [Commits](https://github.com/servo/core-foundation-rs/compare/core-foundation-v0.7.0...core-foundation-v0.9.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Auto merge of #8421 - alexcrichton:read-env-dep, r=ehuss

Parse `# env-dep` directives in dep-info files

This commit updates Cargo's parsing of rustc's dep-info files to account
for changes made upstream in rust-lang/rust#71858. This means that if
`env!` or `option_env!` is used in crate files Cargo will correctly
rebuild the crate if the env var changes.

Closes #8417

Auto merge of #8419 - est31:string_interning, r=ehuss

Move string interning to util

Code that handles string interning is rather an util functionality than
a core functionality.

Handle env var escaping

Bump hashed metadata version

Address review feedback

Get past internal test on CI

Filter env vars to check against

Parse `# env-dep` directives in dep-info files

This commit updates Cargo's parsing of rustc's dep-info files to account
for changes made upstream in rust-lang/rust#71858. This means that if
`env!` or `option_env!` is used in crate files Cargo will correctly
rebuild the crate if the env var changes.

Closes #8417

Auto merge of #8418 - bdonlan:cdylib-out-path, r=alexcrichton

Expose built cdylib artifacts in the Compilation structure

This change makes it much easier to find these artifacts in a
platform-independent way when writing automation around the cargo API.

Make leak function private

The leak function is never used outside of interning.rs
and I don't think it makes any sense to use it.

Move string interning to util

Code that handles string interning is rather an util functionality than
a core functionality.

Expose built cdylib artifacts in the Compilation structure

This change makes it much easier to find these artifacts in a
platform-independent way when writing automation around the cargo API.

Auto merge of #8416 - est31:remove_derive, r=alexcrichton

Remove unused serde_derive dependency from the crates.io crate

Remove unused serde_derive dependency

Auto merge of #8412 - est31:remove_remove, r=alexcrichton

Remove unused remove_dir_all dependency

Originally part of #8384 but sadly the PR got rejected.

Remove unused remove_dir_all dependency

Need to research why it isn't detected by cargo-udeps.

Auto merge of #8409 - alexcrichton:git-instead-of, r=Eh2406

Improve git error messages a bit

This commit is targeted at further improving the error messages
generated from git errors. For authentication errors the actual URL
fetched is now printed out as well if it's different from the original
URL. This should help handle `insteadOf` logic where SSH urls are used
instead of HTTPS urls and users can know to track that down.

Otherwise the logic about recommending `net.git-fetch-with-cli` was
tweaked a bit and moved to the same location as the rest of our error
reporting.

Note that a change piggy-backed here as well is that `Caused by:` errors
are now automatically all tabbed over a bit instead of only having the
first line tabbed over. This required a good number of tests to be
updated, but it's just an updated in renderings.

Improve git error messages a bit

This commit is targeted at further improving the error messages
generated from git errors. For authentication errors the actual URL
fetched is now printed out as well if it's different from the original
URL. This should help handle `insteadOf` logic where SSH urls are used
instead of HTTPS urls and users can know to track that down.

Otherwise the logic about recommending `net.git-fetch-with-cli` was
tweaked a bit and moved to the same location as the rest of our error
reporting.

Note that a change piggy-backed here as well is that `Caused by:` errors
are now automatically all tabbed over a bit instead of only having the
first line tabbed over. This required a good number of tests to be
updated, but it's just an updated in renderings.

Auto merge of #8408 - jstasiak:improve-home-path-documentation, r=alexcrichton

Improve the description of Config.home_path

I poked around and it seems it's not the user's home directory but Cargo
home (which may or may not be in user's home).

Improve the description of Config.home_path

I poked around and it seems it's not the user's home directory but Cargo
home (which may or may not be in user's home).

Try to resolve a build-time conflict with master

This commit changed things a bit: 6263d726f6b32ff7bcb5e1c292e0c83d65145e41.

Add two tests

Auto merge of #8364 - alexcrichton:default-no-master, r=ehuss

Improve support for non-`master` main branches

This commit improves Cargo's support for git repositories whose "main
branch" is not called `master`. Cargo currently pretty liberally assumes
that if nothing else about a git repository is specified then `master`
is the branch name to use. Instead now Cargo has a fourth option as the
desired reference of a repository named `DefaultBranch`. Cargo doesn't
know anything about the actual name of the default branch, it just
updates how git references are fetched internally.

This commit is motivated by news that GitHub is likely to switch away
from the default branch being named `master` in the near future. It
would be a bit of a bummer if from now on everyone had to type
`branch = '...'`, so this tries to improve that!

Closes #3517

Auto merge of #8403 - matklad:abs-out-dir, r=Eh2406

Document that OUT_DIR in JSON messages is an absolute path

Document that OUT_DIR in JSON messages is an absolute path

Auto merge of #8387 - robinmoussu:master, r=alexcrichton

Adding environment variable CARGO_PKG_LICENSE_FILE

When #8325 was added, only CARGO_PKG_LICENSE was added. However, the field license [may be empty](https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields) if the license_field is filled in.

Auto merge of #8391 - bl2e:install-target-dir, r=alexcrichton

Enable "--target-dir" in "cargo install"

Issue #8263

Auto merge of #8323 - naerbnic:add_workspace_metadata_table, r=alexcrichton

Add support for `workspace.metadata` table

Implements feature request #8309

Additionally includes the information in the output of "cargo metadata" through a new top-level field `metadata`, similar to the per-package `metadata` field

Auto merge of #8398 - ehuss:clean-reserved-name, r=Eh2406

Fix overzealous `clean -p` for reserved names.

#8210 changed the way `clean -p` worked, but in some ways it is a little too sloppy.  If a package has a test named `build`, then it would delete the `build` directory thinking an executable named "build" exists.  This changes it so that it does not attempt to delete tests/benches from the uplift directory.

Fix overzealous `clean -p` for reserved names.

Auto merge of #8395 - ehuss:fix-opt-dep-order, r=Eh2406

Fix order-dependent feature resolution.

There is a situation where if you have `pkg/feature` syntax, and `pkg` is an optional dependency, but also a dev-dependency, and the dev-dependency appears before the (optional) normal dependency in the summary, then the optional dependency would not get activated. This is because the feature code used `find` to get the first entry.

Fixes #8394

Fix order-dependent feature resolution.

Fix post-execution  path checks to be compatible with Windows

Fix test compatibility for Windows

Reference options-target-dir in `cargo install` documentation

Add test for `cargo install` option `--target-dir`

Enable `--target-dir` support in `install` subcommand

Auto merge of #8389 - hbina:spelling, r=ehuss

Correct mispelling of `cargo`.

Correct mispelling of `cargo`.

Auto merge of #8386 - crlf0710:master, r=ehuss

Add missing license field.

Hi, i was playing with `cargo-deny`, and found that it says this crate doesn't have a license field. So i'm going ahead and add it for consistency.

Adding environment variable CARGO_PKG_LICENSE_FILE

Auto merge of #8325 - kerkmann:license-field-as-environment-variable, r=joshtriplett

Adding environment variable CARGO_PKG_LICENSE

Fixes #8024

Add missing license field.