about summary refs log tree commit diff
path: root/book/src/development
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2023-01-27 20:21:37 +0100
committerPhilipp Krones <hello@philkrones.com>2023-01-27 20:26:35 +0100
commit2bc2431fd18c212ca081f67f4d853645f83437f5 (patch)
treec86f5bf3ad33a6dca050110cec70e0bc38fac1cd /book/src/development
parenta64940f948757ffe4b0705726b497b552801a93d (diff)
parent54e929bddee5934c527894fabee8a2c48531a795 (diff)
Merge remote-tracking branch 'upstream/master' into rustup
Diffstat (limited to 'book/src/development')
-rw-r--r--book/src/development/adding_lints.md7
-rw-r--r--book/src/development/infrastructure/book.md14
-rw-r--r--book/src/development/infrastructure/changelog_update.md16
3 files changed, 27 insertions, 10 deletions
diff --git a/book/src/development/adding_lints.md b/book/src/development/adding_lints.md
index 8b4eee8c9d9..f57dc627dce 100644
--- a/book/src/development/adding_lints.md
+++ b/book/src/development/adding_lints.md
@@ -146,7 +146,8 @@ For cargo lints, the process of testing differs in that we are interested in the
 manifest.
 
 If our new lint is named e.g. `foo_categories`, after running `cargo dev
-new_lint` we will find by default two new crates, each with its manifest file:
+new_lint --name=foo_categories --type=cargo --category=cargo` we will find by
+default two new crates, each with its manifest file:
 
 * `tests/ui-cargo/foo_categories/fail/Cargo.toml`: this file should cause the
   new lint to raise an error.
@@ -699,6 +700,10 @@ for some users. Adding a configuration is done in the following steps:
        `clippy.toml` file with the configuration value and a rust file that
        should be linted by Clippy. The test can otherwise be written as usual.
 
+5. Update [Lint Configuration](../lint_configuration.md)
+
+   Run `cargo collect-metadata` to generate documentation changes for the book.
+
 [`clippy_lints::utils::conf`]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/utils/conf.rs
 [`clippy_lints` lib file]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/lib.rs
 [`tests/ui`]: https://github.com/rust-lang/rust-clippy/blob/master/tests/ui
diff --git a/book/src/development/infrastructure/book.md b/book/src/development/infrastructure/book.md
index a4874219185..dbd624ecd73 100644
--- a/book/src/development/infrastructure/book.md
+++ b/book/src/development/infrastructure/book.md
@@ -3,15 +3,15 @@
 This document explains how to make additions and changes to the Clippy book, the
 guide to Clippy that you're reading right now. The Clippy book is formatted with
 [Markdown](https://www.markdownguide.org) and generated by
-[mdbook](https://github.com/rust-lang/mdBook).
+[mdBook](https://github.com/rust-lang/mdBook).
 
-- [Get mdbook](#get-mdbook)
+- [Get mdBook](#get-mdbook)
 - [Make changes](#make-changes)
 
-## Get mdbook
+## Get mdBook
 
 While not strictly necessary since the book source is simply Markdown text
-files, having mdbook locally will allow you to build, test and serve the book
+files, having mdBook locally will allow you to build, test and serve the book
 locally to view changes before you commit them to the repository. You likely
 already have `cargo` installed, so the easiest option is to simply:
 
@@ -19,7 +19,7 @@ already have `cargo` installed, so the easiest option is to simply:
 cargo install mdbook
 ```
 
-See the mdbook [installation](https://github.com/rust-lang/mdBook#installation)
+See the mdBook [installation](https://github.com/rust-lang/mdBook#installation)
 instructions for other options.
 
 ## Make changes
@@ -27,7 +27,7 @@ instructions for other options.
 The book's
 [src](https://github.com/rust-lang/rust-clippy/tree/master/book/src)
 directory contains all of the markdown files used to generate the book. If you
-want to see your changes in real time, you can use the mdbook `serve` command to
+want to see your changes in real time, you can use the mdBook `serve` command to
 run a web server locally that will automatically update changes as they are
 made. From the top level of your `rust-clippy` directory:
 
@@ -38,5 +38,5 @@ mdbook serve book --open
 Then navigate to `http://localhost:3000` to see the generated book. While the
 server is running, changes you make will automatically be updated.
 
-For more information, see the mdbook
+For more information, see the mdBook
 [guide](https://rust-lang.github.io/mdBook/).
diff --git a/book/src/development/infrastructure/changelog_update.md b/book/src/development/infrastructure/changelog_update.md
index 80a47affe30..d1ac7237b5e 100644
--- a/book/src/development/infrastructure/changelog_update.md
+++ b/book/src/development/infrastructure/changelog_update.md
@@ -95,11 +95,23 @@ As section headers, we use:
 Please also be sure to update the Beta/Unreleased sections at the top with the
 relevant commit ranges.
 
-If you have the time, it would be appreciated if you double-check, that the
-`#[clippy::version]` attributes for the added lints contains the correct version.
+#### 3.1 Include `beta-accepted` PRs
+
+Look for the [`beta-accepted`] label and make sure to also include the PRs with
+that label in the changelog. If you can, remove the `beta-accepted` labels
+**after** the changelog PR was merged.
+
+> _Note:_ Some of those PRs might even got backported to the previous `beta`.
+> Those have to be included in the changelog of the _previous_ release.
+
+### 4. Update `clippy::version` attributes
+
+Next, make sure to check that the `#[clippy::version]` attributes for the added
+lints contain the correct version.
 
 [changelog]: https://github.com/rust-lang/rust-clippy/blob/master/CHANGELOG.md
 [forge]: https://forge.rust-lang.org/
 [rust_master_tools]: https://github.com/rust-lang/rust/tree/master/src/tools/clippy
 [rust_beta_tools]: https://github.com/rust-lang/rust/tree/beta/src/tools/clippy
 [rust_stable_tools]: https://github.com/rust-lang/rust/releases
+[`beta-accepted`]: https://github.com/rust-lang/rust-clippy/issues?q=label%3Abeta-accepted+