如何使`cargo doc`在出现警告时返回非零退出码?
让
cargo doc在存在警告时返回非零退出码的方法 直接通过设置
RUSTDOCFLAGS环境变量,将警告转为错误:RUSTDOCFLAGS="-D warnings" cargo doc这个命令会让rustdoc把所有警告都当作错误处理,只要有任何警告出现,
cargo doc就会返回非零退出码,刚好满足CI环境的测试需求。如果只想针对特定类型的警告转为错误(比如只关注缺失文档注释的警告),可以指定具体的警告类别:
RUSTDOCFLAGS="-D missing_docs" cargo doc常用的rustdoc警告类别还有
broken_intra_doc_links(文档内链接失效)、private_doc_tests(私有模块的文档测试)等,你可以根据需要组合使用,比如-D missing_docs -D broken_intra_doc_links。如果你希望在项目中持久化这个配置,也可以在
Cargo.toml的对应区域添加:[package.metadata.rustdoc] flags = ["-D", "warnings"]不过在CI环境中,临时设置环境变量通常更灵活,不会影响本地开发的默认行为。
内容的提问来源于stack exchange,提问作者joshlf
相关产品推荐
相关产品推荐

