diff mbox series

doc: fix link to net/bnxt flow capabilities

Message ID 20230621095736.1626037-1-david.marchand@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix link to net/bnxt flow capabilities |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-unit-testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

David Marchand June 21, 2023, 9:57 a.m. UTC 
  Having an explicit link to the main repository documentation breaks
other repositories documentation (like for LTS releases).

Besides, the tables numerotation may change so add an explicit anchor to
those tables and refer to them.

Fixes: b845c295cd13 ("doc: update Broadcom bnxt guide")
Cc: stable@dpdk.org

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/conf.py       | 1 +
 doc/guides/nics/bnxt.rst | 6 ++----
 2 files changed, 3 insertions(+), 4 deletions(-)

Comments

Thomas Monjalon July 20, 2023, 4:28 a.m. UTC | #1 
21/06/2023 11:57, David Marchand:
> Having an explicit link to the main repository documentation breaks
> other repositories documentation (like for LTS releases).
> 
> Besides, the tables numerotation may change so add an explicit anchor to
> those tables and refer to them.
> 
> Fixes: b845c295cd13 ("doc: update Broadcom bnxt guide")
> Cc: stable@dpdk.org
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index a55ce38800..0f7ff5282d 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -203,6 +203,7 @@  def generate_overview_table(output_filename, table_id, section, table_name, titl
     num_cols = len(header_names)
 
     print_table_css(outfile, table_id)
+    print('.. _' + table_name + ':', file=outfile)
     print('.. table:: ' + table_name + '\n', file=outfile)
     print_table_header(outfile, num_cols, header_names, title)
     print_table_body(outfile, num_cols, ini_files, ini_data, default_features)
diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
index 0b09b0c50a..871d14142c 100644
--- a/doc/guides/nics/bnxt.rst
+++ b/doc/guides/nics/bnxt.rst
@@ -1019,8 +1019,7 @@  Listed below are the rte_flow functions supported:
 rte_flow Items
 ~~~~~~~~~~~~~~
 
-Refer to "Table 1.2 rte_flow items availability in networking drivers" in
-`Overview of Networking Drivers <https://doc.dpdk.org/guides/nics/overview.html>`.
+Refer to :ref:`rte_flow items availability in networking drivers`.
 
 Listed below are the rte_flow items supported:
 
@@ -1045,8 +1044,7 @@  Listed below are the rte_flow items supported:
 rte_flow Actions
 ~~~~~~~~~~~~~~~~
 
-Refer to "Table 1.3 rte_flow actions availability in networking drivers" in
-`Overview of Networking Drivers <https://doc.dpdk.org/guides/nics/overview.html>`.
+Refer to :ref:`rte_flow actions availability in networking drivers`.
 
 Listed below are the rte_flow actions supported: