Skip to content

Commit cc0df52

Browse files
llogiqllogiq
authored
Add InfiniBand and RoCE to doc_markdown whitelist (#15558)
Closes rust-lang/rust-clippy#15557 changelog: [`doc_markdown`] add InfiniBand and RoCE to whitelist
2 parents d727fa2 + 54ced9f commit cc0df52

File tree

5 files changed

+26
-23
lines changed

5 files changed

+26
-23
lines changed

‎book/src/lint_configuration.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ default configuration of Clippy. By default, any configuration will replace the
555555
* `doc-valid-idents = ["ClipPy"]` would replace the default list with `["ClipPy"]`.
556556
* `doc-valid-idents = ["ClipPy", ".."]` would append `ClipPy` to the default list.
557557

558-
**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"]`
558+
**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"]`
559559

560560
---
561561
**Affected lints:**

‎clippy_config/src/conf.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ const DEFAULT_DOC_VALID_IDENTS: &[&str] = &[
3333
"GPLv2", "GPLv3",
3434
"GitHub", "GitLab",
3535
"IPv4", "IPv6",
36+
"InfiniBand", "RoCE",
3637
"ClojureScript", "CoffeeScript", "JavaScript", "PostScript", "PureScript", "TypeScript",
3738
"PowerPC", "WebAssembly",
3839
"NaN", "NaNs",

‎tests/ui/doc/doc-fixable.fixed‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ fn test_units() {
7373
/// GPLv2 GPLv3
7474
/// GitHub GitLab
7575
/// IPv4 IPv6
76+
/// InfiniBand RoCE
7677
/// ClojureScript CoffeeScript JavaScript PostScript PureScript TypeScript
7778
/// PowerPC WebAssembly
7879
/// NaN NaNs

‎tests/ui/doc/doc-fixable.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ fn test_units() {
7373
/// GPLv2 GPLv3
7474
/// GitHub GitLab
7575
/// IPv4 IPv6
76+
/// InfiniBand RoCE
7677
/// ClojureScript CoffeeScript JavaScript PostScript PureScript TypeScript
7778
/// PowerPC WebAssembly
7879
/// NaN NaNs

‎tests/ui/doc/doc-fixable.stderr‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
145145
|
146146

147147
error: item in documentation is missing backticks
148-
--> tests/ui/doc/doc-fixable.rs:90:5
148+
--> tests/ui/doc/doc-fixable.rs:91:5
149149
|
150150
LL | /// be_sure_we_got_to_the_end_of_it
151151
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -157,7 +157,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
157157
|
158158

159159
error: item in documentation is missing backticks
160-
--> tests/ui/doc/doc-fixable.rs:108:5
160+
--> tests/ui/doc/doc-fixable.rs:109:5
161161
|
162162
LL | /// be_sure_we_got_to_the_end_of_it
163163
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -169,7 +169,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
169169
|
170170

171171
error: item in documentation is missing backticks
172-
--> tests/ui/doc/doc-fixable.rs:117:8
172+
--> tests/ui/doc/doc-fixable.rs:118:8
173173
|
174174
LL | /// ## CamelCaseThing
175175
| ^^^^^^^^^^^^^^
@@ -181,7 +181,7 @@ LL + /// ## `CamelCaseThing`
181181
|
182182

183183
error: item in documentation is missing backticks
184-
--> tests/ui/doc/doc-fixable.rs:121:7
184+
--> tests/ui/doc/doc-fixable.rs:122:7
185185
|
186186
LL | /// # CamelCaseThing
187187
| ^^^^^^^^^^^^^^
@@ -193,7 +193,7 @@ LL + /// # `CamelCaseThing`
193193
|
194194

195195
error: item in documentation is missing backticks
196-
--> tests/ui/doc/doc-fixable.rs:124:22
196+
--> tests/ui/doc/doc-fixable.rs:125:22
197197
|
198198
LL | /// Not a title #897 CamelCaseThing
199199
| ^^^^^^^^^^^^^^
@@ -205,7 +205,7 @@ LL + /// Not a title #897 `CamelCaseThing`
205205
|
206206

207207
error: item in documentation is missing backticks
208-
--> tests/ui/doc/doc-fixable.rs:126:5
208+
--> tests/ui/doc/doc-fixable.rs:127:5
209209
|
210210
LL | /// be_sure_we_got_to_the_end_of_it
211211
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -217,7 +217,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
217217
|
218218

219219
error: item in documentation is missing backticks
220-
--> tests/ui/doc/doc-fixable.rs:134:5
220+
--> tests/ui/doc/doc-fixable.rs:135:5
221221
|
222222
LL | /// be_sure_we_got_to_the_end_of_it
223223
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -229,7 +229,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
229229
|
230230

231231
error: item in documentation is missing backticks
232-
--> tests/ui/doc/doc-fixable.rs:148:5
232+
--> tests/ui/doc/doc-fixable.rs:149:5
233233
|
234234
LL | /// be_sure_we_got_to_the_end_of_it
235235
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -241,7 +241,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
241241
|
242242

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

255255
error: item in documentation is missing backticks
256-
--> tests/ui/doc/doc-fixable.rs:165:5
256+
--> tests/ui/doc/doc-fixable.rs:166:5
257257
|
258258
LL | And BarQuz too.
259259
| ^^^^^^
@@ -265,7 +265,7 @@ LL + And `BarQuz` too.
265265
|
266266

267267
error: item in documentation is missing backticks
268-
--> tests/ui/doc/doc-fixable.rs:166:1
268+
--> tests/ui/doc/doc-fixable.rs:167:1
269269
|
270270
LL | be_sure_we_got_to_the_end_of_it
271271
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -277,7 +277,7 @@ LL + `be_sure_we_got_to_the_end_of_it`
277277
|
278278

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

291291
error: item in documentation is missing backticks
292-
--> tests/ui/doc/doc-fixable.rs:179:5
292+
--> tests/ui/doc/doc-fixable.rs:180:5
293293
|
294294
LL | And BarQuz too.
295295
| ^^^^^^
@@ -301,7 +301,7 @@ LL + And `BarQuz` too.
301301
|
302302

303303
error: item in documentation is missing backticks
304-
--> tests/ui/doc/doc-fixable.rs:180:1
304+
--> tests/ui/doc/doc-fixable.rs:181:1
305305
|
306306
LL | be_sure_we_got_to_the_end_of_it
307307
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -313,7 +313,7 @@ LL + `be_sure_we_got_to_the_end_of_it`
313313
|
314314

315315
error: item in documentation is missing backticks
316-
--> tests/ui/doc/doc-fixable.rs:194:5
316+
--> tests/ui/doc/doc-fixable.rs:195:5
317317
|
318318
LL | /// be_sure_we_got_to_the_end_of_it
319319
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -325,7 +325,7 @@ LL + /// `be_sure_we_got_to_the_end_of_it`
325325
|
326326

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

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

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

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

375375
error: item in documentation is missing backticks
376-
--> tests/ui/doc/doc-fixable.rs:268:5
376+
--> tests/ui/doc/doc-fixable.rs:269:5
377377
|
378378
LL | /// ABes
379379
| ^^^^
@@ -385,7 +385,7 @@ LL + /// `ABes`
385385
|
386386

387387
error: item in documentation is missing backticks
388-
--> tests/ui/doc/doc-fixable.rs:275:9
388+
--> tests/ui/doc/doc-fixable.rs:276:9
389389
|
390390
LL | /// foo()
391391
| ^^^^^
@@ -397,7 +397,7 @@ LL + /// `foo()`
397397
|
398398

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

0 commit comments

Comments
 (0)