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.

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

Stabilize --color and --error-format options in rustdoc #53003

Merged
merged 1 commit into from
Aug 4, 2018

Conversation

GuillaumeGomez
Copy link
Member

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 2, 2018
@QuietMisdreavus
Copy link
Member

These flags were added in #49542 when rustdoc started emitting warnings for intra-doc links. The flags and parameters are the same as for rustc. These parameters are passed to any error emitter that rustdoc uses, so that errors from both rustc and rustdoc follow the same style. The defaults are auto and human.

A pending bugfix in Cargo (rust-lang/cargo#5862) will make it start capturing output from rustc/rustdoc, but to do so it needs to override their color settings so they don't accidentally strip color codes from their output due to being piped.

I had personally forgotten that these flags were this recent and that they were unstable. Unless anyone else in @rust-lang/rustdoc objects, i'm merging this.

@bors r+

@bors
Copy link
Contributor

bors commented Aug 3, 2018

📌 Commit dda85ab has been approved by QuietMisdreavus

@bors bors 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 Aug 3, 2018
cramertj added a commit to cramertj/rust that referenced this pull request Aug 3, 2018
…tions, r=QuietMisdreavus

Stabilize --color and --error-format options in rustdoc

Fixes rust-lang#52980

cc @kennytm

r? @QuietMisdreavus
@kennytm kennytm added the relnotes Marks issues that should be documented in the release notes of the next release. label Aug 4, 2018
kennytm added a commit to kennytm/rust that referenced this pull request Aug 4, 2018
…tions, r=QuietMisdreavus

Stabilize --color and --error-format options in rustdoc

Fixes rust-lang#52980

cc @kennytm

r? @QuietMisdreavus
@kennytm
Copy link
Member

kennytm commented Aug 4, 2018

As a supplement to the rationale of stabilization, passing --color to rustdoc from cargo is required to fully suppress color:

screenshot_2018-08-04 19 32 06_cvqf6q-fs8

(Bug: --color never is ignored by cargo doc nowadays, which will also be fixed by rust-lang/cargo#5862.)

bors added a commit that referenced this pull request Aug 4, 2018
Rollup of 14 pull requests

Successful merges:

 - #51919 (Provide `{to,from}_{ne,le,be}_bytes` functions on integers)
 - #52940 (Align 6-week cycle check with beta promotion instead of stable release.)
 - #52968 (App-lint-cability)
 - #52969 (rustbuild: fix local_rebuild)
 - #52995 (Remove unnecessary local in await! generator)
 - #52996 (RELEASES.md: fix the `hash_map::Entry::or_default` link)
 - #53001 (privacy: Fix an ICE in `path_is_private_type`)
 - #53003 (Stabilize --color and --error-format options in rustdoc)
 - #53022 (volatile operations docs: clarify that this does not help wrt. concurrency)
 - #53024 (Specify reentrancy gurantees of `Once::call_once`)
 - #53041 (Fix invalid code css rule)
 - #53047 (Make entire row of doc search results clickable)
 - #53050 (Make left column of rustdoc search results narrower)
 - #53062 (Remove redundant field names in structs)
@bors bors merged commit dda85ab into rust-lang:master Aug 4, 2018
@GuillaumeGomez GuillaumeGomez deleted the stabilize-rustdoc-options branch August 5, 2018 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes Marks issues that should be documented in the release notes of the next release. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants