bootstrap: correctly handle doc paths within submodules

[jieyouxu]

Fixes #135041 by passing the correct submodule path when requiring submodules. This PR changes is_path_in_submodule to submodule_path_of. submodule_path_of returns the path of the containing submodule when given a path nested inside a submodule we handle, and None otherwise.

I tested this manually locally by unregistering the src/tools/cargo submodule, then running ./x doc src/tools/cargo/src/doc. This command fails on master with

thread 'main' panicked at src/bootstrap/src/utils/helpers.rs:441:5:
std::fs::read_dir(dir) failed with No such file or directory (os error 2)

since the require submodule fails as src/tools/cargo/src/doc is not a known submodule. Now we use the submodule path if such a nested-in-submodule-path is passed, and thus running this command with cargo submodule unregistered still succeeds:

Rustbook (x86_64-unknown-linux-gnu) - cargo
Doc path: /home/joe/repos/rust/build/x86_64-unknown-linux-gnu/doc/cargo/index.html
Build completed successfully in 0:00:11

r? @onur-ozkan

[jieyouxu]

Not super happy with how this macro still looks (it's still a bit convoluted), but at least the invocation-site is a bit nicer to use, I suppose.

There's also some pre-existing issues, such as:

• We do not really sanity-check the doc path and submodule path, e.g. that they share prefix. That if the doc is inside a submodule, that the Step author correctly passed a path where (1) it's a path of a submodule that we handle and (2) it's the same submodule as where the doc resides in.
• Not sure why requires_submodule silently fails? I think we just don't check it maybe?

[jieyouxu]

@onur-ozkan do you think we should fix-forward (i.e. this PR) or revert #134967 then try to reland that?

[onur-ozkan]

@onur-ozkan do you think we should fix-forward (i.e. this PR) or revert #134967 then try to reland that?

I think we can fix it right away. I need couple minutes to review this.

[onur-ozkan]

@rustbot author

[jieyouxu]

Changes since last review:

• Dropped unrelated macro changes.
• Rename is_path_in_submodule to submodule_path_of. submodule_path_of returns Some(submodule_path) if the given path is nested inside a known submodule or if the given path is already a submodule, and None otherwise.
• Adjusted the helper's tests as suitable.

Tested this locally again by unregistering src/tools/cargo (git submodule deinit -f src/tools/cargo), and running ./x doc src/tools/cargo/src/doc.

@rustbot ready

[onur-ozkan]

LGTM, feel free to r=me once CI goes green

[jieyouxu]

PR CI is 🍏
@bors r=@onur-ozkan rollup

[bors]

📌 Commit 4406f42 has been approved by onur-ozkan

It is now in the queue for this repository.

[jieyouxu]

@bors p=1 (contributor roadblock, feel free to include in rollup)

[jieyouxu]

@bors p=6 (scheduling this before the next-in-line rollup)

[bors]

⌛ Testing commit 4406f42 with merge ead4a8f...

[bors]

☀️ Test successful - checks-actions
Approved by: onur-ozkan
Pushing ead4a8f to master...

[rust-timer]

Finished benchmarking commit (ead4a8f): 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 (secondary 0.8%)

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.8%	[0.8%, 0.8%]	1
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Cycles

Results (secondary 2.8%)

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)	2.8%	[2.4%, 3.3%]	2
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Binary size

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

Bootstrap: 762.575s -> 762.69s (0.02%)
Artifact size: 325.64 MiB -> 325.64 MiB (-0.00%)