From 9a4cd3e85d107719b3750e2fcb6af189c742c655 Mon Sep 17 00:00:00 2001 From: Filipp Zhinkin Date: Wed, 21 Aug 2024 11:14:10 -0400 Subject: [PATCH 1/2] Recommend setting up rootProject.name --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 44713454..241bfb22 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,12 @@ annotated with corresponding target names. During the validation phase, that file is compared to the dump extracted from the latest version of the library, and any differences between these two files are reported as errors. +Generated ABI dumps include a library name, +so it's [recommended](https://docs.gradle.org/current/userguide/multi_project_builds.html#sec:naming_recommendations) +to set Gradle's `rootProject.name` for you library. +Without root project's name being set, Gradle will infer it from project's directory name and that may lead to unstable +validation behavior due to mismatching names. + Currently, all options described in [Optional parameters](#optional-parameters) section are supported for klibs too. The only caveat here is that all class names should be specified in the JVM-format, like `package.name.ClassName$SubclassName`. From e1d41af24879eccfeb6b815e160957dbba415078 Mon Sep 17 00:00:00 2001 From: Filipp Zhinkin Date: Mon, 26 Aug 2024 11:31:55 -0400 Subject: [PATCH 2/2] Fixed typos and rephrased the warning text Co-authored-by: Zongle Wang --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 241bfb22..9adbb9dc 100644 --- a/README.md +++ b/README.md @@ -207,9 +207,9 @@ and any differences between these two files are reported as errors. Generated ABI dumps include a library name, so it's [recommended](https://docs.gradle.org/current/userguide/multi_project_builds.html#sec:naming_recommendations) -to set Gradle's `rootProject.name` for you library. -Without root project's name being set, Gradle will infer it from project's directory name and that may lead to unstable -validation behavior due to mismatching names. +to set Gradle's `rootProject.name` for your library. +Without declaring the root project's name, Gradle defaults to using the project's directory name, which can lead to +unstable validation behavior due to potential mismatches in naming. Currently, all options described in [Optional parameters](#optional-parameters) section are supported for klibs too. The only caveat here is that all class names should be specified in the JVM-format,