Skip to content

Commit

Permalink
Clarify that .sz refers to Google's Snappy format
Browse files Browse the repository at this point in the history
It needs to be disambiguated from the unfortunately named
SZ compression, see https://szcompressor.org/.

Fixes #563
  • Loading branch information
ilyagr authored and marcospb19 committed Dec 5, 2023
1 parent e09d82e commit 9f82c9a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Output:

# Supported formats

| Format | `.tar` | `.zip` | `.gz` | `.xz`, `.lzma` | `.bz`, `.bz2` | `.lz4` | `.sz` | `.zst` |
| Format | `.tar` | `.zip` | `.gz` | `.xz`, `.lzma` | `.bz`, `.bz2` | `.lz4` | `.sz` (Snappy) | `.zst` |
|:---------:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| Supported || ✓¹ | ✓² |||| ✓² ||

Expand Down
2 changes: 1 addition & 1 deletion src/cli/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use clap::{Parser, ValueHint};
// Ouch command line options (docstrings below are part of --help)
/// A command-line utility for easily compressing and decompressing files and directories.
///
/// Supported formats: tar, zip, gz, xz/lzma, bz/bz2, lz4, sz, zst.
/// Supported formats: tar, zip, gz, xz/lzma, bz/bz2, lz4, sz (Snappy), zst.
///
/// Repository: https://github.com/ouch-org/ouch
#[derive(Parser, Debug, PartialEq)]
Expand Down
2 changes: 1 addition & 1 deletion tests/snapshots/ui__ui_test_usage_help_flag.snap
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ expression: "output_to_string(ouch!(\"--help\"))"
---
A command-line utility for easily compressing and decompressing files and directories.

Supported formats: tar, zip, gz, xz/lzma, bz/bz2, lz4, sz, zst.
Supported formats: tar, zip, gz, xz/lzma, bz/bz2, lz4, sz (Snappy), zst.

Repository: https://github.com/ouch-org/ouch

Expand Down

0 comments on commit 9f82c9a

Please sign in to comment.