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

rustdoc: Add an unstable option to print all unversioned files #82803

Merged
merged 2 commits into from
Mar 7, 2021
Merged

rustdoc: Add an unstable option to print all unversioned files #82803

merged 2 commits into from
Mar 7, 2021

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Mar 5, 2021

This allows sharing those files between different doc invocations
without having to know their names ahead of time.

Helps with rust-lang/docs.rs#1302.
r? @GuillaumeGomez cc @pietroalbini @Nemo157

@jyn514
Store UNVERSIONED_FILES in a data structure
69a879f 
This allows querying it programatically.
@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. requires-nightly This issue requires a nightly compiler in some way. labels Mar 5, 2021
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 5, 2021
@jyn514 jyn514 added the T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue. label Mar 5, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@petrochenkov
Copy link
Contributor

Meta: could you add "rustdoc" to PR names so that it's clear that an option is added (or some other change is made) to rustdoc rather than to rustc.
(E.g. "rustdoc: Add an unstable option to print all unversioned files".)

Labels like T-rustdoc are useless for filtering PRs because they are not displayed neither in mail clients, nor even in GitHubs own notification reader.

@jyn514 jyn514 changed the title Add an unstable option to print all unversioned files rustdoc: Add an unstable option to print all unversioned files Mar 5, 2021
@jyn514
Copy link
Member Author

jyn514 commented Mar 5, 2021

Sure thing, I'll do that.

@jyn514 jyn514 force-pushed the unversioned-files branch from 5ea970f to d6c9a6f Compare March 5, 2021 16:40
@GuillaumeGomez
Copy link
Member

It's kinda doing the opposite of what I had in mind but the end result is the same so it's just as good.

Can you add a test for it the newly added option please?

@jyn514 jyn514 force-pushed the unversioned-files branch from d6c9a6f to 11d50c0 Compare March 5, 2021 19:36
@jyn514
Copy link
Member Author

jyn514 commented Mar 5, 2021

Can you add a test for it the newly added option please?

Oops, I forgot to commit it to git. Should be up now.

@jyn514 jyn514 force-pushed the unversioned-files branch from 11d50c0 to 5411db4 Compare March 5, 2021 19:37
GuillaumeGomez
GuillaumeGomez reviewed Mar 5, 2021
View reviewed changes
src/librustdoc/config.rs
for file in crate::html::render::FILES_UNVERSIONED.keys() {
println!("{}", file);
}
return Err(0);
Copy link
Member

Choose a reason for hiding this comment

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

This is really bad API usage we have here... We should clean that up later on.

@GuillaumeGomez
Copy link
Member

Thanks! r=me once CI pass

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514
Add an unstable option to print all unversioned files
173d2aa 
This allows sharing those files between different doc invocations
without having to know their names ahead of time.
@jyn514 jyn514 force-pushed the unversioned-files branch from 5411db4 to 173d2aa Compare March 5, 2021 20:31
@jyn514
Copy link
Member Author

jyn514 commented Mar 5, 2021

@bors r=GuillaumeGomez

@bors
Copy link
Contributor

bors commented Mar 5, 2021

📌 Commit 173d2aa has been approved by GuillaumeGomez

@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 Mar 5, 2021
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Mar 6, 2021
@JohnTitor
Rollup merge of rust-lang#82803 - jyn514:unversioned-files, r=Guillau…
8c591b8 
…meGomez

rustdoc: Add an unstable option to print all unversioned files

This allows sharing those files between different doc invocations
without having to know their names ahead of time.

Helps with rust-lang/docs.rs#1302.
r? `@GuillaumeGomez` cc `@pietroalbini` `@Nemo157`
@JohnTitor JohnTitor mentioned this pull request Mar 6, 2021
Closed
JohnTitor added a commit to JohnTitor/rust that referenced this pull request Mar 6, 2021
@JohnTitor
Rollup merge of rust-lang#82803 - jyn514:unversioned-files, r=Guillau…
85796e0 
…meGomez

rustdoc: Add an unstable option to print all unversioned files

This allows sharing those files between different doc invocations
without having to know their names ahead of time.

Helps with rust-lang/docs.rs#1302.
r? ``@GuillaumeGomez`` cc ``@pietroalbini`` ``@Nemo157``
@JohnTitor JohnTitor mentioned this pull request Mar 6, 2021
Closed
@Nemo157 Nemo157 mentioned this pull request Mar 6, 2021
Closed
m-ou-se added a commit to m-ou-se/rust that referenced this pull request Mar 6, 2021
@m-ou-se
Rollup merge of rust-lang#82803 - jyn514:unversioned-files, r=Guillau…
b4224fe 
…meGomez

rustdoc: Add an unstable option to print all unversioned files

This allows sharing those files between different doc invocations
without having to know their names ahead of time.

Helps with rust-lang/docs.rs#1302.
r? ```@GuillaumeGomez``` cc ```@pietroalbini``` ```@Nemo157```
@m-ou-se m-ou-se mentioned this pull request Mar 6, 2021
Closed
@JohnTitor JohnTitor mentioned this pull request Mar 7, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 7, 2021
@bors
Auto merge of rust-lang#82851 - JohnTitor:rollup-me5ko8g, r=JohnTitor
66ec64c 
Rollup of 13 pull requests

Successful merges:

 - rust-lang#77916 (Change built-in kernel targets to be os = none throughout)
 - rust-lang#82130 (Make some Option, Result methods unstably const)
 - rust-lang#82292 (Prevent specialized ZipImpl from calling `__iterator_get_unchecked` twice with the same index)
 - rust-lang#82402 (Remove RefCell around `module_trait_cache`)
 - rust-lang#82592 (Improve transmute docs with further clarifications)
 - rust-lang#82651 (Cleanup rustdoc warnings)
 - rust-lang#82720 (Fix diagnostic suggests adding type `[type error]`)
 - rust-lang#82751 (improve offset_from docs)
 - rust-lang#82793 (Move some tests to more suitable subdirs)
 - rust-lang#82803 (rustdoc: Add an unstable option to print all unversioned files)
 - rust-lang#82808 (Sync rustc_codegen_cranelift)
 - rust-lang#82822 (Fix typo)
 - rust-lang#82837 (tweak MaybeUninit docs)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 379679b into rust-lang:master Mar 7, 2021
@rustbot rustbot added this to the 1.52.0 milestone Mar 7, 2021
@jyn514 jyn514 deleted the unversioned-files branch March 7, 2021 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
requires-nightly This issue requires a nightly compiler in some way. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-docs-rs Relevant to the docs-rs subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.52.0
Development

Successfully merging this pull request may close these issues.
7 participants
@jyn514 @rust-log-analyzer @petrochenkov @GuillaumeGomez @bors @rust-highfive @rustbot