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 7D6F445AAF; Fri, 4 Oct 2024 18:29:06 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6BF0842D97; Fri, 4 Oct 2024 18:29:06 +0200 (CEST) Received: from mail-pf1-f174.google.com (mail-pf1-f174.google.com [209.85.210.174]) by mails.dpdk.org (Postfix) with ESMTP id 33E864025F for ; Fri, 4 Oct 2024 18:29:05 +0200 (CEST) Received: by mail-pf1-f174.google.com with SMTP id d2e1a72fcca58-71dae4fc4c9so2007699b3a.0 for ; Fri, 04 Oct 2024 09:29:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20230601.gappssmtp.com; s=20230601; t=1728059344; x=1728664144; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:subject:cc:to:from:date:from:to:cc:subject:date :message-id:reply-to; bh=x1/NCmL/Tdm2KN1fkFFztWXP2sbQSyPN8I4pqUgv3r0=; b=ccWRegKrr23Hj8wcQKfSG2+HHkFlyTRI3k/R03C5pFtSewH6u39PVafsiFt0MvqyEj Iy/pUJ97nag5ZMkfusP7icZqGXu16R54vEKyxkloyF+PIQPMpEC39uw0TTovYM7fnKES zBwdQWhOLCj4CMePhg0v9v9V47YSHfPeXu9I99lJP6KW20kflmUfDwUZn7zfzkJwPJvu CvTQgmzvAFkqT1Bg6a5BrfikQzttuAI6qhBIrvHDjVsevKqDVvK86XLvfOys3Eu54Uj3 0LAAGkSPiaCxA3jpk0nd1TFgBiwkBsgmeC6xijvM7p28XSQv//zFpUGgs2yz5kuuZMIo VG6g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1728059344; x=1728664144; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:subject:cc:to:from:date:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=x1/NCmL/Tdm2KN1fkFFztWXP2sbQSyPN8I4pqUgv3r0=; b=KGQCTDedX5dfZmn3G/T9JIxLjCDMGlweoBgoxtMJPq8PmeBbwVyJ1kiUpDR+GhqSj+ NI99VinuowmCZHlfUFF2Yvpm2DXrWwXDjfHaEOQoEuJEzYY2VJU6JDB8t7qdhhgWg1Pg GYGI6/dSoU9WOuEudwSW/Kr7s0wSmQ9yZ5BoJgtOMVF4ZHff02h/3NoN6dHZwH8LIVA1 j1QyJGC+TZikBbLa0mYnT42jlctAHsGM+rc91Gc/pZQgjW150eRXYprppLzgJ6ecDVKi 45RaZkNg/pb1NAohJv1/pbJGdLY1LVvjJHU3DKbRcqvyOAGJf39HIrb+eIyp45BR835N fsIQ== X-Gm-Message-State: AOJu0YwLV3C9R/+t6mXW4nAD6fMiQymIZtXRryZhYM+oAjRkFtHcwXqd bFMQ1VUjCghUeqYy9ArswDDFPolJUJKtXjKfTUTDSlklG9tw8UXXD8UIEED4kwo= X-Google-Smtp-Source: AGHT+IE+/1cmZQnV91mmMw5WohLIlmy/nK/Wqu4zRk+NAR2O9Cx6ivzhPTNX+zgRXFnObOiDfIJZTA== X-Received: by 2002:a05:6a00:2716:b0:71d:eac5:f098 with SMTP id d2e1a72fcca58-71deac5f5f6mr2350011b3a.21.1728059344216; Fri, 04 Oct 2024 09:29:04 -0700 (PDT) Received: from hermes.local (204-195-96-226.wavecable.com. [204.195.96.226]) by smtp.gmail.com with ESMTPSA id 41be03b00d2f7-7e9f682c801sm142920a12.39.2024.10.04.09.29.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 04 Oct 2024 09:29:04 -0700 (PDT) Date: Fri, 4 Oct 2024 09:29:02 -0700 From: Stephen Hemminger To: David Young Cc: dev@dpdk.org, Bruce Richardson , Aaron Conole Subject: Re: [PATCH v4 0/6] docs: getting started guide consolidation Message-ID: <20241004092902.7668ee03@hermes.local> In-Reply-To: <20231123012633.2005-1-dave@youngcopy.com> References: <20231103040202.2849-1-dave@youngcopy.com> <20231123012633.2005-1-dave@youngcopy.com> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit 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 On Wed, 22 Nov 2023 20:26:21 -0500 David Young wrote: > 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 > This patch set is a good start, but it needs more work to be merged. As Thomas said, the old part needs to go and as I showed in another patch the glossary needs to be at top level in DPDK not buried at end of the gsg.