[Documentation] Add compression level explanation and example #859

Merged
witten merged 2 commits from codimp/borgmatic:documentation-compression-level into main 2024-04-28 16:50:09 +00:00
1 changed files with 2 additions and 1 deletions

View File

@ -269,7 +269,8 @@ properties:
compression:
type: string
description: |
Type of compression to use when creating archives. See
Type of compression to use when creating archives. (Compression
codimp marked this conversation as resolved Outdated

Super minor nit: Would you mind making the parenthetical its own sentence? E.g. "Type of compression to use when creating archives. (Compression level can be blah blah blah.)"

Super minor nit: Would you mind making the parenthetical its own sentence? E.g. "Type of compression to use when creating archives. (Compression level can be blah blah blah.)"

Of course!

Of course!
level can be added separated with a comma, like "zstd,7".) See
http://borgbackup.readthedocs.io/en/stable/usage/create.html for
details. Defaults to "lz4".
example: lz4