Skip to content

Commit

Permalink
Update the packdiff readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adithyaov committed Jul 26, 2024
1 parent c6f0f81 commit c12b9bf
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,21 @@
packdiff diff streamly-process rev1 streamly-process rev2
# packdiff

**Usage:**

```
packdiff diff <package-name> <rev1> <package-name> <rev2>
```

**Limitations:**

Packdiff uses the hoogle file created by haddock to generate and compare the
difference between multiple versions of a package

1. The API for modules in the `other-modules` sections is not generated or
compared.
2. The re-exported module is just considered a re-exported module. The API of
the re-exported module isn't merged with the module that re-exports it.

The 2nd limitation might end up falsely reporting a diff even if the diff does
not exist. In our use-case where we have manual intervention this isn't a
problem and does the job well.

0 comments on commit c12b9bf

Please sign in to comment.