[PATCH] docs: Remove broken link to Xen channel doc

Jim Fehlig posted 1 patch 3 years, 2 months ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20210204234507.3081-1-jfehlig@suse.com
docs/formatdomain.rst | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
[PATCH] docs: Remove broken link to Xen channel doc
Posted by Jim Fehlig 3 years, 2 months ago
Many of Xen's text documents have been converted to man pages over
the years, the channel doc being one of them. Replace the broken
channel.txt link with the name of the man page providing the same
information.

Signed-off-by: Jim Fehlig <jfehlig@suse.com>
---
 docs/formatdomain.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 0f78aa3a8c..aa7ea61258 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6353,11 +6353,10 @@ types have different ``target`` attributes.
 ``xen``
    Paravirtualized Xen channel. Channel is exposed in the guest as a Xen console
    but identified with a name. Setup and consumption of a Xen channel depends on
-   software and configuration in the guest (for more info, please see
-   http://xenbits.xen.org/docs/unstable/misc/channel.txt). Channel source path
-   semantics are the same as the virtio target type. The ``state`` attribute is
-   not supported since Xen channels lack the necessary probing mechanism.
-   :since:`Since 2.3.0`
+   software and configuration in the guest. See the xen-pv-channel(7) man page
+   for more information. Channel source path semantics are the same as the virtio
+   target type. The ``state`` attribute is not supported since Xen channels lack
+   the necessary probing mechanism. :since:`Since 2.3.0`
 ``spicevmc``
    Paravirtualized SPICE channel. The domain must also have a SPICE server as a
    `graphics device <#elementsGraphics>`__, at which point the host piggy-backs
-- 
2.29.2


Re: [PATCH] docs: Remove broken link to Xen channel doc
Posted by Michal Privoznik 3 years, 2 months ago
On 2/5/21 12:45 AM, Jim Fehlig wrote:
> Many of Xen's text documents have been converted to man pages over
> the years, the channel doc being one of them. Replace the broken
> channel.txt link with the name of the man page providing the same
> information.
> 
> Signed-off-by: Jim Fehlig <jfehlig@suse.com>
> ---
>   docs/formatdomain.rst | 9 ++++-----
>   1 file changed, 4 insertions(+), 5 deletions(-)

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

Michal