From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 24EF3427FC;
	Wed, 22 Mar 2023 01:48:12 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id F220B40F18;
	Wed, 22 Mar 2023 01:48:11 +0100 (CET)
Received: from szxga08-in.huawei.com (szxga08-in.huawei.com [45.249.212.255])
 by mails.dpdk.org (Postfix) with ESMTP id CC64C40E09
 for <dev@dpdk.org>; Wed, 22 Mar 2023 01:48:10 +0100 (CET)
Received: from dggpeml500024.china.huawei.com (unknown [172.30.72.56])
 by szxga08-in.huawei.com (SkyGuard) with ESMTP id 4Ph8rZ6LyNz17M85;
 Wed, 22 Mar 2023 08:45:02 +0800 (CST)
Received: from [10.67.100.224] (10.67.100.224) by
 dggpeml500024.china.huawei.com (7.185.36.10) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id
 15.1.2507.21; Wed, 22 Mar 2023 08:48:08 +0800
Subject: Re: [PATCH 00/33] Update net driver documentation
To: Ferruh Yigit <ferruh.yigit@amd.com>, John McNamara
 <john.mcnamara@intel.com>
CC: Thomas Monjalon <thomas@monjalon.net>, Andrew Rybchenko
 <andrew.rybchenko@oktetlabs.ru>, <dev@dpdk.org>
References: <20230321235941.2169068-1-ferruh.yigit@amd.com>
From: fengchengwen <fengchengwen@huawei.com>
Message-ID: <fa7883a5-cb71-1a7d-f3c2-7a210048b475@huawei.com>
Date: Wed, 22 Mar 2023 08:48:08 +0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101
 Thunderbird/68.11.0
MIME-Version: 1.0
In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
X-Originating-IP: [10.67.100.224]
X-ClientProxiedBy: dggems703-chm.china.huawei.com (10.3.19.180) To
 dggpeml500024.china.huawei.com (7.185.36.10)
X-CFilter-Loop: Reflected
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

On 2023/3/22 7:59, Ferruh Yigit wrote:
> 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

Suggest document the template, so that new PMD will refer to it.

I didn't find a guide about how to add a new PMD, the above templeate is good in it.
And the guide could also includes which ops should mandatory implements, which ops
is optional implements.

> 
> Note: Patch sent as each driver separately to help review, it can be squashed
> while merging.
> 
> 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.
> 
> .

...