[03/11] docs: xl-network-configuration turns into a man

Commit Message

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

Move docs/misc/xl-network-configuration.markdown to docs/man and
update the references to it in the other man pages.

Signed-off-by: Cédric Bosdonnat <[e-mail]>
---
 docs/INDEX                                                            | 1 -
 .../xl-network-configuration.markdown.5}                              | 0
 docs/man/xl.cfg.pod.5.in                                              | 4 ++--
 docs/man/xl.pod.1.in                                                  | 4 ++--
 4 files changed, 4 insertions(+), 5 deletions(-)
 rename docs/{misc/xl-network-configuration.markdown => man/xl-network-configuration.markdown.5} (100%)

Comments

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

On Fri, Dec 09, 2016 at 05:17:06PM +0100, Cédric Bosdonnat wrote:
> Move docs/misc/xl-network-configuration.markdown to docs/man and
> update the references to it in the other man pages.
> 
> Signed-off-by: Cédric Bosdonnat <[e-mail]>

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

Patch

diff --git a/docs/INDEX b/docs/INDEX
index 7d26cf85d4..2cfeef90a9 100644
--- a/docs/INDEX
+++ b/docs/INDEX
@@ -17,7 +17,6 @@  misc/vbd-interface		Xen Guest Disk (VBD) Interface
 misc/xenstore			Xenstore protocol specification
 misc/xenstore-paths		Xenstore path documentation
 misc/xl-disk-configuration	XL Disk Configuration
-misc/xl-network-configuration	XL Network Configuration
 misc/distro_mapping		Distro Directory Layouts
 misc/dump-core-format		Xen Core Dump Format
 misc/vtd			VT-d HOWTO
diff --git a/docs/misc/xl-network-configuration.markdown b/docs/man/xl-network-configuration.markdown.5
similarity index 100%
rename from docs/misc/xl-network-configuration.markdown
rename to docs/man/xl-network-configuration.markdown.5
diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index 21b58bc21e..517c7f9910 100644
--- a/docs/man/xl.cfg.pod.5.in
+++ b/docs/man/xl.cfg.pod.5.in
@@ -486,7 +486,7 @@  the host they should map to.  See F<docs/misc/xl-disk-configuration.txt>.
 
 Specifies the networking provision (both emulated network adapters,
 and Xen virtual interfaces) to provided to the guest.  See
-F<docs/misc/xl-network-configuration.markdown>.
+L<xl-network-configuration(5)>.
 
 =item B<vtpm=[ "VTPM_SPEC_STRING", "VTPM_SPEC_STRING", ...]>
 
@@ -2032,7 +2032,7 @@  natively or via hardware backwards compatibility support.
 
 =item F<xl-disk-configuration>
 
-=item F<xl-network-configuration>
+=item L<xl-network-configuration(5)>
 
 =item F<docs/misc/tscmode.txt>
 
diff --git a/docs/man/xl.pod.1.in b/docs/man/xl.pod.1.in
index 8e2aa5b5af..2937f33003 100644
--- a/docs/man/xl.pod.1.in
+++ b/docs/man/xl.pod.1.in
@@ -1383,7 +1383,7 @@  How the device should be presented to the guest domain; for example "hdc".
 Creates a new network device in the domain specified by I<domain-id>.
 I<network-device> describes the device to attach, using the same format as the
 B<vif> string in the domain config file. See L<xl.cfg> and
-L<http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html>
+L<xl-network-configuration(5)>
 for more informations.
 
 Note that only attaching PV network interface is supported.
@@ -1797,10 +1797,10 @@  Transcendent Memory.
 The following man pages:
 
 L<xl.cfg>(5), L<xlcpupool.cfg>(5), B<xentop>(1)
+L<xl-network-configuration(5)>
 
 And the following documents on the xen.org website:
 
-L<http://xenbits.xen.org/docs/unstable/misc/xl-network-configuration.html>
 L<http://xenbits.xen.org/docs/unstable/misc/xl-disk-configuration.txt>
 L<http://xenbits.xen.org/docs/unstable/misc/xsm-flask.txt>
 L<http://xenbits.xen.org/docs/unstable/misc/xl-psr.html>