You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Auto merge of #7385 - xFrednet:0000-fix-broken-deploy, r=flip1995
Fixed broken deploy script due to multiline configuration docs
The deploy script on master currently runs into an error (See [log](https://github.com/rust-lang/rust-clippy/runs/2865828873)) due to the new configuration documentation added in #7299. The current documentation collection for the configuration macro sadly doesn't support multiline doc comments. This will be changes in the future with the new metadata collector tracked in #7172 For now we have to use `<br>` inside doc comments to add paragraphs.
This PR restricts `define_Conf!` macro to single lines and adds a comment explaining the reasoning behind it. It also adjusted the actual document parsing to fix a bug. (The parsing was automatically stopping on the first curly bracket, even if it was part of a doc comment).
changelog: none
Copy file name to clipboardExpand all lines: clippy_lints/src/utils/conf.rs
+7-8
Original file line number
Diff line number
Diff line change
@@ -24,15 +24,18 @@ impl TryConf {
24
24
}
25
25
}
26
26
27
+
/// Note that the configuration parsing currently doesn't support documentation that will
28
+
/// that spans over several lines. This will be possible with the new implementation
29
+
/// See (rust-clippy#7172)
27
30
macro_rules! define_Conf {
28
31
($(
29
-
$(#[doc = $doc:literal])*
32
+
#[doc = $doc:literal]
30
33
$(#[conf_deprecated($dep:literal)])?
31
34
($name:ident: $ty:ty = $default:expr),
32
35
)*) => {
33
36
/// Clippy lint configuration
34
37
pubstructConf{
35
-
$($(#[doc = $doc])*pub $name: $ty,)*
38
+
$(#[doc = $doc]pub $name: $ty,)*
36
39
}
37
40
38
41
mod defaults {
@@ -109,7 +112,7 @@ macro_rules! define_Conf {
109
112
stringify!($name),
110
113
stringify!($ty),
111
114
format!("{:?}",super::defaults::$name()),
112
-
concat!($($doc,)*),
115
+
$doc,
113
116
deprecation_reason,
114
117
)
115
118
},
@@ -198,11 +201,7 @@ define_Conf! {
198
201
(upper_case_acronyms_aggressive:bool = false),
199
202
/// Lint: _CARGO_COMMON_METADATA. For internal testing only, ignores the current `publish` settings in the Cargo manifest.
200
203
(cargo_ignore_publish:bool = false),
201
-
/// Lint: NONSTANDARD_MACRO_BRACES. Enforce the named macros always use the braces specified.
202
-
///
203
-
/// A `MacroMatcher` can be added like so `{ name = "macro_name", brace = "(" }`.
204
-
/// If the macro is could be used with a full path two `MacroMatcher`s have to be added one
205
-
/// with the full path `crate_name::macro_name` and one with just the macro name.
204
+
/// Lint: NONSTANDARD_MACRO_BRACES. Enforce the named macros always use the braces specified. <br> A `MacroMatcher` can be added like so `{ name = "macro_name", brace = "(" }`. If the macro is could be used with a full path two `MacroMatcher`s have to be added one with the full path `crate_name::macro_name` and one with just the macro name.
0 commit comments