WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-devel

[Xen-devel] [PATCH 4 of 7] docs: fix references from xl man page to xldo

To: xen-devel@xxxxxxxxxxxxxxxxxxx
Subject: [Xen-devel] [PATCH 4 of 7] docs: fix references from xl man page to xldomain.cfg manpage
From: Ian Campbell <ian.campbell@xxxxxxxxxx>
Date: Mon, 7 Nov 2011 15:13:13 +0000
Cc: ian.jackson@xxxxxxxxxx
Delivery-date: Mon, 07 Nov 2011 07:16:23 -0800
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
In-reply-to: <patchbomb.1320678789@xxxxxxxxxxxxxxxxxxxxxxxxx>
List-help: <mailto:xen-devel-request@lists.xensource.com?subject=help>
List-id: Xen developer discussion <xen-devel.lists.xensource.com>
List-post: <mailto:xen-devel@lists.xensource.com>
List-subscribe: <http://lists.xensource.com/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=unsubscribe>
References: <patchbomb.1320678789@xxxxxxxxxxxxxxxxxxxxxxxxx>
Sender: xen-devel-bounces@xxxxxxxxxxxxxxxxxxx
User-agent: Mercurial-patchbomb/1.6.4
# HG changeset patch
# User Ian Campbell <ian.campbell@xxxxxxxxxx>
# Date 1320678761 0
# Node ID 25c3e859855f71cf25a0d607736821d4858d880a
# Parent  291f6cb0d03e56e4edbe53c640c96dff85d9bf08
docs: fix references from xl man page to xldomain.cfg manpage.

They should reference the xl-domain-config document. pod2html (which I
will call shortly) doesn't like these and reports: "cannot resolve
L<xldomain.cfg> in paragraph" and similar.

Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx>

diff -r 291f6cb0d03e -r 25c3e859855f docs/man/xl.pod.1
--- a/docs/man/xl.pod.1 Mon Nov 07 15:12:38 2011 +0000
+++ b/docs/man/xl.pod.1 Mon Nov 07 15:12:41 2011 +0000
@@ -54,8 +54,9 @@ previously, most commands take I<domain-
 
 =item B<create> [I<OPTIONS>] I<configfile>
 
-The create subcommand requires a config file: see L<xldomain.cfg> for
-full details of that file format and possible options.
+The create subcommand requires a config file: see
+F<xl-domain-config> for full details of that file format and
+possible options.
 
 I<configfile> can either be an absolute path to a file, or a relative
 path to a file located in /etc/xen.
@@ -232,7 +233,7 @@ FIXME: Why would you ever see this state
 
 The domain has crashed, which is always a violent ending.  Usually
 this state can only occur if the domain has been configured not to
-restart on crash.  See L<xldomain.cfg> for more info.
+restart on crash.  See F<xl-domain-config> for more info.
 
 =item B<d - dying>
 
@@ -319,8 +320,8 @@ executed the reboot action, which may be
 domain actually reboots.
 
 The behavior of what happens to a domain when it reboots is set by the
-B<on_reboot> parameter of the xldomain.cfg file when the domain was
-created.
+B<on_reboot> parameter of the domain configuration file when the
+domain was created.
 
 =item B<restore> [I<OPTIONS>] [I<ConfigFile>] I<CheckpointFile>
 
@@ -372,8 +373,8 @@ services must be shutdown in the domain.
 immediately after signally the domain unless that B<-w> flag is used.
 
 The behavior of what happens to a domain when it reboots is set by the
-B<on_shutdown> parameter of the xldomain.cfg file when the domain was
-created.
+B<on_shutdown> parameter of the domain configuration file when the
+domain was created.
 
 B<OPTIONS>
 
@@ -699,7 +700,7 @@ The domain id of the guest domain that t
 =item I<disc-spec-component>
 
 A disc specification in the same format used for the B<disk> variable in
-the domain config file. See L<xldomain.cfg>.
+the domain config file. See F<xl-disk-configuration>.
 
 =back
 
@@ -733,9 +734,9 @@ How the device should be presented to th
 
 =item I<be-dev>
 
-the device in the backend domain (usually domain 0) to be exported; it can be a
-path to a file (file://path/to/file.iso). See B<disk> in L<xldomain.cfg> for 
the
-details.
+the device in the backend domain (usually domain 0) to be exported; it
+can be a path to a file (file://path/to/file.iso). See B<disk> in
+F<xl-domain-config> for the details.
 
 =back
 
@@ -754,7 +755,7 @@ I<VirtualDevice> is the cdrom device in 
 
 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<xldomain.cfg> for the
+B<vif> string in the domain config file. See F<xl-domain-config> for the
 description.
 
 =item B<network-detach> I<domain-id> I<devid|mac>
@@ -795,7 +796,7 @@ List pass-through pci devices for a doma
 
 =head1 SEE ALSO
 
-B<xldomain.cfg>(5), B<xlcpupool.cfg>(5), B<xentop>(1)
+F<xl-domain-config>, B<xlcpupool.cfg>(5), B<xentop>(1)
 
 =head1 AUTHOR
 
diff -r 291f6cb0d03e -r 25c3e859855f docs/man/xm.pod.1
--- a/docs/man/xm.pod.1 Mon Nov 07 15:12:38 2011 +0000
+++ b/docs/man/xm.pod.1 Mon Nov 07 15:12:41 2011 +0000
@@ -71,7 +71,7 @@ Use the key combination Ctrl+] to detach
 
 The create subcommand requires a config file and can optionally take a
 series of I<vars> that add to or override variables defined
-in the config file.  See L<xmdomain.cfg> for full details of that file
+in the config file.  See F<xmdomain.cfg> for full details of that file
 format, and possible options used in either the configfile or for I<vars>.
 
 I<configfile> can either be an absolute path to a file, or a relative
@@ -301,7 +301,7 @@ FIXME: Why would you ever see this state
 
 The domain has crashed, which is always a violent ending.  Usually
 this state can only occur if the domain has been configured not to
-restart on crash.  See L<xmdomain.cfg> for more info.
+restart on crash.  See F<xmdomain.cfg> for more info.
 
 =item B<d - dying>
 

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel