[09/11] docs: convert misc/channel.txt into xen-pv-channel man page

Commit Message

Cedric Bosdonnat Dec. 9, 2016, 4:17 p.m. UTC

channel.txt is referenced in xl.cfg(5). Move it to man pages, section 7

Signed-off-by: Cédric Bosdonnat <[e-mail]>
---
 .../channel.txt => man/xen-pv-channel.markdown.7}    | 20 ++++++++++----------
 docs/man/xl.cfg.pod.5.in                             |  2 +-
 2 files changed, 11 insertions(+), 11 deletions(-)
 rename docs/{misc/channel.txt => man/xen-pv-channel.markdown.7} (92%)

Comments

Wei Liu Jan. 4, 2017, 5:55 p.m. UTC | #1

On Fri, Dec 09, 2016 at 05:17:12PM +0100, Cédric Bosdonnat wrote:
> channel.txt is referenced in xl.cfg(5). Move it to man pages, section 7
> 
> Signed-off-by: Cédric Bosdonnat <[e-mail]>

Acked-by: Wei Liu <[e-mail]>

Patch

diff --git a/docs/misc/channel.txt b/docs/man/xen-pv-channel.markdown.7
similarity index 92%
rename from docs/misc/channel.txt
rename to docs/man/xen-pv-channel.markdown.7
index 9fc701a64a..1c6149dae0 100644
--- a/docs/misc/channel.txt
+++ b/docs/man/xen-pv-channel.markdown.7
@@ -94,13 +94,13 @@  Channel name registry
 It is important that channel names are globally unique. To help ensure
 that no-one's name clashes with yours, please add yours to this list.
 
-Key:
-N: Name
-C: Contact
-D: Short description of use, possibly including a URL to your software
-   or API
-
-N: org.xenproject.guest.clipboard.0.1
-C: David Scott <[e-mail]>
-D: Share clipboard data via an in-guest agent. See:
-   http://wiki.xenproject.org/wiki/Clipboard_sharing_protocol
+    Key:
+    N: Name
+    C: Contact
+    D: Short description of use, possibly including a URL to your software
+       or API
+    
+    N: org.xenproject.guest.clipboard.0.1
+    C: David Scott <[e-mail]>
+    D: Share clipboard data via an in-guest agent. See:
+       http://wiki.xenproject.org/wiki/Clipboard_sharing_protocol
diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index 33fae038f7..94eada381f 100644
--- a/docs/man/xl.cfg.pod.5.in
+++ b/docs/man/xl.cfg.pod.5.in
@@ -603,7 +603,7 @@  Specifies the virtual channels to be provided to the guest. A
 channel is a low-bandwidth, bidirectional byte stream, which resembles
 a serial link. Typical uses for channels include transmitting VM
 configuration after boot and signalling to in-guest agents. Please see
-F<docs/misc/channels.txt> for more details.
+L<xen-pv-channel(7)> for more details.
 
 Each B<CHANNEL_SPEC_STRING> is a comma-separated list of C<KEY=VALUE>
 settings. Leading and trailing whitespace is ignored in both KEY and