Skip to content

docs(batch): investigate zstd as batch-compatible compression alternative (#1685)#3492

Merged
oferchen merged 2 commits into
masterfrom
docs/zstd-batch-compatibility-1685
May 1, 2026
Merged

docs(batch): investigate zstd as batch-compatible compression alternative (#1685)#3492
oferchen merged 2 commits into
masterfrom
docs/zstd-batch-compatibility-1685

Conversation

@oferchen
Copy link
Copy Markdown
Owner

@oferchen oferchen commented May 1, 2026

Summary

  • Adds docs/audits/zstd-batch-compatibility.md
  • Conclusion: zstd works for self-hosted batch round-trips but not for upstream interop, since the batch header records only the do_compression bit without naming the algorithm
  • Recommends keeping zlib as the default for --compress + --write-batch

Closes #1685.

Test plan

  • Documentation-only change; no code paths affected
  • Markdown renders cleanly

…tive (#1685)

Documents whether zstd can serve as a batch-compatible compression
alternative for `--write-batch` and `--read-batch`. Conclusion:
self-hosted batch round-trips work, cross-tool interop with upstream
does not (batch header records only `do_compression` bit, not the
algorithm name, so a zstd batch would be mis-decoded by upstream rsync).

Salvaged from worktree branch docs/zstd-batch-compatibility-audit.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 1, 2026
@oferchen oferchen merged commit 4ef05a7 into master May 1, 2026
4 checks passed
@oferchen oferchen deleted the docs/zstd-batch-compatibility-1685 branch May 1, 2026 21:09
oferchen added a commit that referenced this pull request May 5, 2026
…tive (#1685) (#3492)

Documents whether zstd can serve as a batch-compatible compression
alternative for `--write-batch` and `--read-batch`. Conclusion:
self-hosted batch round-trips work, cross-tool interop with upstream
does not (batch header records only `do_compression` bit, not the
algorithm name, so a zstd batch would be mis-decoded by upstream rsync).

Salvaged from worktree branch docs/zstd-batch-compatibility-audit.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant