DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: john.mcnamara@intel.com, Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH v2 5/8] doc/linux_gsg: expand list of directories
Date: Thu, 10 Mar 2022 12:38:40 +0000	[thread overview]
Message-ID: <20220310123843.612207-6-bruce.richardson@intel.com> (raw)
In-Reply-To: <20220310123843.612207-1-bruce.richardson@intel.com>

Not all directories were given in the GSG document, but many of those
omitted would be of interest to users, e.g. "doc", "license" and
"usertools" directories. Adding these leaves only "devtools", and
"kernel" as the only undocumented directories, so add them in too for
completeness.

When updating the section, add "including" to the line leading up to the
directory list, indicating that, while the list is currently complete,
it is not guaranteed to always be.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/linux_gsg/build_dpdk.rst | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 0b08492ca2..4f2def15ed 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -16,7 +16,11 @@ First, uncompress the archive and move to the uncompressed DPDK source directory
     tar xJf dpdk-<version>.tar.xz
     cd dpdk-<version>
 
-The DPDK is composed of several directories:
+The DPDK is composed of several directories, including:
+
+*   doc: DPDK Documentation
+
+*   license: DPDK license information
 
 *   lib: Source code of DPDK libraries
 
@@ -28,6 +32,13 @@ The DPDK is composed of several directories:
 
 *   config, buildtools: Framework-related scripts and configuration
 
+*   usertools: Utility scripts for end-users of DPDK applications
+
+*   devtools: Scripts for use by DPDK developers
+
+*   kernel: Kernel modules needed for some operating systems
+
+
 Compiling and Installing DPDK System-wide
 -----------------------------------------
 
-- 
2.32.0


  parent reply	other threads:[~2022-03-10 12:39 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-08 14:49 [PATCH 0/5] Small Doc improvements for Linux GSG Bruce Richardson
2022-03-08 14:49 ` [PATCH 1/5] doc/linux_gsg: add driver guides to document list Bruce Richardson
2022-03-08 14:49 ` [PATCH 2/5] doc/linux_gsg: drop note about old chipset Bruce Richardson
2022-03-08 14:49 ` [PATCH 3/5] doc/linux_gsg: remove duplicated note Bruce Richardson
2022-03-08 14:50 ` [PATCH 4/5] doc/linux_gsg: merge requirements section for app building Bruce Richardson
2022-03-08 14:50 ` [PATCH 5/5] doc/linux_gsg: expand list of directories Bruce Richardson
2022-03-10 12:38 ` [PATCH v2 0/8] Linux GSG doc updates Bruce Richardson
2022-03-10 12:38   ` [PATCH v2 1/8] doc/linux_gsg: add driver guides to document list Bruce Richardson
2022-03-10 12:38   ` [PATCH v2 2/8] doc/linux_gsg: drop note about old chipset Bruce Richardson
2022-03-10 12:38   ` [PATCH v2 3/8] doc/linux_gsg: remove duplicated note Bruce Richardson
2022-03-10 12:38   ` [PATCH v2 4/8] doc/linux_gsg: merge requirements section for app building Bruce Richardson
2022-03-10 12:38   ` Bruce Richardson [this message]
2022-03-10 12:38   ` [PATCH v2 6/8] doc/linux_gsg: shorten details on HPET use Bruce Richardson
2022-03-10 12:38   ` [PATCH v2 7/8] doc/linux_gsg: drop reference to KNI Bruce Richardson
2022-03-10 12:38   ` [PATCH v2 8/8] doc/linux_gsg: remove section on IOMMU pass-through Bruce Richardson
2022-03-15 18:46   ` [PATCH v2 0/8] Linux GSG doc updates Thomas Monjalon
2022-03-15 21:41     ` 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=20220310123843.612207-6-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    /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).