[pve-devel] [PATCH storage v2 1/4] rename comment to notes

[Dominik Csapak]

so that we are more consistent with pbs

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 PVE/API2/Storage/Content.pm |  4 ++--
 PVE/Storage/PBSPlugin.pm    |  2 +-
 PVE/Storage/Plugin.pm       | 10 +++++-----
 3 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/PVE/API2/Storage/Content.pm b/PVE/API2/Storage/Content.pm
index 8d2ff32..d4e2392 100644
--- a/PVE/API2/Storage/Content.pm
+++ b/PVE/API2/Storage/Content.pm
@@ -87,8 +87,8 @@ __PACKAGE__->register_method ({
 		    minimum => 0,
 		    optional => 1,
 		},
-		comment => {
-		    description => "An optional Comment.",
+		notes => {
+		    description => "Optional notes. If they contain multiple lines, only the first one is returned here.",
 		    type => 'string',
 		    optional => 1,
 		},
diff --git a/PVE/Storage/PBSPlugin.pm b/PVE/Storage/PBSPlugin.pm
index ef9bc79..fbffbdf 100644
--- a/PVE/Storage/PBSPlugin.pm
+++ b/PVE/Storage/PBSPlugin.pm
@@ -544,7 +544,7 @@ sub list_volumes {
 	};
 
 	$info->{verification} = $item->{verification} if defined($item->{verification});
-	$info->{comment} = $item->{comment} if defined($item->{comment});
+	$info->{notes} = $item->{comment} if defined($item->{comment});
 
 	push @$res, $info;
     }
diff --git a/PVE/Storage/Plugin.pm b/PVE/Storage/Plugin.pm
index c60d84b..1c86666 100644
--- a/PVE/Storage/Plugin.pm
+++ b/PVE/Storage/Plugin.pm
@@ -19,7 +19,7 @@ use base qw(PVE::SectionConfig);
 
 use constant COMPRESSOR_RE => 'gz|lzo|zst';
 
-use constant COMMENT_EXT => ".comment";
+use constant NOTES_EXT => ".notes";
 
 our @COMMON_TAR_FLAGS = qw(
     --one-file-system
@@ -1035,10 +1035,10 @@ my $get_subdir_files = sub {
 		$info->{vmid} = $vmid // $1;
 	    }
 
-	    my $comment_fn = $original.COMMENT_EXT;
-	    if (-f $comment_fn) {
-		my $comment = PVE::Tools::file_read_firstline($comment_fn);
-		$info->{comment} = $comment if defined($comment);
+	    my $notes_fn = $original.NOTES_EXT;
+	    if (-f $notes_fn) {
+		my $notes = PVE::Tools::file_read_firstline($notes_fn);
+		$info->{notes} = $notes if defined($notes);
 	    }
 
 	} elsif ($tt eq 'snippets') {
-- 
2.20.1