From patchwork Fri May 27 13:45:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Van Haaren, Harry" X-Patchwork-Id: 111981 X-Patchwork-Delegate: thomas@monjalon.net 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 3B210A055E; Fri, 27 May 2022 15:45:13 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DBEE84114A; Fri, 27 May 2022 15:45:12 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mails.dpdk.org (Postfix) with ESMTP id 00A9F40E78 for ; Fri, 27 May 2022 15:45:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1653659110; x=1685195110; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=Wmz7iozaax0x3eVwdNPsx8cJFQTdKSS7HP9/Iq+HWyI=; b=PGJkPM97gE2CrYUV4PsoCXp81hHxG2KYpb/Wre7hcafyGdXU/RPxqA6A eAAsmSlry5DN/WhKuyqp2VqNF8PYLokVxFxoo5feyqmy5/p06qETwN2XV IUDss6f7yWHpuOKWigqroz47g2UzGaHN3GvHwD8PhF0wZQZIEzTsUiYo8 GBONo36c3vkwv9hKMwAdf2cJ0P+ZMOzxnRkyu4XQERS8LiBGQLqFvIrvx IwQpSfs/+ydC9aEO03qVmlTaY0orzoXY1YBakD7I7d03gkC2SaK0AZXcR R8aiNr9gEbLLHDjUAR/ZCYoeHsMDAqzp7SBqFGTSQ6SEQWN7zbpc5g6IM g==; X-IronPort-AV: E=McAfee;i="6400,9594,10359"; a="299825139" X-IronPort-AV: E=Sophos;i="5.91,255,1647327600"; d="scan'208";a="299825139" Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 May 2022 06:45:08 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.91,255,1647327600"; d="scan'208";a="643397183" Received: from silpixa00401120.ir.intel.com ([10.55.128.255]) by fmsmga004.fm.intel.com with ESMTP; 27 May 2022 06:45:07 -0700 From: Harry van Haaren To: dev@dpdk.org Cc: Harry van Haaren , konstantin.v.ananyev@yandex.ru Subject: [PATCH 1/2] docs/bpf: fix formatting and link Date: Fri, 27 May 2022 13:45:00 +0000 Message-Id: <20220527134501.2209817-1-harry.van.haaren@intel.com> X-Mailer: git-send-email 2.32.0 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 Small improvements to the documentation based on Sphinx HTML doc output. Signed-off-by: Harry van Haaren Acked-by: Konstantin Ananyev --- Cc: konstantin.v.ananyev@yandex.ru --- doc/guides/prog_guide/bpf_lib.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/guides/prog_guide/bpf_lib.rst b/doc/guides/prog_guide/bpf_lib.rst index 1feb7734a3..1cf2d59429 100644 --- a/doc/guides/prog_guide/bpf_lib.rst +++ b/doc/guides/prog_guide/bpf_lib.rst @@ -10,7 +10,7 @@ user-space dpdk application. It supports basic set of features from eBPF spec. Please refer to the -`eBPF spec ` +`eBPF spec `_ for more information. Also it introduces basic framework to load/unload BPF-based filters on eth devices (right now only via SW RX/TX callbacks). @@ -48,9 +48,9 @@ For example, ``(BPF_IND | BPF_W | BPF_LD)`` means: .. code-block:: c uint32_t tmp; - R0 = rte_pktmbuf_read((const struct rte_mbuf *)R6, src_reg + imm32, - sizeof(tmp), &tmp); - if (R0 == NULL) return FAILED; + R0 = rte_pktmbuf_read((const struct rte_mbuf *)R6, src_reg + imm32, sizeof(tmp), &tmp); + if (R0 == NULL) + return FAILED; R0 = ntohl(*(uint32_t *)R0); and ``R1-R5`` were scratched. From patchwork Fri May 27 13:45:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Van Haaren, Harry" X-Patchwork-Id: 111982 X-Patchwork-Delegate: thomas@monjalon.net 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 BCC76A055E; Fri, 27 May 2022 15:45:18 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AEC2C427F5; Fri, 27 May 2022 15:45:13 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mails.dpdk.org (Postfix) with ESMTP id 67C1840E78 for ; Fri, 27 May 2022 15:45:11 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1653659111; x=1685195111; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=3wHjveeHzdp/W9bdXas0DafO3V41T0LeUPOBRDGJyZk=; b=kwaY96aRivvBQUO3y6Ac3KHOSRWiF1D1JhXg70XvopIXxi+AGogCdYsq 5ir7wTk93o5tulWU6Yq0R4NyHdsoSgFaWt2hF0FS1QCCs5YLvKzRJpRxu +TjGG3DML3/TdnjmGlaRMrO4z3TZDp05v5ui0oKgzosotUhQybkd11MPr EpJ4OiBnpvlPU00NA3IKEsYSRylQHKk83re8YnzsFQSusp+F03YBw1XoI I524iI5Vjzp4sQB3DQvkYLj9c10ztqHjyaRzVfpJEAk2zDlMGHAYSFovX qdp6sSGhZgc1tk+vcPkPAmsi4rivwXuzvhxz8YTFabsNj7cy3AIYqYREH g==; X-IronPort-AV: E=McAfee;i="6400,9594,10359"; a="299825142" X-IronPort-AV: E=Sophos;i="5.91,255,1647327600"; d="scan'208";a="299825142" Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 May 2022 06:45:09 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.91,255,1647327600"; d="scan'208";a="643397192" Received: from silpixa00401120.ir.intel.com ([10.55.128.255]) by fmsmga004.fm.intel.com with ESMTP; 27 May 2022 06:45:08 -0700 From: Harry van Haaren To: dev@dpdk.org Cc: Harry van Haaren Subject: [PATCH 2/2] docs: improve ordering and remove old header titles Date: Fri, 27 May 2022 13:45:01 +0000 Message-Id: <20220527134501.2209817-2-harry.van.haaren@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220527134501.2209817-1-harry.van.haaren@intel.com> References: <20220527134501.2209817-1-harry.van.haaren@intel.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 Move the "source_org" page to after overview, where it fits better to explain the source-code layout of DPDK, before getting into details of specific libraries such as EAL. Also removes the older titles from the 3 documents which still had them. Signed-off-by: Harry van Haaren --- doc/guides/prog_guide/index.rst | 2 +- doc/guides/prog_guide/overview.rst | 2 -- doc/guides/prog_guide/perf_opt_guidelines.rst | 2 -- doc/guides/prog_guide/source_org.rst | 2 -- 4 files changed, 1 insertion(+), 7 deletions(-) diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst index 6c7942b845..8564883018 100644 --- a/doc/guides/prog_guide/index.rst +++ b/doc/guides/prog_guide/index.rst @@ -10,6 +10,7 @@ Programmer's Guide intro overview + source_org env_abstraction_layer service_cores trace_lib @@ -67,7 +68,6 @@ Programmer's Guide bpf_lib ipsec_lib graph_lib - source_org build-sdk-meson meson_ut build_app diff --git a/doc/guides/prog_guide/overview.rst b/doc/guides/prog_guide/overview.rst index 537a568f1e..a3b6603320 100644 --- a/doc/guides/prog_guide/overview.rst +++ b/doc/guides/prog_guide/overview.rst @@ -1,8 +1,6 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -**Part 1: Architecture Overview** - Overview ======== diff --git a/doc/guides/prog_guide/perf_opt_guidelines.rst b/doc/guides/prog_guide/perf_opt_guidelines.rst index 88f92909c1..360009f2e4 100644 --- a/doc/guides/prog_guide/perf_opt_guidelines.rst +++ b/doc/guides/prog_guide/perf_opt_guidelines.rst @@ -3,8 +3,6 @@ .. _Performance_Optimization: -**Part 3: Performance Optimization** - Performance Optimization Guidelines =================================== diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst index 5e4333460a..3d5f7f3bdd 100644 --- a/doc/guides/prog_guide/source_org.rst +++ b/doc/guides/prog_guide/source_org.rst @@ -1,8 +1,6 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation. -**Part 2: Development Environment** - Source Organization ===================