[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [PATCH v2 17/24] docs/man: fix xl(1) documentation for 'pci' operations
From: Paul Durrant <pdurrant@xxxxxxxxxx> Currently the documentation completely fails to mention the existence of PCI_SPEC_STRING. This patch tidies things up, specifically clarifying that 'pci-assignable-add/remove' take <BDF> arguments where as 'pci-attach/detach' take <PCI_SPEC_STRING> arguments (which will be enforced in a subsequent patch). Signed-off-by: Paul Durrant <pdurrant@xxxxxxxxxx> --- Cc: Ian Jackson <iwj@xxxxxxxxxxxxxx> Cc: Wei Liu <wl@xxxxxxx> --- docs/man/xl.1.pod.in | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/man/xl.1.pod.in b/docs/man/xl.1.pod.in index f92bacfa7277..c5fbce3b5c4b 100644 --- a/docs/man/xl.1.pod.in +++ b/docs/man/xl.1.pod.in @@ -1597,14 +1597,18 @@ List virtual network interfaces for a domain. =item B<pci-assignable-list> -List all the assignable PCI devices. +List all the B<BDF> of assignable PCI devices. See +L<xl-pci-configuration(5)> for more information. + These are devices in the system which are configured to be available for passthrough and are bound to a suitable PCI backend driver in domain 0 rather than a real driver. =item B<pci-assignable-add> I<BDF> -Make the device at PCI Bus/Device/Function BDF assignable to guests. +Make the device at B<BDF> assignable to guests. See +L<xl-pci-configuration(5)> for more information. + This will bind the device to the pciback driver and assign it to the "quarantine domain". If it is already bound to a driver, it will first be unbound, and the original driver stored so that it can be @@ -1620,8 +1624,10 @@ being used. =item B<pci-assignable-remove> [I<-r>] I<BDF> -Make the device at PCI Bus/Device/Function BDF not assignable to -guests. This will at least unbind the device from pciback, and +Make the device at B<BDF> not assignable to guests. See +L<xl-pci-configuration(5)> for more information. + +This will at least unbind the device from pciback, and re-assign it from the "quarantine domain" back to domain 0. If the -r option is specified, it will also attempt to re-bind the device to its original driver, making it usable by Domain 0 again. If the device is @@ -1637,15 +1643,15 @@ As always, this should only be done if you trust the guest, or are confident that the particular device you're re-assigning to dom0 will cancel all in-flight DMA on FLR. -=item B<pci-attach> I<domain-id> I<BDF> +=item B<pci-attach> I<domain-id> I<PCI_SPEC_STRING> -Hot-plug a new pass-through pci device to the specified domain. -B<BDF> is the PCI Bus/Device/Function of the physical device to pass-through. +Hot-plug a new pass-through pci device to the specified domain. See +L<xl-pci-configuration(5)> for more information. -=item B<pci-detach> [I<OPTIONS>] I<domain-id> I<BDF> +=item B<pci-detach> [I<OPTIONS>] I<domain-id> I<PCI_SPEC_STRING> -Hot-unplug a previously assigned pci device from a domain. B<BDF> is the PCI -Bus/Device/Function of the physical device to be removed from the guest domain. +Hot-unplug a pci device that was previously passed through to a domain. See +L<xl-pci-configuration(5)> for more information. B<OPTIONS> @@ -1660,7 +1666,7 @@ even without guest domain's collaboration. =item B<pci-list> I<domain-id> -List pass-through pci devices for a domain. +List the B<BDF> of pci devices passed through to a domain. =back -- 2.20.1
|
Lists.xenproject.org is hosted with RackSpace, monitoring our |