docs: link to PCI docs from the kbase page

[libvirt PATCH] docs: link to PCI docs from the kbase page

Daniel P. Berrangé posted 1 patch 3 years, 2 months ago

Download mbox

Test syntax-check failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20210122170811.3522139-1-berrange@redhat.com

docs/kbase/index.rst | 6 ++++++
1 file changed, 6 insertions(+)

Expand all Fold all

[libvirt PATCH] docs: link to PCI docs from the kbase page

Posted by Daniel P. Berrangé 3 years, 2 months ago

While the PCI docs are linked from formatdomain.html, finding those
links is not straightforward. It is good for users to highlight them in
the kbase pages.  The PCI docs are intentionally not moved to the kbase/
sub-directory in order to avoid breaking hyperlinks.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/kbase/index.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/kbase/index.rst b/docs/kbase/index.rst
index 1494be1e77..83b9bb7200 100644
--- a/docs/kbase/index.rst
+++ b/docs/kbase/index.rst
@@ -40,6 +40,12 @@ Usage
 `KVM real time <kvm-realtime.html>`__
    Run real time workloads in guests on a KVM hypervisor
 
+`PCI hotplug <../pci-hotplug.html>`__
+   Effectively usage of PCI hotplug
+
+`PCI topology <../pci-addresses.html>`__
+   Addressing schemes for PCI devices
+
 Internals / Debugging
 ---------------------
 
-- 
2.29.2

Re: [libvirt PATCH] docs: link to PCI docs from the kbase page

Posted by Andrea Bolognani 3 years, 2 months ago

On Fri, 2021-01-22 at 17:08 +0000, Daniel P. Berrangé wrote:
> +`PCI hotplug <../pci-hotplug.html>`__
> +   Effectively usage of PCI hotplug

s/Effectively/Effective/

With that fixed

  Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization