[PATCH] docs: Fix broken links

Han Han posted 1 patch 6 months ago
Failed in applying to current master (apply log)
docs/apps.rst                          | 10 ++--------
docs/kbase/live_full_disk_backup.rst   |  2 +-
docs/manpages/virt-sanlock-cleanup.rst |  2 +-
docs/manpages/virtinterfaced.rst       |  1 -
docs/manpages/virtnetworkd.rst         |  1 -
docs/manpages/virtnwfilterd.rst        |  1 -
docs/manpages/virtstoraged.rst         |  2 +-
docs/manpages/virtvzd.rst              |  2 +-
docs/windows.rst                       |  2 +-
9 files changed, 7 insertions(+), 16 deletions(-)
[PATCH] docs: Fix broken links
Posted by Han Han 6 months ago
For the links of drvinterface, drvnetwork, drvnwfilter, and Nagios-virt,
there are no alternative docs. Just remove them directly.

Signed-off-by: Han Han <hhan@redhat.com>
---
 docs/apps.rst                          | 10 ++--------
 docs/kbase/live_full_disk_backup.rst   |  2 +-
 docs/manpages/virt-sanlock-cleanup.rst |  2 +-
 docs/manpages/virtinterfaced.rst       |  1 -
 docs/manpages/virtnetworkd.rst         |  1 -
 docs/manpages/virtnwfilterd.rst        |  1 -
 docs/manpages/virtstoraged.rst         |  2 +-
 docs/manpages/virtvzd.rst              |  2 +-
 docs/windows.rst                       |  2 +-
 9 files changed, 7 insertions(+), 16 deletions(-)

diff --git a/docs/apps.rst b/docs/apps.rst
index b7d19e15d5..443c888c4d 100644
--- a/docs/apps.rst
+++ b/docs/apps.rst
@@ -35,7 +35,7 @@ virsh
    machine to be cloned to form a new virtual machine. It automates
    copying of data across to new disk images, and updates the UUID, MAC
    address, and name in the configuration.
-`virt-df <https://people.redhat.com/rjones/virt-df/>`__
+`virt-df <https://libguestfs.org/virt-df.1.html>`__
    Examine the utilization of each filesystem in a virtual machine from
    the comfort of the host machine. This tool peeks into the guest disks
    and determines how much space is used. It can cope with common Linux
@@ -235,13 +235,7 @@ Monitoring
    The plugins provided by Guido Günther allow to monitor various things
    like network and block I/O with
    `Munin <https://munin-monitoring.org/>`__.
-`Nagios-virt <https://people.redhat.com/rjones/nagios-virt/>`__
-   Nagios-virt is a configuration tool to add monitoring of your
-   virtualised domains to `Nagios <https://www.nagios.org/>`__. You can
-   use this tool to either set up a new Nagios installation for your Xen
-   or QEMU/KVM guests, or to integrate with your existing Nagios
-   installation.
-`PCP <https://pcp.io/man/man1/pmdalibvirt.1.html>`__
+`PCP <https://man7.org/linux/man-pages/man1/pmdalibvirt.1.html>`__
    The PCP libvirt PMDA (plugin) is part of the
    `PCP <https://pcp.io/>`__ toolkit and provides hypervisor and guest
    information and complete set of guest performance metrics. It
diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_disk_backup.rst
index 562a9e87b0..f20169e314 100644
--- a/docs/kbase/live_full_disk_backup.rst
+++ b/docs/kbase/live_full_disk_backup.rst
@@ -12,7 +12,7 @@ space requirements.  The following outlines an efficient method to do
 that using libvirt's APIs.  This method involves concepts: the notion of
 `backing chains <https://libvirt.org/kbase/backing_chains.html>`_,
 `QCOW2 overlays
-<https://qemu.readthedocs.io/en/latest/interop/live-block-operations.html#disk-image-backing-chain-notation>`_,
+<https://www.qemu.org/docs/master/interop/live-block-operations.html#disk-image-backing-chain-notation>`_,
 and a special operation called "active block-commit", which allows
 live-merging an overlay disk image into its backing file.
 
diff --git a/docs/manpages/virt-sanlock-cleanup.rst b/docs/manpages/virt-sanlock-cleanup.rst
index 3ad70ce683..bf3ef6742b 100644
--- a/docs/manpages/virt-sanlock-cleanup.rst
+++ b/docs/manpages/virt-sanlock-cleanup.rst
@@ -75,5 +75,5 @@ PURPOSE
 SEE ALSO
 ========
 
-virsh(1), `online instructions <https://libvirt.org/locking.html>`_,
+virsh(1), `online instructions <https://libvirt.org/kbase/locking.html>`_,
 `https://libvirt.org/ <https://libvirt.org/>`_
diff --git a/docs/manpages/virtinterfaced.rst b/docs/manpages/virtinterfaced.rst
index 247a8c4009..ef63f4c278 100644
--- a/docs/manpages/virtinterfaced.rst
+++ b/docs/manpages/virtinterfaced.rst
@@ -211,4 +211,3 @@ SEE ALSO
 
 virsh(1), libvirtd(8),
 `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
-`https://libvirt.org/drvinterface.html <https://libvirt.org/drvinterface.html>`_
diff --git a/docs/manpages/virtnetworkd.rst b/docs/manpages/virtnetworkd.rst
index 22b3fc0f2d..3bd1dd3221 100644
--- a/docs/manpages/virtnetworkd.rst
+++ b/docs/manpages/virtnetworkd.rst
@@ -211,4 +211,3 @@ SEE ALSO
 
 virsh(1), libvirtd(8),
 `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
-`https://libvirt.org/drvnetwork.html <https://libvirt.org/drvnetwork.html>`_
diff --git a/docs/manpages/virtnwfilterd.rst b/docs/manpages/virtnwfilterd.rst
index b1fc45e7a2..1ec11c247f 100644
--- a/docs/manpages/virtnwfilterd.rst
+++ b/docs/manpages/virtnwfilterd.rst
@@ -211,4 +211,3 @@ SEE ALSO
 
 virsh(1), libvirtd(8),
 `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
-`https://libvirt.org/drvnwfilter.html <https://libvirt.org/drvnwfilter.html>`_
diff --git a/docs/manpages/virtstoraged.rst b/docs/manpages/virtstoraged.rst
index 70863282d1..fe966f3123 100644
--- a/docs/manpages/virtstoraged.rst
+++ b/docs/manpages/virtstoraged.rst
@@ -211,4 +211,4 @@ SEE ALSO
 
 virsh(1), libvirtd(8),
 `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
-`https://libvirt.org/drvstorage.html <https://libvirt.org/drvstorage.html>`_
+`https://libvirt.org/storage.html <https://libvirt.org/drvstorage.html>`_
diff --git a/docs/manpages/virtvzd.rst b/docs/manpages/virtvzd.rst
index aa44885d46..52aac2259c 100644
--- a/docs/manpages/virtvzd.rst
+++ b/docs/manpages/virtvzd.rst
@@ -211,4 +211,4 @@ SEE ALSO
 
 virsh(1), libvirtd(8),
 `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
-`https://libvirt.org/drvvz.html <https://libvirt.org/drvvz.html>`_
+`https://libvirt.org/drvopenvz.html <https://libvirt.org/drvopenvz.html>`_
diff --git a/docs/windows.rst b/docs/windows.rst
index b9aa5626cf..ee3caef41a 100644
--- a/docs/windows.rst
+++ b/docs/windows.rst
@@ -13,7 +13,7 @@ Installation packages
 
 Users who need pre-built Windows DLLs of libvirt are advised to use the `Virt
 Viewer <https://virt-manager.org>`__ pre-compiled `Windows MSI
-packages <https://virt-manager.org/download/>`__
+packages <https://virt-manager.org/download.html>`__
 
 These installers include the libvirt, gtk-vnc and spice-gtk DLLs along with any
 of their pre-requisite supporting DLLs, the virsh command line tool and the
-- 
2.45.1
Re: [PATCH] docs: Fix broken links
Posted by Michal Prívozník 6 months ago
On 5/21/24 11:07, Han Han wrote:
> For the links of drvinterface, drvnetwork, drvnwfilter, and Nagios-virt,
> there are no alternative docs. Just remove them directly.
> 
> Signed-off-by: Han Han <hhan@redhat.com>
> ---
>  docs/apps.rst                          | 10 ++--------
>  docs/kbase/live_full_disk_backup.rst   |  2 +-
>  docs/manpages/virt-sanlock-cleanup.rst |  2 +-
>  docs/manpages/virtinterfaced.rst       |  1 -
>  docs/manpages/virtnetworkd.rst         |  1 -
>  docs/manpages/virtnwfilterd.rst        |  1 -
>  docs/manpages/virtstoraged.rst         |  2 +-
>  docs/manpages/virtvzd.rst              |  2 +-
>  docs/windows.rst                       |  2 +-
>  9 files changed, 7 insertions(+), 16 deletions(-)
> 

> diff --git a/docs/manpages/virtstoraged.rst b/docs/manpages/virtstoraged.rst
> index 70863282d1..fe966f3123 100644
> --- a/docs/manpages/virtstoraged.rst
> +++ b/docs/manpages/virtstoraged.rst
> @@ -211,4 +211,4 @@ SEE ALSO
>  
>  virsh(1), libvirtd(8),
>  `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
> -`https://libvirt.org/drvstorage.html <https://libvirt.org/drvstorage.html>`_
> +`https://libvirt.org/storage.html <https://libvirt.org/drvstorage.html>`_

s/drvstorage/storage/


Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

and merged. Thanks!

Michal
Re: [PATCH] docs: Fix broken links
Posted by Han Han 6 months ago
@Richard Jones <rjones@redhat.com> Hi Richard,
I cannot find the valid link for Nagios-virt. However, I saw your ID in the
broken link for Nagios-virt.
Could you help provide the new link for Nagios-virt?

On Tue, May 21, 2024 at 5:08 PM Han Han <hhan@redhat.com> wrote:

> For the links of drvinterface, drvnetwork, drvnwfilter, and Nagios-virt,
> there are no alternative docs. Just remove them directly.
>
> Signed-off-by: Han Han <hhan@redhat.com>
> ---
>  docs/apps.rst                          | 10 ++--------
>  docs/kbase/live_full_disk_backup.rst   |  2 +-
>  docs/manpages/virt-sanlock-cleanup.rst |  2 +-
>  docs/manpages/virtinterfaced.rst       |  1 -
>  docs/manpages/virtnetworkd.rst         |  1 -
>  docs/manpages/virtnwfilterd.rst        |  1 -
>  docs/manpages/virtstoraged.rst         |  2 +-
>  docs/manpages/virtvzd.rst              |  2 +-
>  docs/windows.rst                       |  2 +-
>  9 files changed, 7 insertions(+), 16 deletions(-)
>
> diff --git a/docs/apps.rst b/docs/apps.rst
> index b7d19e15d5..443c888c4d 100644
> --- a/docs/apps.rst
> +++ b/docs/apps.rst
> @@ -35,7 +35,7 @@ virsh
>     machine to be cloned to form a new virtual machine. It automates
>     copying of data across to new disk images, and updates the UUID, MAC
>     address, and name in the configuration.
> -`virt-df <https://people.redhat.com/rjones/virt-df/>`__
> +`virt-df <https://libguestfs.org/virt-df.1.html>`__
>     Examine the utilization of each filesystem in a virtual machine from
>     the comfort of the host machine. This tool peeks into the guest disks
>     and determines how much space is used. It can cope with common Linux
> @@ -235,13 +235,7 @@ Monitoring
>     The plugins provided by Guido Günther allow to monitor various things
>     like network and block I/O with
>     `Munin <https://munin-monitoring.org/>`__.
> -`Nagios-virt <https://people.redhat.com/rjones/nagios-virt/>`__
> -   Nagios-virt is a configuration tool to add monitoring of your
> -   virtualised domains to `Nagios <https://www.nagios.org/>`__. You can
> -   use this tool to either set up a new Nagios installation for your Xen
> -   or QEMU/KVM guests, or to integrate with your existing Nagios
> -   installation.
> -`PCP <https://pcp.io/man/man1/pmdalibvirt.1.html>`__
> +`PCP <https://man7.org/linux/man-pages/man1/pmdalibvirt.1.html>`__
>     The PCP libvirt PMDA (plugin) is part of the
>     `PCP <https://pcp.io/>`__ toolkit and provides hypervisor and guest
>     information and complete set of guest performance metrics. It
> diff --git a/docs/kbase/live_full_disk_backup.rst
> b/docs/kbase/live_full_disk_backup.rst
> index 562a9e87b0..f20169e314 100644
> --- a/docs/kbase/live_full_disk_backup.rst
> +++ b/docs/kbase/live_full_disk_backup.rst
> @@ -12,7 +12,7 @@ space requirements.  The following outlines an efficient
> method to do
>  that using libvirt's APIs.  This method involves concepts: the notion of
>  `backing chains <https://libvirt.org/kbase/backing_chains.html>`_,
>  `QCOW2 overlays
> -<
> https://qemu.readthedocs.io/en/latest/interop/live-block-operations.html#disk-image-backing-chain-notation
> >`_,
> +<
> https://www.qemu.org/docs/master/interop/live-block-operations.html#disk-image-backing-chain-notation
> >`_,
>  and a special operation called "active block-commit", which allows
>  live-merging an overlay disk image into its backing file.
>
> diff --git a/docs/manpages/virt-sanlock-cleanup.rst
> b/docs/manpages/virt-sanlock-cleanup.rst
> index 3ad70ce683..bf3ef6742b 100644
> --- a/docs/manpages/virt-sanlock-cleanup.rst
> +++ b/docs/manpages/virt-sanlock-cleanup.rst
> @@ -75,5 +75,5 @@ PURPOSE
>  SEE ALSO
>  ========
>
> -virsh(1), `online instructions <https://libvirt.org/locking.html>`_,
> +virsh(1), `online instructions <https://libvirt.org/kbase/locking.html
> >`_,
>  `https://libvirt.org/ <https://libvirt.org/>`_
> diff --git a/docs/manpages/virtinterfaced.rst
> b/docs/manpages/virtinterfaced.rst
> index 247a8c4009..ef63f4c278 100644
> --- a/docs/manpages/virtinterfaced.rst
> +++ b/docs/manpages/virtinterfaced.rst
> @@ -211,4 +211,3 @@ SEE ALSO
>
>  virsh(1), libvirtd(8),
>  `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
> -`https://libvirt.org/drvinterface.html <
> https://libvirt.org/drvinterface.html>`_
> diff --git a/docs/manpages/virtnetworkd.rst
> b/docs/manpages/virtnetworkd.rst
> index 22b3fc0f2d..3bd1dd3221 100644
> --- a/docs/manpages/virtnetworkd.rst
> +++ b/docs/manpages/virtnetworkd.rst
> @@ -211,4 +211,3 @@ SEE ALSO
>
>  virsh(1), libvirtd(8),
>  `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
> -`https://libvirt.org/drvnetwork.html <https://libvirt.org/drvnetwork.html
> >`_
> diff --git a/docs/manpages/virtnwfilterd.rst
> b/docs/manpages/virtnwfilterd.rst
> index b1fc45e7a2..1ec11c247f 100644
> --- a/docs/manpages/virtnwfilterd.rst
> +++ b/docs/manpages/virtnwfilterd.rst
> @@ -211,4 +211,3 @@ SEE ALSO
>
>  virsh(1), libvirtd(8),
>  `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
> -`https://libvirt.org/drvnwfilter.html <
> https://libvirt.org/drvnwfilter.html>`_
> diff --git a/docs/manpages/virtstoraged.rst
> b/docs/manpages/virtstoraged.rst
> index 70863282d1..fe966f3123 100644
> --- a/docs/manpages/virtstoraged.rst
> +++ b/docs/manpages/virtstoraged.rst
> @@ -211,4 +211,4 @@ SEE ALSO
>
>  virsh(1), libvirtd(8),
>  `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
> -`https://libvirt.org/drvstorage.html <https://libvirt.org/drvstorage.html
> >`_
> +`https://libvirt.org/storage.html <https://libvirt.org/drvstorage.html>`_
> diff --git a/docs/manpages/virtvzd.rst b/docs/manpages/virtvzd.rst
> index aa44885d46..52aac2259c 100644
> --- a/docs/manpages/virtvzd.rst
> +++ b/docs/manpages/virtvzd.rst
> @@ -211,4 +211,4 @@ SEE ALSO
>
>  virsh(1), libvirtd(8),
>  `https://libvirt.org/daemons.html <https://libvirt.org/daemons.html>`_,
> -`https://libvirt.org/drvvz.html <https://libvirt.org/drvvz.html>`_
> +`https://libvirt.org/drvopenvz.html <https://libvirt.org/drvopenvz.html
> >`_
> diff --git a/docs/windows.rst b/docs/windows.rst
> index b9aa5626cf..ee3caef41a 100644
> --- a/docs/windows.rst
> +++ b/docs/windows.rst
> @@ -13,7 +13,7 @@ Installation packages
>
>  Users who need pre-built Windows DLLs of libvirt are advised to use the
> `Virt
>  Viewer <https://virt-manager.org>`__ pre-compiled `Windows MSI
> -packages <https://virt-manager.org/download/>`__
> +packages <https://virt-manager.org/download.html>`__
>
>  These installers include the libvirt, gtk-vnc and spice-gtk DLLs along
> with any
>  of their pre-requisite supporting DLLs, the virsh command line tool and
> the
> --
> 2.45.1
>
>
Re: [PATCH] docs: Fix broken links
Posted by Richard W.M. Jones 6 months ago
On Tue, May 21, 2024 at 05:12:00PM +0800, Han Han wrote:
> @Richard Jones Hi Richard,
> I cannot find the valid link for Nagios-virt. However, I saw your ID in the
> broken link for Nagios-virt.
> Could you help provide the new link for Nagios-virt?
> 
>     -`Nagios-virt <https://people.redhat.com/rjones/nagios-virt/>`__
>     -   Nagios-virt is a configuration tool to add monitoring of your
>     -   virtualised domains to `Nagios <https://www.nagios.org/>`__. You can
>     -   use this tool to either set up a new Nagios installation for your Xen
>     -   or QEMU/KVM guests, or to integrate with your existing Nagios
>     -   installation.

I think it's dead, so removing it (as you seem to be doing here)
is the right thing to do IMHO.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
Fedora Windows cross-compiler. Compile Windows programs, test, and
build Windows installers. Over 100 libraries supported.
http://fedoraproject.org/wiki/MinGW
Re: [PATCH] docs: Fix broken links
Posted by Han Han 6 months ago
On Tue, May 21, 2024 at 5:43 PM Richard W.M. Jones <rjones@redhat.com>
wrote:

> On Tue, May 21, 2024 at 05:12:00PM +0800, Han Han wrote:
> > @Richard Jones Hi Richard,
> > I cannot find the valid link for Nagios-virt. However, I saw your ID in
> the
> > broken link for Nagios-virt.
> > Could you help provide the new link for Nagios-virt?
> >
> >     -`Nagios-virt <https://people.redhat.com/rjones/nagios-virt/>`__
> >     -   Nagios-virt is a configuration tool to add monitoring of your
> >     -   virtualised domains to `Nagios <https://www.nagios.org/>`__.
> You can
> >     -   use this tool to either set up a new Nagios installation for
> your Xen
> >     -   or QEMU/KVM guests, or to integrate with your existing Nagios
> >     -   installation.
>
> I think it's dead, so removing it (as you seem to be doing here)
> is the right thing to do IMHO.
>
> OK. Thanks for your confirmation

> Rich.
>
> --
> Richard Jones, Virtualization Group, Red Hat
> http://people.redhat.com/~rjones
> Read my programming and virtualization blog: http://rwmj.wordpress.com
> Fedora Windows cross-compiler. Compile Windows programs, test, and
> build Windows installers. Over 100 libraries supported.
> http://fedoraproject.org/wiki/MinGW
>
>