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

Message ID 20180420093410.4856-1-pbhagavatula@caviumnetworks.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Pavan Nikhilesh April 20, 2018, 9:34 a.m. UTC
  Fixes: 26cb0a72412f ("doc: add octeontx platform guide")
Fixes: 48191dde6acf ("doc: add octeontx mempool guide")

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
---

 v2 Changes:
 - Remove .rst at the end of doc links.
 - Remove space prior to linux gsg link.

 doc/guides/eventdevs/octeontx.rst | 2 +-
 doc/guides/platform/octeontx.rst  | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

--
2.17.0
  

Comments

Thomas Monjalon April 22, 2018, 11:45 p.m. UTC | #1
20/04/2018 11:34, Pavan Nikhilesh:
> Fixes: 26cb0a72412f ("doc: add octeontx platform guide")
> Fixes: 48191dde6acf ("doc: add octeontx mempool guide")
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Applied, thanks
  

Patch

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..b0a99c38d 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` for octeontx ssovf eventdev driver
    information.

 2. **Mempool Driver**
-   See :doc: `../mempool/octeontx.rst` for octeontx fpavf mempool driver
+   See :doc:`../mempool/octeontx` for octeontx fpavf mempool driver
    information.

 Steps To Setup Platform
@@ -52,4 +52,4 @@  OCTEONTX compatible board:

    SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.

-- Follow the DPDK :doc: `../linux_gsg/index.rst` to setup the basic DPDK environment.
+- Follow the DPDK :doc:`../linux_gsg/index` to setup the basic DPDK environment.