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 75C8645A6E; Mon, 30 Sep 2024 18:19:58 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 870C84064F; Mon, 30 Sep 2024 18:19:55 +0200 (CEST) Received: from mail-pg1-f175.google.com (mail-pg1-f175.google.com [209.85.215.175]) by mails.dpdk.org (Postfix) with ESMTP id 3DA8740299 for ; Mon, 30 Sep 2024 18:19:54 +0200 (CEST) Received: by mail-pg1-f175.google.com with SMTP id 41be03b00d2f7-656d8b346d2so2774632a12.2 for ; Mon, 30 Sep 2024 09:19:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1727713193; x=1728317993; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=9RjKpFSNdJ+sb1akXU4aDs9ps/leif5FkWOZq3/mZQY=; b=TMxvLaxMd0xbd+fWmi+b5xbBBirDyMeldvgVAwlEET42fBw6yYJBkIArdx9EFOhhYR 7Il38BI+6U7ntM+NaP/NvFw/MZV9XM4lyzhwSpcMEK6aglDhufsq5mSp9Ap/VUwwpMBT 7PpTzy43noMQojhgtSXXdv0I/q/od1DTGjD9Yt30oQASJAGpI73K6vAYvvW5ZcT3qTDV j73gB+ppOC2HZKD0uJE0fSIOMT76oHFNBbxRgH8SLh+fVwI9LbJyN3f4MceV1cc+UGvf 7TSRlw9G2VNnDnXz50xc+YeEaztOMuExLsI0GbnqXP6oXkf5wPjIIlCeuNUWV+jsZHUV BNyA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1727713193; x=1728317993; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=9RjKpFSNdJ+sb1akXU4aDs9ps/leif5FkWOZq3/mZQY=; b=wRIGxAMPAEzgG2/wGY+ur4Wxv/gdg8DRCs7r/yttiytHlsrG63W+GocMPqquNa+UAl DdGp/xFgEJyDH/b7k9vVo4b5F5548o6aA3/MC1VckMh6gcMwCGX/IHAR4knWFZLl2m93 i6mt+DdxWnOjAfjKFKsfju7DGRIJWqKD1OPgCdX2xTzI8XVNoDz1GLPIot0t3ssra0rT NmGndeW/7sWpEaJP0hJ/5L6oV5R8L24uxKXd8FEeXSv+mblefQSyVyI5ZqMyl4ft2MVc NVNHZHOOSq+DA223sHYC9QP4d+OP1N4hyoC5kTBzMKG+HXE+Ny96DQ4yjU5bBxk7Ay8G iYbw== X-Gm-Message-State: AOJu0Yyg8W/DrgvIpYWb0ciUWrWFoE35znloUXeP4s1AF7OA9n6AvdlG yf8ptRvi70f1yT1+YHg/MQi1kMskFLvvYfImWiWu02lCgsy0nf02YKUw0lGq2IicfmHquTqtE9y dy9W3JA== X-Google-Smtp-Source: AGHT+IGiyOoLS+eutQs69FXtkRNxVr51w84iR7OmZ42PxEuqUAR+MBgmt+ig71JYYDUrcygkixb9aQ== X-Received: by 2002:a05:6a20:c998:b0:1cf:2ef7:b396 with SMTP id adf61e73a8af0-1d4fa63cb4dmr18229943637.6.1727713193323; Mon, 30 Sep 2024 09:19:53 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-71b2649b8f4sm6408045b3a.26.2024.09.30.09.19.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 30 Sep 2024 09:19:52 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Subject: [RFC v2 2/2] doc: restructure the introduction Date: Mon, 30 Sep 2024 09:19:36 -0700 Message-ID: <20240930161942.8097-2-stephen@networkplumber.org> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20240930161942.8097-1-stephen@networkplumber.org> References: <20240911042800.9203-1-stephen@networkplumber.org> <20240930161942.8097-1-stephen@networkplumber.org> 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 some basic description about the project. Rearrange the guide to put glossary and project information first. Break the main page into sections. Signed-off-by: Stephen Hemminger --- doc/guides/index.rst | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 5cec8a8287..1824f26bf1 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,7 +56,4 @@ DPDK documentation rawdevs/index mempool/index platform/index - contributing/index glossary/index - rel_notes/index - faq/index -- 2.45.2