DPDK patches and discussions
 help / color / mirror / Atom feed
From: David Marchand <david.marchand@redhat.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, stable@dpdk.org,
	Ajit Khaparde <ajit.khaparde@broadcom.com>,
	Somnath Kotur <somnath.kotur@broadcom.com>,
	Kalesh AP <kalesh-anakkur.purayil@broadcom.com>
Subject: [PATCH] doc: fix link to net/bnxt flow capabilities
Date: Wed, 21 Jun 2023 11:57:36 +0200	[thread overview]
Message-ID: <20230621095736.1626037-1-david.marchand@redhat.com> (raw)

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


             reply	other threads:[~2023-06-21  9:57 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-21  9:57 David Marchand [this message]
2023-07-20  4:28 ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230621095736.1626037-1-david.marchand@redhat.com \
    --to=david.marchand@redhat.com \
    --cc=ajit.khaparde@broadcom.com \
    --cc=dev@dpdk.org \
    --cc=kalesh-anakkur.purayil@broadcom.com \
    --cc=somnath.kotur@broadcom.com \
    --cc=stable@dpdk.org \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).