From patchwork Tue Mar 15 22:05:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108726 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 14277A0032; Tue, 15 Mar 2022 23:05:17 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EF478410FC; Tue, 15 Mar 2022 23:05:14 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 0DDEA410EF for ; Tue, 15 Mar 2022 23:05:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647381913; x=1678917913; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=MTUuUlkyL2li90tctqvEqltgs2gdCBGNLIZcaD+7D9U=; b=URqmk4gsvUe/BhWsBHMQ4OhfyCRabBX5vjLL/eGRMr5GecOz9llJOA4p T9eglZSU3ZE2F5W4QWGDaL57/cc0NwZpPaLHw6bApwE9orzRNHMsSTXEO tERg9A9tINEdL+41wFW6SUv+ODMoPtp4qmcR0sojYcCQRy4fD6oLjBmiR kXuycy9X7eH5mNDm5FRlVD67IgfL+I2s6QHgfTmxDJHbhTh9e+rjtLKvu k91oA9FLbHFA1nxZkfxnV3YQJqgrLtGUkceMe7gGMq8dHqd/4V22lqfB8 QDLOLxmwPBQlq2Q1VWwjbISnnUS9SO+UUXzuJjA47pzcDpxJn+oTOhMFD g==; X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256623308" X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="256623308" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Mar 2022 15:05:12 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="512776027" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 15 Mar 2022 15:05:11 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 1/4] doc: add hyperlinks to other docs from FreeBSD GSG Date: Tue, 15 Mar 2022 22:05:01 +0000 Message-Id: <20220315220504.1092437-2-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220315220504.1092437-1-bruce.richardson@intel.com> References: <20220315220504.1092437-1-bruce.richardson@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 The document roadmap section called out the titles of other documents, but these are better as hyperlinks. Signed-off-by: Bruce Richardson --- doc/guides/freebsd_gsg/intro.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst index b2e57909ee..5f677e1655 100644 --- a/doc/guides/freebsd_gsg/intro.rst +++ b/doc/guides/freebsd_gsg/intro.rst @@ -25,15 +25,15 @@ Documentation Roadmap The following is a list of DPDK documents in the suggested reading order: -* **Release Notes** : Provides release-specific information, including supported +* :doc:`../rel_notes/index`: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on. Also, provides the answers to frequently asked questions in FAQ format. -* **Getting Started Guide** (this document): Describes how to install and +* :doc:`../freebsd_gsg/index` (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software. -* **Programmer's Guide**: Describes: +* :doc:`../prog_guide/index`: Describes: * The software architecture and how to use it (through examples), specifically in a Linux* application (linux) environment @@ -47,9 +47,9 @@ The following is a list of DPDK documents in the suggested reading order: A glossary of terms is also provided. -* **API Reference**: Provides detailed information about DPDK functions, +* `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions, data structures and other programming constructs. -* **Sample Applications User Guide**: Describes a set of sample applications. +* :doc:`../sample_app_ug/index`: Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application. From patchwork Tue Mar 15 22:05:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108727 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 72E86A0032; Tue, 15 Mar 2022 23:05:22 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EAC36410FF; Tue, 15 Mar 2022 23:05:17 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 6734841151 for ; Tue, 15 Mar 2022 23:05:16 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647381916; x=1678917916; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=mf+5Y7PIFDquHQnB/MZV6Jy/tPhXOvALV7s+1nchz+A=; b=m14x0GyRnuDtBI1kWOmodpBskkCj/NYyh5vcKJP3eGZGXytbDXKzFtA/ rshxtHaw/p9a8a8wDl5tJ2dQszc+MyetzAPIplTjkv6s3uH32Gp0WTO/o OSOONx2aTrXPvvVMc0F43isdSPFsgF6DnuGW7ANAuOf1gndiZRXdVJM4L B61ONxubzHaf19hCx7FKEUJ/aLQhc/81LFPFTy59tLQoyFrvFlV25NFsK SzE+MTlSbhSUDNu9578qjMB0l9d+xPKxeFNFIH5WjmKtcYOpYarGqeH72 SxHfo9zcEHDGPJDKM2G1Z4BBoS9GecQ/NATNz0XddLk5g970agk9ZkBMT A==; X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256623320" X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="256623320" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Mar 2022 15:05:16 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="512776059" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 15 Mar 2022 15:05:15 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 2/4] doc: add driver guides to document list in FreeBSD GSG Date: Tue, 15 Mar 2022 22:05:02 +0000 Message-Id: <20220315220504.1092437-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220315220504.1092437-1-bruce.richardson@intel.com> References: <20220315220504.1092437-1-bruce.richardson@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 The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list. Signed-off-by: Bruce Richardson --- doc/guides/freebsd_gsg/intro.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst index 5f677e1655..596d84c8f1 100644 --- a/doc/guides/freebsd_gsg/intro.rst +++ b/doc/guides/freebsd_gsg/intro.rst @@ -53,3 +53,28 @@ The following is a list of DPDK documents in the suggested reading order: * :doc:`../sample_app_ug/index`: Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application. + +* **Driver Reference Guides**: Provides details on each driver inside a particular category. + Separate guides exist for each of: + + * :doc:`../bbdevs/index` + + * :doc:`../compressdevs/index` + + * :doc:`../cryptodevs/index` + + * :doc:`../dmadevs/index` + + * :doc:`../eventdevs/index` + + * :doc:`../gpus/index` + + * :doc:`../mempool/index` + + * :doc:`../nics/index` + + * :doc:`../rawdevs/index` + + * :doc:`../regexdevs/index` + + * :doc:`../vdpadevs/index` From patchwork Tue Mar 15 22:05:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108728 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 21C25A0032; Tue, 15 Mar 2022 23:05:28 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D8B6941151; Tue, 15 Mar 2022 23:05:20 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 3EAD541157 for ; Tue, 15 Mar 2022 23:05:19 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647381919; x=1678917919; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=//9gJrXC7kStLZ/OzYtp43O2Gy7QIjsJb6Rbyd70MQY=; b=k1RnJXf9ec1CZ5VU7qnawUNHB3/IV2w8FknIKtAChhawSohFXkFxjObs 79TxJC37w3UABbJgjsIZLUB3t3sZK38IQzuKKDKoyc59FWV/aVKZAGk9z lFRT5tTUG3ldU6sw2gsfMeoYmPvqB0UnkZuqiO+08jJPHHXLkt3zk2nbj 6wOTgnrfwHNrRlCEzkz6x4Ywiuczq9t5YR43lQKpFoOgFaNW7F0Rct6jR UwQEqDsX6Vyip3KXD1WRK+y0rDksvrtPuOYn3AgXq/wBWNpf+njV3tupH UKYVL6QJZbzKWsZcZee0IN4unMX6yLwTQbZvCXZlx1Pz/dRYI6jgSf7PW Q==; X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256623332" X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="256623332" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Mar 2022 15:05:18 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="512776072" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 15 Mar 2022 15:05:18 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 3/4] doc: add hyperlinks to other docs from Linux GSG Date: Tue, 15 Mar 2022 22:05:03 +0000 Message-Id: <20220315220504.1092437-4-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220315220504.1092437-1-bruce.richardson@intel.com> References: <20220315220504.1092437-1-bruce.richardson@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 The document roadmap section called out the titles of other documents, but these are better as hyperlinks. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/intro.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst index 890169e97f..20fe4de630 100644 --- a/doc/guides/linux_gsg/intro.rst +++ b/doc/guides/linux_gsg/intro.rst @@ -14,12 +14,12 @@ Documentation Roadmap The following is a list of DPDK documents in the suggested reading order: -* Release Notes: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on. +* :doc:`../rel_notes/index`: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on. Also, provides the answers to frequently asked questions in FAQ format. -* Getting Started Guide (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software. +* :doc:`../linux_gsg/index` (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software. -* Programmer's Guide: Describes: +* :doc:`../prog_guide/index`: Describes: * The software architecture and how to use it (through examples), specifically in a Linux application (linux) environment @@ -30,7 +30,7 @@ The following is a list of DPDK documents in the suggested reading order: A glossary of terms is also provided. -* API Reference: Provides detailed information about DPDK functions, data structures and other programming constructs. +* `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions, data structures and other programming constructs. -* Sample Applications User Guide: Describes a set of sample applications. +* :doc:`../sample_app_ug/index`: Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application. From patchwork Tue Mar 15 22:05:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108729 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 0A264A0032; Tue, 15 Mar 2022 23:05:34 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C5F9D41157; Tue, 15 Mar 2022 23:05:23 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 4606141157 for ; Tue, 15 Mar 2022 23:05:22 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647381922; x=1678917922; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=J0x8IPQba3G1UboUf6yWjB6pm6jGiZLKIRq60D89pJU=; b=Fn1BAFVuW7duCSN7ej3iIU6x3p+T/m4xMyDedW3Md3FrZYiIoN539iZX ZK2hBI7IbP3KLEDnDFQ9GyVGPQHUYANHf4Hag7O1hqPcS0zQcqnHGd/fz tWFgfHcOPZ+EbanwsQ3qO3RWscy9Kcxtbu2ka7IRFZHsBaMre2yT8gm8C CWswa6TQAtzYEdoHJoG61gHrMtD7Ss3UK0EactzQPCmNKnCfasAcsfosY 97aJgy1WDdQaGfra+TXtBx/d39t4unvRWtUnc4tJ63hpiG18g76lEdJtt DAYmyMe12N7cMIRGwDXPZwLdE/J9V1YQatOXfbXDHJWyXClX6CeZaxxda w==; X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256623346" X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="256623346" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Mar 2022 15:05:21 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="512776094" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 15 Mar 2022 15:05:21 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 4/4] doc: add driver guides to document list in Linux GSG Date: Tue, 15 Mar 2022 22:05:04 +0000 Message-Id: <20220315220504.1092437-5-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220315220504.1092437-1-bruce.richardson@intel.com> References: <20220315220504.1092437-1-bruce.richardson@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 The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/intro.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst index 20fe4de630..1b81df8a0f 100644 --- a/doc/guides/linux_gsg/intro.rst +++ b/doc/guides/linux_gsg/intro.rst @@ -34,3 +34,28 @@ The following is a list of DPDK documents in the suggested reading order: * :doc:`../sample_app_ug/index`: Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application. + +* **Driver Reference Guides**: Provides details on each driver inside a particular category. + Separate guides exist for each of: + + * :doc:`../bbdevs/index` + + * :doc:`../compressdevs/index` + + * :doc:`../cryptodevs/index` + + * :doc:`../dmadevs/index` + + * :doc:`../eventdevs/index` + + * :doc:`../gpus/index` + + * :doc:`../mempool/index` + + * :doc:`../nics/index` + + * :doc:`../rawdevs/index` + + * :doc:`../regexdevs/index` + + * :doc:`../vdpadevs/index`