[dpdk-dev] [PATCH] doc: fix minor typos in OcteonTx platform and eventdev docs

[dpdk-dev] [PATCH] doc: fix minor typos in OcteonTx platform and eventdev docs

[Pavan Nikhilesh]

Fixes: 26cb0a72412f ("doc: add octeontx platform guide")
Fixes: 48191dde6acf ("doc: add octeontx mempool guide")

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
---
 doc/guides/eventdevs/octeontx.rst | 2 +-
 doc/guides/platform/octeontx.rst  | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guides/eventdevs/octeontx.rst b/doc/guides/eventdevs/octeontx.rst
index f77bc5c54..3dcf6afbd 100644
--- a/doc/guides/eventdevs/octeontx.rst
+++ b/doc/guides/eventdevs/octeontx.rst
@@ -39,7 +39,7 @@ Supported OCTEONTX SoCs
 Prerequisites
 -------------
 
-See :doc: `../platform/octeontx` for setup information.
+See :doc:`../platform/octeontx` for setup information.
 
 Pre-Installation Configuration
 ------------------------------
diff --git a/doc/guides/platform/octeontx.rst b/doc/guides/platform/octeontx.rst
index dc1aa4fe1..535504998 100644
--- a/doc/guides/platform/octeontx.rst
+++ b/doc/guides/platform/octeontx.rst
@@ -16,11 +16,11 @@ Common Offload HW Block Drivers
 -------------------------------
 
 1. **Eventdev Driver**
-   See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver
+   See :doc:`../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver
    information.
 
 2. **Mempool Driver**
-   See :doc: `../mempool/octeontx.rst` for octeontx fpavf mempool driver
+   See :doc:`../mempool/octeontx.rst` for octeontx fpavf mempool driver
    information.
 
 Steps To Setup Platform
-- 
2.17.0

Re: [dpdk-dev] [PATCH] doc: fix minor typos in OcteonTx platform and eventdev docs

[Kovacevic, Marko]

> 
> Fixes: 26cb0a72412f ("doc: add octeontx platform guide")
> Fixes: 48191dde6acf ("doc: add octeontx mempool guide")
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> ---
>  doc/guides/eventdevs/octeontx.rst | 2 +-
> doc/guides/platform/octeontx.rst  | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/eventdevs/octeontx.rst
> b/doc/guides/eventdevs/octeontx.rst
> index f77bc5c54..3dcf6afbd 100644
> --- a/doc/guides/eventdevs/octeontx.rst
> +++ b/doc/guides/eventdevs/octeontx.rst
> @@ -39,7 +39,7 @@ Supported OCTEONTX SoCs  Prerequisites
>  -------------
> 
> -See :doc: `../platform/octeontx` for setup information.
> +See :doc:`../platform/octeontx` for setup information.
> 
>  Pre-Installation Configuration
>  ------------------------------
> diff --git a/doc/guides/platform/octeontx.rst
> b/doc/guides/platform/octeontx.rst
> index dc1aa4fe1..535504998 100644
> --- a/doc/guides/platform/octeontx.rst
> +++ b/doc/guides/platform/octeontx.rst
> @@ -16,11 +16,11 @@ Common Offload HW Block Drivers
>  -------------------------------
> 
>  1. **Eventdev Driver**
> -   See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver
> +   See :doc:`../eventdevs/octeontx.rst` for octeontx ssovf eventdev
> + driver
>     information.
> 
>  2. **Mempool Driver**
> -   See :doc: `../mempool/octeontx.rst` for octeontx fpavf mempool driver
> +   See :doc:`../mempool/octeontx.rst` for octeontx fpavf mempool driver
>     information.

Hi Pavan,

Can you please remove the .rst from the two files ":doc: `../eventdevs/octeontx.rst`" , :doc: `../mempool/octeontx.rst` 
as it is failing to find the html part if the rst is added onto the end and in not referenced to the file. 
And as I was looking at this I noticed at the bottom there is the doc: `../linux_gsg/indes.rst`
Can you remove the .rst from it too and just add the fixes line to your patch.

Otherwise you can add my ack after as iv tested it and it works.

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Re: [dpdk-dev] [PATCH] doc: fix minor typos in OcteonTx platform and eventdev docs

[Kovacevic, Marko]

And there is a space you need to just get rid of at the bottom 

:doc: `../linux_gsg/index.rst`

:doc:`../linux_gsg/index`

Marko K

Re: [dpdk-dev] [PATCH] doc: fix minor typos in OcteonTx platform and eventdev docs

[Pavan Nikhilesh]

Hi Marko,

Will send out v2 with the appropriate changes.

Thanks,
Pavan
On Fri, Apr 20, 2018 at 09:24:34AM +0000, Kovacevic, Marko wrote:
> And there is a space you need to just get rid of at the bottom
>
> :doc: `../linux_gsg/index.rst`
>
> :doc:`../linux_gsg/index`
>
> Marko K