DPDK patches and discussions
 help / color / mirror / Atom feed
* [PATCH] doc: fix link to net/bnxt flow capabilities
@ 2023-06-21  9:57 David Marchand
  2023-07-20  4:28 ` Thomas Monjalon
  0 siblings, 1 reply; 2+ messages in thread
From: David Marchand @ 2023-06-21  9:57 UTC (permalink / raw)
  To: dev; +Cc: thomas, stable, Ajit Khaparde, Somnath Kotur, Kalesh AP

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(-)

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:
 
-- 
2.40.1


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] doc: fix link to net/bnxt flow capabilities
  2023-06-21  9:57 [PATCH] doc: fix link to net/bnxt flow capabilities David Marchand
@ 2023-07-20  4:28 ` Thomas Monjalon
  0 siblings, 0 replies; 2+ messages in thread
From: Thomas Monjalon @ 2023-07-20  4:28 UTC (permalink / raw)
  To: David Marchand; +Cc: dev, stable, Ajit Khaparde, Somnath Kotur, Kalesh AP

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.




^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-07-20  4:29 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-06-21  9:57 [PATCH] doc: fix link to net/bnxt flow capabilities David Marchand
2023-07-20  4:28 ` Thomas Monjalon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).