From: Masahiro Yamada <masahiroy@kernel.org>
To: John Moon <quic_johmoo@quicinc.com>
Cc: Nathan Chancellor <nathan@kernel.org>,
Nick Desaulniers <ndesaulniers@google.com>,
Nicolas Schier <nicolas@fjasle.eu>,
Jonathan Corbet <corbet@lwn.net>,
linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-arm-msm@vger.kernel.org, kernel@quicinc.com,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Rob Herring <robh@kernel.org>,
"Carlos O'Donell" <carlos@redhat.com>,
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,
Dodji Seketeli <dodji@redhat.com>,
Trilok Soni <quic_tsoni@quicinc.com>,
Satya Durga Srinivasu Prabhala <quic_satyap@quicinc.com>,
Jordan Crouse <jorcrous@amazon.com>
Subject: Re: [PATCH v7 1/3] check-uapi: Introduce check-uapi.sh
Date: Sat, 23 Dec 2023 02:50:55 +0900 [thread overview]
Message-ID: <CAK7LNASZzeJzZV0hiMrcKd6FUtQXqfuvUqux8Bf+WvBmjCwNCA@mail.gmail.com> (raw)
In-Reply-To: <20231212020259.2451253-2-quic_johmoo@quicinc.com>
On Tue, Dec 12, 2023 at 11:04 AM John Moon <quic_johmoo@quicinc.com> wrote:
>
> While the kernel community has been good at maintaining backwards
> compatibility with kernel UAPIs, it would be helpful to have a tool
> to check if a commit introduces changes that break backwards
> compatibility.
>
> To that end, introduce check-uapi.sh: a simple shell script that
> checks for changes to UAPI headers using libabigail.
>
> libabigail is "a framework which aims at helping developers and
> software distributors to spot some ABI-related issues like interface
> incompatibility in ELF shared libraries by performing a static
> analysis of the ELF binaries at hand."
>
> The script uses one of libabigail's tools, "abidiff", to compile the
> changed header before and after the commit to detect any changes.
>
> abidiff "compares the ABI of two shared libraries in ELF format. It
> emits a meaningful report describing the differences between the two
> ABIs."
>
> The script also includes the ability to check the compatibility of
> all UAPI headers across commits. This allows developers to inspect
> the stability of the UAPIs over time.
>
> Signed-off-by: John Moon <quic_johmoo@quicinc.com>
> ---
> - Applied minor code style suggestions from v6 review.
The code looks OK. I think it should work as designed.
Line 197 is inconsistently indented by spaces instead of a space,
but I can fix it up locally.
I just thought requiring target commits as positional parameters
("check-uapi.sh treeA treeB" just like "git diff treeA treeB")
might be intuitive, but I guess everything is specified
by a short option is a design. I can live with that.
I will wait a few days, and if there is nothing more,
I will pick up 1/3 and 2/3.
--
Best Regards
Masahiro Yamada
next prev parent reply other threads:[~2023-12-22 17:51 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-12 2:02 [PATCH v7 0/3] Validating UAPI backwards compatibility John Moon
2023-12-12 2:02 ` [PATCH v7 1/3] check-uapi: Introduce check-uapi.sh John Moon
2023-12-22 17:50 ` Masahiro Yamada [this message]
2024-01-10 17:24 ` John Moon
2023-12-12 2:02 ` [PATCH v7 2/3] docs: dev-tools: Add UAPI checker documentation John Moon
2023-12-12 2:02 ` [PATCH v7 3/3] check-module-params: Introduce check-module-params.sh John Moon
2023-12-12 7:41 ` Christoph Hellwig
2023-12-12 16:58 ` John Moon
2023-12-22 17:57 ` Masahiro Yamada
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAK7LNASZzeJzZV0hiMrcKd6FUtQXqfuvUqux8Bf+WvBmjCwNCA@mail.gmail.com \
--to=masahiroy@kernel.org \
--cc=andersson@kernel.org \
--cc=arnd@arndb.de \
--cc=carlos@redhat.com \
--cc=corbet@lwn.net \
--cc=dodji@redhat.com \
--cc=gprocida@google.com \
--cc=gregkh@linuxfoundation.org \
--cc=jorcrous@amazon.com \
--cc=kernel-team@android.com \
--cc=kernel@quicinc.com \
--cc=libabigail@sourceware.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maennich@google.com \
--cc=nathan@kernel.org \
--cc=ndesaulniers@google.com \
--cc=nicolas@fjasle.eu \
--cc=quic_johmoo@quicinc.com \
--cc=quic_satyap@quicinc.com \
--cc=quic_tsoni@quicinc.com \
--cc=rdunlap@infradead.org \
--cc=robh@kernel.org \
--cc=tkjos@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).