You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "EJ Ciramella (JIRA)" <ji...@apache.org> on 2012/06/09 01:23:24 UTC

[jira] [Created] (HADOOP-8500) Javadoc jars contain entire target directory

EJ Ciramella created HADOOP-8500:
------------------------------------

             Summary: Javadoc jars contain entire target directory
                 Key: HADOOP-8500
                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
             Project: Hadoop Common
          Issue Type: Bug
          Components: build
    Affects Versions: 2.0.0-alpha
         Environment: N/A
            Reporter: EJ Ciramella
            Priority: Minor
             Fix For: 2.0.1-alpha


The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.

Sometimes the resulting javadoc jar is 10X bigger than it should be.

The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.

I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "Jim Donofrio (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13292199#comment-13292199 ] 

Jim Donofrio commented on HADOOP-8500:
--------------------------------------

What is wrong with the default of ${project.build.directory}/apidocs by not specifying <destDir> at all?
                
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.1-alpha
>
>         Attachments: HADOOP-8500.patch
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "Arun C Murthy (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Arun C Murthy updated HADOOP-8500:
----------------------------------

    Fix Version/s:     (was: 2.0.2-alpha)
                   2.0.3-alpha
    
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.3-alpha
>
>         Attachments: HADOOP-8500.patch, site-redo.tar
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "EJ Ciramella (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13292190#comment-13292190 ] 

EJ Ciramella commented on HADOOP-8500:
--------------------------------------

...and I can still see some 60+ mv javadoc jars.  Patch is go in my book :-)
                
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.1-alpha
>
>         Attachments: HADOOP-8500.patch
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "EJ Ciramella (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

EJ Ciramella updated HADOOP-8500:
---------------------------------

    Attachment: HADOOP-8500.patch

Patch required to fix the javadoc jars completely such that they aren't extremely big.
                
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.1-alpha
>
>         Attachments: HADOOP-8500.patch
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "EJ Ciramella (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13293031#comment-13293031 ] 

EJ Ciramella commented on HADOOP-8500:
--------------------------------------

That would be ideal - and truthfully - that's where I started too.

BUT - it's WAY easier to fix maven then the entire site generated around it (forrest).  That changes things from a one line fix to a touch-a-ton-of-files fix.  I was told the patch would be accepted by the community faster/easier if it was small (for my first time).

What's sad is while exploring this fix, there are several places where the live apache hadoop site is broken but I refrained from fixing them as well.  

In fact, I was so frustrated with the site, I rewrote several of the pages in apt, just to see how easy it'd be (I have the main site complete now).
                
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.1-alpha
>
>         Attachments: HADOOP-8500.patch
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "EJ Ciramella (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

EJ Ciramella updated HADOOP-8500:
---------------------------------

    Attachment: site-redo.tar

Here are all the apt/images for redoing the maven site.  You should be able to drop these in place of the current site output and join up all the other site's that have been generated.
                
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.1-alpha
>
>         Attachments: HADOOP-8500.patch, site-redo.tar
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HADOOP-8500) Javadoc jars contain entire target directory

Posted by "EJ Ciramella (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-8500?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13292186#comment-13292186 ] 

EJ Ciramella commented on HADOOP-8500:
--------------------------------------

Upon further inspection - it seems that this is fixed in trunk already with a very similar tweak to the maven-javadoc-plugin...

Testing a bit further locally....
                
> Javadoc jars contain entire target directory
> --------------------------------------------
>
>                 Key: HADOOP-8500
>                 URL: https://issues.apache.org/jira/browse/HADOOP-8500
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>    Affects Versions: 2.0.0-alpha
>         Environment: N/A
>            Reporter: EJ Ciramella
>            Priority: Minor
>             Fix For: 2.0.1-alpha
>
>         Attachments: HADOOP-8500.patch
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> The javadoc jars contain the contents of the target directory - which includes classes and all sorts of binary files that it shouldn't.
> Sometimes the resulting javadoc jar is 10X bigger than it should be.
> The fix is to reconfigure maven to use "api" as it's destDir for javadoc generation.
> I have a patch/diff incoming.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira