Skip to content

Commit

Permalink
Internal change
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 675567286
  • Loading branch information
kluever authored and Error Prone Team committed Sep 17, 2024
1 parent b09da34 commit f10f5f9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/inlineme.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,25 @@ Users who call the method tagged with `@InlineMe` (e.g.,
`myClass.setDeadline(3000)`) will be migrated to the new method:
`myClass.setDeadline(Duration.ofMillis(3000))`

## `-parameters` flag is required for use!

InlineMe requires the use of the `-parameters` flag because it relies on
parameter name information at runtime --- see
[JEP 118](https://openjdk.org/jeps/118).

Maven users should add the `<parameters>true</parameters>` option to their
`maven-compiler-plugin`.

Gradle
[does not currently enable this flag by default](https://github.com/gradle/gradle/issues/14781),
so users should add the following to their `build.gradle`:

```
tasks.withType(JavaCompile) {
options.compilerArgs << '-parameters'
}
```

<!-- TODO(kak): add instructions on how to run the Inliner in patch mode -->

## Example Usage
Expand Down

0 comments on commit f10f5f9

Please sign in to comment.