From: Bruce Richardson Date: Tue, 15 Mar 2022 22:05:01 +0000 (+0000) Subject: doc: add hyperlinks to other docs from FreeBSD guide X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=bdeaa926d80338a4b4f5b0f7d8d166184891b9ed;p=dpdk.git doc: add hyperlinks to other docs from FreeBSD guide The document roadmap section called out the titles of other documents, but these are better as hyperlinks. Signed-off-by: Bruce Richardson --- 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.