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 1B6CC42804; Wed, 22 Mar 2023 09:43:55 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F3211410D1; Wed, 22 Mar 2023 09:43:54 +0100 (CET) Received: from NAM04-DM6-obe.outbound.protection.outlook.com (mail-dm6nam04on2063.outbound.protection.outlook.com [40.107.102.63]) by mails.dpdk.org (Postfix) with ESMTP id C334740A84 for ; Wed, 22 Mar 2023 09:43:52 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=IW+diJZBXaN0Csw6xtgdvf64X3dLj/BVaVOXS+diA5zSlQ7bD142PRHrSeL+xzedRRkQP0gE8V6p4Qk+hDv8mPemRMTl8HJRYTkb57D7fAGLQjDH6mHrsAPS2YWZNZS/lcbpDR/PnAKI7BFOvMXaPC1+JuXHJAAHK94VtoXw08PvNiDHhSiKabAhAn3kFs/TA/PAso9vB+YEY4aQybPyIcRdnbCs7MG/VTlFkEDpnJSgYY3VS7k4ZJGp0n4/buDuGLAVS4legdiayvAaD0LUZi8LL84cF4z9KQqBsM9nPOjvhIR+XaO9KZ6BEP6mJxWDsVpyVB6TrVWBVQed8N5bLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=EWxDFCTk9g9UGcGM23kS6Bzz6n3jQVgsBkOXaWTMuaE=; b=fVee69raA208DzhQOy54YlgtZW8OkNA2FCGe3M0M7bRbF3vYi7YJ2X9x5VPVvSDuaa2NhUEsgeA4AJ9cMs3nxsSc56e/DlisJmpOpBm60QUg6VqIOGPEIS9ZQ8xFDYz3SJEWGjNn97OG5T0SuM5Gcpzbcy5mvbkqhTl7AL3tSWXsnxn3A/XRYsC5xiYfunyCX5DexyuadDTOjfjn+kLEAF2b+jYOD8CuqUeyZb3H2JtR4LYvB85800q4P8CZ6yW1gwcEyNXC1qQqoka9dXT7CAsb4SdnDTuAVcgzs1QksW5YfHNJnfEeti9ZtWAa+XJ5mB52/GcisP98flloCvAn2A== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=EWxDFCTk9g9UGcGM23kS6Bzz6n3jQVgsBkOXaWTMuaE=; b=XhyCyfnH9P0TjSqjosW3T1jGRZFJK2d0kkmGL+TQwrIjhQ79ugT0t2NEjG1iMJAdC8bY8UaZa9SDrTPeM4uCl0OUCPkQ3PH+L/WVjwnUdFERnoLFTwtmTRws2F24YOAcuS6aLZGo5ENBrYoR7caTKPq5sJ7ScmT/SCdx1WmP4WU= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by DM4PR12MB8558.namprd12.prod.outlook.com (2603:10b6:8:187::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37; Wed, 22 Mar 2023 08:43:51 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::dd5a:8a5c:f493:9640]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::dd5a:8a5c:f493:9640%5]) with mapi id 15.20.6178.037; Wed, 22 Mar 2023 08:43:50 +0000 Message-ID: <4bccd2b9-5a6b-58a1-ef8e-68a0e91ee91a@amd.com> Date: Wed, 22 Mar 2023 08:43:44 +0000 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.9.0 Subject: Re: [PATCH 00/33] Update net driver documentation Content-Language: en-US To: fengchengwen , John McNamara Cc: Thomas Monjalon , Andrew Rybchenko , dev@dpdk.org References: <20230321235941.2169068-1-ferruh.yigit@amd.com> From: Ferruh Yigit In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ClientProxiedBy: LO4P123CA0083.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:190::16) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|DM4PR12MB8558:EE_ X-MS-Office365-Filtering-Correlation-Id: 6fc1995d-8b96-4321-b4f7-08db2ab18f54 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: gTVS9a+/gSaSjpyuL/FuskLl7+Nvj5MAO5TQuaqjm8G7pat0UmHklaSFFVk/So8FPiOE4r4lXxv0+AFVXQVMp0w8f37LJmvOXP50R4LBvHUgyIAD09QfXLDI9+C/f4/TtLfNxaNVJJ1lwllLNxcMl34tcRWfkNi5oTw54zzy6LKPC/AoCmR3hhUyMY6TY9fs9HVyJ4EFxcy2QdLZ9eETmHQmXKuY41KZ1l+6SZ9dsRx8FaLoOK1lvd35xrxhivORAgIyQeKgY5kmJ28kgic2RCUpMi8QYGxSZsQ7v9qG/oJOBDh0p0sd2l39Gf5Q7mZ41Ry19w6BjWVHHlQfpMZgU4hG2zlBx6wYRbswmptwdxVXKZzdviOIjKPh+RWnGXnYhKRgZ/EGtnvJioHPQ0EpcBuxCXtancp5Gx9dAvFMEeRFaz+ym23ekYhUtz5pumdzSU1+D/Wuto1Twv++oUDbqNySvZRl99KhaS2mYAjCmVHP5bGaCs47qcyvY0FMEDSzreKd+8B6Yev+9gt+QO6PTxUwc3uycCDKiL9zDSzhrC5SnUknM7Q06g9jLN2LXyWR2HsitIZKWOB0WJuaDPG60v5bRBrPs35Eg5N2QUATP/LbfXocltW9GnCFSiMZzH3TvPkJq8uHFTHHCbCHpAbfdwrYHoUMZWUDwDqVxQchYBxrnuH+7WyGm98SUr9yfoBRr7LZOZO3QeMYiF2c4fV+JpPjP+Xjcfb4dGXr1xqLby0= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230025)(4636009)(366004)(346002)(39860400002)(396003)(376002)(136003)(451199018)(2616005)(6666004)(186003)(6486002)(478600001)(83380400001)(316002)(110136005)(26005)(66556008)(66946007)(66476007)(8676002)(31686004)(6512007)(6506007)(53546011)(54906003)(8936002)(44832011)(41300700001)(5660300002)(2906002)(38100700002)(4326008)(86362001)(36756003)(31696002)(45980500001)(43740500002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?SjN1VVN5SkRHTWxZY2dGQWt2Z0VXTXVGbUs5OGsvSDNlR3FQUVRWNHgxYU84?= =?utf-8?B?eDFsanNSUGY4QXhRbHJGY3Fvb1ZpaGRmL1J2V1JCejhXV0F5NlgvUWVDemk1?= =?utf-8?B?L011S01ubTVJbWdMR2hDSGwvRytQSjlhV3BoM1E2K1Qwb2VsZEJmZjI0bi81?= =?utf-8?B?aWpxRU5JakwrTnl6aVZ3eFJsS1QvQ1J5VlU2RTNTaUptT3BnZ2VseGM5ZXYz?= =?utf-8?B?Z2g3bUFKbG1xRkNJWlVXRFk5ZEtja3lSaERFL05Ua0kwd0F4a0Z0cHNzcUl6?= =?utf-8?B?bHVSSlk0dFVQZ2I4NUFyYU9DRlc2QkUzWGw0Qzdwekk1Q2JDT2FrVEhGaWw0?= =?utf-8?B?ZXl2aVF4WnVBRnZGUm91T2JIMTAwMkVpMmtxRkpYakdpci9UczFNanczMFVD?= =?utf-8?B?aGxab2tiM2RpOUN0S2JSNVJ2TjRxUng0RVFTNldYWG8xT0cxSEpqRm83eFl1?= =?utf-8?B?QVd2LzdVcUpGQzFJOU8yZVRjSFN2dEdBczJHd3J5YncyVzZJQ3hYZ0lHRml6?= =?utf-8?B?YmNiZHpXWWEySDg5Njhpa2x3YjJYdmtnNG53dTVYN2JnZFVRRFU0Wk9SZ3Mw?= =?utf-8?B?TlNiUTRPa2NCQWFWbUlXUWV6cW0vQ3ZiRVFlOHlQcE8vMEJZSlExbC9PU3dw?= =?utf-8?B?OHdZWFpMSjJsQVdsWEc3WmIyVVg1Q21GVSsvbXpkLzlIS0dmWUg3YWdBWGhC?= =?utf-8?B?VXdmWUJnSElaaUk4Zzh5MUFBbjR2a0wzL2YrS0dCVFdDT3Y1UE1ueG92U0F5?= =?utf-8?B?cnkrc3FFaGI3WEJNZjduOGtYd2NzT3E3UU1sMC9zR2ZWZjRzSGZHQTkycW8y?= =?utf-8?B?d3ErSHVINVZaZmNnYWYxbExqY2dFTmMwTS9WeFFYK1NhcC9WN0srSE1mSXE5?= =?utf-8?B?Q2NML2lVK25iNWhlT1E0ZUlHbi8zc0dQTVdiTnpaT3pIMnlNbmJra1hHeS9v?= =?utf-8?B?a01JMFlseHU4OTJmd0M0NHFVcldhb2hUSzQyVXI0Snl2Wm9aNU9LeVk5L2JI?= =?utf-8?B?dG80MitSaUV5di96cFExNlRZWVhvZE9yMEdlcjc2RGdoaGhlUHJFVllsc0Nm?= =?utf-8?B?WDQ5VVErYzh6TkVsT29qQWFMM2txY3piSFZydGpOZUhOOHRNbkpJa2dNSWk3?= =?utf-8?B?cCsyZXNSUzFOSXdKaElqZG1KUkk2V2l5YU9ZbmhiUzd2N0F5Q2hsWmc2L1la?= =?utf-8?B?MmtEOE41bk9RZFUrNGlVS1hjNXpOTE80bzMzNFA4bGtTamNzeDRoSWVOY3d0?= =?utf-8?B?YnpOUitvZFRNVmlONFFMUGx1amFkaGRITGhFQ2RPbWtEQlhaQytMSmNsa0Zp?= =?utf-8?B?VTRocGtGUWFaYWRDRXFZdllsV3FLVGY2RkVvZjlNb1hBWWFHcEovVWk5Y1l0?= =?utf-8?B?QXFjelUwY0JpaFY1MEJoQUZYNUxDRmNBZEY2cFpVbkc2VEthMmRZRlU2eDB5?= =?utf-8?B?V0RKSWxnYWh2bU1EbUZ6ZW9Pb2VKUFdwUEwxR2xTRG1vRW1BNFJBWUxhTTdZ?= =?utf-8?B?RlBDcGVPeURtaVVIaGpZb3Q0VWlGYVZyYmpYN3ZFb0NpM1luaGZCdTRBMHYv?= =?utf-8?B?eUx4UW5lb3V5TXRTdXZIMjdZQjBwdDk3QlVjdkl0Z2lhcXN5M1kwVHd0U2RY?= =?utf-8?B?cVZyRWhwWWVJb1FSUXpsUVRqVWZHNzVnVHlNeUNXOTVDK0VsTmlDRSttMldE?= =?utf-8?B?QkNTMkM2QzdQWGt2RkM2TTNLMDkvcEF2YkZRZjgzZ3d1aG00TlV2ek0zaTFz?= =?utf-8?B?dHcxSDhaRlpjKzZ6enNEZGQxZUpTWjRhYVkyZnB1anYzS2hxekEvSHVIRWRY?= =?utf-8?B?M0oyMm96VktRR0tZNEdIM081ZWx5T1BGcFFnVEtYbGdpM0F3Z0VJdjB1NjM0?= =?utf-8?B?NVJaOTNMUlk3b29icjNWWWk2amdnZXVpdU5hUkxqZVdBVjArQ1g3cU4wUFdE?= =?utf-8?B?bS9ZdUtUbFJyVVBRd0czdUgwZytCZ3V0VUFXNUswVzMzbFg0N0w2WnVGQWVZ?= =?utf-8?B?RGZ2TnZ5UVJHUXZVand6RXFtV2ZVTjhTdmtDTEZYWElYN2RYRXhlczBzZzh0?= =?utf-8?B?bm13aHBobnpndWQ0WTVWRWNVSTVUNzNLRE5jM0UvZlB5aU9VOVk2Qjg5dVhL?= =?utf-8?Q?7Cs7hHkoXzC3dz9MjJb5I8uKi?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: 6fc1995d-8b96-4321-b4f7-08db2ab18f54 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2023 08:43:50.8609 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: HqixGSunIzm59R65YO6lYrwMia7uXzSCpIdOJOLIcajlqIAEA5HDfKv+5P2ELqeP X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR12MB8558 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 On 3/22/2023 12:48 AM, fengchengwen wrote: > 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. > +1 to document it, but not sure where to put this information. > 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. >> >> . > > ...