Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
int
Rust
提交
12607ef5
R
Rust
项目概览
int
/
Rust
接近 1 年 前同步成功
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
R
Rust
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
12607ef5
编写于
12月 01, 2019
作者:
G
Guillaume Gomez
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add lint when no doc is present at the crate-level
上级
98803c18
变更
4
隐藏空白更改
内联
并排
Showing
4 changed file
with
42 addition
and
0 deletion
+42
-0
src/librustc_session/lint/builtin.rs
src/librustc_session/lint/builtin.rs
+7
-0
src/librustdoc/core.rs
src/librustdoc/core.rs
+19
-0
src/test/rustdoc-ui/no-crate-level-doc-lint.rs
src/test/rustdoc-ui/no-crate-level-doc-lint.rs
+3
-0
src/test/rustdoc-ui/no-crate-level-doc-lint.stderr
src/test/rustdoc-ui/no-crate-level-doc-lint.stderr
+13
-0
未找到文件。
src/librustc_session/lint/builtin.rs
浏览文件 @
12607ef5
...
...
@@ -386,6 +386,12 @@
"failures in resolving intra-doc link targets"
}
declare_lint!
{
pub
NO_CRATE_LEVEL_DOC
,
Allow
,
"detects crates with no crate-level documentation"
}
declare_lint!
{
pub
MISSING_DOC_CODE_EXAMPLES
,
Allow
,
...
...
@@ -547,6 +553,7 @@
UNSTABLE_NAME_COLLISIONS
,
IRREFUTABLE_LET_PATTERNS
,
INTRA_DOC_LINK_RESOLUTION_FAILURE
,
NO_CRATE_LEVEL_DOC
,
MISSING_DOC_CODE_EXAMPLES
,
PRIVATE_DOC_TESTS
,
WHERE_CLAUSES_OBJECT_SAFETY
,
...
...
src/librustdoc/core.rs
浏览文件 @
12607ef5
...
...
@@ -249,6 +249,7 @@ pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOpt
let
missing_docs
=
rustc_lint
::
builtin
::
MISSING_DOCS
.name
;
let
missing_doc_example
=
rustc_lint
::
builtin
::
MISSING_DOC_CODE_EXAMPLES
.name
;
let
private_doc_tests
=
rustc_lint
::
builtin
::
PRIVATE_DOC_TESTS
.name
;
let
no_crate_level_doc
=
rustc_lint
::
builtin
::
NO_CRATE_LEVEL_DOC
.name
;
// In addition to those specific lints, we also need to whitelist those given through
// command line, otherwise they'll get ignored and we don't want that.
...
...
@@ -258,6 +259,7 @@ pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOpt
missing_docs
.to_owned
(),
missing_doc_example
.to_owned
(),
private_doc_tests
.to_owned
(),
no_crate_level_doc
.to_owned
(),
];
whitelisted_lints
.extend
(
lint_opts
.iter
()
.map
(|(
lint
,
_
)|
lint
)
.cloned
());
...
...
@@ -411,6 +413,23 @@ pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOpt
let
mut
krate
=
clean
::
krate
(
&
mut
ctxt
);
if
let
Some
(
ref
m
)
=
krate
.module
{
match
m
.doc_value
()
{
None
|
Some
(
""
)
=>
{
let
mut
diag
=
tcx
.struct_lint_node
(
rustc_lint
::
builtin
::
NO_CRATE_LEVEL_DOC
,
ctxt
.as_local_hir_id
(
m
.def_id
)
.unwrap
(),
"No documentation found on this crate top module.
\n\n
\
Maybe you could be interested into looking at this documentation:
\n
\
https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation
\
.html"
);
diag
.emit
();
}
_
=>
{}
}
}
fn
report_deprecated_attr
(
name
:
&
str
,
diag
:
&
rustc_errors
::
Handler
)
{
let
mut
msg
=
diag
.struct_warn
(
&
format!
(
"the `#![doc({})]` attribute is
\
...
...
src/test/rustdoc-ui/no-crate-level-doc-lint.rs
0 → 100644
浏览文件 @
12607ef5
#![deny(no_crate_level_doc)]
pub
fn
foo
()
{}
src/test/rustdoc-ui/no-crate-level-doc-lint.stderr
0 → 100644
浏览文件 @
12607ef5
error: No documentation found on this crate top module.
Maybe you could be interested into looking at this documentation:
https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html
|
note: lint level defined here
--> $DIR/no-crate-level-doc-lint.rs:1:9
|
LL | #![deny(no_crate_level_doc)]
| ^^^^^^^^^^^^^^^^^^
error: aborting due to previous error
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录