[pve-devel] [PATCH docs 1/2] remove 4th section and fix typos

Dominik Csapak d.csapak at proxmox.com
Tue Nov 13 16:04:38 CET 2018


On 11/13/18 3:25 PM, Thomas Lamprecht wrote:
> On 11/13/18 3:18 PM, Dominik Csapak wrote:
>> manpages cannot have a 4th section, replace them with
>> titles
> 
> could we do such a thing automatically in our perl tooling? We now the (target)
> environment so this should be dooable, I'd guess?

possibly, i know too little about our asciidoc wrappers to do it
and since we only used the 4th section here, i thought it was
easier to just change it

looks the same (or at least very similar) to me in html/pdf
and works in the manpage

> 
>>
>> Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
>> ---
>>   qm-pci-passthrough.adoc | 17 +++++++----------
>>   1 file changed, 7 insertions(+), 10 deletions(-)
>>
>> diff --git a/qm-pci-passthrough.adoc b/qm-pci-passthrough.adoc
>> index b85bfb6..6a70469 100644
>> --- a/qm-pci-passthrough.adoc
>> +++ b/qm-pci-passthrough.adoc
>> @@ -40,11 +40,10 @@ Once you ensured that your hardware supports passthrough, you will need to do
>>   some configuration to enable PCI(e) passthrough.
>>   
>>   
>> -IOMMU
>> -+++++
>> +.IOMMU
>>   
>>   The IOMMU has to be activated on the kernel commandline. The easiest way is to
>> -enable trough grub. Edit `'/etc/default/grub'' and add the following to th
>> +enable trough grub. Edit `'/etc/default/grub'' and add the following to the
>>   'GRUB_CMDLINE_LINUX_DEFAULT' variable:
>>   
>>   * for Intel CPUs:
>> @@ -58,14 +57,14 @@ enable trough grub. Edit `'/etc/default/grub'' and add the following to th
>>    amd_iommu=on
>>   ----
>>   
>> +[[qm_pci_passthrough_update_grub]]
>>   To bring this change in effect, make sure you run:
>>   
>>   ----
>>   # update-grub
>>   ----
>>   
>> -Kernel Modules
>> -++++++++++++++
>> +.Kernel Modules
>>   
>>   You have to make sure the following modules are loaded. This can be achieved by
>>   adding them to `'/etc/modules''
>> @@ -85,8 +84,7 @@ After changing anything modules related, you need to refresh your
>>   # update-initramfs -u -k all
>>   ----
>>   
>> -Finish Configuration
>> -++++++++++++++++++++
>> +.Finish Configuration
>>   
>>   Finally reboot to bring the changes into effect and check that it is indeed
>>   enabled.
>> @@ -198,8 +196,7 @@ Some PCI(e) devices need this disabled.
>>   * *romfile=<path>*, is an optional path to a ROM file for the device to use.
>>   This is a relative path under */usr/share/kvm/*.
>>   
>> -Example
>> -+++++++
>> +.Example
>>   
>>   An example of PCIe passthrough with a GPU set to primary:
>>   
>> @@ -261,7 +258,7 @@ the fly. For example, to setup 4 VFs on device 0000:01:00.0 execute:
>>   ----
>>   +
>>   To make this change persistent you can use the `sysfsutils` Debian package.
>> -After installation configure it via */etc/sysfs.conf* or a `FILE.conf' inf
>> +After installation configure it via */etc/sysfs.conf* or a `FILE.conf' in
>>   */etc/sysfs.d/*.
>>   
>>   VM Configuration
>>
> 





More information about the pve-devel mailing list