[jira] [Commented] (MJAVADOC-431) Allow Javadoc Jar to contain Maven descriptor

[Peter lynch (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15081891#comment-15081891
 ] 

Peter lynch commented on MJAVADOC-431:
--

[~michael-o] Thanks for the MSHARED ticket link - I am fully aware what 
pom.properties contains. A missing classifier in there does not matter for this 
use case. The pom.properties still contains valuable information. If ever it 
changes to include classifier, all the better.

The use case I have stated in earlier comments is not adding a requirement that 
the artifact file name must match or that pom.properties contain all parts of 
the coordinate system ( although would be nice ). Only that the location of the 
maven generated archiver configuration is in a well known location inside the 
produced jar and that there is no other way to insert same information into a 
javadoc jar without changing the sha1 of the produced artifact or heavily 
modifying a build or introducing a complex change to the javadoc plugin.

> Allow Javadoc Jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) Allow Javadoc Jar to contain Maven descriptor

[Michael Osipov (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15076198#comment-15076198
 ] 

Michael Osipov commented on MJAVADOC-431:
-

[~peterlynch], the entire solution has one drawback. The {{pom.properties}} 
does not contain the type of the file and the classifier. Relying on the 
filename is a bad thing. If you need this to be feature-complete for Javadoc 
JAR and Source JAR, you need that information too.

> Allow Javadoc Jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15062488#comment-15062488
 ] 

ASF GitHub Bot commented on MJAVADOC-431:
-

Github user peterlynch closed the pull request at:

https://github.com/apache/maven-plugins/pull/70


> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15062483#comment-15062483
 ] 

ASF GitHub Bot commented on MJAVADOC-431:
-

GitHub user peterlynch opened a pull request:

https://github.com/apache/maven-plugins/pull/73

MJAVADOC-431 allow maven descriptor to javadoc jar

replaces #70 

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/sonatype/maven-plugins 
MJAVADOC-431-maven-descriptor-3

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/maven-plugins/pull/73.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #73


commit fe06afdbb22172e3129e0e7f9e21935100943b50
Author: Peter Lynch 
Date:   2015-12-17T18:07:13Z

MJAVADOC-431 allow maven descriptor to javadoc jar




> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) Allow Javadoc Jar to contain Maven descriptor

[Hudson (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15062999#comment-15062999
 ] 

Hudson commented on MJAVADOC-431:
-

SUCCESS: Integrated in maven-plugins #4890 (See 
[https://builds.apache.org/job/maven-plugins/4890/])
[MJAVADOC-431] Allow Javadoc Jar to contain Maven descriptor

Contributed by: Peter Lynch 

This closes #73 (michaelo: [http://svn.apache.org/viewvc/?view=rev=1720689])
* 
maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocArchiveConfiguration.java
* 
maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java
* 
maven-javadoc-plugin/src/test/java/org/apache/maven/plugin/javadoc/JavadocJarTest.java
* 
maven-javadoc-plugin/src/test/java/org/apache/maven/plugin/javadoc/stubs/JavadocJarArchiveConfigProjectStub.java
* maven-javadoc-plugin/src/test/resources/unit/javadocjar-archive-config
* 
maven-javadoc-plugin/src/test/resources/unit/javadocjar-archive-config/javadocjar
* 
maven-javadoc-plugin/src/test/resources/unit/javadocjar-archive-config/javadocjar-archive-config.xml
* 
maven-javadoc-plugin/src/test/resources/unit/javadocjar-archive-config/javadocjar/def
* 
maven-javadoc-plugin/src/test/resources/unit/javadocjar-archive-config/javadocjar/def/App.java


> Allow Javadoc Jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) Allow Javadoc Jar to contain Maven descriptor

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15063011#comment-15063011
 ] 

ASF GitHub Bot commented on MJAVADOC-431:
-

Github user asfgit closed the pull request at:

https://github.com/apache/maven-plugins/pull/73


> Allow Javadoc Jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15033904#comment-15033904
 ] 

ASF GitHub Bot commented on MJAVADOC-431:
-

GitHub user peterlynch opened a pull request:

https://github.com/apache/maven-plugins/pull/70

MJAVADOC-431 allow maven descriptor to javadoc jar



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/sonatype/maven-plugins 
MJAVADOC-431-maven-descriptor-2

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/maven-plugins/pull/70.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #70


commit d9b32cbbde1d617832211b712f6ea81e4a5de0fe
Author: Peter Lynch 
Date:   2015-12-01T15:44:36Z

MJAVADOC-431 allow maven descriptor to javadoc jar




> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15033910#comment-15033910
 ] 

ASF GitHub Bot commented on MJAVADOC-431:
-

Github user peterlynch closed the pull request at:

https://github.com/apache/maven-plugins/pull/57


> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[Peter lynch (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14994497#comment-14994497
 ] 

Peter lynch commented on MJAVADOC-431:
--

[~michael-o] PR updated - can you take a look?

> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
>Assignee: Michael Osipov
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[Michael Osipov (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14945166#comment-14945166
 ] 

Michael Osipov commented on MJAVADOC-431:
-

I see your point. I will review your PR happily.

> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[Peter lynch (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14943681#comment-14943681
 ] 

Peter lynch commented on MJAVADOC-431:
--

[~michael-o] The javadoc plugin accepts a generic archiver configuration for 
the javadoc-jar goal, yet silently prevents users from adding the descriptor as 
part of that configuration. This is an abuse of the generic archiver 
configuration.

The maven descriptor files are located at a well known path and contains well 
known contents, a properties file and pom. The existence of the GA specific 
paths in the javadoc-jar archive can help identify the GA of the artifact 
without needing the original pom or original jar. There are cases I need to 
know the GA, but I do not have the 'main' jar or the pom separately. 

There is no easy way to automatically generate a maven descriptor like path or 
file and put this into the javadoc jar, without polluting the source tree with 
dummy class files which exist only generate packages at certain GA paths. 
Adding complexity to a build process to generate such files is overkill and 
needless. Even then we still can't put these under META-INF to indicate this is 
meta information only. Certain organizations have strict policies around adding 
dummy class files with no operational purpose. All that is needed is to fix the 
bug where the archiver configuration is not respected when configured by plugin 
configuration - a single line to the javadoc plugin configuration - done.

The javadoc and source plugin are the only two core plugins known to do this, 
yet there is no good reason documented. I suggest it was one plugin copied the 
other. If there was a good reason, I suggest the archiver configuration library 
should go to greater lengths to not have a generic option to add the descriptor.

The existing forced, non-overridable blocking of the descriptor is confusing 
and not-consistent with standard archiver configuration use in the very least. 
The patch preserves backwards compatibility of the default behaviour just in 
case we cannot foresee a good reason why it was done this way.

I can accept a plugin chooses defaults for the archiver configuration, but 
unless we can cite a solid reason not to respect user configured archiver 
configuration, like it breaks well established Maven tooling which would rely 
on it only existing except in the main jar ( even then one could argue it is at 
user discretion ), I urge this patch to be accepted.

The source plugin has already moved ahead with a patch to fix this. See 
MSOURCES-81.

> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[Michael Osipov (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=14940250#comment-14940250
 ] 

Michael Osipov commented on MJAVADOC-431:
-

I guess the reason is that the class JAR is intended to be the main artifact 
while the rest are side artifacts. If the main contains that information, no 
nee to duplicate it.
What is your usecase actually?

> allow javadoc jar to contain Maven descriptor
> -
>
> Key: MJAVADOC-431
> URL: https://issues.apache.org/jira/browse/MJAVADOC-431
> Project: Maven Javadoc Plugin
>  Issue Type: Bug
>Affects Versions: 2.10.3
>Reporter: Peter lynch
> Fix For: 2.10.4
>
>
> The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
> added to the produced javadoc.jar file.
> https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
> I could not find an explanation or technical reason why this is done.
> Adding the maven descriptor to the javadoc jar can help expose valuable 
> information about the build that produced it and should be at the discretion 
> of the build process.
> Expected:
> - allow the archiver used to create the javadoc jar to respect the plexus 
> archiver configuration if it is configured to include the Maven descriptor.
> - preserve the default behaviour of not including the Maven descriptor, for 
> (unknown) backwards compatibility reasons only



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

[jira] [Commented] (MJAVADOC-431) allow javadoc jar to contain Maven descriptor

[ASF GitHub Bot (JIRA)]

[ 
https://issues.apache.org/jira/browse/MJAVADOC-431?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14644951#comment-14644951
 ] 

ASF GitHub Bot commented on MJAVADOC-431:
-

GitHub user peterlynch opened a pull request:

https://github.com/apache/maven-plugins/pull/57

MJAVADOC-431 allow maven descriptor to javadoc jar

Note: maven-archiver dependency version was upgraded to take advantage of 
MavenProject.clone(), which avoids having the new unit test from creating a 
maven-archiver directory in the basedir because the MavenProject() constructor 
used in 2.5 does not copy the build element.

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/sonatype/maven-plugins 
MJAVADOC-431-maven-descriptor

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/maven-plugins/pull/57.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #57


commit 8bcf42405d1171da9a7fb370c1af0ae8178f8986
Author: Peter Lynch ply...@sonatype.com
Date:   2015-07-28T19:55:51Z

MJAVADOC-431 allow maven descriptor to javadoc jar

Note: maven-archiver dependency version was upgraded to take advantage of 
MavenProject.clone(), which avoids having the new unit test from creating a 
maven-archiver directory in the basedir because the MavenProject() constructor 
used in 2.5 does not copy the build element.




 allow javadoc jar to contain Maven descriptor
 -

 Key: MJAVADOC-431
 URL: https://issues.apache.org/jira/browse/MJAVADOC-431
 Project: Maven Javadoc Plugin
  Issue Type: Bug
Affects Versions: 2.10.3
Reporter: Peter lynch

 The javadoc:jar mojo explicitly prevents the Maven descriptor from being 
 added to the produced javadoc.jar file.
 https://github.com/apache/maven-plugins/blob/trunk/maven-javadoc-plugin/src/main/java/org/apache/maven/plugin/javadoc/JavadocJar.java#L299-299
 I could not find an explanation or technical reason why this is done.
 Adding the maven descriptor to the javadoc jar can help expose valuable 
 information about the build that produced it and should be at the discretion 
 of the build process.
 Expected:
 - allow the archiver used to create the javadoc jar to respect the plexus 
 archiver configuration if it is configured to include the Maven descriptor.
 - preserve the default behaviour of not including the Maven descriptor, for 
 (unknown) backwards compatibility reasons only



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