diff mbox series

[v2,5/8] doc/linux_gsg: expand list of directories

Message ID 20220310123843.612207-6-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Linux GSG doc updates |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson March 10, 2022, 12:38 p.m. UTC 
  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 mbox series

Patch

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
 -----------------------------------------