From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH 22.07] doc: make doc roadmap common for Linux/BSD GSGs
Date: Wed, 16 Mar 2022 16:05:46 +0000 [thread overview]
Message-ID: <20220316160546.1100901-1-bruce.richardson@intel.com> (raw)
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.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
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
diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst
index 596d84c8f1..6cdfea4b87 100644
--- a/doc/guides/freebsd_gsg/intro.rst
+++ b/doc/guides/freebsd_gsg/intro.rst
@@ -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
diff --git a/doc/guides/linux_gsg/doc_roadmap_inc.rst b/doc/guides/linux_gsg/doc_roadmap_inc.rst
new file mode 100644
index 0000000000..6686975f7b
--- /dev/null
+++ b/doc/guides/linux_gsg/doc_roadmap_inc.rst
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2010-2022 Intel Corporation.
+
+..
+ NOTE: this file is common between BSD and Linux, so should be kept general
+
+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:`./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`
diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst
index 1b81df8a0f..06987a40d0 100644
--- a/doc/guides/linux_gsg/intro.rst
+++ b/doc/guides/linux_gsg/intro.rst
@@ -12,50 +12,4 @@ without going deeply into detail.
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:`../linux_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:: doc_roadmap_inc.rst
--
2.32.0
next reply other threads:[~2022-03-16 16:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-16 16:05 Bruce Richardson [this message]
2022-06-14 14:12 ` Mcnamara, John
2022-06-26 21:34 ` Thomas Monjalon
2022-06-27 7:49 ` Bruce Richardson
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=20220316160546.1100901-1-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 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).