Skip to content

Commit a0b3fa9

Browse files
committed
[README.md] add external diff executable documentation
1 parent 4cafd2d commit a0b3fa9

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,21 @@ Use the `--tail` option followed by an integer for the number of lines at the en
153153
$ fdiff --tail 20 [PRE-FONT FILE PATH] [POST-FONT FILE PATH]
154154
```
155155

156+
#### Use an external diff tool <img src="https://img.shields.io/badge/beta-feature-orange" />
157+
158+
**Please Note**: This feature has not been tested across all supported platforms. Please report any issues that you come across on the project issue tracker.
159+
160+
By default, fdiff performs diffs with Python source. If you run into performance issues with this approach, you can use compiled diff executables that are available on your platform. fdiff will dump the ttx files and run the command that you provide on the command line passing the pre and post font ttx dump file paths as the first and second positional arguments to your command.
161+
162+
For example, you may run the `diff -u` command on GNU/Linux or macOS like this:
163+
164+
```
165+
$ fdiff --external
166+
```
167+
168+
fdiff supports external diff tool with colored formatting and OpenType table filtering. The context line, head, and tail options are not supported with the use of external diff tools.
169+
170+
156171
### Other Options
157172

158173
Use `fdiff -h` to view all available options.

0 commit comments

Comments
 (0)