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

Add no-crate filter option on rustdoc #57006

Merged
merged 1 commit into from
Dec 29, 2018
Merged

Add no-crate filter option on rustdoc #57006

merged 1 commit into from
Dec 29, 2018

Conversation

GuillaumeGomez
Copy link
Member

@onur asked me about it so here it is!

r? @QuietMisdreavus

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 20, 2018
QuietMisdreavus
QuietMisdreavus reviewed Dec 20, 2018
View reviewed changes
Copy link
Member

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a nit on the wording of the flag, otherwise this looks good!

This is going to conflict with #57011, so whichever merges first will leave the other with a merge conflict.

src/librustdoc/lib.rs Outdated
unstable("no-doc-crate-filtering", |o| {
o.optflag("",
"no-doc-crate-filtering",
"to prevent crate filtering button generation on search")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--disable-per-crate-search

"disables generating the crate selector on the search box"

@QuietMisdreavus QuietMisdreavus added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 20, 2018
@rust-highfive
Copy link
Collaborator

The job x86_64-gnu-llvm-6.0 of your PR failed on Travis (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log. 
travis_time:end:01243ef1:start=1545346558041760494,finish=1545346622112984869,duration=64071224375
$ git checkout -qf FETCH_HEAD
travis_fold:end:git.checkout

Encrypted environment variables have been removed for security reasons.
See https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions
$ export SCCACHE_BUCKET=rust-lang-ci-sccache2
$ export SCCACHE_REGION=us-west-1
Setting environment variables from .travis.yml
$ export IMAGE=x86_64-gnu-llvm-6.0
---
[00:52:14] travis_fold:end:stage2-rustdoc

[00:52:14] travis_time:end:stage2-rustdoc:start=1545349764166532219,finish=1545349764474454938,duration=307922719

[00:52:14] thread '<unnamed>' panicked at 'No option 'no-doc-crate-filtering' defined', /cargo/registry/src/github.com-1ecc6299db9ec823/getopts-0.2.17/src/lib.rs:767:21
[00:52:14] 
[00:52:14] 
[00:52:14] 
[00:52:14] command did not execute successfully: "/checkout/obj/build/bootstrap/debug/rustdoc" "--html-after-content" "/checkout/src/doc/footer.inc" "--html-before-content" "/checkout/obj/build/x86_64-unknown-linux-gnu/doc/version_info.html" "--html-in-header" "/checkout/src/doc/favicon.inc" "--markdown-no-toc" "--index-page" "/checkout/src/doc/index.md" "--markdown-playground-url" "https://play.rust-lang.org/" "-o" "/checkout/obj/build/x86_64-unknown-linux-gnu/doc" "/checkout/src/doc/rust.md" "--markdown-css" "rust.css"
[00:52:14] 
[00:52:14] 
[00:52:14] failed to run: /checkout/obj/build/bootstrap/debug/bootstrap doc
[00:52:14] Build completed unsuccessfully in 0:04:04
[00:52:14] Build completed unsuccessfully in 0:04:04
[00:52:14] make: *** [all] Error 1
[00:52:14] Makefile:28: recipe for target 'all' failed
The command "stamp sh -x -c "$RUN_SCRIPT"" exited with 2.
travis_time:start:174daa12
$ date && (curl -fs --head https://google.com | grep ^Date: | sed 's/Date: //g' || true)
Thu Dec 20 23:49:24 UTC 2018
---
travis_time:end:05978768:start=1545349765220290677,finish=1545349765229557051,duration=9266374
travis_fold:end:after_failure.4
travis_fold:start:after_failure.5
travis_time:start:118ff8a8
$ cat ./obj/build/x86_64-unknown-linux-gnu/native/asan/build/lib/asan/clang_rt.asan-dynamic-i386.vers || true
cat: ./obj/build/x86_64-unknown-linux-gnu/native/asan/build/lib/asan/clang_rt.asan-dynamic-i386.vers: No such file or directory
travis_fold:end:after_failure.5
travis_fold:start:after_failure.6
travis_time:start:1b449bda
$ dmesg | grep -i kill

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

@GuillaumeGomez
Copy link
Member Author

Updated.

@QuietMisdreavus QuietMisdreavus mentioned this pull request Dec 21, 2018
Closed
QuietMisdreavus
QuietMisdreavus reviewed Dec 21, 2018
View reviewed changes
src/librustdoc/config.rs Outdated
@@ -192,6 +192,9 @@ pub struct RenderOptions {
/// If present, playground URL to use in the "Run" button added to code samples generated from
/// standalone Markdown files. If not present, `playground_url` is used.
pub markdown_playground_url: Option<String>,
/// If false, the `select` element to have search filtering by crates on rendered docs
/// won't be generated.
pub generate_filter_crates: bool,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also change this to something like generate_search_filter to match the CLI flag a little closer.

@GuillaumeGomez
Copy link
Member Author

Updated.

@bors
Copy link
Contributor

bors commented Dec 23, 2018

☔ The latest upstream changes (presumably #57063) made this pull request unmergeable. Please resolve the merge conflicts.

@GuillaumeGomez
Copy link
Member Author

@bors: r=QuietMisdreavus

@bors
Copy link
Contributor

bors commented Dec 28, 2018

📌 Commit dbcf689 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 28, 2018
@bors
Copy link
Contributor

bors commented Dec 29, 2018

⌛ Testing commit dbcf689 with merge 43d26b1...

bors added a commit that referenced this pull request Dec 29, 2018
@bors
Auto merge of #57006 - GuillaumeGomez:no-crate-filter, r=QuietMisdreavus
43d26b1 
Add no-crate filter option on rustdoc

@onur asked me about it so here it is!

r? @QuietMisdreavus
@bors
Copy link
Contributor

bors commented Dec 29, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: QuietMisdreavus
Pushing 43d26b1 to master...

@bors bors merged commit dbcf689 into rust-lang:master Dec 29, 2018
@bors bors mentioned this pull request Dec 29, 2018
Closed
@GuillaumeGomez GuillaumeGomez deleted the no-crate-filter branch December 29, 2018 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuietMisdreavus QuietMisdreavus QuietMisdreavus left review comments

Assignees

@QuietMisdreavus QuietMisdreavus

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@GuillaumeGomez @rust-highfive @bors @QuietMisdreavus