Skip to content

Revert "doc: Mention XDG_DATA_HOME" #15512

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
May 9, 2025
Merged

Conversation

epage
Copy link
Contributor

@epage epage commented May 9, 2025

This reverts commit 15a7672.

What does this PR try to resolve?

There was a miscommunication about some outstanding concerns with #15480 and it got merged before we were ready.

Specifically

  • How important is this for unstable docs?
  • How universal is the use of bash-completions and what should we do for people who don't have it?
  • How likely is someone to catch that they don't have XDG_DATA_HOME set and get tripped up over this documentation
  • Should we be aligned with upstream clap?

How should we test and review this PR?

Additional information

@rustbot
Copy link
Collaborator

rustbot commented May 9, 2025

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 9, 2025
Copy link
Member

@weihanglo weihanglo May 9, 2025

Choose a reason for hiding this comment

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

How universal is the use of bash-completions and what should we do for people who don't have it?

I was under the impression that clap-complete relies on bash-completion because the current stable completion code in Cargo uses a function from it:

_get_comp_words_by_ref cur prev words cword

But that doesn't seem to be the case after I re-read the source code of clap-complete, so yes I think we should revert.

@weihanglo weihanglo enabled auto-merge May 9, 2025 14:35
@weihanglo weihanglo added this pull request to the merge queue May 9, 2025
Merged via the queue into rust-lang:master with commit 056f5f4 May 9, 2025
23 checks passed
bors added a commit to rust-lang-ci/rust that referenced this pull request May 10, 2025
Update cargo

25 commits in 7918c7eb59614c39f1c4e27e99d557720976bdd7..056f5f4f3c100cb36b5e9aed2d20b9ea70aae295
2025-04-27 09:44:23 +0000 to 2025-05-09 14:54:18 +0000
- Revert "doc: Mention `XDG_DATA_HOME`" (rust-lang/cargo#15512)
- docs: update version notice for deprecation removal (rust-lang/cargo#15511)
- doc: Update instructions on using native-completions (rust-lang/cargo#15480)
- feat(network): use Retry-After header for HTTP 429 responses (rust-lang/cargo#15463)
- CI: Require schema job to pass (rust-lang/cargo#15504)
- chore(config): migrate renovate config (rust-lang/cargo#15501)
- Make cargo script ignore workspaces (rust-lang/cargo#15496)
- fix(rustc): Don't panic on unknown bins (rust-lang/cargo#15497)
- test: Remove unused nightly requirements (rust-lang/cargo#15498)
- Add support for `-Zembed-metadata` (rust-lang/cargo#15378)
- Fix tracking issue template link (rust-lang/cargo#15494)
- Refactor artifact deps in FeatureResolver::deps (rust-lang/cargo#15492)
- Improved error message for versions prefixed with `v` (rust-lang/cargo#15484)
- chore: fix some typos in comment (rust-lang/cargo#15485)
- fix: default to all targets when using `--edition` and ` --edition-idioms` in cargo fix (rust-lang/cargo#15192)
- Update fingerprint footnote (rust-lang/cargo#15478)
- feat(add): suggest similarly named features (rust-lang/cargo#15438)
- In package-workspace, keep dev-dependencies if they have a version (rust-lang/cargo#15470)
- docs: fix a typo in DependencyUI (rust-lang/cargo#15472)
- fix grammar, and remove confusing example (rust-lang/cargo#15457)
- Added tracing spans for rustc invocations (rust-lang/cargo#15464)
- Trivial tweaks to 'target_short_hash' (rust-lang/cargo#15461)
- chore(deps): update msrv (3 versions) to v1.84 (rust-lang/cargo#15456)
- feat(add/install): check if given crate argument would be valid with inserted @ symbol (rust-lang/cargo#15441)
- chang 1 tries to 1 try (rust-lang/cargo#15328)

r? ghost
@rustbot rustbot added this to the 1.89.0 milestone May 10, 2025
@epage epage deleted the revert branch May 22, 2025 13:35
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants