From a54f04373382b085837f5f835569d238bf6049e1 Mon Sep 17 00:00:00 2001
From: Guillaume Gomez <guillaume1.gomez@gmail.com>
Date: Mon, 12 Oct 2020 18:29:38 +0200
Subject: [PATCH] Add documentation for automatic_links lint

---
 compiler/rustc_lint_defs/src/builtin.rs |  6 ++--
 src/doc/rustdoc/src/lints.md            | 40 +++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/compiler/rustc_lint_defs/src/builtin.rs b/compiler/rustc_lint_defs/src/builtin.rs
index 3fc9c096696..1294dd9d685 100644
--- a/compiler/rustc_lint_defs/src/builtin.rs
+++ b/compiler/rustc_lint_defs/src/builtin.rs
@@ -1892,13 +1892,13 @@ declare_lint! {
 
 declare_lint! {
     /// The `automatic_links` lint detects when a URL/email address could be
-    /// written using only brackets. This is a `rustdoc` only lint, see the
-    /// documentation in the [rustdoc book].
+    /// written using only angle brackets. This is a `rustdoc` only lint, see
+    /// the documentation in the [rustdoc book].
     ///
     /// [rustdoc book]: ../../../rustdoc/lints.html#automatic_links
     pub AUTOMATIC_LINKS,
     Allow,
-    "detects URLs/email adresses that could be written using only brackets"
+    "detects URLs/email adresses that could be written using only angle brackets"
 }
 
 declare_lint! {
diff --git a/src/doc/rustdoc/src/lints.md b/src/doc/rustdoc/src/lints.md
index cb9099cd50b..2c10f6c06a9 100644
--- a/src/doc/rustdoc/src/lints.md
+++ b/src/doc/rustdoc/src/lints.md
@@ -285,3 +285,43 @@ warning: unclosed HTML tag `h1`
 
 warning: 2 warnings emitted
 ```
+
+## automatic_links
+
+This link is **allowed by default** and is **nightly-only**. It detects links
+which could use the "automatic" link syntax. For example:
+
+```rust
+#![warn(automatic_links)]
+
+/// [http://a.com](http://a.com)
+/// [http://b.com]
+///
+/// [http://b.com]: http://b.com
+pub fn foo() {}
+```
+
+Which will give:
+
+```text
+error: Unneeded long form for URL
+ --> foo.rs:3:5
+  |
+3 | /// [http://a.com](http://a.com)
+  |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  |
+note: the lint level is defined here
+ --> foo.rs:1:9
+  |
+1 | #![deny(automatic_links)]
+  |         ^^^^^^^^^^^^^^^
+  = help: Try with `<http://a.com>` instead
+
+error: Unneeded long form for URL
+ --> foo.rs:5:5
+  |
+5 | /// [http://b.com]
+  |     ^^^^^^^^^^^^^^
+  |
+  = help: Try with `<http://b.com>` instead
+```