Re: [pve-devel] [RFC qemu-server 2/9] cfg2cmd: improve error message for invalid volume storage content type

[Fiona Ebner <f.ebner@proxmox.com>]

Am 22.01.25 um 14:16 schrieb Daniel Kral:
> Thank you very much for taking a look over this!
> 
> Sorry for taking such a long time for getting back to you on this, I'll
> rework this patch series for a v2 now.
> 
> On 11/29/24 15:23, Fiona Ebner wrote:
>> Am 16.09.24 um 18:38 schrieb Daniel Kral:
>>> diff --git a/PVE/QemuServer/Helpers.pm b/PVE/QemuServer/Helpers.pm
>>> index 0afb6317..9d0f24aa 100644
>>> --- a/PVE/QemuServer/Helpers.pm
>>> +++ b/PVE/QemuServer/Helpers.pm
>>> @@ -106,6 +106,51 @@ sub vm_running_locally {
>>>       return;
>>>   }
>>>   +=head3 check_storage_content_type($storecfg, $storeid [,
>>> $content_type])
>>
>> Usually, "assert_" rather than "check_" is used for such helpers that
>> die upon failing the check, so maybe "assert_content_type_supported"
>>
>> Nit: there is no blank line below the header when viewed with perldoc
> 
> Hm, I'm sure it's possible but a quick glance over some other perldocs
> showed me that other perldocs don't seem to add a blank line below the
> function signature either (I looked at `AnyEvent::HTTP` and
> `Archive::Cpio` specifically, but they also seem to not follow the
> `head3` as we do).
> 
> Do you have a reference that I can see how documentation should be
> formatted?
> 

We do not have a reference except what Max was working on, but that is
an RFC, see "Perl Documentation" in the internal wiki. But I suppose
it's fine without a blank, we already went with this for e.g.
Storage/Common.pm


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel