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 8C48F4591A;
	Fri,  6 Sep 2024 08:46:27 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 7CE5442EBB;
	Fri,  6 Sep 2024 08:46:27 +0200 (CEST)
Received: from dkmailrelay1.smartsharesystems.com
 (smartserver.smartsharesystems.com [77.243.40.215])
 by mails.dpdk.org (Postfix) with ESMTP id A0CC642EBA;
 Fri,  6 Sep 2024 08:46:25 +0200 (CEST)
Received: from smartserver.smartsharesystems.com
 (smartserver.smartsharesys.local [192.168.4.10])
 by dkmailrelay1.smartsharesystems.com (Postfix) with ESMTP id AD36720EE8;
 Fri,  6 Sep 2024 08:46:24 +0200 (CEST)
Content-class: urn:content-classes:message
MIME-Version: 1.0
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Subject: RE: [RFC 1/3] uapi: introduce kernel uAPI headers importation
Date: Fri, 6 Sep 2024 08:46:20 +0200
X-MimeOLE: Produced By Microsoft Exchange V6.5
Message-ID: <98CBD80474FA8B44BF855DF32C47DC35E9F6AC@smartserver.smartshare.dk>
In-Reply-To: <20240905221528.1861323-2-maxime.coquelin@redhat.com>
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
Thread-Topic: [RFC 1/3] uapi: introduce kernel uAPI headers importation
Thread-Index: Adr/4SXforbQitPPS/OEugteybndxwARjnnQ
References: <20240905221528.1861323-1-maxime.coquelin@redhat.com>
 <20240905221528.1861323-2-maxime.coquelin@redhat.com>
From: =?iso-8859-1?Q?Morten_Br=F8rup?= <mb@smartsharesystems.com>
To: "Maxime Coquelin" <maxime.coquelin@redhat.com>
Cc: <dev@dpdk.org>, <techboard@dpdk.org>, <david.marchand@redhat.com>,
 <thomas@monjalon.net>
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

> From: Maxime Coquelin [mailto:maxime.coquelin@redhat.com]
> Sent: Friday, 6 September 2024 00.15
>=20
> This patch introduces uAPI headers importation into the
> DPDK repository. This import is possible thanks to Linux
> Kernel licence exception for syscalls:
>=20
> =
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/L=
ICENS
> ES/exceptions/Linux-syscall-note
>=20
> Header files are have to be explicitly imported, and
> libraries and drivers have to explicitly enable their
> inclusion.
>=20
> Guidelines are provided in the documentation, and a helper
> script is also provided to ensure proper importation of the
> header (unmodified content from a released Kernel version).
>=20
> Next version will introduce a script to check headers are
> valids.
>=20
> Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---

Excellent solution, Maxime.

Minor suggestions and typos mentioned below.

Acked-by: Morten Br=F8rup <mb@smartsharesystems.com>


> +print_usage()
> +{
> +	echo "Usage: $(basename $0) [-h] [file] [version]"
> +	echo "Example of valid file is linux/vfio.h"
> +	echo "Example of valid version is v6.10"

Suggest:
+	echo "Example of valid file: linux/vfio.h"
+	echo "Example of valid version: v6.10"


> +Once imported, the header files should be committed without any other =
change,
> +and the commit message MUST specify the imported version using ``uAPI =
ID:``
> +tag and title MUST be prefixed with uapi keywork. For example::

"uAPI ID:" -> "uAPI Version"
"keywork" -> "keyword"