Skip to content

Commit b51440b

Browse files
committed
README: add NOTE for complex regexes confusing diff
1 parent b5f4770 commit b51440b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ In the latter, occurrences of `\g<name>` in the pattern line will be
3535
replaced with a previously captured value before the pattern is applied.
3636
See [example 3](#example-3-pyre-pgroup-and-ggroup).
3737

38+
> **Note**: `pyrediff PATTERN OUTPUT` post-processes the output of `diff`.
39+
> Complex regular expressions, and/or lots of non-alphanumeric escaping
40+
> in `PATTERN` may cause `diff` to generate output as added and removed
41+
> lines at different line offsets (instead of changed lines),
42+
> preventing `pyrediff` from applying the `PATTERN` correctly.
43+
3844
## check\_pattern.awk
3945

4046
`check_pattern.awk` is an AWK script to post-process the output of

0 commit comments

Comments
 (0)