From patchwork Thu Nov 23 01:26:21 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dave Young X-Patchwork-Id: 429 Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2D1184339F; Thu, 23 Nov 2023 02:26:56 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AA845402BD; Thu, 23 Nov 2023 02:26:55 +0100 (CET) Received: from mail-yw1-f173.google.com (mail-yw1-f173.google.com [209.85.128.173]) by mails.dpdk.org (Postfix) with ESMTP id 2249040041 for ; Thu, 23 Nov 2023 02:26:55 +0100 (CET) Received: by mail-yw1-f173.google.com with SMTP id 00721157ae682-5bbfc735572so758797b3.0 for ; Wed, 22 Nov 2023 17:26:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1700702813; x=1701307613; 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=iPV8Olmeg6MUeUZXNLDSCqyC8FxZCD+LW2Zy1Hlyhls=; b=BXnuAtgtuSazK6jOs0zxO27QQzmzK5ZLhTbPJ42ESc2vBzchKhTevVVzA846w3g6cB mCSXpPrt3hX+5lpz056eqh9vCW+2yxeQrp2tw5/qYjcGTXrg4EnpH+zLag0K3UN9mYE7 BIG+SIJnYmiFBYvBFrcRSuUHGQXORqYIlcAOHRkGItIUGbo2r9e3wVoOfkTeCq/vC0dd KTARFtimylsnqXEF8raeGweK6WcPsH85q2gUurx7r+jNvRRkcaHWVQV5I9lTkIJ4+9yt FrlObQDuLH86SQab7P/kg0n3s18hnab2W/qK4WparJv+rlIon7njIzNkhvm1eVmq2xfY HCyQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700702813; x=1701307613; 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=iPV8Olmeg6MUeUZXNLDSCqyC8FxZCD+LW2Zy1Hlyhls=; b=bnyxssEQqlI5ERKH5SmegWVljQA9NUODxaRIE3As3MJniixGRxp9A6z2KCV4Z1pXU7 n0AYA8/IRjyXDVvc0LahDI4wG4UM4q3qk7AeAY+n2AsGKGRXbM/TT75TWMR62/9dDyo3 WVSGVdfUjbnNP/MK5XvTmczQcrNS8TIt4gFiJoG17NGgzXZvDkbyODyMikD7feH+d+mc Eqq/Xz/E3NwvpUKgSoJ9WkQcP0OCugG9f8dQtO+qsrDmRN75TY2qpjaFDl2KUHQn39Af C5F4OkrrwLhJHecpzVQNxLMzOqiagQBtRnlPSWpLBtTZz+eSsdKE/bWC/E3U0tmojUlW wZwQ== X-Gm-Message-State: AOJu0YzJwjRN86o3S978mRLjB78H3gkib8rhgE3btEqvKLT6K/CWnVmT PauRtlvv9gkYW6t0ZD9BUy8G+xZ4miTwHo1R7kA= X-Google-Smtp-Source: AGHT+IFg7/stZWYltzh4a/dWNZl5LzDo+UxCE6+Q/pvlrhJqvkjcbh7UxXzgnR0zjsSIFKyW9yZGUQ== X-Received: by 2002:a81:ae4d:0:b0:5c9:64bf:b037 with SMTP id g13-20020a81ae4d000000b005c964bfb037mr3474652ywk.1.1700702813594; Wed, 22 Nov 2023 17:26:53 -0800 (PST) Received: from localhost.localdomain ([2600:1700:20c0:a560:40f7:d2c:d53a:d071]) by smtp.gmail.com with ESMTPSA id j184-20020a0dc7c1000000b005a815346d95sm89832ywd.71.2023.11.22.17.26.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Nov 2023 17:26:52 -0800 (PST) From: David Young To: dev@dpdk.org Cc: Bruce Richardson , Aaron Conole , David Young Subject: [PATCH v4 0/6] docs: getting started guide consolidation Date: Wed, 22 Nov 2023 20:26:21 -0500 Message-ID: <20231123012633.2005-1-dave@youngcopy.com> X-Mailer: git-send-email 2.41.0.windows.1 In-Reply-To: <20231103040202.2849-1-dave@youngcopy.com> References: <20231103040202.2849-1-dave@youngcopy.com> MIME-Version: 1.0 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 This patch series introduces significant updates to the DPDK Getting Started Guide, enhancing user accessibility and content clarity: 1-Structural Improvements: Integrated links to the Getting Started Guide in the main index. Relocated run_apps.rst to the GSG index and removed run_apps/index.rst. 2-Refined Introduction: Revised the introduction for improved clarity. Highlighted step-by-step instructions adaptable for various operating systems. 3-Installation and Build Process Updates: Redesigned installation instructions, categorizing tools under specific Linux distributions and FreeBSD. Updated Windows section with intuitive navigation and refreshed DPDK building instructions in line with the latest Meson build system. 4-Technical Enhancements: Updated unicode representations with isonum.txt. Refined the hugepages section with corrected information and additional guidance. Streamlined VFIO section instructions for network port binding using dpdk-devbind.py. 5-New Additions and Content Streamlining: Introduced a guide on hugepages for various architectures. Focused on IOMMU support for VFIO on Linux, along with simplified FreeBSD content. Introduced reference tags (.. _vfio_platform:, .. _bifurcated_driver:, .. _uio:) for improved document navigation. 6-Glossary and Navigation Enhancement: Enhanced glossary formatting for readability. Employed structured term definitions with .. glossary:: directive. Expanded term definitions with links to content pages and integrated hyperlinks. David Young (6): Section 1: Introduction Section 2: Install and Build DPDK Section 3: Setting up a System to Run DPDK Applications Section 4: Running Applications Section 5: Appendix Section 6: Glossary .../appendix/cross_compile_dpdk.rst | 37 +++ .../appendix/dpdk_meson_build_options.rst | 57 ++++ .../hugepages_different_architectures.rst | 56 ++++ .../getting_started_guide/appendix/index.rst | 18 ++ .../running_dpdk_apps_without_root.rst | 24 ++ .../appendix/vfio_advanced.rst | 301 ++++++++++++++++++ doc/guides/getting_started_guide/glossary.rst | 78 +++++ doc/guides/getting_started_guide/index.rst | 18 ++ .../building_from_sources.rst | 180 +++++++++++ .../install_and_build/index.rst | 14 + .../installing_prebuilt_packages.rst | 54 ++++ doc/guides/getting_started_guide/intro.rst | 13 + doc/guides/getting_started_guide/run_apps.rst | 114 +++++++ .../getting_started_guide/run_apps/index.rst | 10 + .../run_apps/run_apps.rst | 118 +++++++ .../getting_started_guide/system_setup.rst | 197 ++++++++++++ doc/guides/index.rst | 1 + 17 files changed, 1290 insertions(+) create mode 100644 doc/guides/getting_started_guide/appendix/cross_compile_dpdk.rst create mode 100644 doc/guides/getting_started_guide/appendix/dpdk_meson_build_options.rst create mode 100644 doc/guides/getting_started_guide/appendix/hugepages_different_architectures.rst create mode 100644 doc/guides/getting_started_guide/appendix/index.rst create mode 100644 doc/guides/getting_started_guide/appendix/running_dpdk_apps_without_root.rst create mode 100644 doc/guides/getting_started_guide/appendix/vfio_advanced.rst create mode 100644 doc/guides/getting_started_guide/glossary.rst create mode 100644 doc/guides/getting_started_guide/index.rst create mode 100644 doc/guides/getting_started_guide/install_and_build/building_from_sources.rst create mode 100644 doc/guides/getting_started_guide/install_and_build/index.rst create mode 100644 doc/guides/getting_started_guide/install_and_build/installing_prebuilt_packages.rst create mode 100644 doc/guides/getting_started_guide/intro.rst create mode 100644 doc/guides/getting_started_guide/run_apps.rst create mode 100644 doc/guides/getting_started_guide/run_apps/index.rst create mode 100644 doc/guides/getting_started_guide/run_apps/run_apps.rst create mode 100644 doc/guides/getting_started_guide/system_setup.rst