Skip to content

ls,pr: wrap angle-bracket placeholders in backticks to fix mdbook HTML warnings#11520

Draft
sylvestre wants to merge 1 commit intouutils:mainfrom
sylvestre:ls-fix-mdbook-html
Draft

ls,pr: wrap angle-bracket placeholders in backticks to fix mdbook HTML warnings#11520
sylvestre wants to merge 1 commit intouutils:mainfrom
sylvestre:ls-fix-mdbook-html

Conversation

@sylvestre
Copy link
Copy Markdown
Contributor

mdbook interprets tokens like , , etc. as unclosed HTML tags. Wrapping them in backticks renders them as code instead.

see
https://uutils.github.io/coreutils/docs/utils/ls.html
image

…L warnings

mdbook interprets tokens like <field>, <newline>, <tab> etc. as unclosed
HTML tags. Wrapping them in backticks renders them as code instead.
@github-actions
Copy link
Copy Markdown

GNU testsuite comparison:

Skip an intermittent issue tests/pr/bounded-memory (fails in this run but passes in the 'main' branch)
Skipping an intermittent issue tests/date/date-locale-hour (passes in this run but fails in the 'main' branch)
Skipping an intermittent issue tests/tail/follow-name (passes in this run but fails in the 'main' branch)
Note: The gnu test tests/unexpand/bounded-memory is now being skipped but was previously passing.
Congrats! The gnu test tests/tail/pipe-f is now passing!

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Mar 27, 2026

Merging this PR will improve performance by 13.59%

⚠️ 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

⚡ 2 improved benchmarks
✅ 298 untouched benchmarks
⏩ 46 skipped benchmarks1

Performance Changes

Mode Benchmark BASE HEAD Efficiency
Simulation sort_ascii_utf8_locale 16.1 ms 15.4 ms +4.83%
Memory cp_recursive_deep_tree[(120, 4)] 699.2 KB 615.6 KB +13.59%

Comparing sylvestre:ls-fix-mdbook-html (cae5396) with main (af6c8f2)2

Open in CodSpeed

Footnotes

  1. 46 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.

  2. No successful run was found on main (2b05f2f) during the generation of this report, so af6c8f2 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant