From: Thomas Lamprecht <t.lamprecht@proxmox.com>
Date: Tue, 1 Oct 2019 15:20:21 +0000 (+0200)
Subject: followup: rename to print_snapshot_tree, add comment and rename $res param
X-Git-Url: https://git.proxmox.com/?p=pve-guest-common.git;a=commitdiff_plain;h=5ee5f8873ea494339fe7251b0a3e46d99d931c81

followup: rename to print_snapshot_tree, add comment and rename $res param

This was taken from a CLI helper, there $res is a common parameter
name which denotes that it's the res from the API call the CLI
command bases on. But here that makes no sense and is not really
telling about what the value(s) of $res could be. Further explain
that with a comment.

As this also prints uncoditionally to STDOUT let's say so through the
method name.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
---

diff --git a/PVE/GuestHelpers.pm b/PVE/GuestHelpers.pm
index 64e26c9..35059e6 100644
--- a/PVE/GuestHelpers.pm
+++ b/PVE/GuestHelpers.pm
@@ -62,13 +62,15 @@ sub exec_hookscript {
     }
 }
 
-sub snapshot_tree {
-    my ($res) = @_;
+# takes a snapshot list (e.g., qm/pct snapshot_list API call result) and
+# prints it out in a nice tree sorted by age. Can cope with multiple roots
+sub print_snapshot_tree {
+    my ($snapshot_list) = @_;
 
-    my $snapshots = { map { $_->{name} => $_ } @$res };
+    my $snapshots = { map { $_->{name} => $_ } @$snapshot_list };
 
     my @roots;
-    foreach my $e (@$res) {
+    foreach my $e (@$snapshot_list) {
 	my $parent;
 	if (($parent = $e->{parent}) && defined $snapshots->{$parent}) {
 	    push @{$snapshots->{$parent}->{children}}, $e->{name};