public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: "Max R. Carrara" <m.carrara@proxmox.com>
To: pve-devel@lists.proxmox.com
Cc: Wolfgang Bumiller <w.bumiller@proxmox.com>
Subject: [PATCH pve-storage v3 02/51] plugin, common: remove superfluous use of =pod command paragraph
Date: Tue, 17 Nov 2026 21:38:34 +0100	[thread overview]
Message-ID: <20261117203953.913035-3-m.carrara@proxmox.com> (raw)
In-Reply-To: <20261117203953.913035-1-m.carrara@proxmox.com>

Because a POD block may be started using any POD command
paragraph [1], using =pod here is not necessary. =head1 and =head3
(for example) already begin a POD block, so explicitly opening one
with =pod is not needed.

Therefore, remove these occurrences.

This has the benefit of making the docstrings take up a little less
space overall.

[1]: https://perldoc.perl.org/perlpodspec#Pod-Commands

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 src/PVE/Storage/Common.pm | 28 ----------------------------
 src/PVE/Storage/Plugin.pm |  6 ------
 2 files changed, 34 deletions(-)

diff --git a/src/PVE/Storage/Common.pm b/src/PVE/Storage/Common.pm
index cc3fa45d..aa3b5531 100644
--- a/src/PVE/Storage/Common.pm
+++ b/src/PVE/Storage/Common.pm
@@ -10,12 +10,10 @@ use PVE::Tools qw(run_command);
 use constant {
     FALLOC_FL_KEEP_SIZE => 0x01, # see linux/falloc.h
     FALLOC_FL_PUNCH_HOLE => 0x02, # see linux/falloc.h
 };
 
-=pod
-
 =head1 NAME
 
 PVE::Storage::Common - Shared functions and utilities for storage plugins and storage operations
 
 =head1 DESCRIPTION
@@ -73,12 +71,10 @@ PVE::JSONSchema::register_standard_option(
         enum => ['raw', 'qcow2', 'vmdk'],
         description => "Format of the image.",
     },
 );
 
-=pod
-
 =head1 VOLUME TYPES
 
 A volume that belongs to a guest has one of the following types. They are also content types that
 a storage can be restricted to.
 
@@ -111,32 +107,26 @@ my $GENERIC_VTYPE = {
     'vm-vol' => 'images',
     'vm-state' => 'images',
     'ct-vol' => 'rootdir',
 };
 
-=pod
-
 =head1 FUNCTIONS
 
 =cut
 
-=pod
-
 =head3 generic_vtype
 
     $generic = generic_vtype($vtype)
 
 Returns the generic type that includes the volume type C<$vtype>, or C<undef> if there is none.
 
 =cut
 
 sub generic_vtype : prototype($) ($vtype) {
     return $GENERIC_VTYPE->{$vtype};
 }
 
-=pod
-
 =head3 is_guest_vtype
 
     $is_guest_vtype = is_guest_vtype($vtype)
 
 Returns whether volumes of type C<$vtype> belong to a guest. These are the volume types of VMs and
@@ -147,12 +137,10 @@ an external plugin may report is not one of them, callers that support it check
 
 sub is_guest_vtype : prototype($) ($vtype) {
     return $vtype eq 'images' || defined($GENERIC_VTYPE->{$vtype});
 }
 
-=pod
-
 =head3 vtype_matches
 
     $matches = vtype_matches($vtype, $expected)
 
 Returns whether a volume of type C<$vtype> can be used where one of type C<$expected> is required.
@@ -167,12 +155,10 @@ sub vtype_matches : prototype($$) ($vtype, $expected) {
     return 1 if ($GENERIC_VTYPE->{$vtype} // '') eq $expected;
     return 1 if ($GENERIC_VTYPE->{$expected} // '') eq $vtype;
     return 0;
 }
 
-=pod
-
 =head3 content_allows
 
     $allowed = content_allows($content, $type)
 
 Returns whether the content types in the hash C<$content>, as found in a storage configuration,
@@ -187,12 +173,10 @@ sub content_allows : prototype($$) ($content, $type) {
     return 1 if defined($generic) && $content->{$generic};
     return 1 if grep { $GENERIC_VTYPE->{$_} eq $type && $content->{$_} } keys $GENERIC_VTYPE->%*;
     return 0;
 }
 
-=pod
-
 =head3 align_size_up
 
     $aligned_size = align_size_up($size, $granularity)
 
 Returns the next size bigger than or equal to C<$size> that is aligned with a
@@ -209,12 +193,10 @@ sub align_size_up : prototype($$) {
     print "size $size is not aligned to granularity $granularity, rounding up to $aligned_size\n"
         if $aligned_size != $size;
     return $aligned_size;
 }
 
-=pod
-
 =head3 deallocate
 
     deallocate($file_handle, $offset, $length)
 
 Deallocates the range with C<$length> many bytes starting from offset C<$offset>
@@ -254,12 +236,10 @@ my sub run_qemu_img_json {
         warn $err_output;
     }
     return $json;
 }
 
-=pod
-
 =head3 qemu_img_create
 
     qemu_img_create($fmt, $size, $path, $options)
 
 Create a new qemu image with a specific format C<$format> and size C<$size> KiB for a target
@@ -280,12 +260,10 @@ sub qemu_img_create {
     push @$cmd, '-f', $fmt, '--', $path, "${size}K";
 
     run_command($cmd, errmsg => "unable to create image");
 }
 
-=pod
-
 =head3 qemu_img_create_qcow2_backed
 
     qemu_img_create_qcow2_backed($path, $backing_path, $backing_format, $options)
 
 Create a new qemu qcow2 image C<$path> using an existing backing image C<$backing_path> with
@@ -313,12 +291,10 @@ sub qemu_img_create_qcow2_backed {
     push @$cmd, '--', $path;
 
     run_command($cmd, errmsg => "unable to create image");
 }
 
-=pod
-
 =head3 qemu_img_info
 
     qemu_img_info($filename, $file_format, $timeout, $follow_backing_files)
 
 Returns a json with qemu image C<$filename> information with format <$file_format>. If
@@ -336,12 +312,10 @@ sub qemu_img_info {
     push $cmd->@*, '--', $filename;
 
     return run_qemu_img_json($cmd, $timeout);
 }
 
-=pod
-
 =head3 qemu_img_measure
 
     qemu_img_measure($size, $fmt, $timeout, $options)
 
 Returns a json with the maximum size including all metadata overhead for an image with format
@@ -362,12 +336,10 @@ sub qemu_img_measure {
         push $cmd->@*, '-o', join(',', @$options) if @$options > 0;
     }
     return run_qemu_img_json($cmd, $timeout);
 }
 
-=pod
-
 =head3 qemu_img_resize
 
     qemu_img_resize($path, $format, $size, $preallocation, $timeout)
 
 Resize a qemu image C<$path> with format C<$format> to a target size C<$size> in bytes.
diff --git a/src/PVE/Storage/Plugin.pm b/src/PVE/Storage/Plugin.pm
index 1f1e1658..7eb8a244 100644
--- a/src/PVE/Storage/Plugin.pm
+++ b/src/PVE/Storage/Plugin.pm
@@ -2594,12 +2594,10 @@ sub rename_volume {
         || die "rename '$old_path' to '$new_path' failed - $!\n";
 
     return "${storeid}:${base}${target_vmid}/${target_volname}";
 }
 
-=pod
-
 =head3 rename_snapshot
 
     $plugin->rename_snapshot($scfg, $storeid, $volname, $source_snap, $target_snap)
 
 Rename a volume source snapshot C<$source_snap> to a target snapshot C<$target_snap>.
@@ -2645,12 +2643,10 @@ my sub blockdev_options_nbd_unix {
     $blockdev->{export} = "$export" if defined($export);
 
     return $blockdev;
 }
 
-=pod
-
 =head3 qemu_blockdev_options
 
     $blockdev =
         $plugin->qemu_blockdev_options($scfg, $storeid, $volname, $machine_version, $options)
 
@@ -2819,12 +2815,10 @@ sub new_backup_provider {
     my ($class, $scfg, $storeid, $log_function) = @_;
 
     die "implement me if enabling the feature 'backup-provider' in plugindata()->{features}\n";
 }
 
-=pod
-
 =head3 volume_qemu_snapshot_method
 
     $method = $plugin->volume_qemu_snapshot_method($storeid, $scfg, $volname);
 
 Returns a string with the type of snapshot that qemu can do for a specific volume
-- 
2.47.3





  parent reply	other threads:[~2026-11-17 20:40 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-17 20:38 [PATCH manager/storage v3 00/51] Fix #2884: Implement Subdirectory Scanning for Dir-Based Storage Types Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 01/51] test: plugin tests: run tests with at most 4 jobs Max R. Carrara
2026-11-17 20:38 ` Max R. Carrara [this message]
2026-11-17 20:38 ` [PATCH pve-storage v3 03/51] common: use Exporter module for PVE::Storage::Common Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 04/51] plugin: make get_subdir_files a proper subroutine and update style Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 05/51] plugin api: replace subdir helper methods with standalone functions Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 06/51] common: prevent autovivification in plugin_get_vtype_subdir helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 07/51] plugin: break up if-elsif chain into separate if-blocks Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 08/51] plugin: adapt get_subdir_files helper of list_volumes API method Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 09/51] plugin: update code style of list_volumes plugin " Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 10/51] plugin: use closure for obtaining raw volume data in list_volumes Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 11/51] plugin: use closure for inner loop logic " Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 12/51] storage: update code style in function path_to_volume_id Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 13/51] storage: break up if-elsif chain in path_to_volume_id Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 14/51] storage: heave vtype file path parsing logic inside loop into helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 15/51] storage: clean up code that was moved into helper in path_to_volume_id Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 16/51] api: status: move content type assert for up-/downloads into helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 17/51] api: status: use get_subdir helper method to get content directory Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 18/51] api: status: move up-/download file path parsing code into helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 19/51] api: status: simplify file content assertion logic for up-/download Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 20/51] test: guest import: add tests for PVE::GuestImport Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 21/51] tree-wide: introduce parsing module and replace usages of ISO_EXT_RE_0 Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 22/51] common: test: set up parser testing code, add tests for 'iso' vtype Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 23/51] tree-wide: replace usages of VZTMPL_EXT_RE_1 with parsing functions Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 24/51] tree-wide: replace usages of BACKUP_EXT_RE_2 " Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 25/51] tree-wide: replace usages of inline regexes for snippets with parsers Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 26/51] tree-wide: partially replace usages of regexes for 'import' vtype Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 27/51] tree-wide: replace remaining " Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 28/51] tree-wide: simplify recently refactored parsing logic Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 29/51] test: list volumes: reorganize and modernize test running code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 30/51] test: list volumes: fix broken test checking for vmlist modifications Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 31/51] test: list volumes: introduce new format for test cases Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 32/51] test: list volumes: remove legacy code and migrate cases to new format Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 33/51] plugin: do not return volumes of undeclared content types anymore Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 34/51] plugin: correct comment in get_subdir_files helper Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 35/51] test: parse volname: modernize code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 36/51] test: parse volname: adapt tests regarding 'import' volume type Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 37/51] test: parse volname: move VM disk test creation into separate block Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 38/51] test: parse volname: move backup file test creation into sep. block Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 39/51] test: parse volname: parameterize test case creation for some vtypes Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 40/51] test: volume id: modernize code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 41/51] test: volume id: rename 'volname' test case parameter to 'file' Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 42/51] test: filesystem path: modernize code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 43/51] plugin: list content directories without globbing Max R. Carrara
2026-11-18  9:12 ` [PATCH pve-storage v3 44/51] fix #2884: implement nested subdir scanning and support 'iso' vtype Max R. Carrara
2026-11-18  9:14 ` [PATCH pve-storage v3 45/51] fix #2884: support nested subdir scanning for 'vztmpl' volume type Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 46/51] fix #2884: support nested subdir scanning for 'snippets' vtype Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 47/51] test: add more tests for 'import' vtype & guard against nested subdirs Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 48/51] test: add tests guarding against subdir scanning for vtypes Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 49/51] storage: resolve images in content dir overrides ending with a slash Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 50/51] bump the storage plugin API version Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-manager v3 51/51] fix #2884: ui: storage: add field for 'max-scan-depth' property Max R. Carrara

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261117203953.913035-3-m.carrara@proxmox.com \
    --to=m.carrara@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=w.bumiller@proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal