Kotlin: rework header comment

This commit is contained in:
Paolo Tranquilli
2024-06-04 14:21:58 +02:00
parent fcd326eb11
commit 6a9cb90a57
3 changed files with 1683 additions and 7 deletions

View File

@@ -1,6 +1,9 @@
""" """
# Usage overview # Usage overview
Building the extractor can be done via Building the extractor can be done with bazel. If building from the internal repository, it is recommended to use
`tools/bazel` from there.
A specific kotlin extractor variant can be built with
``` ```
bazel build @codeql//java/kotlin-extractor:codeql-extractor-kotlin-<variant>-<version> bazel build @codeql//java/kotlin-extractor:codeql-extractor-kotlin-<variant>-<version>
``` ```
@@ -16,8 +19,8 @@ will build a default variant:
If `kotlinc` is updated, bazel won't be aware of it and will therefore keep the same default version. Possible workarounds for that: If `kotlinc` is updated, bazel won't be aware of it and will therefore keep the same default version. Possible workarounds for that:
* `bazel clean` * `bazel clean`
* `bazel fetch --force @codeql_kotlin_defaults\\:all` * `bazel fetch --force @codeql//java/kotlin-extractor`
* `CODEQL_KOTLIN_SINGLE_VERSION= bazel build //java/kotlin-extractor` * `bazel fetch --force @codeql_kotlin_defaults//:all` (only from `codeql`)
If building from the `codeql` repository, `@codeql` can be skipped. If building from the `codeql` repository, `@codeql` can be skipped.
""" """

View File

@@ -1,7 +1,5 @@
The Git LFS files contained in this directory are mirrored The Git LFS files contained in this directory are mirrored
from [org.jetbrains.kotlin packages in the Maven repository][1]. Please refer to [the kotlin Apache 2.0 license][2] for from [org.jetbrains.kotlin packages in the Maven repository][1]. A copy of the license is included as
details about their license. the [`license`](./license) file.
[1]: https://mvnrepository.com/artifact/org.jetbrains.kotlin [1]: https://mvnrepository.com/artifact/org.jetbrains.kotlin
[2]: https://github.com/JetBrains/kotlin/tree/master/license

File diff suppressed because one or more lines are too long