Skip to content

Commit

Permalink
docs: add cow notes for the plain compress_method
Browse files Browse the repository at this point in the history
  • Loading branch information
Fallen-Breath committed Dec 20, 2023
1 parent 5f3e31c commit daa16d2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ The method to compress files stored in a backup

| Compress Method | Description | Speed | Compress rate |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|---------------|
| `plain` | No compression, copy the file directly | ★★★★★ ||
| `plain` | No compression, copy the file directly. Can utilize the copy-on-write technique if the file system supports that | ★★★★★ ||
| `gzip` | The [gzip](https://docs.python.org/3/library/gzip.html) library based on [zlib](https://www.zlib.net/). The format same as a `.gz` file | ★★ | ★★★★ |
| `lzma` | The [LZMA](https://docs.python.org/3/library/lzma.html) algorithm. The same format as a `.xz` file. Provides the best compression, but the speed is very slow || ★★★★★ |
| `zstd` | The [Zstandard](https://github.com/facebook/zstd) algorithm. A good balance between speed and compression rate. Recommend to use | ★★★☆ | ★★★★ |
Expand Down
2 changes: 1 addition & 1 deletion docs/config.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ Prime Backup 除了会保存 `world` 这个符号链接外,还会保存 `foo`

| 压缩方法 | 描述 | 速度 | 压缩率 |
|---------|-------------------------------------------------------------------------------------------------------|-------|-------|
| `plain` | 无压缩,直接复制 | ★★★★★ ||
| `plain` | 无压缩,直接复制。若文件系统支持,将使用写时复制技术进行文件复制 | ★★★★★ ||
| `gzip` | 基于 [zlib](https://www.zlib.net/)[gzip](https://docs.python.org/3/library/gzip.html) 库。`.gz` 文件同款格式 | ★★ | ★★★★ |
| `lzma` | [LZMA](https://docs.python.org/3/library/lzma.html) 算法。`.xz` 文件同款格式。提供最佳的压缩率,但是速度非常慢 || ★★★★★ |
| `zstd` | [Zstandard](https://github.com/facebook/zstd) 算法。一个优秀的压缩算法,在速度和压缩率间取得了较好的平衡。推荐使用 | ★★★☆ | ★★★★ |
Expand Down

0 comments on commit daa16d2

Please sign in to comment.