get_backup_volumes: clarifcation and indentation improvements to comment

Aaron clarified that one documented element actually slipped through
and won't be returned.

Also firx the mixed tab/space indentation, for such comments we can
be pretty liberal and I just went with the two spaces per level, as
some part already had that.

Clarify that both array and hash are refs.

[0]: https://pve.proxmox.com/pipermail/pve-devel/2020-March/042070.html

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2020-03-10 12:17:00 +01:00
parent b2a2affa3f
commit 1245ad854c

View File

@ -412,17 +412,15 @@ sub get_replicatable_volumes {
die "implement me - abstract method\n";
}
# Returns whether the guests volumes are included in a vzdump job
# Return Format:
# referenced array with hashes as elements:
# Returns all the guests volumes which would be included in a vzdump job
# Return Format (array-ref with hash-refs as elements):
# [
# {
# key, key in the config, e.g. mp0, scsi0,...
# included, boolean
# reason, string
# volume, volid / mountpoint
# data volume object as returned from foreach_drive/foreach_mountpoint
# },
# key, key in the config, e.g. mp0, scsi0,...
# included, boolean
# reason, string
# data volume object as returned from foreach_drive/foreach_mountpoint
# },
# ]
sub get_backup_volumes {
my ($class, $conf) = @_;