Commit bfb4685

committed

Improve code comments and extend tests for doc_cfg feature

1 parent 12c142f commit bfb4685Copy full SHA for bfb4685

File tree

+32

-3

lines changed

+32

-3

lines changed

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1044,7 +1044,8 @@ pub(crate) fn hir_attr_lists<'a, I: IntoIterator<Item = &'a hir::Attribute>>(`
`1044`	`1044`	`/// This type keeps track of (doc) cfg information as we go down the item tree.`
`1045`	`1045`	`#[derive(Clone, Debug)]`
`1046`	`1046`	`pub(crate) struct CfgInfo {`
`1047`		- /// List of `doc(auto_cfg(hide(...)))` cfgs.
	`1047`	+ /// List of currently active `doc(auto_cfg(hide(...)))` cfgs,minus currently active
	`1048`	+ /// `doc(auto_cfg(show(...)))` cfgs.
`1048`	`1049`	`hidden_cfg: FxHashSet<Cfg>,`
`1049`	`1050`	/// Current computed `cfg`. Each time we enter a new item, this field is updated as well while
`1050`	`1051`	/// taking into account the `hidden_cfg` information.
`@@ -1300,7 +1301,8 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>`
`1300`	`1301`	`Some(Arc::new(cfg_info.current_cfg.clone()))`
`1301`	`1302`	`}`
`1302`	`1303`	`} else {`
`1303`		- // Since we always want to collect all `cfg` items, we remove the hidden ones afterward.
	`1304`	+ // If `doc(auto_cfg)` feature is enabled, we want to collect all `cfg` items, we remove the
	`1305`	`+ // hidden ones afterward.`
`1304`	`1306`	`match cfg_info.current_cfg.strip_hidden(&cfg_info.hidden_cfg) {`
`1305`	`1307`	`None \| Some(Cfg::True) => None,`
`1306`	`1308`	`Some(cfg) => Some(Arc::new(cfg)),`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`	`#[doc(auto_cfg(hide(42)))] //~ ERROR`
`14`	`14`	`#[doc(auto_cfg(hide("a")))] //~ ERROR`
`15`	`15`	`#[doc(auto_cfg(hide(foo::bar)))] //~ ERROR`
	`16`	`+#[doc(auto_cfg = 42)] //~ ERROR`
	`17`	`+#[doc(auto_cfg = "a")] //~ ERROR`
`16`	`18`	`// Shouldn't lint`
`17`	`19`	`#[doc(auto_cfg(hide(windows)))]`
`18`	`20`	`#[doc(auto_cfg(hide(feature = "windows")))]`

Lines changed: 13 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -30,6 +30,18 @@ error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/value item
`30`	`30`	`LL \| #[doc(auto_cfg(hide(foo::bar)))]`
`31`	`31`	`\| ^^^^^^^^`
`32`	`32`
	`33`	+error: `expected boolean for #[doc(auto_cfg = ...)]`
	`34`	`+ --> $DIR/doc-cfg.rs:16:7`
	`35`	`+ \|`
	`36`	`+LL \| #[doc(auto_cfg = 42)]`
	`37`	`+ \| ^^^^^^^^^^^^^`
	`38`	`+`
	`39`	+error: `expected boolean for #[doc(auto_cfg = ...)]`
	`40`	`+ --> $DIR/doc-cfg.rs:17:7`
	`41`	`+ \|`
	`42`	`+LL \| #[doc(auto_cfg = "a")]`
	`43`	`+ \| ^^^^^^^^^^^^^^`
	`44`	`+`
`33`	`45`	warning: unexpected `cfg` condition name: `foo`
`34`	`46`	`--> $DIR/doc-cfg.rs:6:11`
`35`	`47`	`\|`
@@ -74,5 +86,5 @@ error: multiple `cfg` predicates are specified
`74`	`86`	`LL \| #[doc(cfg(foo, bar))]`
`75`	`87`	`\| ^^^`
`76`	`88`
`77`		`-error: aborting due to 9 previous errors; 2 warnings emitted`
	`89`	`+error: aborting due to 11 previous errors; 2 warnings emitted`
`78`	`90`

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -20,3 +20,16 @@ mod x {`
`20`	`20`	`// 'Available on non-crate feature pistache only.'`
`21`	`21`	`#[cfg(not(feature = "pistache"))]`
`22`	`22`	`pub use crate::x::B;`
	`23`	`+`
	`24`	+// Now checking that `cfg`s are not applied on non-inlined reexports.
	`25`	`+pub mod pub_sub_mod {`
	`26`	`+ //@ has 'foo/pub_sub_mod/index.html'`
	`27`	+ // There should be only only item with `cfg` note.
	`28`	`+ //@ count - '//*[@class="stab portability"]' 1`
	`29`	`+ // And obviously the item should be "blabla".`
	`30`	`+ //@ has - '//dt' 'blablaNon-pistache'`
	`31`	`+ #[cfg(not(feature = "pistache"))]`
	`32`	`+ pub fn blabla() {}`
	`33`	`+`
	`34`	`+ pub use self::blabla as another;`
	`35`	`+}`

Comments

(0)