Skip to content

Commit

Permalink
Rollup merge of rust-lang#90354 - xFrednet:00000-lets-deploy-clippy-d…
Browse files Browse the repository at this point in the history
…ocs, r=Mark-Simulacrum

Document clippy on nightly-rustc

Adding Clippy's docs to nightly-rustc, based on commit 01cf0bd. This PR only adds `clippy_utils` to the documentation. I've decided to only document one crate for now, as `clippy_lints` etc. contain very specific and undocumented functions which aren't really reusable. I'm guessing that they would mostly clutter up the search results with little benefit.

`./x.py --stage 1 doc src/tools/clippy` if working fine now after the help that ``@jyn514`` and ``@ehuss`` have provided. A big THANK YOU to them!
  • Loading branch information
matthiaskrgr committed Nov 1, 2021
2 parents 45f2366 + 01e441f commit 859f5b9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/bootstrap/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,7 @@ impl<'a> Builder<'a> {
doc::RustByExample,
doc::RustcBook,
doc::CargoBook,
doc::Clippy,
doc::EmbeddedBook,
doc::EditionGuide,
),
Expand Down
1 change: 1 addition & 0 deletions src/bootstrap/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -755,6 +755,7 @@ tool_doc!(
"src/tools/rustfmt",
["rustfmt-nightly", "rustfmt-config_proc_macro"],
);
tool_doc!(Clippy, "clippy", "src/tools/clippy", ["clippy_utils"]);

#[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
pub struct ErrorIndex {
Expand Down

0 comments on commit 859f5b9

Please sign in to comment.