Rollup merge of #130567 - jieyouxu:tool-docs-compiletest, r=Kobzol

Register tool docs for compiletest

This PR registers tool docs for `src/tools/compiletest`, meaning that

```
$ ./x doc src/tools/compiletest
```

or

```
$ ./x doc compiletest
```

will now generate docs, like for `run-make-support`.

Fixes #130564.
This commit is contained in:
Matthias Krüger 2024-09-20 06:43:39 +02:00 committed by GitHub
commit ee2bec0af7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 14 additions and 6 deletions

View File

@ -1058,6 +1058,13 @@ fn run(self, builder: &Builder<'_>) {
is_library = true, is_library = true,
crates = ["run_make_support"] crates = ["run_make_support"]
); );
tool_doc!(
Compiletest,
"src/tools/compiletest",
rustc_tool = false,
is_library = true,
crates = ["compiletest"]
);
#[derive(Ord, PartialOrd, Debug, Clone, Hash, PartialEq, Eq)] #[derive(Ord, PartialOrd, Debug, Clone, Hash, PartialEq, Eq)]
pub struct ErrorIndex { pub struct ErrorIndex {

View File

@ -945,6 +945,7 @@ macro_rules! describe {
doc::Releases, doc::Releases,
doc::RunMakeSupport, doc::RunMakeSupport,
doc::BuildHelper, doc::BuildHelper,
doc::Compiletest,
), ),
Kind::Dist => describe!( Kind::Dist => describe!(
dist::Docs, dist::Docs,

View File

@ -125,7 +125,7 @@ pub struct TestProps {
// Build documentation for all specified aux-builds as well // Build documentation for all specified aux-builds as well
pub build_aux_docs: bool, pub build_aux_docs: bool,
/// Build the documentation for each crate in a unique output directory. /// Build the documentation for each crate in a unique output directory.
/// Uses <root output directory>/docs/<test name>/doc /// Uses `<root output directory>/docs/<test name>/doc`.
pub unique_doc_out_dir: bool, pub unique_doc_out_dir: bool,
// Flag to force a crate to be built with the host architecture // Flag to force a crate to be built with the host architecture
pub force_host: bool, pub force_host: bool,
@ -1304,12 +1304,12 @@ fn is_lld_built_with_zstd(_llvm_bin_dir: &Path) -> Option<()> {
false false
} }
/// Takes a directive of the form "<version1> [- <version2>]", /// Takes a directive of the form `"<version1> [- <version2>]"`,
/// returns the numeric representation of <version1> and <version2> as /// returns the numeric representation of `<version1>` and `<version2>` as
/// tuple: (<version1> as u32, <version2> as u32) /// tuple: `(<version1> as u32, <version2> as u32)`.
/// ///
/// If the <version2> part is omitted, the second component of the tuple /// If the `<version2>` part is omitted, the second component of the tuple
/// is the same as <version1>. /// is the same as `<version1>`.
fn extract_version_range<F>(line: &str, parse: F) -> Option<(u32, u32)> fn extract_version_range<F>(line: &str, parse: F) -> Option<(u32, u32)>
where where
F: Fn(&str) -> Option<u32>, F: Fn(&str) -> Option<u32>,