Re: [pve-devel] [PATCH pve-docs v8 1/1] update the PCI(e) docs

[Thomas Lamprecht <t.lamprecht@proxmox.com>]

On 20/07/2023 10:09, Dominik Csapak wrote:
> On 6/26/23 14:41, Noel Ullreich wrote:
>> @@ -75,13 +93,15 @@ to the xref:sysboot_edit_kernel_cmdline[kernel commandline].
>>   .Kernel Modules
>>     You have to make sure the following modules are loaded. This can be achieved by
>> -adding them to `'/etc/modules''
>> +adding them to `'/etc/modules''. In kernels newer than 6.2 ({pve} 8 and onward)
>> +the 'vfio_virqfd' module is part of the 'vfio' module, therefore loading
>> +'vfio_virqfd' in {pve} 8 and newer is not necessary.
>>     ----
>>    vfio
>>    vfio_iommu_type1
>>    vfio_pci
>> - vfio_virqfd
>> + vfio_virqfd #not needed if on kernel 6.2 or newer
>>   ----
> 
> i'd add some comment (does such a thing exists in asciidoc?) or something
> so that we can remove that part with e.g. pve 9.x
> since thats only relevant as long as we're supporting 7.x

yes, can use // at start of line in asciidoc for comments, like:

// TODO: adapt/remove/... with Proxmox VE 9

You naturally need to position it outside of the code block though, else
it's verbatim text.

>>   # qm set VMID -hostpci0 02:00,device-id=0x10f6,sub-vendor-id=0x0000
>>   ----
>>   -
>> -Other considerations
>> -^^^^^^^^^^^^^^^^^^^^
>> -
>> -When passing through a GPU, the best compatibility is reached when using
>> -'q35' as machine type, 'OVMF' ('EFI' for VMs) instead of SeaBIOS and PCIe
>> -instead of PCI. Note that if you want to use 'OVMF' for GPU passthrough, the
>> -GPU needs to have an EFI capable ROM, otherwise use SeaBIOS instead.
>> -
>>   SR-IOV
>>   ~~~~~~
>>   -Another variant for passing through PCI(e) devices, is to use the hardware
>> +Another variant for passing through PCI(e) devices is to use the hardware
>>   virtualization features of your devices, if available.
>>   +{{Note | To use SR-IOV, platform support is especially important. It may be necessary
>> +to enable this feature in the BIOS/UEFI first, or to use a specific PCI(e) port
>> +for it to work. In doubt, consult the manual of the platform or contact its
>> +vendor.}}
> 
> this syntax does not work here with the html nor the pdf renderer, maybe
> some bad copy&paste ?

Yeah, this looks like mediawiki syntax,rather use the Asciidoc admonition
syntax, in a new paragraph:

NOTE: To use SR-IOV, platform support is especially important. ...

https://asciidoc-py.github.io/userguide.html#X28