linux-kernel - Re: [PATCH v2 2/2] docs: dev-tools: Add UAPI checker documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <186dd23e-765f-584f-11e1-84b27f728abe@quicinc.com>
Date:   Mon, 6 Mar 2023 08:56:10 -0800
From:   John Moon <quic_johmoo@...cinc.com>
To:     Masahiro Yamada <masahiroy@...nel.org>
CC:     Nathan Chancellor <nathan@...nel.org>,
        Nick Desaulniers <ndesaulniers@...gle.com>,
        Nicolas Schier <nicolas@...sle.eu>,
        <linux-kbuild@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <linux-arm-kernel@...ts.infradead.org>,
        <linux-arm-msm@...r.kernel.org>,
        "Greg Kroah-Hartman" <gregkh@...uxfoundation.org>,
        Randy Dunlap <rdunlap@...radead.org>,
        Arnd Bergmann <arnd@...db.de>,
        Bjorn Andersson <andersson@...nel.org>,
        Todd Kjos <tkjos@...gle.com>,
        Matthias Maennich <maennich@...gle.com>,
        Giuliano Procida <gprocida@...gle.com>,
        <kernel-team@...roid.com>, <libabigail@...rceware.org>,
        Jordan Crouse <jorcrous@...zon.com>,
        Trilok Soni <quic_tsoni@...cinc.com>,
        "Satya Durga Srinivasu Prabhala" <quic_satyap@...cinc.com>,
        Elliot Berman <quic_eberman@...cinc.com>
Subject: Re: [PATCH v2 2/2] docs: dev-tools: Add UAPI checker documentation

On 3/4/2023 10:20 PM, Masahiro Yamada wrote:
> On Wed, Mar 1, 2023 at 4:54 PM John Moon <quic_johmoo@...cinc.com> wrote:
>>
>> Add detailed documentation for scripts/check-uapi.sh.
>> ---
>>   Documentation/dev-tools/checkuapi.rst | 258 ++++++++++++++++++++++++++
>>   Documentation/dev-tools/index.rst     |   1 +
>>   2 files changed, 259 insertions(+)
>>   create mode 100644 Documentation/dev-tools/checkuapi.rst
>>
>> diff --git a/Documentation/dev-tools/checkuapi.rst b/Documentation/dev-tools/checkuapi.rst
>> new file mode 100644
>> index 000000000000..2255066658e3
>> --- /dev/null
>> +++ b/Documentation/dev-tools/checkuapi.rst
>> @@ -0,0 +1,258 @@
>> +.. SPDX-License-Identifier: GPL-2.0-only
>> +
>> +============
>> +UAPI Checker
>> +============
>> +
>> +The UAPI checker (scripts/check-uapi.sh) is a shell script which checks UAPI
>> +header files for userspace backwards-compatibility across the git tree.
>> +
>> +The script can produce false positives in some cases, so developers are
> 
> 
> and false negatives too.
> 

Yes, I'll expand the notes to include examples of false negatives in v3.