From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 124584595B; Wed, 11 Sep 2024 06:28:13 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EEA02402DE; Wed, 11 Sep 2024 06:28:12 +0200 (CEST) Received: from mail-pf1-f182.google.com (mail-pf1-f182.google.com [209.85.210.182]) by mails.dpdk.org (Postfix) with ESMTP id 3F3D3402D1 for ; Wed, 11 Sep 2024 06:28:11 +0200 (CEST) Received: by mail-pf1-f182.google.com with SMTP id d2e1a72fcca58-7191f58054aso37639b3a.0 for ; Tue, 10 Sep 2024 21:28:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1726028890; x=1726633690; darn=dpdk.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=+8di1045xahVLCrCqp0IOh8cwkcfLF0KQL/iIxW/Nf0=; b=yvAqUADgcAMHRzf78X8mvtJ/rRTKENW43Fn2g+NFN0HUG1BZsX9Om17reu1dLG4QQf Sax3wD7FmvB+OKYW1/bPTaZBfhHph4QmsH1zFunvc9jafrXtRVDTeUKMcvW3r1mgE/9v wJMQDp2OBTxCdn4WR9peJg2KnfyqRdXDSrJDiI0PwkOOTHWEkFR9a9qw9P+UkZwECbEp d8k7w4HAfViO2GuEH20UC69RMCq/87BgtK3CwePwmbATypnow/ksaMZPz7igTXlqqnxY UehyclVwO3AQeoZ2OK83xTMS0fxTGBXczSWQu0W9GVQEW/Tmuhir0n0Hf26c8bZbTEBu 7CKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1726028890; x=1726633690; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=+8di1045xahVLCrCqp0IOh8cwkcfLF0KQL/iIxW/Nf0=; b=kYe9sUp+75HriZP16QYfJ5yW4D5dWl+gxJHxP95/e0KDQLuS5UFGitCGKF0XNhUcbG 6tSMuoTJhxmgyCFZGs3NzklCWO1LtHKpXcpZHZAfriCeAq/xcxMgP0kb0EJBdr6mU294 nnK23Vs0H/YlGF4FyNwd1SF8Atr+r7bmQiDHQ6STXpC0ZgFWLCX6USFatAQN4ElLqdvK AEVzKcWfqVNk7WoqRbcl1FQMEmg2aupzJMqbH1cKF2mJ2alnw1HZLny6+Rosgh5FMK+r gr7a7bKFPKp7r2aNcRlwbU5/ifws4Uz4JIOnRpY2NAUAkisuKJUoV2yi+PrAZw21gA/C VwKw== X-Gm-Message-State: AOJu0YygLsDGJCT+mcaqEch45Pzz/mfeOHpoG6Ylt+Uu/AuSTU1QLoF3 7WGSJC0StECcad5Wm5HwQ9wG/lgvkTPFRdlVz07OwjBwrNcZZXfvR2+AhITLgB8lDzgfFKoQ7bj + X-Google-Smtp-Source: AGHT+IFT02b9/tbsNjXQ0u6IB8iA0bX1ir8/Diomc6CuZ9QukaWWGjzxR7zpmbzvKyVeH2Lrg1OYgA== X-Received: by 2002:a05:6a21:e85:b0:1cf:122b:6ab6 with SMTP id adf61e73a8af0-1cf62cbaf89mr2926820637.12.1726028890271; Tue, 10 Sep 2024 21:28:10 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7d825ba5eb5sm6389917a12.91.2024.09.10.21.28.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 10 Sep 2024 21:28:09 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: andinipersad361@gmail.com, Stephen Hemminger Subject: [RFC] doc: restructure the introduction Date: Tue, 10 Sep 2024 21:27:26 -0700 Message-ID: <20240911042800.9203-1-stephen@networkplumber.org> X-Mailer: git-send-email 2.45.2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Add an about DPDK section (taken from web site), and a glossary. Split the Programmer's Guide and Devices section. Signed-off-by: Stephen Hemminger --- Rough draft as starting point. Need to also cleanup headers of the sub-sections doc/guides/glossary/index.rst | 26 ++++++++++++++++++++++++++ doc/guides/index.rst | 35 ++++++++++++++++++++++++++++++----- 2 files changed, 56 insertions(+), 5 deletions(-) create mode 100644 doc/guides/glossary/index.rst diff --git a/doc/guides/glossary/index.rst b/doc/guides/glossary/index.rst new file mode 100644 index 0000000000..5da74758b0 --- /dev/null +++ b/doc/guides/glossary/index.rst @@ -0,0 +1,26 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2024 The DPDK contributors + +Glossary of Terms +================== + +EAL + Environment Abstraction Layer. Originally used to isolate differences between running + on bare metal versus running as a userspace process. Bare metal is no longer supported. + Now used to provide abstraction across operating system envrionments. + +Process + An operating system process consisting of one or more threads. + +Thread + The unit of execution in the operating system. A thread maybe bound to a specific physical + core on the CPU or migrate among core's via the operating system scheduler. + +Lcore + A logical core. In DPDK lcore's are usually bound to a isolated physical CPU core. + +Isolated core + A core is isolated if it is reserved by the operating system and not used for normal + (muggle) processes. The operating system scheduler will not migrate a thread onto an + isolated core; the only way a thread will run on an isolated core is by requesting + affinity to that core. diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 244b99624c..ed3557f070 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -1,20 +1,48 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2019 Intel Corporation. -DPDK documentation -================== +############################################ +What is the Dataplane Development Kit (DPDK) +############################################ + +The Dataplane Development Kit (DPDK) is a set of libraries to accelerate packet processing +workloads running on a wide variety of CPU architectures. + +Network performance, throughput, and latency are crucial for diverse applications, including wireless and wireline infrastructure, routers, load balancers, firewalls, video streaming, and VoIP. DPDK (Data Plane Development Kit), an open source project hosted by the Linux Foundation, provides a robust framework that boosts packet processing speeds on various CPU architectures like Intel x86, ARM, and PowerPC. This framework is key to rapidly developing high-speed data packet networking applications. + +By running DPDK, new users can significantly accelerate their network applications’ performance due to its efficient run-to-completion model and optimized libraries that ensure all necessary resources are allocated upfront. .. toctree:: + :caption: About DPDK + :maxdepth: 1 + + glossary/index + contributing/index + rel_notes/index + faq/index + +.. toctree:: + :caption: Getting Started :maxdepth: 1 linux_gsg/index freebsd_gsg/index windows_gsg/index sample_app_ug/index + +.. toctree:: + :caption: Programmers Guide + :maxdepth: 1 + prog_guide/index howto/index tools/index testpmd_app_ug/index + +.. toctree:: + :caption: Device Drivers + :maxdepth: 1 + nics/index bbdevs/index cryptodevs/index @@ -28,6 +56,3 @@ DPDK documentation rawdevs/index mempool/index platform/index - contributing/index - rel_notes/index - faq/index -- 2.45.2