Skip to content

Clarify supported delta patch format #72

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

Draft
s3cody wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Clarify supported delta patch format #72

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
2 changes: 2 additions & 0 deletions docs/packaging/deltas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ If you don't have the latest local release, eg. you're running in CI, you can us

Delta packages use [Zstandard](https://github.com/facebook/zstd) to create binary patches of individual files in your package. Due to limitations of Zstandard, no single file can be bigger than 2 GB.

Zstandard (`.zsdiff`) is the only supported non-empty patch format. If Velopack cannot create a Zstandard patch, delta generation fails instead of producing a delta that clients cannot apply. Legacy `.bsdiff` and MSDelta patches are not supported and fail during patching with an `Unsupported patch format` error; publish a full package or regenerate the delta with a current version of `vpk`.

## Optimising for size
The default parameters picked for patch generation are to provide a good balance of size and speed.
If you would like to optimize for size, you can do this with the `--delta BestSize` argument.
Expand Down