Skip to main content

Module rustdoc_gui_test

Module rustdoc_gui_test 

Source
Expand description

This module isolates the compiletest APIs used by the rustdoc-gui-test tool.

Thanks to this isolation layer, changes to compiletest directive parsing might require changes to the items in this module, but shouldnโ€™t require changes to rustdoc-gui-test itself.

The current relationship between compiletest and rustdoc-gui-test is awkward. Ideally, rustdoc-gui-test should either split off its own directive parser and become fully independent, or be incorporated into compiletest as another test mode.

See https://github.com/rust-lang/rust/issues/143827 for more context.

Re-exportsยง

use std::path::Path; ๐Ÿ”’
use camino::Utf8Path; ๐Ÿ”’
use camino::Utf8PathBuf; ๐Ÿ”’
use crate::common::CodegenBackend; ๐Ÿ”’
use crate::common::Config; ๐Ÿ”’
use crate::common::TestMode; ๐Ÿ”’
use crate::common::TestSuite; ๐Ÿ”’
use crate::directives::TestProps; ๐Ÿ”’

Structsยง

RustdocGuiTestProps
Subset of compiletest directive values that are actually used by rustdoc-gui-test.

Functionsยง

incomplete_config_for_rustdoc_gui_test ๐Ÿ”’
Incomplete config intended for src/tools/rustdoc-gui-test only as src/tools/rustdoc-gui-test wants to reuse compiletestโ€™s directive -> test property handling for //@ {compile,run}-flags, do not use for any other purpose.