Skip to content

Commit

Permalink
Fix some compiler plugin documentation nits. (pantsbuild#4462)
Browse files Browse the repository at this point in the history
  • Loading branch information
benjyw authored Apr 16, 2017
1 parent 6363f67 commit 33c008c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ These are specified like this:
```
java_library(
...
javac_plugins: ['simple_javac_plugin'],
javac_plugin_args: {
javac_plugins=['simple_javac_plugin'],
javac_plugin_args={
'simple_javac_plugin': ['arg1', 'arg2']
}
)
Expand All @@ -88,6 +88,7 @@ java_library(

In order to load a plugin, it has to be on javac's classpath.
This can be achieved in one of two ways:

- Have targets that must be compiled with a plugin depend (directly or indirectly)
either on the `javac_plugin` target, or on a `jar_library` pointing to a published version
of the plugin.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ These are specified like this:
```
scala_library(
...
scalac_plugins: ['simple_scalac_plugin'],
scalac_plugin_args: {
scalac_plugins=['simple_scalac_plugin'],
scalac_plugin_args={
'simple_scalac_plugin': ['arg1', 'arg2']
}
)
Expand All @@ -87,6 +87,7 @@ scala_library(

In order to load a plugin, it has to be on scalac's classpath.
This can be achieved in one of two ways:

- Have targets that must be compiled with a plugin depend (directly or indirectly)
either on the `scalac_plugin` target, or on a `jar_library` pointing to a published version
of the plugin.
Expand Down
2 changes: 1 addition & 1 deletion src/python/pants/backend/jvm/subsystems/java.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def register_options(cls, register):

register('--compiler-plugin-deps', advanced=True, type=list, member_type=target_option,
removal_version='1.5.0.dev0',
removal_hint='Use --compile-zinc-javac-plugin-deps instead.',
removal_hint='See http://www.pantsbuild.org/javac_plugins.html#depending-on-plugins.',
fingerprint=True)

@classmethod
Expand Down

0 comments on commit 33c008c

Please sign in to comment.