[Xen-devel] [PATCH] docs: turn links to docs/* into absolute path

[Cédric Bosdonnat <cbosdonnat@xxxxxxxx>]

From a user point of view, when reading things like "See
docs/misc/....txt" in a man page, it is not obvious to find the
location of that file. Use $docdir to turn these into absolute
paths.

Signed-off-by: Cédric Bosdonnat <cbosdonnat@xxxxxxxx>
---
 docs/man/xl.cfg.pod.5.in | 16 ++++++++--------
 docs/man/xl.pod.1.in     |  2 +-
 m4/paths.m4              |  3 +++
 3 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in
index 21b58bc21e..29a012b794 100644
--- a/docs/man/xl.cfg.pod.5.in
+++ b/docs/man/xl.cfg.pod.5.in
@@ -185,7 +185,7 @@ host cpus and memory. In that case, the soft affinity of 
all the vcpus
 of the domain will be set to the pcpus belonging to the NUMA nodes
 chosen during placement.
 
-For more details, see F<docs/misc/xl-numa-placement.markdown>.
+For more details, see L</@XEN_DOC_DIR@/docs/misc/xl-numa-placement.markdown>.
 
 =back
 
@@ -480,18 +480,18 @@ devices which the guest will contain.
 
 Specifies the disks (both emulated disks and Xen virtual block
 devices) which are to be provided to the guest, and what objects on
-the host they should map to.  See F<docs/misc/xl-disk-configuration.txt>.
+the host they should map to.  See 
L</@XEN_DOC_DIR@/docs/misc/xl-disk-configuration.txt>.
 
 =item B<vif=[ "NET_SPEC_STRING", "NET_SPEC_STRING", ...]>
 
 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</@XEN_DOC_DIR@/docs/misc/xl-network-configuration.markdown>.
 
 =item B<vtpm=[ "VTPM_SPEC_STRING", "VTPM_SPEC_STRING", ...]>
 
 Specifies the virtual trusted platform module to be
-provided to the guest. Please see F<docs/misc/vtpm.txt>
+provided to the guest. Please see L</@XEN_DOC_DIR@/docs/misc/vtpm.txt>
 for more details.
 
 Each B<VTPM_SPEC_STRING> is a comma-separated list of C<KEY=VALUE>
@@ -604,7 +604,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_DOC_DIR@/docs/misc/channels.txt> 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
@@ -1464,7 +1464,7 @@ determined in the similar way to that of B<default> TSC 
mode.
 
 =back
 
-Please see F<docs/misc/tscmode.txt> for more information on this option.
+Please see L</@XEN_DOC_DIR@/docs/misc/tscmode.txt> for more information on 
this option.
 
 =item B<localtime=BOOLEAN>
 
@@ -1895,7 +1895,7 @@ specified, enabling the use of XenServer PV drivers in 
the guest.
 =back
 
 This parameter only takes effect when device_model_version=qemu-xen.
-See F<docs/misc/pci-device-reservations.txt> for more information.
+See L</@XEN_DOC_DIR@/docs/misc/pci-device-reservations.txt> for more 
information.
 
 =back
 
@@ -2034,7 +2034,7 @@ natively or via hardware backwards compatibility support.
 
 =item F<xl-network-configuration>
 
-=item F<docs/misc/tscmode.txt>
+=item L</@XEN_DOC_DIR@/docs/misc/tscmode.txt>
 
 =back
 
diff --git a/docs/man/xl.pod.1.in b/docs/man/xl.pod.1.in
index 8e2aa5b5af..22f24607a1 100644
--- a/docs/man/xl.pod.1.in
+++ b/docs/man/xl.pod.1.in
@@ -1354,7 +1354,7 @@ How the device should be presented to the guest domain; 
for example "hdc".
 
 the target path in the backend domain (usually domain 0) to be
 exported; Can be a block device or a file etc. See B<target> in
-F<docs/misc/xl-disk-configuration.txt>.
+L</@XEN_DOC_DIR@/docs/misc/xl-disk-configuration.txt>.
 
 =back
 
diff --git a/m4/paths.m4 b/m4/paths.m4
index 722a8aa4a9..9a6ede4a11 100644
--- a/m4/paths.m4
+++ b/m4/paths.m4
@@ -140,4 +140,7 @@ AC_SUBST(XEN_PAGING_DIR)
 
 XEN_DUMP_DIR=$xen_dumpdir_path
 AC_SUBST(XEN_DUMP_DIR)
+
+XEN_DOC_DIR=$docdir
+AC_SUBST(XEN_DOC_DIR)
 ])
-- 
2.11.0


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
https://lists.xen.org/xen-devel