Skip to content

Conversation

@CBSpeir
Copy link
Contributor

@CBSpeir CBSpeir commented Feb 25, 2024

changelog: alphabetize configuration options and affected lints listed in section 3.1. of the Clippy Documentation

r? blyxyas

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Feb 25, 2024
@flip1995
Copy link
Member

The file you changed is auto-generated by cargo collect-metadata. So in order to order them alphabetically (which makes sense) you'll have to change the generating code:

pub fn get_configuration_metadata() -> Vec<ClippyConfiguration> {

@CBSpeir CBSpeir marked this pull request as draft February 26, 2024 15:20
@CBSpeir CBSpeir changed the title Alphabetize 'affected lints' in Clippy Doc: 3.1. Lint Configuration Alphabetize configuration options and lints in Clippy documentation Feb 26, 2024
@CBSpeir CBSpeir force-pushed the alphabetize-affected-lints branch from 738d424 to d85642e Compare February 26, 2024 21:07
@CBSpeir CBSpeir marked this pull request as ready for review February 26, 2024 21:13
@CBSpeir
Copy link
Contributor Author

CBSpeir commented Feb 28, 2024

Should I run cargo collect-metadata before pushing the commit?

I ran it for the latest commit pushed, which alphabetized lint_configuration.md as well as the auto-generated configuration options in CHANGELOG.md.

@flip1995
Copy link
Member

flip1995 commented Feb 29, 2024

Oh my suggestion also sorted the config options themselves alphabetically. I guess this is not a bad thing. I like it.

Yeah, you have to push those changes, otherwise CI will fail on merge:

- name: Test metadata collection
run: cargo collect-metadata
- name: Test lint_configuration.md is up-to-date
run: |
echo "run \`cargo collect-metadata\` if this fails"
git update-index --refresh

Thanks for this cleanup!

@bors r+

@bors
Copy link
Contributor

bors commented Feb 29, 2024

📌 Commit d85642e has been approved by flip1995

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Feb 29, 2024

⌛ Testing commit d85642e with merge 04b74ee...

@bors
Copy link
Contributor

bors commented Feb 29, 2024

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: flip1995
Pushing 04b74ee to master...

@bors bors merged commit 04b74ee into rust-lang:master Feb 29, 2024
@CBSpeir CBSpeir deleted the alphabetize-affected-lints branch February 29, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

5 participants