Distribute rust-docs-json via rustup. #102042

LukeMathWalker · 2022-09-20T09:38:26Z

I am not 100% sure on how to treat rust-json-docs in target_host_combination. I went along with a similar strategy to the one used for rust-docs, but looking for guidance there.

rust-highfive · 2022-09-20T09:38:29Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Mark-Simulacrum (or someone else) soon.

Please see the contribution instructions for more information.

Mark-Simulacrum

r=me with complete profile removed

We may also want to remove the check in bootstrap that gates building these on unstable_features(), since we just won't ship the component via the bulid-manifest nightly-only gate.

Mark-Simulacrum · 2022-09-20T12:35:58Z

src/tools/build-manifest/src/main.rs

+
+            // JSON docs are not yet stable, therefore we only include them in the nightly complete
+            // profile for the time being
+            self.extend_profile("complete", &mut manifest.profiles, &["rust-json-docs"]);


I wouldn't include them in the complete profile, nightly or not. In general the complete profile isn't really something we need to extend further IMO.

ehuss · 2022-09-20T14:05:05Z

Just to be clear, these are still unstable? Is there a particular reason it doesn't have a preview tag? What is the relationship with #101799? Did that PR only add the ability to build them, but did nothing with the results? Are these built for all targets that have std docs built?

jyn514 · 2022-09-20T14:10:05Z

@ehuss that PR built the JSON and added it to static.RLO, but I didn't realize changing the manifest it's a separate step, so currently is only possible to download the json manually, not through rustup.

Using -preview sounds correct to me, we only distribute this component on nightly currently.

Yes, this is for all targets that have docs built. Yes, the json format is still unstable (similar to save-analysis, but we plan to stabilize it in the near future).

LukeMathWalker · 2022-09-20T19:48:02Z

Based on the comments above:

I've marked rust-json-docs as a preview component;
Removed rust-json-docs from the complete profile;
Removed the nightly logic from dist, relying on build-manifest to ensure that it doesn't get shipped on stable/beta.

Let me know if you have further comments @Mark-Simulacrum!

Mark-Simulacrum · 2022-09-22T00:11:06Z

src/tools/build-manifest/src/main.rs

@@ -318,6 +318,7 @@ impl Builder {
        package!("rust-mingw", MINGW);
        package!("rust-std", TARGETS);
        self.package("rust-docs", &mut manifest.pkg, HOSTS, DOCS_FALLBACK);
+        self.package("rust-json-docs-preview", &mut manifest.pkg, HOSTS, DOCS_FALLBACK);


Hm, so looking at this, can we rename the component to rust-docs-json-preview? I think keeping that common prefix will help with sorting the files etc and feels a little cleaner to me. I think we call them "JSON docs" in some places, so if you disagree I don't feel strongly at all about this and we can keep the current name (renaming it is more of a pain down the line).

"JSON docs" feels more natural than "docs JSON", but I see your point. I don't feel strongly about either - @jyn514?

The other 3-compenent name is llvm-tools-preview. The other two doc components are rust-docs and rustc-docs.

rustc-docs-json and rustc-json-docs both seem like reasonable extensions to me, so I don't think there's an indicator there. But going from most specific to least specific seems good to me; rust-json-docs kind of sounds like documentation about save-analysis or something. So I have a slight preference for rust-docs-json.

I've renamed everything to rust-docs-json and squashed all commits 👍🏻

Mark-Simulacrum · 2022-09-22T13:10:15Z

@bors r+ rollup

bors · 2022-09-22T13:10:17Z

📌 Commit e572d51 has been approved by Mark-Simulacrum

It is now in the queue for this repository.

…to-rustup, r=Mark-Simulacrum Distribute rust-docs-json via rustup. I am not 100% sure on how to treat `rust-json-docs` in `target_host_combination`. I went along with a similar strategy to the one used for `rust-docs`, but looking for guidance there.

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#100734 (Split out async_fn_in_trait into a separate feature) - rust-lang#101664 (Note if mismatched types have a similar name) - rust-lang#101815 (Migrated the rustc_passes annotation without effect diagnostic infrastructure) - rust-lang#102042 (Distribute rust-docs-json via rustup.) - rust-lang#102066 (rustdoc: remove unnecessary `max-width` on headers) - rust-lang#102095 (Deduplicate two functions that would soon have been three) - rust-lang#102104 (Set 'exec-env:RUST_BACKTRACE=0' in const-eval-select tests) - rust-lang#102112 (Allow full relro on powerpc64-unknown-linux-gnu) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned Mark-Simulacrum Sep 20, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 20, 2022

Mark-Simulacrum reviewed Sep 20, 2022

View reviewed changes

rustbot added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Sep 20, 2022

Mark-Simulacrum reviewed Sep 22, 2022

View reviewed changes

Distribute rust-json-docs via rustup.

e572d51

LukeMathWalker force-pushed the add-rust-json-docs-to-rustup branch from 3d205fd to e572d51 Compare September 22, 2022 11:23

LukeMathWalker changed the title ~~Distribute rust-json-docs via rustup.~~ Distribute rust-docs-json via rustup. Sep 22, 2022

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 Sep 22, 2022

matthiaskrgr mentioned this pull request Sep 22, 2022

Rollup of 7 pull requests #102149

Closed

matthiaskrgr mentioned this pull request Sep 22, 2022

Rollup of 9 pull requests #102153

Closed

matthiaskrgr mentioned this pull request Sep 23, 2022

Rollup of 8 pull requests #102165

Merged

bors merged commit adde928 into rust-lang:master Sep 23, 2022

rustbot added this to the 1.66.0 milestone Sep 23, 2022

matthiaskrgr mentioned this pull request Sep 23, 2022

Rollup of 10 pull requests #102191

Closed

LukeMathWalker deleted the add-rust-json-docs-to-rustup branch August 3, 2024 16:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Distribute rust-docs-json via rustup. #102042

Distribute rust-docs-json via rustup. #102042

LukeMathWalker commented Sep 20, 2022 •

edited

Loading

rust-highfive commented Sep 20, 2022

Mark-Simulacrum left a comment

Mark-Simulacrum Sep 20, 2022

ehuss commented Sep 20, 2022

jyn514 commented Sep 20, 2022 •

edited

Loading

LukeMathWalker commented Sep 20, 2022

Mark-Simulacrum Sep 22, 2022

LukeMathWalker Sep 22, 2022

jyn514 Sep 22, 2022 •

edited

Loading

LukeMathWalker Sep 22, 2022

Mark-Simulacrum commented Sep 22, 2022

bors commented Sep 22, 2022

Distribute rust-docs-json via rustup. #102042

Distribute rust-docs-json via rustup. #102042

Conversation

LukeMathWalker commented Sep 20, 2022 • edited Loading

rust-highfive commented Sep 20, 2022

Mark-Simulacrum left a comment

Choose a reason for hiding this comment

Mark-Simulacrum Sep 20, 2022

Choose a reason for hiding this comment

ehuss commented Sep 20, 2022

jyn514 commented Sep 20, 2022 • edited Loading

LukeMathWalker commented Sep 20, 2022

Mark-Simulacrum Sep 22, 2022

Choose a reason for hiding this comment

LukeMathWalker Sep 22, 2022

Choose a reason for hiding this comment

jyn514 Sep 22, 2022 • edited Loading

Choose a reason for hiding this comment

LukeMathWalker Sep 22, 2022

Choose a reason for hiding this comment

Mark-Simulacrum commented Sep 22, 2022

bors commented Sep 22, 2022

LukeMathWalker commented Sep 20, 2022 •

edited

Loading

jyn514 commented Sep 20, 2022 •

edited

Loading

jyn514 Sep 22, 2022 •

edited

Loading