doc: improve grepdiff documentation with better examples #146
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tion
Fix several issues with grepdiff documentation in patchutils.xml:
* Move misplaced grepdiff example from filterdiff Examples section to
grepdiff Examples section. The advanced example showing
--output-matching=hunk with --as-numbered-lines was incorrectly
placed in filterdiff documentation.
* Clean up grepdiff Description section by removing embedded example
that used a complex, inefficient pipeline (grepdiff | xargs filterdiff).
Keep the section focused on conceptual explanation.
* Completely rewrite grepdiff Examples section with comprehensive,
progressive examples:
- Start with filename-only output showing why it's useful for
quick patch scanning
- Show --output-matching=hunk for seeing actual matching hunks
- Show --output-matching=file for complete file diffs
- Include advanced usage with line numbering options
- Preserve Git format example with explanatory notes
* Add explanatory text for each example showing when and why to use
each mode, making grepdiff's capabilities clearer
These changes better showcase grepdiff as a powerful standalone tool
rather than just a helper for filterdiff, with clear examples of its
different output modes and proper organization of documentation.
Assisted-by: Cursor
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #146 +/- ##
=======================================
Coverage 83.50% 83.50%
=======================================
Files 5 5
Lines 4159 4159
Branches 985 985
=======================================
Hits 3473 3473
Misses 686 686
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.