MIME-Version: 1.0
References: <20230301075402.4578-1-quic_johmoo@quicinc.com> <20230301075402.4578-3-quic_johmoo@quicinc.com>
In-Reply-To: <20230301075402.4578-3-quic_johmoo@quicinc.com>
From:   Masahiro Yamada <masahiroy@kernel.org>
Date:   Sun, 5 Mar 2023 15:20:13 +0900
Message-ID: <CAK7LNAQUgr0rrJv8ZvPKfyC8zZ1XX-Wv2Npw4iJXDGor=HSKyQ@mail.gmail.com>
Subject: Re: [PATCH v2 2/2] docs: dev-tools: Add UAPI checker documentation
To:     John Moon <quic_johmoo@quicinc.com>
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>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

On Wed, Mar 1, 2023 at 4:54=E2=80=AFPM 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-to=
ols/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
> +
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +UAPI Checker
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +
> +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.


--=20
Best Regards
Masahiro Yamada