Skip to content

Handle whitespace properly in rustdoc and rustc options - #1057

Merged
jyn514 merged 2 commits into
rust-lang:masterfrom
jyn514:whitespace
Sep 30, 2020
Merged

jyn514 merged 2 commits into
rust-lang:masterfrom
jyn514:whitespace

Conversation

@jyn514

@jyn514 jyn514 commented Sep 19, 2020

Copy link
Copy Markdown
Member
  • Use cargo rustdoc and --config build.rustflags to preserve whitespace
  • Allow passing in additional rustdoc and cargo arguments now that RUSTDOCFLAGS isn't dependable

Closes #1038
r? @Nemo157

- Use `cargo rustdoc` and `--config build.rustflags` to preserve whitespace
- Allow passing in additional rustdoc and cargo arguments now that `RUSTDOCFLAGS` isn't dependable
@jyn514 jyn514 added S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed A-builds Area: Building the documentation for a crate labels Sep 19, 2020
@jyn514

jyn514 commented Sep 19, 2020

Copy link
Copy Markdown
Member Author
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr]  Documenting adler v0.2.3 (/opt/rustwide/workdir)
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr] error: Unrecognized option: 'cfg docsrs'
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr] 
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr] error: could not document `adler`
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr] 
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr] Caused by:
2020/09/19 01:16:06 [INFO] rustwide::cmd: [stderr]   process didn't exit successfully: `rustdoc --crate-type lib --crate-name adler src/lib.rs -o /opt/rustwide/target/doc --cfg 'feature="default"' --cfg 'feature="std"' --error-format=json --json=diagnostic-rendered-ansi '--cfg docsrs' -Z unstable-options --extern-html-root-url 'criterion=https://docs.rs/criterion/0.3.3' --resource-suffix -20200918-1.48.0-nightly-bbc677480 --static-root-path / --cap-lints warn --disable-per-crate-search -L dependency=/opt/rustwide/target/debug/deps --crate-version 0.2.3` (exit code: 1)

@jyn514

jyn514 commented Sep 19, 2020

Copy link
Copy Markdown
Member Author

Hmm, I need to test this with custom rustc arguments.

@jyn514

jyn514 commented Sep 19, 2020

Copy link
Copy Markdown
Member Author

Ok yes, that looks about right. The build succeeded too.

2020/09/19 01:34:29 [INFO] rustwide::cmd: running `Command { std: "docker" "create" "-v" "/home/joshua/src/rust/docs.rs/.workspace/builds/pulldown-cmark-0.7.1/target:/opt/rustwide/target:rw,Z" "-v" "/home/joshua/src/rust/docs.rs/.workspace/builds/pulldown-cmark-0.7.1/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/joshua/src/rust/docs.rs/.workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/joshua/src/rust/docs.rs/.workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "3221225472" "--user" "1000:1000" "--network" "none" "rustops/crates-build-env@sha256:d92eaeed33fa75130ca1ee6c8a01d1ffb62bac859dfdfb3450e3e5d1c0146529" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Z" "unstable-options" "--config" "build.rustflags=[\"--cfg\", \"x\"]" "--target" "x86_64-pc-windows-msvc" "--" "-Z" "unstable-options" "--output-format" "json" "--show-coverage" "--static-root-path" "/" "--cap-lints" "warn" "--disable-per-crate-search", kill_on_drop: false }`

@jyn514 jyn514 mentioned this pull request Sep 19, 2020
2 tasks done
@jyn514
jyn514 merged commit 2d27a12 into rust-lang:master Sep 30, 2020
@jyn514
jyn514 deleted the whitespace branch September 30, 2020 14:11
dylni added a commit to dylni/process_control that referenced this pull request Oct 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-builds Area: Building the documentation for a crate S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Whitespace in rustdoc-args isn't correctly handled

2 participants