Skip to content

Commit

Permalink
Recommend setting up rootProject.name (#268)
Browse files Browse the repository at this point in the history
* Recommend setting up rootProject.name

* Fixed typos and rephrased the warning text

Co-authored-by: Zongle Wang <wangzongler@gmail.com>
  • Loading branch information
fzhinkin and Goooler authored Oct 2, 2024
1 parent 6428c88 commit 7b12744
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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,
like `package.name.ClassName$SubclassName`.
Expand Down

0 comments on commit 7b12744

Please sign in to comment.