maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Hervé Boutemy (JIRA) <j...@apache.org>
Subject [jira] [Updated] (MPLUGIN-321) improve documentation on maven-plugin-annotations telling that provided is sufficient
Date Sat, 24 Dec 2016 16:35:58 GMT

     [ https://issues.apache.org/jira/browse/MPLUGIN-321?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Hervé Boutemy updated MPLUGIN-321:
----------------------------------
    Priority: Minor  (was: Major)

> improve documentation on maven-plugin-annotations telling that provided is sufficient
> -------------------------------------------------------------------------------------
>
>                 Key: MPLUGIN-321
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-321
>             Project: Maven Plugin Tools
>          Issue Type: Improvement
>          Components: maven-plugin-annotations
>    Affects Versions: 3.5
>            Reporter: Hervé Boutemy
>            Priority: Minor
>             Fix For: 3.5.1
>
>
> https://maven.apache.org/plugin-tools-archives/plugin-tools-3.5/maven-plugin-plugin/examples/using-annotations.html#POM_configuration
> tells
> {code:xml}  <dependencies>
>     <!-- dependencies to annotations -->
>     <dependency>
>       <groupId>org.apache.maven.plugin-tools</groupId>
>       <artifactId>maven-plugin-annotations</artifactId>
>       <version>3.5</version>
>       <scope>provided</scope><!-- annotations are needed only to build
the plugin -->
>     </dependency>
>   </dependencies>
> {code}
> Yes, annotations are needed only to build the plugin, since they have {{@Retention(value=CLASS)}}
which means they stay in bytecode but are not loaded at runtime.
> What is not clear is that this dependency is not really _provided_ at runtime: Maven
core does not inject maven-plugin-annotations at runtime (why would it? Maven core works by
reading [META-INF/maven/plugin.xml|http://maven.apache.org/ref/3-LATEST/maven-plugin-api/]).
But the dependency is simply not used at runtime.
> This doc can be improved:
> {code:xml}<!-- annotations are not used at runtime, they are needed only to build
the plugin -->{code}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message