[dpdk-dev] [PATCH] doc: fix vhost bad section number references

[dpdk-dev] [PATCH] doc: fix vhost bad section number references

[Mauricio Vasquez B]

Section numbers were "hard-coded". This patch adds them as hyperlinks.

Signed-off-by: Mauricio Vasquez B <mauricio.vasquezbernal@studenti.polito.it>
---
 doc/guides/sample_app_ug/vhost.rst | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index e5d1326..2ad2243 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -260,7 +260,7 @@ Setting up the Guest Execution Environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 It is recommended for testing purposes that the DPDK testpmd sample application is used in the guest to forward packets,
-the reasons for this are discussed in Section 22.7, "Running the Virtual Machine (QEMU)".
+the reasons for this are discussed in :ref:`running_the_vm`.
 
 The testpmd application forwards packets between pairs of Ethernet devices,
 it requires an even number of Ethernet devices (virtio or otherwise) to execute.
@@ -530,6 +530,8 @@ It is enabled by default.
     ./vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge \
      -- --vlan-strip [0, 1]
 
+.. _running_the_vm:
+
 Running the Virtual Machine (QEMU)
 ----------------------------------
 
@@ -583,7 +585,7 @@ an open file descriptor must be passed to QEMU running as a child process.
 
 .. note::
 
-    This process is automated in the QEMU wrapper script discussed in Section 24.7.3.
+    This process is automated in the :ref:`qemu_wrapper`.
 
 Mapping the Virtual Machine's Memory
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -600,10 +602,12 @@ In this case, the path passed to the guest should be that of the 1 GB page huget
 
 .. note::
 
-    This process is automated in the QEMU wrapper script discussed in Section 24.7.3.
+    This process is automated in the :ref:`qemu_wrapper`.
     The following two sections only applies to vhost cuse.
     For vhost-user, please make corresponding changes to qemu-wrapper script and guest XML file.
 
+.. _qemu_wrapper:
+
 QEMU Wrapper Script
 ~~~~~~~~~~~~~~~~~~~
 
-- 
1.9.1

Re: [dpdk-dev] [PATCH] doc: fix vhost bad section number references

[Yuanhan Liu]

On Sat, Feb 20, 2016 at 12:12:50PM +0100, Mauricio Vasquez B wrote:
> Section numbers were "hard-coded". This patch adds them as hyperlinks.

Good catch. Thanks.

Acked-by: Yuanhan Liu <yuanhan.liu@linux.intel.com>

	--yliu

Re: [dpdk-dev] [PATCH] doc: fix vhost bad section number references

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mauricio Vasquez B
> Sent: Saturday, February 20, 2016 11:13 AM
> To: Xie, Huawei <huawei.xie@intel.com>; yuanhan.liu@linux.intel.com
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: fix vhost bad section number references
> 
> Section numbers were "hard-coded". This patch adds them as hyperlinks.
> 
> Signed-off-by: Mauricio Vasquez B
> <mauricio.vasquezbernal@studenti.polito.it>

Acked-by: John McNamara <john.mcnamara@intel.com>

Thanks.

It is probably best to include some reference to the file or doc section in
the target name since they are shared across all of the Html documentation.
For example _vhost_running_the_vm instead of _running_the_vm. 

Btw, I was surprised this issue hadn't be fixed in an earlier doc patchset.
Checking the docs there are around 20 other hardcoded references like this.
If you have some time it would be could if you could fix those in the same
way.

John

Re: [dpdk-dev] [PATCH] doc: fix vhost bad section number references

[Mauricio Vásquez]

Hi John,

I'll check for other hard-coded references like this, so, I think it is
better to drop this patch.
I'll include the doc name in the reference and send it in a patch series.


On 22 February 2016 at 10:56, Mcnamara, John <john.mcnamara@intel.com>
wrote:

> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mauricio Vasquez B
> > Sent: Saturday, February 20, 2016 11:13 AM
> > To: Xie, Huawei <huawei.xie@intel.com>; yuanhan.liu@linux.intel.com
> > Cc: dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH] doc: fix vhost bad section number references
> >
> > Section numbers were "hard-coded". This patch adds them as hyperlinks.
> >
> > Signed-off-by: Mauricio Vasquez B
> > <mauricio.vasquezbernal@studenti.polito.it>
>
> Acked-by: John McNamara <john.mcnamara@intel.com>
>
> Thanks.
>
> It is probably best to include some reference to the file or doc section in
> the target name since they are shared across all of the Html documentation.
> For example _vhost_running_the_vm instead of _running_the_vm.
>
> Btw, I was surprised this issue hadn't be fixed in an earlier doc patchset.
> Checking the docs there are around 20 other hardcoded references like this.
> If you have some time it would be could if you could fix those in the same
> way.
>
> John
>
>