Mailing-List: contact dev-help@openjpa.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@openjpa.apache.org
Date: Tue, 27 Aug 2013 15:59:52 +0000 (UTC)
From: "Kevin Sutter (JIRA)" <jira@apache.org>
To: dev@openjpa.apache.org
Message-ID: <JIRA.12445543.1263495582610.39999.1377619192075@arcas>
In-Reply-To: <JIRA.12445543.1263495582610@arcas>
References: <JIRA.12445543.1263495582610@arcas>
Subject: [jira] [Commented] (OPENJPA-1459) Remove heavy documentation
 objects from the binary distribution
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


    [ https://issues.apache.org/jira/browse/OPENJPA-1459?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13751383#comment-13751383 ] 

Kevin Sutter commented on OPENJPA-1459:
---------------------------------------

Mike, Thanks for looking into this JIRA.  I just re-built with your changes and I see the new file (binary-nodocs.zip) getting created and it looks to be minus the docs and the examples.  So, that's good.  But, the binary.zip file seems to be missing the docs.  This file still contains the examples directory, but the docs are missing.

I thought the direction was to leave the binary.zip file as is (complete with docs and examples) and introduce a new file called binary-nodocs.zip that would be slimmed down.  So, I looked back and noticed that this non-docs version of the binary.zip was introduced sometime before we cut the 2.2.0 release.  The 2.1.0 release did contain the docs in the binary.zip.  Did we (Mike) just do a bunch of work for no reason?  :-)


> Remove heavy documentation objects from the binary distribution 
> ----------------------------------------------------------------
>
>                 Key: OPENJPA-1459
>                 URL: https://issues.apache.org/jira/browse/OPENJPA-1459
>             Project: OpenJPA
>          Issue Type: Improvement
>          Components: build / infrastructure
>    Affects Versions: 1.2.3, 1.3.0, 2.0.0
>            Reporter: Michael Dick
>            Assignee: Michael Dick
>            Priority: Minor
>             Fix For: 2.2.3
>
>
> Per Kevin's comment in the OpenJPA 1.2.2 release vote [1] our binary distribution contains a large amount of documentation files (roughly 90% of the archive is docs). Kevin posed the question of whether other Apache projects include docs in their distributions.
> So I took a random (and small) sampling : 
> * HTTPServer only delivers binaries for Windows as a .msi file - I'm not sure whether the docs are included there or not. 
> * Ant 1.8.0-RC1 includes documentation in the binary distribution.
> * Derby 10.5.3.0 includes documentation in the binary distribution
> * OpenEJB 3.1.2 does not include documentation in the binary distribution
> The results don't show a clear trend (maybe a larger sample size would reveal one), but it looks like we have leeway here to include or omit documentation in our releases. 
> Also FWIW OpenEJB and Derby's binary distributions are roughly the same size as OpenJPA 1.2.2 (around 18MB), Ant is a bit smaller (around 7 MB). 
> Removing all docs would put the size around 5.8 MB, removing just the javadoc (the larger portion of documentation) puts the size around 11 MB. 
> [1]  http://markmail.org/message/gqlt25vpdgba3glq

--
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