[pve-devel] [PATCH docs] vzdump: fleecing: rephrase manual vzdump example

[Fiona Ebner]

Am 11.07.24 um 13:11 schrieb Aaron Lauterer:
> Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
> ---
> @fiona please let me know if this works and doesn't introduce wrong
> infos.
> I think this way the sentence represents better what is happening, as
> it is not enabling it, but running that particular backup with fleecing.
> 
> I am also thinking of placing the actual command of this and the now
> applied change detection mode into a code block instead of having them
> inline.
> 

Fine by me :)

>  vzdump.adoc | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/vzdump.adoc b/vzdump.adoc
> index 415742e..10dff9e 100644
> --- a/vzdump.adoc
> +++ b/vzdump.adoc
> @@ -149,11 +149,11 @@ With backup fleecing, such old data is cached in a fleecing image rather than
>  sent directly to the backup target. This can help guest IO performance and even
>  prevent hangs in certain scenarios, at the cost of requiring more storage space.
>  
> -Use e.g. `vzdump 123 --fleecing enabled=1,storage=local-lvm` to enable backup
> -fleecing, with fleecing images created on the storage `local-lvm`. As always,
> -you can set the option for specific backup jobs, or as a node-wide fallback via
> -the xref:vzdump_configuration[configuration options]. In the UI, fleecing can be
> -configured in the 'Advanced' tab when editing a backup job.
> +To manually run a backup of guest `123` with fleecing images created on the

Fleecing is only supported for VMs, so I don't like the use of 'guest'
here, let's use 'VM' instead.

> +storage `local-lvm`, run `vzdump 123 --fleecing enabled=1,storage=local-lvm`. As

The duplicate 'run' in the sentence can be fine, but maybe having the
first 'run' be 'start' instead reads slightly nicer?

> +always, you can set the option for specific backup jobs, or as a node-wide
> +fallback via the xref:vzdump_configuration[configuration options]. In the UI,
> + fleecing can be configured in the 'Advanced' tab when editing a backup job.
>  
>  The fleecing storage should be a fast local storage, with thin provisioning and
>  discard support. Examples are LVM-thin, RBD, ZFS with `sparse 1` in the storage