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

[John Moon]

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