From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH 1/4] doc: add hyperlinks to other docs from FreeBSD GSG
Date: Tue, 15 Mar 2022 22:05:01 +0000 [thread overview]
Message-ID: <20220315220504.1092437-2-bruce.richardson@intel.com> (raw)
In-Reply-To: <20220315220504.1092437-1-bruce.richardson@intel.com>
The document roadmap section called out the titles of other documents,
but these are better as hyperlinks.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/freebsd_gsg/intro.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst
index b2e57909ee..5f677e1655 100644
--- a/doc/guides/freebsd_gsg/intro.rst
+++ b/doc/guides/freebsd_gsg/intro.rst
@@ -25,15 +25,15 @@ Documentation Roadmap
The following is a list of DPDK documents in the suggested reading order:
-* **Release Notes** : Provides release-specific information, including supported
+* :doc:`../rel_notes/index`: Provides release-specific information, including supported
features, limitations, fixed issues, known issues and so on. Also, provides the
answers to frequently asked questions in FAQ format.
-* **Getting Started Guide** (this document): Describes how to install and
+* :doc:`../freebsd_gsg/index` (this document): Describes how to install and
configure the DPDK; designed to get users up and running quickly with the
software.
-* **Programmer's Guide**: Describes:
+* :doc:`../prog_guide/index`: Describes:
* The software architecture and how to use it (through examples),
specifically in a Linux* application (linux) environment
@@ -47,9 +47,9 @@ The following is a list of DPDK documents in the suggested reading order:
A glossary of terms is also provided.
-* **API Reference**: Provides detailed information about DPDK functions,
+* `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions,
data structures and other programming constructs.
-* **Sample Applications User Guide**: Describes a set of sample applications.
+* :doc:`../sample_app_ug/index`: Describes a set of sample applications.
Each chapter describes a sample application that showcases specific functionality
and provides instructions on how to compile, run and use the sample application.
--
2.32.0
next prev parent reply other threads:[~2022-03-15 22:05 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-15 22:05 [PATCH 0/4] Update doc lists in GSG intros Bruce Richardson
2022-03-15 22:05 ` Bruce Richardson [this message]
2022-03-15 22:05 ` [PATCH 2/4] doc: add driver guides to document list in FreeBSD GSG Bruce Richardson
2022-03-15 22:05 ` [PATCH 3/4] doc: add hyperlinks to other docs from Linux GSG Bruce Richardson
2022-03-15 22:05 ` [PATCH 4/4] doc: add driver guides to document list in " Bruce Richardson
2022-03-16 17:56 ` [PATCH 0/4] Update doc lists in GSG intros 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=20220315220504.1092437-2-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.