Skip to content

Commit 9f60f4f

Browse files
committed
Update README
Assisted-by: Cursor
1 parent 3a40638 commit 9f60f4f

File tree

4 files changed

+81
-37
lines changed

4 files changed

+81
-37
lines changed

Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ distclean-local:
312312
EXTRA_DIST = $(man_MANS) \
313313
tests/common.sh tests/soak-test \
314314
$(TESTS) $(XFAIL_TESTS) \
315-
BUGS COPYING TODO ChangeLog \
315+
README.md BUGS COPYING TODO ChangeLog \
316316
bootstrap \
317317
patchutils.spec \
318318
doc/patchutils.xml \

README

Lines changed: 0 additions & 35 deletions
This file was deleted.

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Patchutils
2+
3+
A collection of tools that operate on patch files.
4+
5+
## Overview
6+
7+
Patchutils is a small collection of programs that operate on patch files. It provides utilities for manipulating, analyzing, and transforming patch files in various ways.
8+
9+
## Tools
10+
11+
### Core Tools
12+
13+
- **interdiff** - Generates an incremental patch from two patches against a common source. For example, if you have applied a pre-patch to a source tree, and wish to apply another pre-patch (which is against the same original source tree), you can use interdiff to generate the patch that you need to apply. You can also use this to review changes between two pre-patches.
14+
15+
- **combinediff** - Generates a single patch from two incremental patches, allowing you to merge patches together. The resulting patch file only alters each file once.
16+
17+
- **filterdiff** - Selects the portions of a patch file that apply to files matching (or, alternatively, not matching) a shell wildcard.
18+
19+
- **rediff** - Corrects hand-edited patches, by comparing the original patch with the modified one and adjusting the offsets and counts.
20+
21+
### Analysis Tools
22+
23+
- **lsdiff** - Displays a short listing of affected files in a patch file, along with (optionally) the line numbers of the start of each patch.
24+
25+
- **grepdiff** - Displays a list of the files modified by a patch where the patch contains a given regular expression.
26+
27+
### Utility Tools
28+
29+
- **splitdiff** - Separates out patches from a patch file so that each new patch file only alters any given file once. In this way, a file containing several incremental patches can be split into individual incremental patches.
30+
31+
- **fixcvsdiff** - Corrects the output of 'cvs diff'.
32+
33+
- **recountdiff** - Fixes up counts and offsets in a unified diff.
34+
35+
- **unwrapdiff** - Fixes word-wrapped unified diffs.
36+
37+
- **flipdiff** - Exchanges the order of two patches.
38+
39+
- **dehtmldiff** - Extracts a diff from an HTML page.
40+
41+
- **editdiff** - Edit a patch file interactively.
42+
43+
- **espdiff** - Apply the appropriate transformation to a patch.
44+
45+
### Viewer Tools
46+
47+
- **patchview** - View patches with syntax highlighting.
48+
49+
- **gitdiff** / **gitdiffview** - Git-specific diff viewing tools.
50+
51+
- **svndiff** / **svndiffview** - Subversion-specific diff viewing tools.
52+
53+
## Installation
54+
55+
Patchutils uses the standard GNU autotools build system:
56+
57+
```bash
58+
./configure
59+
make
60+
make install
61+
```
62+
63+
## Requirements
64+
65+
- A C compiler (GCC recommended)
66+
- Standard Unix utilities (diff, patch)
67+
- Perl (for some scripts)
68+
- Optional: xmlto (for building documentation)
69+
- Optional: PCRE2 library (for enhanced regex support)
70+
71+
## Documentation
72+
73+
Manual pages are available for all tools. After installation, you can access them with:
74+
75+
```bash
76+
man interdiff
77+
man filterdiff
78+
# etc.
79+
```

patchutils.spec.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ rm -rf %{buildroot}
3333

3434
%files
3535
%defattr(-,root,root)
36-
%doc AUTHORS ChangeLog README COPYING BUGS NEWS patchview/README.patchview
36+
%doc AUTHORS ChangeLog README.md COPYING BUGS NEWS patchview/README.patchview
3737
%{_bindir}/*
3838
%{_mandir}/*/*
3939

0 commit comments

Comments
 (0)