Skip to content

Doc fixes#163

Merged
twaugh merged 2 commits into0.4.xfrom
doc-fixes
Feb 25, 2026
Merged

Doc fixes#163
twaugh merged 2 commits into0.4.xfrom
doc-fixes

Conversation

@twaugh
Copy link
Owner

@twaugh twaugh commented Feb 25, 2026

Documentation fixes for man pages and --help output.

Change the help text filtering syntax from (parentheses) to {braces}
to allow free use of parentheses and square brackets in help output.

Previously, options ending with (toolname) were filtered to only show
in specific tools (filterdiff, lsdiff, grepdiff), but this prevented
using parentheses for natural purposes like "(default: keep)" or
"(original-before or original-after)". Square brackets like "[OPTION]"
are also common in CLI help text.

Changes to src/filterdiff.c:
- Parser now looks for {toolname} instead of (toolname) at line ends
- All help text annotations changed from [toolname] to {toolname}
- Filters applied to every line of multi-line options to prevent
  orphaned descriptions from appearing in wrong tools

Changes to doc/patchutils.xml:
- Added missing lsdiff options: --addoldprefix, --addnewprefix,
  -I/--include-from-file, -X/--exclude-from-file
- Added missing grepdiff option: --empty-files-as-absent
- Documented all options in both synopsis and description sections

This ensures help output matches actual available options and allows
natural use of punctuation in help text.

Assisted-by: Claude Code
@codecov
Copy link

codecov bot commented Feb 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.60%. Comparing base (a492206) to head (f2c9bf0).
⚠️ Report is 3 commits behind head on 0.4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##            0.4.x     #163   +/-   ##
=======================================
  Coverage   83.60%   83.60%           
=======================================
  Files           5        5           
  Lines        4173     4173           
  Branches      997      997           
=======================================
  Hits         3489     3489           
  Misses        684      684           
Flag Coverage Δ
unittests 83.60% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@twaugh twaugh merged commit 120a87f into 0.4.x Feb 25, 2026
7 checks passed
@twaugh twaugh deleted the doc-fixes branch February 25, 2026 08:51
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