DPDK patches and discussions
 help / color / mirror / Atom feed
From: David Young <dave@youngcopy.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
	Aaron Conole <aconole@redhat.com>,
	David Young <dave@youngcopy.com>
Subject: [PATCH v4 6/6] Section 6: Glossary
Date: Wed, 22 Nov 2023 20:26:27 -0500	[thread overview]
Message-ID: <20231123012633.2005-7-dave@youngcopy.com> (raw)
In-Reply-To: <20231123012633.2005-1-dave@youngcopy.com>

-Glossary Introduction Formatting: Refined the introduction's formatting for clarity.
-Directive Implementation: Used .. glossary:: directive for structured term definitions.
-Term Definitions and Linking: Expanded definitions for terms like BIOS,
Bifurcated Driver, Clang-LLVM, etc., with reference tags and links to their respective
content pages.
Enhanced Navigation: Integrated hyperlinks for each term, directing to detailed information 
on content pages.
---
 doc/guides/getting_started_guide/glossary.rst | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/glossary.rst

diff --git a/doc/guides/getting_started_guide/glossary.rst b/doc/guides/getting_started_guide/glossary.rst
new file mode 100644
index 0000000000..29e3f041ba
--- /dev/null
+++ b/doc/guides/getting_started_guide/glossary.rst
@@ -0,0 +1,78 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2025 Intel Corporation.
+
+Glossary
+========
+
+This glossary provides definitions for key terms and concepts used within DPDK. Understanding 
+these terms will help in comprehending the functionality and architecture of DPDK.
+
+.. glossary::
+
+    BIOS (Basic Input/Output System)
+
+        The firmware used to perform hardware initialization during the booting process and to provide runtime services for operating systems and programs.
+
+    :ref:`Bifurcated Driver <bifurcated_driver>`
+
+        A driver model that splits functionality between kernel and userspace, often used in high-performance networking.
+
+    :ref:`Clang-LLVM <clang_llvm>`
+
+        A compiler toolchain that includes the Clang C compiler and LLVM linker, used for building DPDK on Windows.
+
+    :ref:`contigmem Module <loading_contigmem_module>`
+
+        A module in FreeBSD that provides physically contiguous memory allocation used by DPDK.
+
+    :ref:`DMA (Direct Memory Access) <direct_memory_access_dma>`
+
+        A feature that allows hardware devices to access the main system memory directly, without involving the CPU.
+
+    :ref:`EAL (Environment Abstraction Layer) <Environment_Abstraction_Layer>`
+
+        The layer within DPDK that abstracts environmental specifics and provides a standard programming interface.
+
+    :ref:`hugepages <memory_setup_reserving_hugepages>`
+
+        Large memory pages used by the operating system to manage memory more efficiently, especially in high-performance applications like DPDK.
+
+    IOMMU (Input-Output Memory Management Unit)
+
+        A hardware component that translates device-visible virtual addresses to physical addresses, providing memory protection and isolation.
+
+    :ref:`MinGW-w64 Toolchain <mingw_w64_toolchain>`
+
+        A development environment for creating Windows applications, used as an option for compiling DPDK on Windows.
+
+    NIC (Network Interface Card)
+
+        A hardware component that connects a computer to a network.
+
+    :ref:`nic_uio Module <nic_uio_module>`
+
+        A UIO driver for network devices in FreeBSD, used by DPDK.
+
+    NUMA (Non-Uniform Memory Access)
+
+        A computer memory design used in multiprocessing where the memory access time depends on the memory location relative to the processor.
+
+    PMD (POLL Mode Driver)
+
+        A type of driver in DPDK that continuously polls for events rather than relying on interrupts, often used for high-performance networking.
+
+    SoC (System on a Chip)
+
+        An integrated circuit that integrates all components of a computer or other electronic system into a single chip.
+
+    :ref:`UIO (Userspace I/O) <uio>`
+
+        A Linux kernel module that enables user-space applications to access hardware devices directly.
+
+    :ref:`VFIO (Virtual Function I/O) <device_setup_vfio>`
+
+        A kernel driver that allows a virtual machine to access physical devices directly, used in DPDK for device assignment.
+
+    :ref:`VFIO Platform <vfio_platform>`
+
+        A framework in Linux that allows exposing direct device access to userspace, in a secure, IOMMU-protected way.
-- 
2.41.0.windows.1


  parent reply	other threads:[~2023-11-23  1:27 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-03  4:01 [PATCH v3 0/7] docs: getting started guide consolidation David Young
2023-11-03  4:01 ` [PATCH v3 1/7] Section 1: Introduction David Young
2023-11-03 13:11   ` Bruce Richardson
2023-11-03  4:01 ` [PATCH v3 2/7] Section 2: Install and Build DPDK David Young
2023-11-03 13:55   ` Bruce Richardson
2023-11-03  4:01 ` [PATCH v3 3/7] Section 3: Setting up a System to Run DPDK Applications David Young
2023-11-03 14:17   ` Bruce Richardson
2023-11-03  4:01 ` [PATCH v3 4/7] Section 4: Running Applications David Young
2023-11-03 15:13   ` Bruce Richardson
2023-11-03  4:01 ` [PATCH v3 5/7] Section 5: Appendix David Young
2023-11-03 15:23   ` Bruce Richardson
2023-11-16  1:28     ` Dave Young
2023-11-17 13:04       ` Bruce Richardson
2023-11-03  4:01 ` [PATCH v3 6/7] Added link to Getting Started Guide in index.rst David Young
2023-11-03 13:32   ` Bruce Richardson
2023-11-03 14:22   ` Bruce Richardson
2023-11-08  1:47     ` Dave Young
2023-11-08  2:06       ` Dave Young
2023-11-03  4:01 ` [PATCH v3 7/7] Section 6: Glossary David Young
2023-11-03 15:26   ` Bruce Richardson
2023-11-23  1:26 ` [PATCH v4 0/6] docs: getting started guide consolidation David Young
2023-11-23  1:26   ` [PATCH v4 1/6] Section 1: Introduction David Young
2023-11-23  1:26   ` [PATCH v4 2/6] Section 2: Install and Build DPDK David Young
2023-11-23  1:26   ` [PATCH v4 3/6] Section 3: Setting up a System to Run DPDK Applications David Young
2023-11-23  1:26   ` [PATCH v4 4/6] Section 4: Running Applications David Young
2023-11-23  1:26   ` [PATCH v4 5/6] Section 5: Appendix David Young
2023-11-23  1:26   ` David Young [this message]
2024-09-11 15:54     ` [PATCH v4 6/6] Section 6: Glossary Stephen Hemminger
2024-09-11 15:55     ` Stephen Hemminger
2023-12-01 15:17   ` [PATCH v4 0/6] docs: getting started guide consolidation Thomas Monjalon
2024-10-04 16:29   ` Stephen Hemminger

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=20231123012633.2005-7-dave@youngcopy.com \
    --to=dave@youngcopy.com \
    --cc=aconole@redhat.com \
    --cc=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).