Support mdBook preprocessors for TRPL in rustbook #125408

chriskrycho · 2024-05-22T13:43:15Z

rust-lang/book recently added two mdBook preprocessors. Enable rustbook to use those preprocessors for books where they are requested by the book.toml by adding the preprocessors as path dependencies, and ignoring them where they are not requested, i.e. by all the books other than TRPL at present.

Addresses rust-lang/book#3927

rustbot · 2024-05-22T13:43:24Z

r? @ehuss

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2024-05-22T13:43:25Z

⚠️ Warning ⚠️

These commits modify submodules.

rustbot · 2024-05-22T16:50:42Z

These commits modify the Cargo.lock file. Unintentional changes to Cargo.lock can be introduced when switching branches and rebasing PRs.

If this was unintentional then you should revert the changes before this PR is merged.
Otherwise, you can ignore this comment.

chriskrycho · 2024-05-22T16:55:46Z

@ehuss tidy check failed locally with this:

tidy check
tidy error: invalid license `CC0-1.0` in `registry+https://github.com/rust-lang/crates.io-index#notify@6.1.1`

However, I went spelunking a bit and:

The notify dependency is completely unaltered by this change.
It has had the CC0 license for quite a while—certainly since the last bump to the dep as rust-lang/rust consumes it, likely much earlier (I did not chase git blame further than that).

I did a git push --no-verify since that appeared to be the only issue, but am worried that may end up causing issues with this PR. If it does, I would love to know (a) why this only just started failing with this PR and (b) what I should do to fix it!

Also, should CC0 be allowed? I can chase that down in tidy and get a PR up for it if so.

Cargo.lock

chriskrycho · 2024-05-22T20:45:23Z

I investigated further and see that no, CC0 should not be allowed!

`rust-lang/book` recently added two mdBook preprocessors. Enable `rustbook` to use those preprocessors for books where they are requested by the `book.toml` by adding the preprocessors as path dependencies, and ignoring them where they are not requested, i.e. by all the books other than TRPL at present.

ehuss · 2024-05-31T15:41:41Z

Thanks!

@bors r+ rollup

bors · 2024-05-31T15:41:43Z

📌 Commit 2c9fc62 has been approved by ehuss

It is now in the queue for this repository.

bors · 2024-05-31T18:30:19Z

⌛ Testing commit 2c9fc62 with merge 20be84a...

bors · 2024-06-01T04:02:16Z

☀️ Test successful - checks-actions
Approved by: ehuss
Pushing 20be84a to master...

rust-timer · 2024-06-01T05:17:40Z

Finished benchmarking commit (20be84a): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results (primary 2.4%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	2.4%	[0.9%, 3.4%]	3
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	2.4%	[0.9%, 3.4%]	3

Cycles

Results (primary -1.0%, secondary -1.3%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-1.0%	[-1.2%, -0.9%]	5
Improvements ✅ (secondary)	-1.3%	[-1.3%, -1.3%]	1
All ❌✅ (primary)	-1.0%	[-1.2%, -0.9%]	5

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 672.771s -> 667.385s (-0.80%)
Artifact size: 318.83 MiB -> 318.81 MiB (-0.01%)

Zalathar · 2024-06-01T13:31:57Z

This change seems to have made bootstrap fail with an error when the submodule src/doc/book/ hasn't been checked out, even when not trying to build rustbook.

GnomedDev · 2024-06-01T13:33:25Z

Yep, I'm running into that problem as well.

As of rust-lang#125408 PR, rustbook now relies on dependencies from the "src/doc/book" submodule. However, bootstrap does not automatically sync this submodule before reading metadata informations. And if the submodule is not present, reading metadata will fail because rustbook's dependencies will be missing. This change makes "src/doc/book" to be fetched/synced automatically before trying to read metadata. Signed-off-by: onur-ozkan <work@onurozkan.dev>

…fix, r=onur-ozkan include missing submodule on bootstrap As of rust-lang#125408 PR, rustbook now relies on dependencies from the "src/doc/book" submodule. However, bootstrap does not automatically sync this submodule before reading metadata informations. And if the submodule is not present, reading metadata will fail because rustbook's dependencies will be missing. This change makes "src/doc/book" to be fetched/synced automatically before trying to read metadata. cc `@Zalathar`

…fix, r=onur-ozkan include missing submodule on bootstrap As of rust-lang#125408 PR, rustbook now relies on dependencies from the "src/doc/book" submodule. However, bootstrap does not automatically sync this submodule before reading metadata informations. And if the submodule is not present, reading metadata will fail because rustbook's dependencies will be missing. This change makes "src/doc/book" to be fetched/synced automatically before trying to read metadata. cc ``@Zalathar``

Zalathar · 2024-06-01T14:53:08Z

As a workaround until #125856 lands, this should get bootstrap working again:

git submodule update --init src/doc/book/

…fix, r=onur-ozkan include missing submodule on bootstrap As of rust-lang#125408 PR, rustbook now relies on dependencies from the "src/doc/book" submodule. However, bootstrap does not automatically sync this submodule before reading metadata informations. And if the submodule is not present, reading metadata will fail because rustbook's dependencies will be missing. This change makes "src/doc/book" to be fetched/synced automatically before trying to read metadata. cc `@Zalathar`

…x, r=onur-ozkan include missing submodule on bootstrap As of rust-lang#125408 PR, rustbook now relies on dependencies from the "src/doc/book" submodule. However, bootstrap does not automatically sync this submodule before reading metadata informations. And if the submodule is not present, reading metadata will fail because rustbook's dependencies will be missing. This change makes "src/doc/book" to be fetched/synced automatically before trying to read metadata. cc `@Zalathar`

rustbot assigned ehuss May 22, 2024

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 22, 2024

This comment has been minimized.

Sign in to view

chriskrycho force-pushed the chriskrycho/book-updates branch from a8fba20 to a2fc7e0 Compare May 22, 2024 16:50

This comment has been minimized.

Sign in to view

chriskrycho commented May 22, 2024

View reviewed changes

Cargo.lock Outdated Show resolved Hide resolved

chriskrycho force-pushed the chriskrycho/book-updates branch from a2fc7e0 to 81b2f96 Compare May 22, 2024 18:47

chriskrycho marked this pull request as draft May 22, 2024 23:00

chriskrycho force-pushed the chriskrycho/book-updates branch from 81b2f96 to 2c9fc62 Compare May 22, 2024 23:29

chriskrycho marked this pull request as ready for review May 22, 2024 23:29

chriskrycho mentioned this pull request May 22, 2024

preprocessors need to be integrated with the rust build system rust-lang/book#3927

Open

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 May 31, 2024

bors added the merged-by-bors This PR was explicitly merged by bors. label Jun 1, 2024

bors merged commit 20be84a into rust-lang:master Jun 1, 2024
7 checks passed

rustbot added this to the 1.80.0 milestone Jun 1, 2024

onur-ozkan mentioned this pull request Jun 1, 2024

include missing submodule on bootstrap #125856

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support mdBook preprocessors for TRPL in rustbook #125408

Support mdBook preprocessors for TRPL in rustbook #125408

chriskrycho commented May 22, 2024 •

edited

rustbot commented May 22, 2024

rustbot commented May 22, 2024

This comment has been minimized.

rustbot commented May 22, 2024

chriskrycho commented May 22, 2024

This comment has been minimized.

chriskrycho commented May 22, 2024

ehuss commented May 31, 2024

bors commented May 31, 2024

bors commented May 31, 2024

bors commented Jun 1, 2024

rust-timer commented Jun 1, 2024

Zalathar commented Jun 1, 2024

GnomedDev commented Jun 1, 2024

Zalathar commented Jun 1, 2024

Support mdBook preprocessors for TRPL in rustbook #125408

Support mdBook preprocessors for TRPL in rustbook #125408

Conversation

chriskrycho commented May 22, 2024 • edited

rustbot commented May 22, 2024

rustbot commented May 22, 2024

This comment has been minimized.

rustbot commented May 22, 2024

chriskrycho commented May 22, 2024

This comment has been minimized.

chriskrycho commented May 22, 2024

ehuss commented May 31, 2024

bors commented May 31, 2024

bors commented May 31, 2024

bors commented Jun 1, 2024

rust-timer commented Jun 1, 2024

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Zalathar commented Jun 1, 2024

GnomedDev commented Jun 1, 2024

Zalathar commented Jun 1, 2024

chriskrycho commented May 22, 2024 •

edited