Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Rename ignore-git to omit-git-hash #110020

Closed
duckymirror opened this issue Apr 6, 2023 · 5 comments · Fixed by #110059
Closed

Rename ignore-git to omit-git-hash #110020

duckymirror opened this issue Apr 6, 2023 · 5 comments · Fixed by #110059
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@duckymirror
Copy link
Contributor

duckymirror commented Apr 6, 2023 •
edited by rustbot
Loading

As mentioned by @jyn514 on Zulip, the ignore-git option of the bootstrap configuration should be renamed to omit-git-hash to better describe its meaning and distinguish it from submodules = false. It indicates that information about the current commit shouldn't be displayed when e.g. rustdoc --version --verbose is run. This isn't clear from the current name.
@duckymirror
Copy link
Contributor Author

@rustbot label +T-bootstrap +C-cleanup

@rustbot rustbot added C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Apr 6, 2023
@jyn514
Copy link
Member

jyn514 commented Apr 6, 2023

I think it's rare for anyone to set this option manually, but we should update src/bootstrap/CHANGELOG.md at the same time we remove the option just in case.

@Mark-Simulacrum
Copy link
Member

Do we have this by default in some profile? Otherwise, I would expect setting this to be common - it's necessary to avoid rebuilds after git commit, I think.

@duckymirror
Copy link
Contributor Author

The default configurations don't use it, but it defaults to channel == "dev" if it's unset.

@ghost
Copy link

ghost commented Apr 7, 2023

@rustbot claim

@rustbot rustbot assigned ghost Apr 7, 2023
@ghost ghost mentioned this issue Apr 7, 2023
Merged
@bors bors closed this as completed in ec1712f Apr 9, 2023
@duckymirror duckymirror mentioned this issue Apr 9, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Apr 9, 2023
@matthiaskrgr
Rollup merge of rust-lang#110108 - duckymirror:rename-ignore-git-chan…
4916371 
…gelog, r=ozkanonur

Add renaming of ignore-git to changelog

`bootstrap`'s `ignore-git` option has been renamed to `omit-git-hash` in rust-lang#110059. This PR adds this change to the `CHANGELOG.md`. See also rust-lang#110020 (comment).
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Apr 9, 2023
@matthiaskrgr
Rollup merge of rust-lang#110108 - duckymirror:rename-ignore-git-chan…
7822064 
…gelog, r=ozkanonur

Add renaming of ignore-git to changelog

`bootstrap`'s `ignore-git` option has been renamed to `omit-git-hash` in rust-lang#110059. This PR adds this change to the `CHANGELOG.md`. See also rust-lang#110020 (comment).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-cleanup Category: PRs that clean code up or issues documenting cleanup. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ignore_git → omit_git_hash
4 participants
@Mark-Simulacrum @jyn514 @duckymirror @rustbot