Skip to contentSkip to conversation

doc: make doc roadmap common for Linux/BSD GSGs

PATCH In review Bruce Richardson 3 participants 4 messages Mar 16, 2022 – Jun 27, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: make doc roadmap common for Linux/BSD GSGs

Both the Linux and FreeBSD GSG docs had a "Documentation Roadmap" section as part of the introduction page, and this contained the same information, with only the reference to the GSGs themselves being different. This text can be consolidated into a single text file which is included by both GSG intro sections - using relative links for the self reference.

---
 doc/guides/freebsd_gsg/intro.rst         | 56 +---------------------
 doc/guides/linux_gsg/doc_roadmap_inc.rst | 61 ++++++++++++++++++++++++
 doc/guides/linux_gsg/intro.rst           | 48 +------------------
 3 files changed, 63 insertions(+), 102 deletions(-)
 create mode 100644 doc/guides/linux_gsg/doc_roadmap_inc.rst
doc/guides/freebsd_gsg/intro.rst +1 -55
index 596d84c8f1..6cdfea4b87 100644
@@ -23,58 +23,4 @@ handbook is available from the FreeBSD Documentation Project:
 Documentation Roadmap
 ---------------------
 
-The following is a list of DPDK documents in the suggested reading order:
-
-*   :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.
-
-*   :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.
-
-*   :doc:`../prog_guide/index`: Describes:
-
-    *   The software architecture and how to use it (through examples),
-        specifically in a Linux* application (linux) environment
-
-    *   The content of the DPDK, the build system (including the commands
-        that can be used to build the development kit and an application)
-        and guidelines for porting an application
-
-    *   Optimizations used in the software and those that should be considered
-        for new development
-
-    A glossary of terms is also provided.
-
-*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions,
-    data structures and other programming constructs.
-
-*   :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.
-
-*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
-    Separate guides exist for each of:
-
-    * :doc:`../bbdevs/index`
-
-    * :doc:`../compressdevs/index`
-
-    * :doc:`../cryptodevs/index`
-
-    * :doc:`../dmadevs/index`
-
-    * :doc:`../eventdevs/index`
-
-    * :doc:`../gpus/index`
-
-    * :doc:`../mempool/index`
-
-    * :doc:`../nics/index`
-
-    * :doc:`../rawdevs/index`
-
-    * :doc:`../regexdevs/index`
-
-    * :doc:`../vdpadevs/index`
+.. include:: ../linux_gsg/doc_roadmap_inc.rst
doc/guides/linux_gsg/doc_roadmap_inc.rst new file +61 -0

61 lines not on this page · raw message

doc/guides/linux_gsg/intro.rst +1 -47

51 lines not on this page · raw message

Signature · 1 line
2.32.0
Acked-by on v1 1/1
#1 lore raw
Quoted 9 lines

-----Original Message-----
From: Bruce Richardson <[email protected]>
Sent: Wednesday, March 16, 2022 4:06 PM
To: [email protected]
Cc: Richardson, Bruce <[email protected]>
Subject: [PATCH 22.07] doc: make doc roadmap common for Linux/BSD GSGs

Quoted 6 lines

Both the Linux and FreeBSD GSG docs had a "Documentation Roadmap" section as part of the introduction page, and this contained the same information, with only the reference to the GSGs themselves being different. This text can be consolidated into a single text file which is included by both GSG intro sections - using relative links for the self reference.

Good idea.

#2 lore raw

14/06/2022 16:12, Mcnamara, John:

Quoted 11 lines

From: Bruce Richardson <[email protected]>

Quoted 6 lines

Both the Linux and FreeBSD GSG docs had a "Documentation Roadmap" section as part of the introduction page, and this contained the same information, with only the reference to the GSGs themselves being different. This text can be consolidated into a single text file which is included by both GSG intro sections - using relative links for the self reference.

Good idea.

We already have a file doc/guides/linux_gsg/eal_args.include.rst I'll keep the format .include.rst for such file.

Applied with this update, thanks.

#3 lore raw
Quoted 9 lines · Thomas Monjalon

14/06/2022 16:12, Mcnamara, John:

Quoted 8 lines

From: Bruce Richardson <[email protected]>

Quoted 6 lines

Both the Linux and FreeBSD GSG docs had a "Documentation Roadmap" section as part of the introduction page, and this contained the same information, with only the reference to the GSGs themselves being different. This text can be consolidated into a single text file which is included by both GSG intro sections - using relative links for the self reference.

Quoted 7 lines
Quoted 3 lines

Good idea.

We already have a file doc/guides/linux_gsg/eal_args.include.rst I'll keep the format .include.rst for such file.

Good idea. I missed that common file.

Quoted 2 lines

Applied with this update, thanks.

Thanks