From patchwork Wed Mar 16 13:45:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108737 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 46588A0032; Wed, 16 Mar 2022 14:46:05 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BD6BE410F3; Wed, 16 Mar 2022 14:46:04 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id F0A4140395 for ; Wed, 16 Mar 2022 14:46:02 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1647438363; x=1678974363; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=lkWGvuxdhYOALfVYMepcK+cKUCFeSdiSfFxE9f/ssRY=; b=ZBhjbyxburk/Pmvn2YttokW0khHjUJyt0kwejEstmK9Sj7ihwr0ak0e0 CmDLHLusZyd1B1T4SKH8m7I+4uKRfHnfng6sO0r8C1sz3H1iBaVOw7PWo /0OUOA4OrrkzpAdfNP4rrUs4JFqVNCa27pQCIS/6RQFJ4LPQo/r3tEsQh y9MKwhpBTOzC7hFSb5VxMY2Gh59ltTPiEEVNgHCHPSNdIgaWcogcS8FXj ImVPZehmomqsaIvaa5Dk2Ooojb0a3phRozxhbtG7R2ZioG0tuxuOOvn5w l1Rynqd61F7eraqNzKr/cY72T9nl6BpRWKSaSjjbAqYTZpO4PH04RlkCA Q==; X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256780527" X-IronPort-AV: E=Sophos;i="5.90,186,1643702400"; d="scan'208";a="256780527" Received: from orsmga005.jf.intel.com ([10.7.209.41]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 Mar 2022 06:46:01 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,186,1643702400"; d="scan'208";a="714606466" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga005.jf.intel.com with ESMTP; 16 Mar 2022 06:46:00 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH v2 0/9] Improve Linux drivers GSG section Date: Wed, 16 Mar 2022 13:45:42 +0000 Message-Id: <20220316134551.1099599-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220302172217.472279-1-bruce.richardson@intel.com> References: <20220302172217.472279-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 This patchset reworks large parts of the linux drivers section of the Linux Getting Started Guide, so as to make it clearer and easier to read. The overall flow of the page is adjusted so that more important information is nearer the top, and so that all information on VFIO is consolidated into a single section. In terms of the content of the sections, there are some minor changes to adjust what is a warning vs just a "note" in the doc, and there are some updates to increase emphasis on VFIO ovs UIO. Including stable on CC for the set, as all patches may be candidates for backport to help improve docs for older releases too. V2: * Rebased on top of main, now that other doc patches are applied * Reworded commit titles to use "doc:" prefix Bruce Richardson (9): doc: replace special characters for (R) symbol in Linux GSG doc: fix missing note on UIO module in Linux GSG doc: make UIO safety warning more visible in Linux GSG doc: move section on binding drivers up the page in GSG doc: emphasise VFIO over UIO-based modules in GSG doc: split GSG VFIO section into subsections doc: move GSG section on UIO to the end of drivers page doc: consolidate all VFIO content on GSG driver page doc: change informational warnings to notes in Linux GSG doc/guides/linux_gsg/enable_func.rst | 8 +- doc/guides/linux_gsg/linux_drivers.rst | 396 +++++++++++++------------ doc/guides/linux_gsg/sys_reqs.rst | 6 +- 3 files changed, 217 insertions(+), 193 deletions(-) --- 2.32.0