Skip to content

Update helper docs display disable option - #131117

Merged
bors merged 1 commit into
rust-lang:masterfrom
AvatarSenju:helpstring-fix
Oct 2, 2024
Merged

Update helper docs display disable option#131117
bors merged 1 commit into
rust-lang:masterfrom
AvatarSenju:helpstring-fix

Conversation

@AvatarSenju

@AvatarSenjuAvatarSenju commented Oct 1, 2024

Copy link
Copy Markdown
Contributor

Updated helper docs via configure.py to make it clearer that users can control options with enable and disable
Fixing issue #129146

@AvatarSenju
Update helper docs display disable option
9de4b62
Updated helper docs via configure.py to make it clearer that users can control options with enable and disable
@rustbot

rustbot commented Oct 1, 2024

Copy link
Copy Markdown
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Kobzol (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Oct 1, 2024
@AvatarSenjuAvatarSenju mentioned this pull request Oct 1, 2024
Closed
@AvatarSenju

AvatarSenju commented Oct 1, 2024

Copy link
Copy Markdown
ContributorAuthor

ref suggestion for the change #129146 (comment)

@Kobzol

Kobzol commented Oct 2, 2024

Copy link
Copy Markdown
Member

LGTM, but I'm gonna

r? @onur-ozkan

since you discussed the original issue.

@rustbotrustbot assigned onur-ozkan and unassigned KobzolOct 2, 2024
@onur-ozkan

onur-ozkan commented Oct 2, 2024

Copy link
Copy Markdown
Contributor

@bors r+

@bors

bors commented Oct 2, 2024

Copy link
Copy Markdown
Collaborator

📌 Commit 9de4b62 has been approved by onur-ozkan

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 2, 2024
@bors

bors commented Oct 2, 2024

Copy link
Copy Markdown
Collaborator

⌛ Testing commit 9de4b62 with merge 360f7d7...

@bors

bors commented Oct 2, 2024

Copy link
Copy Markdown
Collaborator

☀️ Test successful - checks-actions
Approved by: onur-ozkan
Pushing 360f7d7 to master...

@borsbors added the merged-by-bors This PR was explicitly merged by bors. label Oct 2, 2024
@bors
bors merged commit 360f7d7 into rust-lang:masterOct 2, 2024
@rustbotrustbot added this to the 1.83.0 milestone Oct 2, 2024
@rust-timer

rust-timer commented Oct 2, 2024

Copy link
Copy Markdown
Collaborator

Finished benchmarking commit (360f7d7): comparison URL.

Overall result: ❌ regressions - no action needed

@rustbot label: -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

meanrangecount
Regressions ❌
(primary)		0.2%[0.2%, 0.2%]1
Regressions ❌
(secondary)		--0
Improvements ✅
(primary)		--0
Improvements ✅
(secondary)		--0
All ❌✅ (primary)0.2%[0.2%, 0.2%]1

Max RSS (memory usage)

Results (primary -3.4%, secondary -2.7%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

meanrangecount
Regressions ❌
(primary)		--0
Regressions ❌
(secondary)		--0
Improvements ✅
(primary)		-3.4%[-3.4%, -3.4%]1
Improvements ✅
(secondary)		-2.7%[-2.7%, -2.6%]2
All ❌✅ (primary)-3.4%[-3.4%, -3.4%]1

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 770.256s -> 769.583s (-0.09%)
Artifact size: 341.54 MiB -> 341.50 MiB (-0.01%)

@clubby789clubby789 mentioned this pull request Oct 19, 2024
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 20, 2024
@matthiaskrgr
Rollup merge ofrust-lang#131926- clubby789:configure-enable, r=Kobzol
4aaa2ea
Align boolean option descriptions in `configure.py`
Boolean options are currently printed as
```
Options
--enable-debug OR --disable-debug enables debugging environment; does not affect optimization of bootstrapped code
--enable-docs OR --disable-docs build standard library documentation
--enable-compiler-docs OR --disable-compiler-docs build compiler documentation
--enable-optimize-tests OR --disable-optimize-tests build tests with optimizations
--enable-verbose-tests OR --disable-verbose-tests enable verbose output when running tests
--enable-ccache OR --disable-ccache invoke gcc/clang via ccache to reuse object files between builds
--enable-sccache OR --disable-sccache invoke gcc/clang via sccache to reuse object files between builds
--enable-local-rust OR --disable-local-rust use an installed rustc rather than downloading a snapshot
--local-rust-root=VAL set prefix for local rust binary
--enable-local-rebuild OR --disable-local-rebuild assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version
```
as of rust-lang#131117
imo, this is a little difficult to skim. This PR changes this to align the `OR`s and push the description onto a newline:
```
Options
--enable-debug OR --disable-debug
enables debugging environment; does not affect optimization of bootstrapped code
--enable-docs OR --disable-docs
build standard library documentation
--enable-compiler-docs OR --disable-compiler-docs
build compiler documentation
--enable-optimize-tests OR --disable-optimize-tests
build tests with optimizations
--enable-verbose-tests OR --disable-verbose-tests
enable verbose output when running tests
--enable-ccache OR --disable-ccache
invoke gcc/clang via ccache to reuse object files between builds
--enable-sccache OR --disable-sccache
invoke gcc/clang via sccache to reuse object files between builds
--enable-local-rust OR --disable-local-rust
use an installed rustc rather than downloading a snapshot
--local-rust-root=VAL set prefix for local rust binary
--enable-local-rebuild OR --disable-local-rebuild
assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version
```
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 20, 2024
@matthiaskrgr
Rollup merge ofrust-lang#131926- clubby789:configure-enable, r=Kobzol
2f77343
Align boolean option descriptions in `configure.py`
Boolean options are currently printed as
```
Options
--enable-debug OR --disable-debug enables debugging environment; does not affect optimization of bootstrapped code
--enable-docs OR --disable-docs build standard library documentation
--enable-compiler-docs OR --disable-compiler-docs build compiler documentation
--enable-optimize-tests OR --disable-optimize-tests build tests with optimizations
--enable-verbose-tests OR --disable-verbose-tests enable verbose output when running tests
--enable-ccache OR --disable-ccache invoke gcc/clang via ccache to reuse object files between builds
--enable-sccache OR --disable-sccache invoke gcc/clang via sccache to reuse object files between builds
--enable-local-rust OR --disable-local-rust use an installed rustc rather than downloading a snapshot
--local-rust-root=VAL set prefix for local rust binary
--enable-local-rebuild OR --disable-local-rebuild assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version
```
as of rust-lang#131117
imo, this is a little difficult to skim. This PR changes this to align the `OR`s and push the description onto a newline:
```
Options
--enable-debug OR --disable-debug
enables debugging environment; does not affect optimization of bootstrapped code
--enable-docs OR --disable-docs
build standard library documentation
--enable-compiler-docs OR --disable-compiler-docs
build compiler documentation
--enable-optimize-tests OR --disable-optimize-tests
build tests with optimizations
--enable-verbose-tests OR --disable-verbose-tests
enable verbose output when running tests
--enable-ccache OR --disable-ccache
invoke gcc/clang via ccache to reuse object files between builds
--enable-sccache OR --disable-sccache
invoke gcc/clang via sccache to reuse object files between builds
--enable-local-rust OR --disable-local-rust
use an installed rustc rather than downloading a snapshot
--local-rust-root=VAL set prefix for local rust binary
--enable-local-rebuild OR --disable-local-rebuild
assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version
```
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Oct 20, 2024
@rust-timer
Unrolled build forrust-lang#131926
54c38d7
Rollup merge of rust-lang#131926 - clubby789:configure-enable, r=Kobzol
Align boolean option descriptions in `configure.py`
Boolean options are currently printed as
```
Options
--enable-debug OR --disable-debug enables debugging environment; does not affect optimization of bootstrapped code
--enable-docs OR --disable-docs build standard library documentation
--enable-compiler-docs OR --disable-compiler-docs build compiler documentation
--enable-optimize-tests OR --disable-optimize-tests build tests with optimizations
--enable-verbose-tests OR --disable-verbose-tests enable verbose output when running tests
--enable-ccache OR --disable-ccache invoke gcc/clang via ccache to reuse object files between builds
--enable-sccache OR --disable-sccache invoke gcc/clang via sccache to reuse object files between builds
--enable-local-rust OR --disable-local-rust use an installed rustc rather than downloading a snapshot
--local-rust-root=VAL set prefix for local rust binary
--enable-local-rebuild OR --disable-local-rebuild assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version
```
as of rust-lang#131117
imo, this is a little difficult to skim. This PR changes this to align the `OR`s and push the description onto a newline:
```
Options
--enable-debug OR --disable-debug
enables debugging environment; does not affect optimization of bootstrapped code
--enable-docs OR --disable-docs
build standard library documentation
--enable-compiler-docs OR --disable-compiler-docs
build compiler documentation
--enable-optimize-tests OR --disable-optimize-tests
build tests with optimizations
--enable-verbose-tests OR --disable-verbose-tests
enable verbose output when running tests
--enable-ccache OR --disable-ccache
invoke gcc/clang via ccache to reuse object files between builds
--enable-sccache OR --disable-sccache
invoke gcc/clang via sccache to reuse object files between builds
--enable-local-rust OR --disable-local-rust
use an installed rustc rather than downloading a snapshot
--local-rust-root=VAL set prefix for local rust binary
--enable-local-rebuild OR --disable-local-rebuild
assume local-rust matches the current version, for rebuilds; implies local-rust, and is implied if local-rust already matches the current version
```
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@onur-ozkanonur-ozkan

Labels

merged-by-borsThis PR was explicitly merged by bors.S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Projects

None yet

Milestone

1.83.0

Development

Successfully merging this pull request may close these issues.

6 participants

@AvatarSenju@rustbot@Kobzol@onur-ozkan@bors@rust-timer