From a13b70ea83f1f3781cba2dbdc990520bdbb6a740 Mon Sep 17 00:00:00 2001
From: David Wood <david.wood@huawei.com>
Date: Tue, 28 Jun 2022 13:35:33 +0100
Subject: [PATCH] lint: port unused doc comment diagnostics
Signed-off-by: David Wood <david.wood@huawei.com>
---
compiler/rustc_error_messages/locales/en-US/lint.ftl | 5 +++++
compiler/rustc_lint/src/builtin.rs | 12 +++++-------
2 files changed, 10 insertions(+), 7 deletions(-)
diff --git a/compiler/rustc_error_messages/locales/en-US/lint.ftl b/compiler/rustc_error_messages/locales/en-US/lint.ftl
index 74a6e7ecdb5..3de652e3093 100644
--- a/compiler/rustc_error_messages/locales/en-US/lint.ftl
+++ b/compiler/rustc_error_messages/locales/en-US/lint.ftl
@@ -338,3 +338,8 @@ lint-builtin-anonymous-params = anonymous parameters are deprecated and will be
lint-builtin-deprecated-attr-link = use of deprecated attribute `{$name}`: {$reason}. See {$link}
lint-builtin-deprecated-attr-used = use of deprecated attribute `{$name}`: no longer used.
lint-builtin-deprecated-attr-default-suggestion = remove this attribute
+
+lint-builtin-unused-doc-comment = unused doc comment
+ .label = rustdoc does not generate documentation for {$kind}
+ .plain-help = use `//` for a plain comment
+ .block-help = use `/* */` for a plain comment
diff --git a/compiler/rustc_lint/src/builtin.rs b/compiler/rustc_lint/src/builtin.rs
index 147c4e94326..a31936f376a 100644
--- a/compiler/rustc_lint/src/builtin.rs
+++ b/compiler/rustc_lint/src/builtin.rs
@@ -1039,17 +1039,15 @@ fn warn_if_doc(cx: &EarlyContext<'_>, node_span: Span, node_kind: &str, attrs: &
if is_doc_comment || attr.has_name(sym::doc) {
cx.struct_span_lint(UNUSED_DOC_COMMENTS, span, |lint| {
- let mut err = lint.build("unused doc comment");
- err.span_label(
- node_span,
- format!("rustdoc does not generate documentation for {}", node_kind),
- );
+ let mut err = lint.build(fluent::lint::builtin_unused_doc_comment);
+ err.set_arg("kind", node_kind);
+ err.span_label(node_span, fluent::lint::label);
match attr.kind {
AttrKind::DocComment(CommentKind::Line, _) | AttrKind::Normal(..) => {
- err.help("use `//` for a plain comment");
+ err.help(fluent::lint::plain_help);
}
AttrKind::DocComment(CommentKind::Block, _) => {
- err.help("use `/* */` for a plain comment");
+ err.help(fluent::lint::block_help);
}
}
err.emit();