Message-ID: <186dd23e-765f-584f-11e1-84b27f728abe@quicinc.com>
Date:   Mon, 6 Mar 2023 08:56:10 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Thunderbird/102.6.1
From:   John Moon <quic_johmoo@quicinc.com>
Subject: Re: [PATCH v2 2/2] docs: dev-tools: Add UAPI checker documentation
To:     Masahiro Yamada <masahiroy@kernel.org>
CC:     Nathan Chancellor <nathan@kernel.org>,
        Nick Desaulniers <ndesaulniers@google.com>,
        Nicolas Schier <nicolas@fjasle.eu>,
        <linux-kbuild@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
        <linux-arm-kernel@lists.infradead.org>,
        <linux-arm-msm@vger.kernel.org>,
        "Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
        Randy Dunlap <rdunlap@infradead.org>,
        Arnd Bergmann <arnd@arndb.de>,
        Bjorn Andersson <andersson@kernel.org>,
        Todd Kjos <tkjos@google.com>,
        Matthias Maennich <maennich@google.com>,
        Giuliano Procida <gprocida@google.com>,
        <kernel-team@android.com>, <libabigail@sourceware.org>,
        Jordan Crouse <jorcrous@amazon.com>,
        Trilok Soni <quic_tsoni@quicinc.com>,
        "Satya Durga Srinivasu Prabhala" <quic_satyap@quicinc.com>,
        Elliot Berman <quic_eberman@quicinc.com>
References: <20230301075402.4578-1-quic_johmoo@quicinc.com>
 <20230301075402.4578-3-quic_johmoo@quicinc.com>
 <CAK7LNAQUgr0rrJv8ZvPKfyC8zZ1XX-Wv2Npw4iJXDGor=HSKyQ@mail.gmail.com>
Content-Language: en-US
In-Reply-To: <CAK7LNAQUgr0rrJv8ZvPKfyC8zZ1XX-Wv2Npw4iJXDGor=HSKyQ@mail.gmail.com>
Content-Type: text/plain; charset="UTF-8"; format=flowed
Content-Transfer-Encoding: 8bit
Precedence: bulk

On 3/4/2023 10:20 PM, Masahiro Yamada wrote:
> On Wed, Mar 1, 2023 at 4:54 PM John Moon <quic_johmoo@quicinc.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.