[jira] [Commented] (MJAVADOC-523) Exclude non-Java JARs from Maven Javadoc plugin processing
[
https://issues.apache.org/jira/browse/MJAVADOC-523?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16705968#comment-16705968
]
Robert Scholte commented on MJAVADOC-523:
-
Please provide a project to reproduce
> Exclude non-Java JARs from Maven Javadoc plugin processing
> --
>
> Key: MJAVADOC-523
> URL: https://issues.apache.org/jira/browse/MJAVADOC-523
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
>Affects Versions: 2.8
>Reporter: Thorsten Glaser
>Assignee: Robert Scholte
>Priority: Minor
>
> I have a multi-module project which builds a couple of JARs and then
> distributed them into two WARs.
> However, one of the JARs does not contain any Java code at all, merely
> (maven-filtered) resources. This leads to warnings during the build like
> these:
> {noformat}[…]
> [INFO] — maven-javadoc-plugin:2.8:jar (attach-javadocs) @ foo-services —
> [INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc'
> has not been previously called for the module:
> 'de.tarent.foo:foo-rsrcs:jar:1.3.900-SNAPSHOT'. Trying to invoke it...
> [WARNING] Creating fake javadoc directory to prevent repeated invocations:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs
> [ERROR] Error fetching link:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs/package-list.
> Ignored it.
> [INFO]
> Loading source files for package de.tarent.foo.rest.transformation...
> […]{noformat}
> I found how I can exclude javadoc stuff by package, but not by artifact.
> The plugin is currently included ONLY in the parent POM, like this:
> {code:xml}
>
> org.apache.maven.plugins
> maven-javadoc-plugin
> 2.8
>
>
> attach-javadocs
>
> jar
>
>
>
>
> {code}
> While it _is_ run during “compilation” of the resources-only JAR, it
> (obviously) produces no result, thus the warning (as it’s not excluded
> either).
> How can I either make it produce something (i.e. the ability to create a
> valid-looking yet contentless FOO-javadoc.jar that satisfies references by
> reverse dependencies, in a JAR not containing any Java™ code) or, probably
> preferably, exclude the {{foo-rsrcs}} module from being accessed by mjavadoc
> on modules depending on it?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (MJAVADOC-523) Exclude non-Java JARs from Maven Javadoc plugin processing
[
https://issues.apache.org/jira/browse/MJAVADOC-523?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16705967#comment-16705967
]
Thorsten Glaser commented on MJAVADOC-523:
--
Please reopen!
{color:#FF}This is a *compile-time* dependency, *not* a run-time
resource{color}. It is actually baked into the WAR because parts of the backend
operation use it, and for this, we need it available during the compile phase
(package is too late).
> Exclude non-Java JARs from Maven Javadoc plugin processing
> --
>
> Key: MJAVADOC-523
> URL: https://issues.apache.org/jira/browse/MJAVADOC-523
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
>Affects Versions: 2.8
>Reporter: Thorsten Glaser
>Assignee: Robert Scholte
>Priority: Minor
>
> I have a multi-module project which builds a couple of JARs and then
> distributed them into two WARs.
> However, one of the JARs does not contain any Java code at all, merely
> (maven-filtered) resources. This leads to warnings during the build like
> these:
> {noformat}[…]
> [INFO] — maven-javadoc-plugin:2.8:jar (attach-javadocs) @ foo-services —
> [INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc'
> has not been previously called for the module:
> 'de.tarent.foo:foo-rsrcs:jar:1.3.900-SNAPSHOT'. Trying to invoke it...
> [WARNING] Creating fake javadoc directory to prevent repeated invocations:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs
> [ERROR] Error fetching link:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs/package-list.
> Ignored it.
> [INFO]
> Loading source files for package de.tarent.foo.rest.transformation...
> […]{noformat}
> I found how I can exclude javadoc stuff by package, but not by artifact.
> The plugin is currently included ONLY in the parent POM, like this:
> {code:xml}
>
> org.apache.maven.plugins
> maven-javadoc-plugin
> 2.8
>
>
> attach-javadocs
>
> jar
>
>
>
>
> {code}
> While it _is_ run during “compilation” of the resources-only JAR, it
> (obviously) produces no result, thus the warning (as it’s not excluded
> either).
> How can I either make it produce something (i.e. the ability to create a
> valid-looking yet contentless FOO-javadoc.jar that satisfies references by
> reverse dependencies, in a JAR not containing any Java™ code) or, probably
> preferably, exclude the {{foo-rsrcs}} module from being accessed by mjavadoc
> on modules depending on it?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (MJAVADOC-523) Exclude non-Java JARs from Maven Javadoc plugin processing
[
https://issues.apache.org/jira/browse/MJAVADOC-523?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16700745#comment-16700745
]
Thorsten Glaser commented on MJAVADOC-523:
--
Thanks for the workaround, it at least gets rid of several yellow and red lines
in my Jenkins output, making it more manageable. I’d still prefer a proper fix
of course, and I don’t know how this can negatively affect documentation.
Perhaps an invocation to build a dummy javadoc could be added to the non-Java
modules, if the plugin supports such… it’s easy enough to run it after all.
Even better would be if it could do that automatically, if invoked in a project
without Java files, *and* skip attaching the dummy javadoc, use it only to
satisfy resolution.
> Exclude non-Java JARs from Maven Javadoc plugin processing
> --
>
> Key: MJAVADOC-523
> URL: https://issues.apache.org/jira/browse/MJAVADOC-523
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
>Affects Versions: 2.8
>Reporter: Thorsten Glaser
>Priority: Minor
>
> I have a multi-module project which builds a couple of JARs and then
> distributed them into two WARs.
> However, one of the JARs does not contain any Java code at all, merely
> (maven-filtered) resources. This leads to warnings during the build like
> these:
> {{[…]
> [INFO] --- maven-javadoc-plugin:2.8:jar (attach-javadocs) @ foo-services ---
> [INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc'
> has not been previously called for the module:
> 'de.tarent.foo:foo-rsrcs:jar:1.3.900-SNAPSHOT'. Trying to invoke it...
> [WARNING] Creating fake javadoc directory to prevent repeated invocations:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs
> [ERROR] Error fetching link:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs/package-list.
> Ignored it.
> [INFO]
> Loading source files for package de.tarent.foo.rest.transformation...
> […]}}
> I found how I can exclude javadoc stuff by package, but not by artifact.
> The plugin is currently included ONLY in the parent POM, like this:
> {{org.apache.maven.pluginsmaven-javadoc-plugin2.8attach-javadocsjar}}
> While it _is_ run during “compilation” of the resources-only JAR, it
> (obviously) produces no result, thus the warning (as it’s not excluded
> either).
> How can I either make it produce something (i.e. the ability to create a
> valid-looking yet contentless FOO-javadoc.jar that satisfies references by
> reverse dependencies, in a JAR not containing any Java™ code) or, probably
> preferably, exclude the {{foo-rsrcs}} module from being accessed by mjavadoc
> on modules depending on it?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (MJAVADOC-523) Exclude non-Java JARs from Maven Javadoc plugin processing
[
https://issues.apache.org/jira/browse/MJAVADOC-523?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16700452#comment-16700452
]
Rune Flobakk commented on MJAVADOC-523:
---
I can make the warn go away using
{{false}}
(Found here: https://issues.jboss.org/browse/ISPN-8629)
I guess this works ok in my case because I have _only_ two modules, where one
is not producing any javadocs.
> Exclude non-Java JARs from Maven Javadoc plugin processing
> --
>
> Key: MJAVADOC-523
> URL: https://issues.apache.org/jira/browse/MJAVADOC-523
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
>Affects Versions: 2.8
>Reporter: Thorsten Glaser
>Priority: Minor
>
> I have a multi-module project which builds a couple of JARs and then
> distributed them into two WARs.
> However, one of the JARs does not contain any Java code at all, merely
> (maven-filtered) resources. This leads to warnings during the build like
> these:
> {{[…]
> [INFO] --- maven-javadoc-plugin:2.8:jar (attach-javadocs) @ foo-services ---
> [INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc'
> has not been previously called for the module:
> 'de.tarent.foo:foo-rsrcs:jar:1.3.900-SNAPSHOT'. Trying to invoke it...
> [WARNING] Creating fake javadoc directory to prevent repeated invocations:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs
> [ERROR] Error fetching link:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs/package-list.
> Ignored it.
> [INFO]
> Loading source files for package de.tarent.foo.rest.transformation...
> […]}}
> I found how I can exclude javadoc stuff by package, but not by artifact.
> The plugin is currently included ONLY in the parent POM, like this:
> {{org.apache.maven.pluginsmaven-javadoc-plugin2.8attach-javadocsjar}}
> While it _is_ run during “compilation” of the resources-only JAR, it
> (obviously) produces no result, thus the warning (as it’s not excluded
> either).
> How can I either make it produce something (i.e. the ability to create a
> valid-looking yet contentless FOO-javadoc.jar that satisfies references by
> reverse dependencies, in a JAR not containing any Java™ code) or, probably
> preferably, exclude the {{foo-rsrcs}} module from being accessed by mjavadoc
> on modules depending on it?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (MJAVADOC-523) Exclude non-Java JARs from Maven Javadoc plugin processing
[
https://issues.apache.org/jira/browse/MJAVADOC-523?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16437765#comment-16437765
]
Thorsten Glaser commented on MJAVADOC-523:
--
Actually, I have *two* cases in which this occurs; one is a JAR without Java™
code, the other even has…
{{ pom}}
…so I cannot even use the workaround to add one dummy class into it.
> Exclude non-Java JARs from Maven Javadoc plugin processing
> --
>
> Key: MJAVADOC-523
> URL: https://issues.apache.org/jira/browse/MJAVADOC-523
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
>Affects Versions: 2.8
>Reporter: Thorsten Glaser
>Priority: Minor
>
> I have a multi-module project which builds a couple of JARs and then
> distributed them into two WARs.
> However, one of the JARs does not contain any Java code at all, merely
> (maven-filtered) resources. This leads to warnings during the build like
> these:
> {{[…]
> [INFO] --- maven-javadoc-plugin:2.8:jar (attach-javadocs) @ foo-services ---
> [INFO] The goal 'org.apache.maven.plugins:maven-javadoc-plugin:2.8:javadoc'
> has not been previously called for the module:
> 'de.tarent.foo:foo-rsrcs:jar:1.3.900-SNAPSHOT'. Trying to invoke it...
> [WARNING] Creating fake javadoc directory to prevent repeated invocations:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs
> [ERROR] Error fetching link:
> /var/lib/jenkins/jobs/FooTool/workspace/foo-backend/foo-rsrcs/target/apidocs/package-list.
> Ignored it.
> [INFO]
> Loading source files for package de.tarent.foo.rest.transformation...
> […]}}
> I found how I can exclude javadoc stuff by package, but not by artifact.
> The plugin is currently included ONLY in the parent POM, like this:
> {{org.apache.maven.pluginsmaven-javadoc-plugin2.8attach-javadocsjar}}
> While it _is_ run during “compilation” of the resources-only JAR, it
> (obviously) produces no result, thus the warning (as it’s not excluded
> either).
> How can I either make it produce something (i.e. the ability to create a
> valid-looking yet contentless FOO-javadoc.jar that satisfies references by
> reverse dependencies, in a JAR not containing any Java™ code) or, probably
> preferably, exclude the {{foo-rsrcs}} module from being accessed by mjavadoc
> on modules depending on it?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
