Skip to content

Add InfiniBand and RoCE to doc_markdown whitelist #15558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2025
+26 −23
Merged

Add InfiniBand and RoCE to doc_markdown whitelist #15558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion book/src/lint_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ default configuration of Clippy. By default, any configuration will replace the
* `doc-valid-idents = ["ClipPy"]` would replace the default list with `["ClipPy"]`.
* `doc-valid-idents = ["ClipPy", ".."]` would append `ClipPy` to the default list.

**Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "MHz", "GHz", "THz", "AccessKit", "CoAP", "CoreFoundation", "CoreGraphics", "CoreText", "DevOps", "Direct2D", "Direct3D", "DirectWrite", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript", "PowerPC", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenAL", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "OpenType", "WebGL", "WebGL2", "WebGPU", "WebRTC", "WebSocket", "WebTransport", "WebP", "OpenExr", "YCbCr", "sRGB", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "NetBSD", "OpenBSD", "NixOS", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]`
**Default Value:** `["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "MHz", "GHz", "THz", "AccessKit", "CoAP", "CoreFoundation", "CoreGraphics", "CoreText", "DevOps", "Direct2D", "Direct3D", "DirectWrite", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "InfiniBand", "RoCE", "ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript", "PowerPC", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenAL", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "OpenType", "WebGL", "WebGL2", "WebGPU", "WebRTC", "WebSocket", "WebTransport", "WebP", "OpenExr", "YCbCr", "sRGB", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "NetBSD", "OpenBSD", "NixOS", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]`

---
**Affected lints:**
Expand Down
1 change: 1 addition & 0 deletions clippy_config/src/conf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ const DEFAULT_DOC_VALID_IDENTS: &[&str] = &[
"GPLv2", "GPLv3",
"GitHub", "GitLab",
"IPv4", "IPv6",
"InfiniBand", "RoCE",
"ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript",
"PowerPC", "WebAssembly",
"NaN", "NaNs",
Expand Down
1 change: 1 addition & 0 deletions tests/ui/doc/doc-fixable.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ fn test_units() {
/// GPLv2 GPLv3
/// GitHub GitLab
/// IPv4 IPv6
/// InfiniBand RoCE
/// ClojureScript CoffeeScript JavaScript PostScript PureScript TypeScript
/// PowerPC WebAssembly
/// NaN NaNs
Expand Down
1 change: 1 addition & 0 deletions tests/ui/doc/doc-fixable.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ fn test_units() {
/// GPLv2 GPLv3
/// GitHub GitLab
/// IPv4 IPv6
/// InfiniBand RoCE
/// ClojureScript CoffeeScript JavaScript PostScript PureScript TypeScript
/// PowerPC WebAssembly
/// NaN NaNs
Expand Down
44 changes: 22 additions & 22 deletions tests/ui/doc/doc-fixable.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:90:5
--> tests/ui/doc/doc-fixable.rs:91:5
|
LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -157,7 +157,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:108:5
--> tests/ui/doc/doc-fixable.rs:109:5
|
LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -169,7 +169,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:117:8
--> tests/ui/doc/doc-fixable.rs:118:8
|
LL | /// ## CamelCaseThing
| ^^^^^^^^^^^^^^
Expand All @@ -181,7 +181,7 @@ LL + /// ## `CamelCaseThing`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:121:7
--> tests/ui/doc/doc-fixable.rs:122:7
|
LL | /// # CamelCaseThing
| ^^^^^^^^^^^^^^
Expand All @@ -193,7 +193,7 @@ LL + /// # `CamelCaseThing`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:124:22
--> tests/ui/doc/doc-fixable.rs:125:22
|
LL | /// Not a title #897 CamelCaseThing
| ^^^^^^^^^^^^^^
Expand All @@ -205,7 +205,7 @@ LL + /// Not a title #897 `CamelCaseThing`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:126:5
--> tests/ui/doc/doc-fixable.rs:127:5
|
LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -217,7 +217,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:134:5
--> tests/ui/doc/doc-fixable.rs:135:5
|
LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -229,7 +229,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:148:5
--> tests/ui/doc/doc-fixable.rs:149:5
|
LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -241,7 +241,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:160:43
--> tests/ui/doc/doc-fixable.rs:161:43
|
LL | /** E.g., serialization of an empty list: FooBar
| ^^^^^^
Expand All @@ -253,7 +253,7 @@ LL + /** E.g., serialization of an empty list: `FooBar`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:165:5
--> tests/ui/doc/doc-fixable.rs:166:5
|
LL | And BarQuz too.
| ^^^^^^
Expand All @@ -265,7 +265,7 @@ LL + And `BarQuz` too.
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:166:1
--> tests/ui/doc/doc-fixable.rs:167:1
|
LL | be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -277,7 +277,7 @@ LL + `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:174:43
--> tests/ui/doc/doc-fixable.rs:175:43
|
LL | /** E.g., serialization of an empty list: FooBar
| ^^^^^^
Expand All @@ -289,7 +289,7 @@ LL + /** E.g., serialization of an empty list: `FooBar`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:179:5
--> tests/ui/doc/doc-fixable.rs:180:5
|
LL | And BarQuz too.
| ^^^^^^
Expand All @@ -301,7 +301,7 @@ LL + And `BarQuz` too.
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:180:1
--> tests/ui/doc/doc-fixable.rs:181:1
|
LL | be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -313,7 +313,7 @@ LL + `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:194:5
--> tests/ui/doc/doc-fixable.rs:195:5
|
LL | /// be_sure_we_got_to_the_end_of_it
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -325,7 +325,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:214:22
--> tests/ui/doc/doc-fixable.rs:215:22
|
LL | /// An iterator over mycrate::Collection's values.
| ^^^^^^^^^^^^^^^^^^^
Expand All @@ -337,7 +337,7 @@ LL + /// An iterator over `mycrate::Collection`'s values.
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:239:34
--> tests/ui/doc/doc-fixable.rs:240:34
|
LL | /// Foo \[bar\] \[baz\] \[qux\]. DocMarkdownLint
| ^^^^^^^^^^^^^^^
Expand All @@ -349,7 +349,7 @@ LL + /// Foo \[bar\] \[baz\] \[qux\]. `DocMarkdownLint`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:263:22
--> tests/ui/doc/doc-fixable.rs:264:22
|
LL | /// There is no try (do() or do_not()).
| ^^^^
Expand All @@ -361,7 +361,7 @@ LL + /// There is no try (`do()` or do_not()).
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:263:30
--> tests/ui/doc/doc-fixable.rs:264:30
|
LL | /// There is no try (do() or do_not()).
| ^^^^^^^^
Expand All @@ -373,7 +373,7 @@ LL + /// There is no try (do() or `do_not()`).
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:268:5
--> tests/ui/doc/doc-fixable.rs:269:5
|
LL | /// ABes
| ^^^^
Expand All @@ -385,7 +385,7 @@ LL + /// `ABes`
|

error: item in documentation is missing backticks
--> tests/ui/doc/doc-fixable.rs:275:9
--> tests/ui/doc/doc-fixable.rs:276:9
|
LL | /// foo()
| ^^^^^
Expand All @@ -397,7 +397,7 @@ LL + /// `foo()`
|

error: you should put bare URLs between `<`/`>` or make a proper Markdown link
--> tests/ui/doc/doc-fixable.rs:280:5
--> tests/ui/doc/doc-fixable.rs:281:5
|
LL | /// https://github.com/rust-lang/rust-clippy/pull/12836
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `<https://github.com/rust-lang/rust-clippy/pull/12836>`
Expand Down
Loading