Auto merge of #7578 - xFrednet:7172-update-some-docs, r=camsteffen

[rust.git] / doc / changelog_update.md

diff --git a/doc/changelog_update.md b/doc/changelog_update.md
index 0b80cce6d23eaa15df2644b130267e78c30d1d0c..115848c48044ce19000414b2923ba5f1fc5f3e4e 100644 (file)
--- a/doc/changelog_update.md
+++ b/doc/changelog_update.md
@@ -18,7 +18,7 @@ been very rare that Clippy changes were included in a patch release.
 
 ### 1. Finding the relevant Clippy commits
 
-Each Rust release ships with its own version of Clippy. The Clippy submodule can
+Each Rust release ships with its own version of Clippy. The Clippy subtree can
 be found in the `tools` directory of the Rust repository.
 
 Depending on the current time and what exactly you want to update, the following
@@ -29,11 +29,16 @@ bullet points might be helpful:
 * When writing the release notes for the **upcoming beta release**, you need to check
   out the Clippy commit of the current Rust `master`. [Link][rust_master_tools]
 * When writing the (forgotten) release notes for a **past stable release**, you
-  need to select the Rust release tag from the dropdown and then check the
-  commit of the Clippy directory:
+  need to check out the Rust release tag of the stable release.
+  [Link][rust_stable_tools]
 
-  ![Explanation of how to find the commit hash](https://user-images.githubusercontent.com/2042399/62846160-1f8b0480-bcce-11e9-9da8-7964ca034e7a.png)
+Usually you want to wirte the changelog of the **upcoming stable release**. Make
+sure though, that `beta` was already branched in the Rust repository.
 
+To find the commit hash, issue the following command when in a `rust-lang/rust` checkout:
+```
+git log --oneline -- src/tools/clippy/ | grep -o "Merge commit '[a-f0-9]*' into .*" | head -1 | sed -e "s/Merge commit '\([a-f0-9]*\)' into .*/\1/g"
+```
 
 ### 2. Fetching the PRs between those commits
 
@@ -69,10 +74,24 @@ The order should roughly be:
 7. Documentation improvements
 8. Others
 
+As section headers, we use:
+
+```
+### New Lints
+### Moves and Deprecations
+### Enhancements
+### False Positive Fixes
+### Suggestion Fixes/Improvements
+### ICE Fixes
+### Documentation Improvements
+### Others
+```
+
 Please also be sure to update the Beta/Unreleased sections at the top with the
 relevant commit ranges.
 
 [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
-[rust_beta_tools]: https://github.com/rust-lang/rust/tree/beta/src/tools
+[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