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 5E04B4285A; Tue, 28 Mar 2023 18:59:19 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E4E604021D; Tue, 28 Mar 2023 18:59:18 +0200 (CEST) Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com [66.111.4.26]) by mails.dpdk.org (Postfix) with ESMTP id 4640040156 for ; Tue, 28 Mar 2023 18:59:17 +0200 (CEST) Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailout.nyi.internal (Postfix) with ESMTP id CDE695C0181; Tue, 28 Mar 2023 12:59:15 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute4.internal (MEProxy); Tue, 28 Mar 2023 12:59:15 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:content-type:content-type:date :date:from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:sender:subject:subject:to:to; s=fm2; t= 1680022755; x=1680109155; bh=3Dc2DZia9WhMBzR32Huyy5uc+07PSc+THD9 7mGCYx3A=; b=dY1wAoqMlRLNsXnEcOec6WyQIASx+Kl5OBNRnzEAwQvouz+gaut 6MHeVuGdg9Xg9CqzEi8xgu+bqzaFDy20fXKAGzED2Q22vXlQkHqDI1UilNjjjscV cMJt6eqwiIQAMm8UGz/o3mfr5ZeDIIwQjzZ0lI2wl+tWcjMU5O1CL9XhEYuczDo7 KdV7cRFoYhotEmALdUV/zQngiEP+luC047XEKd0/ZeMYAsln0aYuAC1uLZGpP8xt 1ZWUWBkkIlHUmhLTdW+dGzpbodKkcpO2jwWWJbqLaRlcHmdYgejadQZ2L+70l0rm IZCnIbjA5NO1RbAzw1nKR8b6aLV4Na95KIw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:content-type:date:date:feedback-id:feedback-id :from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:sender:subject:subject:to:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t= 1680022755; x=1680109155; bh=3Dc2DZia9WhMBzR32Huyy5uc+07PSc+THD9 7mGCYx3A=; b=pE/p2B8Xipv5RZUCCh5K82mGsf1GtdbrJhyYU/ssPoS7moslotd iShig+FLRPFDZsUId6X+tjF9v4AWx+iZUzpavqALCXnCEsowl6kXzNqqK4pv/kD1 CUqtNn+Nmu0P3Gf0TbcRRW7p951iXM1t7cGjPG1Wo9Dc9Ikn0BXe9B9H06xipMaN k2A10zA9cYc46UaifrP5kBC6CtHwIQ3r5gTFAU/PuU5dKJ8e6ncpQOYWqUMA0zDl WemaC2NCTvVoDbAuXNBbqHe7YwG51Mrfx7WSOfVq4NDbqB54jM6YA3dezVMAhnPJ elHePL50Y/GdlvwFmHwbfEX6F/uYtBmQAvg== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvhedrvdehgedguddtjecutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfgh necuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmd enucfjughrpefhvfevufffkfgjfhgggfgtsehtufertddttddvnecuhfhrohhmpefvhhho mhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqne cuggftrfgrthhtvghrnheptdejieeifeehtdffgfdvleetueeffeehueejgfeuteeftddt ieekgfekudehtdfgnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilh hfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvth X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 28 Mar 2023 12:59:14 -0400 (EDT) From: Thomas Monjalon To: Ferruh Yigit Cc: John McNamara , dev@dpdk.org, Andrew Rybchenko Subject: Re: [PATCH 00/33] Update net driver documentation Date: Tue, 28 Mar 2023 18:59:12 +0200 Message-ID: <5755074.zQ0Gbyo6oJ@thomas> In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com> References: <20230321235941.2169068-1-ferruh.yigit@amd.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" 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 22/03/2023 00:59, Ferruh Yigit: > Some PMDs has "Pre-Installation Configuration" section in their documentation, > although section is not clear I assume that is historical from times compile > time parameters and 'make' build system used, where common make target was > 'install', so section refers to compile time configuration. > > Right now device arguments ("Runtime configuration") is documented under this > section which is confusing, so updating section name > from "Pre-Installation Configuration" to "Configuration". > > While touching documents trying to keep following template in the documents, > with section names and order, to have consistent documents without being > too strict on applying the template: > > [Overview] > Supported Devices > Supported Features > Prerequisites > Configuration > Compilation Options > Environment variables > Runtime Configuration > Debugging > Limitations or Known issues > Testpmd driver specific commands > > Note: Patch sent as each driver separately to help review, it can be squashed > while merging. Squashed and applied, thanks. > Other further improvements not covered here can be visiting > "Building DPDK" sections which has redundant and less useful information, > and "Usage example" section which has testpmd log, most of the part is same for > all drivers. Yes, good idea to remove redundant information and replace with good links.