Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the packdiff readme #21

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Update the packdiff readme #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"hidden modules" to be explicit.

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.
Loading