Skip to content

Commit cbd56c9

Browse files
fzhinkinGoooler
authored andcommitted
[ABI Validation] Recommend setting up rootProject.name
* Recommend setting up rootProject.name * Fixed typos and rephrased the warning text Co-authored-by: Zongle Wang <[email protected]> Pull request Kotlin/binary-compatibility-validator#268
1 parent 59b4e21 commit cbd56c9

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

libraries/tools/abi-validation/README.md

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

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

0 commit comments

Comments
 (0)