run-make: add some basic docs about the test suite's setup

[jieyouxu]

r? @Kobzol

[jieyouxu]

@rustbot review

[Kobzol]

Looks good, at least now there is some basic documentation about this, for the uninitiated. I left two nits, but otherwise LGTM. This should wait for #126097, ofc.

[Kobzol]

Feel free to r=me once #126097 gets merged :)

[Kobzol]

#126097 has been merged.

[jieyouxu]

Addressed review comments. I plan to add some more docs on best practices for rmake.rs tests and a high-level overview of the support library in follow-up PR(s). (Still gathering thoughts / sitting on some ideas for those.)

@bors r=@Kobzol

[bors]

📌 Commit e7409d2 has been approved by Kobzol

It is now in the queue for this repository.

[jieyouxu]

@bors rollup

[bors]

⌛ Testing commit e7409d2 with merge 13423be...

[bors]

☀️ Test successful - checks-actions
Approved by: Kobzol
Pushing 13423be to master...

[rust-timer]

Finished benchmarking commit (13423be): 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)

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

Cycles

Results (primary -0.4%, secondary 2.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)	2.1%	[2.1%, 2.1%]	1
Regressions ❌ (secondary)	2.3%	[2.3%, 2.3%]	1
Improvements ✅ (primary)	-3.0%	[-3.0%, -3.0%]	1
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-0.4%	[-3.0%, 2.1%]	2

Binary size

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

Bootstrap: missing data
Artifact size: 319.87 MiB -> 319.75 MiB (-0.04%)