Re: [PATCH docs v3 1/1] examples: add new hookscript phase to example hookscript

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

Am 27.02.26 um 1:07 PM schrieb Dominik Csapak:
> qemu-server has a new phase 'post-pci-prepare' that is called for vms
> with pci passthrough for each device prepared.
> 
> add that to the example hookscript and explain when it's called and it's

The second "it's" should be "its"

> parameters with a comment.
> 
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
>  examples/guest-example-hookscript.pl | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/examples/guest-example-hookscript.pl b/examples/guest-example-hookscript.pl
> index 1cce2e3..da14fd1 100755
> --- a/examples/guest-example-hookscript.pl
> +++ b/examples/guest-example-hookscript.pl
> @@ -38,6 +38,31 @@ if ($phase eq 'pre-start') {
>  
>      print "$vmid started successfully.\n";
>  
> +} elsif ($phase eq 'post-pci-prepare') {
> +
> +    # Only called for virtual machines, not containers.
> +    #
> +    # This phase will be called for each pci device that is passed through,
> +    # after it was prepared by the PVE stack. In other words when either

Nit: please use "Proxmox VE" rather than "PVE" for user-facing text

> +    # * the mdev/vGPU was created
> +    # * the driver was changed to vfio-pci and the device was reset
> +    #
> +    # This phase has 3 additional parameters given via the environment
> +
> +    # the id from the config, e.g. 'hostpci0'
> +    my $hostpci_x = $ENV{PVE_HOOK_ID};
> +
> +    # the pciid of the passed through device or the underlying device in case of an mdev/vGPU
> +    # e.g. '0000:01:00.0'
> +    my $pciid = $ENV{PVE_HOOK_PCIID};
> +
> +    # the uuid of the mediated device if it was one,
> +    # e.g. '00000001-0000-0000-0000-000000008006'
> +    my $mdev_uuid = $ENV{PVE_HOOK_MDEV_UUID};
> +
> +    print "Prepared PCI device for $hostpci_x with pciid: $pciid.\n";
> +    print "It is a mediated device with UUID: $mdev_uuid\n" if $mdev_uuid;

Nit: maybe mention one of the actual use cases in a comment?

> +
>  } elsif ($phase eq 'pre-stop') {
>  
>      # Third phase 'pre-stop' will be executed before stopping the guest