Skip to content

Commit 7b12744

Browse files
fzhinkinGoooler
andauthored
Recommend setting up rootProject.name (#268)
* Recommend setting up rootProject.name * Fixed typos and rephrased the warning text Co-authored-by: Zongle Wang <[email protected]>
1 parent 6428c88 commit 7b12744

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,12 @@ annotated with corresponding target names.
205205
During the validation phase, that file is compared to the dump extracted from the latest version of the library,
206206
and any differences between these two files are reported as errors.
207207

208+
Generated ABI dumps include a library name,
209+
so it's [recommended](https://docs.gradle.org/current/userguide/multi_project_builds.html#sec:naming_recommendations)
210+
to set Gradle's `rootProject.name` for your library.
211+
Without declaring the root project's name, Gradle defaults to using the project's directory name, which can lead to
212+
unstable validation behavior due to potential mismatches in naming.
213+
208214
Currently, all options described in [Optional parameters](#optional-parameters) section are supported for klibs too.
209215
The only caveat here is that all class names should be specified in the JVM-format,
210216
like `package.name.ClassName$SubclassName`.

0 commit comments

Comments
 (0)