clippy: enable doc_markdown lint by vatsanbalaji-ossagent · Pull Request #15283 · uutils/coreutils

vatsanbalaji-ossagent · 2026-10-12T15:58:05Z

Following up on sylvestre’s feedback in #15257, this PR removes the doc_markdown lint suppression and fixes the remaining warnings throughout the workspace. It also adds AppArmor and SELinux to the accepted words list to prevent unnecessary warnings.

Ref #4949

🤖 Generated with Claude Code

codspeed · 2026-10-12T17:11:57Z

Merging this PR will degrade performance by 15.66%

⚠️

119 benchmarks spent significant time in system calls

System calls cannot be consistently instrumented, so they are not included in the measure, which understates the real cost. Please switch to the Walltime instrument to accurately measure system calls.

Measurement and system calls

du_deep_tree[(100, 3)]

du_wide_tree[(5000, 500)]

dd_copy_partial

hostname_ip_lookup[100000]

cksum_default

cksum_multiple_files

du_all_wide_tree[(5000, 500)]

cksum_sysv

dd_copy_1m_blocks

dd_copy_64k_blocks

…and 109 more

ℹ️ 1 benchmark has no flame graph

The flamegraph could not be generated because too much time was spent in runtime internals, making the visualization not useful for performance analysis.

sort_dictionary_order[500000]

⚠️

Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark
❌ 1 regressed benchmark
✅ 399 untouched benchmarks
⏩ 70 skipped benchmarks¹

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

	Mode	Benchmark	`BASE`	`HEAD`	Efficiency
❌	Simulation	`factor_three_39_bit_primes`	598.6 ms	950.4 ms	-37.02%
⚡	Simulation	`factor_five_38_bit_primes`	1.9 s	1.7 s	+12.94%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.

_{Comparing vatsanbalaji-ossagent:clippy-doc-markdown (947e1d7) with main (b136eca)²}

70 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩
No successful run was found on main (4945ecf) during the generation of this report, so b136eca was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

RenjiSann

I've only browsed half the diff, but you get the idea. Adding brackets around rust identifiers allows for rustdoc to generate links

RenjiSann · 2026-10-13T18:10:17Z

 }

-/// Format examples using std::fmt::Write
+/// Format examples using `std::fmt::Write`


Suggested change

/// Format examples using `std::fmt::Write`

/// Format examples using [`std::fmt::Write`]

You can even put brackets around it so the doc generation makes it a working link to the documentation of std::fmt::Write.

RenjiSann · 2026-10-13T18:10:55Z


 /// Build timezone abbreviation lookup map from IANA database.
-/// This is a fallback for abbreviations not covered by FIXED_OFFSET_ABBREVIATIONS.
+/// This is a fallback for abbreviations not covered by `FIXED_OFFSET_ABBREVIATIONS`.


Suggested change

/// This is a fallback for abbreviations not covered by `FIXED_OFFSET_ABBREVIATIONS`.

/// This is a fallback for abbreviations not covered by [`FIXED_OFFSET_ABBREVIATIONS`].

RenjiSann · 2026-10-13T18:15:08Z

+    /// Mutex to serialize `setlocale()` calls during tests.
    ///
-    /// setlocale() is process-global, so parallel tests that call it can
+    /// `setlocale()` is process-global, so parallel tests that call it can


Suggested change

/// Mutex to serialize `setlocale()` calls during tests.

///

/// setlocale() is process-global, so parallel tests that call it can

/// `setlocale()` is process-global, so parallel tests that call it can

/// Mutex to serialize [`libc::setlocale`] calls during tests.

///

/// [`libc::setlocale`] is process-global, so parallel tests that call it can

RenjiSann · 2026-10-13T18:15:23Z

 pub type ConversionTable = [u8; 256];

-/// Builds a lowercase conversion table using locale-aware libc::tolower
+/// Builds a lowercase conversion table using locale-aware `libc::tolower`


Suggested change

/// Builds a lowercase conversion table using locale-aware `libc::tolower`

/// Builds a lowercase conversion table using locale-aware [`libc::tolower`]

RenjiSann · 2026-10-13T18:15:31Z

 }

-/// Builds an uppercase conversion table using locale-aware libc::toupper
+/// Builds an uppercase conversion table using locale-aware `libc::toupper`


Suggested change

/// Builds an uppercase conversion table using locale-aware `libc::toupper`

/// Builds an uppercase conversion table using locale-aware [`libc::toupper`]

RenjiSann · 2026-10-13T18:15:56Z


 impl<'a> PathData<'a> {
-    /// Convert this PathData to an EntryInfo for programmatic access
+    /// Convert this `PathData` to an `EntryInfo` for programmatic access


Suggested change

/// Convert this `PathData` to an `EntryInfo` for programmatic access

/// Convert this [`PathData`] to an [`EntryInfo`] for programmatic access

RenjiSann · 2026-10-13T18:16:12Z

 }

-/// Helper function to convert input strings to InputSource
+/// Helper function to convert input strings to `InputSource`


Suggested change

/// Helper function to convert input strings to `InputSource`

/// Helper function to convert input strings to [`InputSource`]

RenjiSann · 2026-10-13T18:16:33Z


 /// Compute the number of integral and fractional digits in input string,
-/// and wrap the result in a PreciseNumber.
+/// and wrap the result in a `PreciseNumber`.


Suggested change

/// and wrap the result in a `PreciseNumber`.

/// and wrap the result in a [`PreciseNumber`].

Stop allowing clippy::doc_markdown and fix the remaining warnings across the workspace by wrapping identifiers and bare URLs in doc comments. Add AppArmor and SELinux to doc-valid-idents so product names are not flagged. Docs and lint config only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Fix the doc_markdown warnings in Linux-only tests for cat, mv and stdbuf, which were not compiled on macOS. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Turn backticked identifiers into intra-doc links where rustdoc can resolve them, as suggested in review. Names that are not Rust items in scope (environment variables, C constants, parameters) and references in tests, benches and platform-specific code stay as plain code spans. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

vatsanbalaji-ossagent · 2026-10-15T22:20:59Z

Thanks for the review, RenjiSann!

I went through the entire PR and applied the bracket links wherever appropriate, including places beyond the examples you pointed out.

I kept environment variables, C constants, and parameter names in plain backticks since they aren't Rust items in scope and would result in broken links. I also left references in tests, benchmarks, and platform-specific code in backticks because cargo doc can't validate those links.

I also rebased onto main and addressed a new warning introduced by upstream changes.

RenjiSann reviewed Oct 13, 2026

View reviewed changes

vatsanbalaji-ossagent and others added 4 commits October 15, 2026 12:52

tests: wrap bare URLs in doc comments

908d3b8

Fix the doc_markdown warnings in Linux-only tests for cat, mv and stdbuf, which were not compiled on macOS. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

uucore: fix doc_markdown warning in c_quoter

42cf7e1

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

vatsanbalaji-ossagent force-pushed the clippy-doc-markdown branch from 2442573 to 947e1d7 Compare October 15, 2026 22:20

Navigation Menu

Repository navigation

clippy: enable doc_markdown lint - #15283

clippy: enable doc_markdown lint#15283
vatsanbalaji-ossagent wants to merge 4 commits into
uutils:mainfrom
vatsanbalaji-ossagent:clippy-doc-markdown

vatsanbalaji-ossagent commented Oct 12, 2026

Uh oh!

codspeed Bot commented Oct 12, 2026 •

edited

Loading

Uh oh!

RenjiSann left a comment

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

RenjiSann Oct 13, 2026

Uh oh!

vatsanbalaji-ossagent commented Oct 15, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	/// Format examples using `std::fmt::Write`
	/// Format examples using [`std::fmt::Write`]

	/// This is a fallback for abbreviations not covered by `FIXED_OFFSET_ABBREVIATIONS`.
	/// This is a fallback for abbreviations not covered by [`FIXED_OFFSET_ABBREVIATIONS`].

	/// Builds a lowercase conversion table using locale-aware `libc::tolower`
	/// Builds a lowercase conversion table using locale-aware [`libc::tolower`]

	/// Builds an uppercase conversion table using locale-aware `libc::toupper`
	/// Builds an uppercase conversion table using locale-aware [`libc::toupper`]

	/// Convert this `PathData` to an `EntryInfo` for programmatic access
	/// Convert this [`PathData`] to an [`EntryInfo`] for programmatic access

	/// Helper function to convert input strings to `InputSource`
	/// Helper function to convert input strings to [`InputSource`]

	/// and wrap the result in a `PreciseNumber`.
	/// and wrap the result in a [`PreciseNumber`].

Conversation

vatsanbalaji-ossagent commented Oct 12, 2026

Uh oh!

codspeed Bot commented Oct 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will degrade performance by 15.66%

Performance Changes

Footnotes

Uh oh!

RenjiSann left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vatsanbalaji-ossagent commented Oct 15, 2026

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codspeed Bot commented Oct 12, 2026 •

edited

Loading