diff options
| author | Prajwal S N <prajwalnadig21@gmail.com> | 2025-03-17 14:12:11 +0530 |
|---|---|---|
| committer | Prajwal S N <prajwalnadig21@gmail.com> | 2025-03-17 14:40:24 +0530 |
| commit | 63722ea55d61cbd803caf635893930d430e318ce (patch) | |
| tree | 71fc25360bc1d2d3523cb77034599e30a8898547 | |
| parent | 2e7901e90c53c7bd8b93889b588687116af670e5 (diff) | |
| download | rust-63722ea55d61cbd803caf635893930d430e318ce.tar.gz rust-63722ea55d61cbd803caf635893930d430e318ce.zip | |
fix(codegen): do not generate docs with `--check`
Running `cargo codegen --check` should not generate any mdbook files, since they are ignored in the repo and used only while releasing a new copy of the documentation. Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
3 files changed, 18 insertions, 7 deletions
diff --git a/src/tools/rust-analyzer/xtask/src/codegen/assists_doc_tests.rs b/src/tools/rust-analyzer/xtask/src/codegen/assists_doc_tests.rs index 1bb7845b9c8..dd55d06bd34 100644 --- a/src/tools/rust-analyzer/xtask/src/codegen/assists_doc_tests.rs +++ b/src/tools/rust-analyzer/xtask/src/codegen/assists_doc_tests.rs @@ -53,6 +53,11 @@ r#####" ); } + // Do not generate assists manual when run with `--check` + if check { + return; + } + { // Generate assists manual. Note that we do _not_ commit manual to the // git repo. Instead, `cargo xtask release` runs this test before making diff --git a/src/tools/rust-analyzer/xtask/src/codegen/diagnostics_docs.rs b/src/tools/rust-analyzer/xtask/src/codegen/diagnostics_docs.rs index 7858e9ae1b4..4a47a5f6aa4 100644 --- a/src/tools/rust-analyzer/xtask/src/codegen/diagnostics_docs.rs +++ b/src/tools/rust-analyzer/xtask/src/codegen/diagnostics_docs.rs @@ -10,13 +10,15 @@ use crate::{ pub(crate) fn generate(check: bool) { let diagnostics = Diagnostic::collect().unwrap(); - if !check { - let contents = - diagnostics.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); - let contents = add_preamble(crate::flags::CodegenType::DiagnosticsDocs, contents); - let dst = project_root().join("docs/book/src/diagnostics_generated.md"); - fs::write(dst, contents).unwrap(); + // Do not generate docs when run with `--check` + if check { + return; } + let contents = + diagnostics.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); + let contents = add_preamble(crate::flags::CodegenType::DiagnosticsDocs, contents); + let dst = project_root().join("docs/book/src/diagnostics_generated.md"); + fs::write(dst, contents).unwrap(); } #[derive(Debug)] diff --git a/src/tools/rust-analyzer/xtask/src/codegen/feature_docs.rs b/src/tools/rust-analyzer/xtask/src/codegen/feature_docs.rs index c10ada25337..170de5db9a7 100644 --- a/src/tools/rust-analyzer/xtask/src/codegen/feature_docs.rs +++ b/src/tools/rust-analyzer/xtask/src/codegen/feature_docs.rs @@ -8,8 +8,12 @@ use crate::{ util::list_rust_files, }; -pub(crate) fn generate(_check: bool) { +pub(crate) fn generate(check: bool) { let features = Feature::collect().unwrap(); + // Do not generate docs when run with `--check` + if check { + return; + } let contents = features.into_iter().map(|it| it.to_string()).collect::<Vec<_>>().join("\n\n"); let contents = add_preamble(crate::flags::CodegenType::FeatureDocs, contents); let dst = project_root().join("docs/book/src/features_generated.md"); |
