Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit d276920

Browse files
Rename DocTest into DocTestBuilder
1 parent 13acb1d commit d276920

File tree

5 files changed

+22
-17
lines changed

5 files changed

+22
-17
lines changed

src/librustdoc/doctest.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use std::sync::atomic::{AtomicUsize, Ordering};
1111
use std::sync::{Arc, Mutex};
1212
use std::{panic, str};
1313

14-
pub(crate) use make::DocTest;
14+
pub(crate) use make::DocTestBuilder;
1515
pub(crate) use markdown::test as test_markdown;
1616
use rustc_ast as ast;
1717
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
@@ -250,7 +250,7 @@ pub(crate) fn run_tests(
250250
rustdoc_options: &Arc<RustdocOptions>,
251251
unused_extern_reports: &Arc<Mutex<Vec<UnusedExterns>>>,
252252
mut standalone_tests: Vec<test::TestDescAndFn>,
253-
mergeable_tests: FxHashMap<Edition, Vec<(DocTest, ScrapedDoctest)>>,
253+
mergeable_tests: FxHashMap<Edition, Vec<(DocTestBuilder, ScrapedDoctest)>>,
254254
) {
255255
let mut test_args = Vec::with_capacity(rustdoc_options.test_args.len() + 1);
256256
test_args.insert(0, "rustdoctest".to_string());
@@ -754,7 +754,7 @@ pub(crate) trait DoctestVisitor {
754754

755755
struct CreateRunnableDoctests {
756756
standalone_tests: Vec<test::TestDescAndFn>,
757-
mergeable_tests: FxHashMap<Edition, Vec<(DocTest, ScrapedDoctest)>>,
757+
mergeable_tests: FxHashMap<Edition, Vec<(DocTestBuilder, ScrapedDoctest)>>,
758758

759759
rustdoc_options: Arc<RustdocOptions>,
760760
opts: GlobalTestOptions,
@@ -803,7 +803,7 @@ impl CreateRunnableDoctests {
803803
);
804804

805805
let edition = scraped_test.edition(&self.rustdoc_options);
806-
let doctest = DocTest::new(
806+
let doctest = DocTestBuilder::new(
807807
&scraped_test.text,
808808
Some(&self.opts.crate_name),
809809
edition,
@@ -827,7 +827,7 @@ impl CreateRunnableDoctests {
827827

828828
fn generate_test_desc_and_fn(
829829
&mut self,
830-
test: DocTest,
830+
test: DocTestBuilder,
831831
scraped_test: ScrapedDoctest,
832832
) -> test::TestDescAndFn {
833833
if !scraped_test.langstr.compile_fail {
@@ -845,7 +845,7 @@ impl CreateRunnableDoctests {
845845
}
846846

847847
fn generate_test_desc_and_fn(
848-
test: DocTest,
848+
test: DocTestBuilder,
849849
scraped_test: ScrapedDoctest,
850850
opts: GlobalTestOptions,
851851
rustdoc_options: Arc<RustdocOptions>,
@@ -892,7 +892,7 @@ fn generate_test_desc_and_fn(
892892
fn doctest_run_fn(
893893
test_opts: IndividualTestOptions,
894894
global_opts: GlobalTestOptions,
895-
doctest: DocTest,
895+
doctest: DocTestBuilder,
896896
scraped_test: ScrapedDoctest,
897897
rustdoc_options: Arc<RustdocOptions>,
898898
unused_externs: Arc<Mutex<Vec<UnusedExterns>>>,

src/librustdoc/doctest/make.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use super::GlobalTestOptions;
1919

2020
/// This struct contains information about the doctest itself which is then used to generate
2121
/// doctest source code appropriately.
22-
pub(crate) struct DocTest {
22+
pub(crate) struct DocTestBuilder {
2323
pub(crate) supports_color: bool,
2424
pub(crate) already_has_extern_crate: bool,
2525
pub(crate) has_main_fn: bool,
@@ -34,7 +34,7 @@ pub(crate) struct DocTest {
3434
pub(crate) can_be_merged: bool,
3535
}
3636

37-
impl DocTest {
37+
impl DocTestBuilder {
3838
pub(crate) fn new(
3939
source: &str,
4040
crate_name: Option<&str>,

src/librustdoc/doctest/runner.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ use rustc_span::edition::Edition;
44
use std::fmt::Write;
55

66
use crate::doctest::{
7-
run_test, DocTest, GlobalTestOptions, IndividualTestOptions, RunnableDoctest, RustdocOptions,
8-
ScrapedDoctest, TestFailure, UnusedExterns,
7+
run_test, DocTestBuilder, GlobalTestOptions, IndividualTestOptions, RunnableDoctest,
8+
RustdocOptions, ScrapedDoctest, TestFailure, UnusedExterns,
99
};
1010
use crate::html::markdown::{Ignore, LangString};
1111

@@ -31,7 +31,7 @@ impl DocTestRunner {
3131

3232
pub(crate) fn add_test(
3333
&mut self,
34-
doctest: &DocTest,
34+
doctest: &DocTestBuilder,
3535
scraped_test: &ScrapedDoctest,
3636
target_str: &str,
3737
) {
@@ -193,7 +193,7 @@ std::process::Termination::report(test::test_main(test_args, Vec::from(TESTS), N
193193

194194
/// Push new doctest content into `output`. Returns the test ID for this doctest.
195195
fn generate_mergeable_doctest(
196-
doctest: &DocTest,
196+
doctest: &DocTestBuilder,
197197
scraped_test: &ScrapedDoctest,
198198
ignore: bool,
199199
id: usize,

src/librustdoc/doctest/tests.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use std::path::PathBuf;
22

3-
use super::{DocTest, GlobalTestOptions};
3+
use super::{DocTestBuilder, GlobalTestOptions};
44
use rustc_span::edition::DEFAULT_EDITION;
55

66
fn make_test(
@@ -10,8 +10,13 @@ fn make_test(
1010
opts: &GlobalTestOptions,
1111
test_id: Option<&str>,
1212
) -> (String, usize) {
13-
let doctest =
14-
DocTest::new(test_code, crate_name, DEFAULT_EDITION, false, test_id.map(|s| s.to_string()));
13+
let doctest = DocTestBuilder::new(
14+
test_code,
15+
crate_name,
16+
DEFAULT_EDITION,
17+
false,
18+
test_id.map(|s| s.to_string()),
19+
);
1520
let (code, line_offset) =
1621
doctest.generate_unique_doctest(test_code, dont_insert_main, opts, crate_name);
1722
(code, line_offset)

src/librustdoc/html/markdown.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'_, 'a, I> {
297297
attrs: vec![],
298298
args_file: PathBuf::new(),
299299
};
300-
let doctest = doctest::DocTest::new(&test, krate, edition, false, None);
300+
let doctest = doctest::DocTestBuilder::new(&test, krate, edition, false, None);
301301
let (test, _) = doctest.generate_unique_doctest(&test, false, &opts, krate);
302302
let channel = if test.contains("#![feature(") { "&amp;version=nightly" } else { "" };
303303

0 commit comments

Comments
 (0)