[RFC 1/3] uapi: introduce kernel uAPI headers importation

Maxime Coquelin maxime.coquelin at redhat.com
Fri Sep 6 09:01:01 CEST 2024



On 9/6/24 08:46, Morten Brørup wrote:
>> From: Maxime Coquelin [mailto:maxime.coquelin at redhat.com]
>> Sent: Friday, 6 September 2024 00.15
>>
>> This patch introduces uAPI headers importation into the
>> DPDK repository. This import is possible thanks to Linux
>> Kernel licence exception for syscalls:
>>
>> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/LICENS
>> ES/exceptions/Linux-syscall-note
>>
>> Header files are have to be explicitly imported, and
>> libraries and drivers have to explicitly enable their
>> inclusion.
>>
>> 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).
>>
>> Next version will introduce a script to check headers are
>> valids.
>>
>> Signed-off-by: Maxime Coquelin <maxime.coquelin at redhat.com>
>> ---
> 
> Excellent solution, Maxime.
> 
> Minor suggestions and typos mentioned below.
> 
> Acked-by: Morten Brørup <mb at smartsharesystems.com>
> 

Thanks Morten, I'll fix below typos and several build failures caught by
CI in next revision.

>> +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"
> 



More information about the dev mailing list