While ASF policy is that we release source code, in practice most users will download binaries given the choice. Most users will also prefer to read the docs on the web site rather than build them on their own, especially if doing so takes a lot of time and requires a non-standard setup.
My opinion is that Flume should strive to have its default build be as quick and simple as possible so those doing development can get the fastest turnaround possible when compiling and debugging. For example, I never run tests in my IDE but run them in Maven and use Intellij's ability to remotely debug. While updating the documentation is important, there has got to be something wrong with a tool that requires more than 256M of permgen to function. Secondly, the site build is almost certainly going to need some modification to comply with Infra's requirement to leverage the CMS by the end of the year. Ralph On Jun 7, 2012, at 12:02 PM, Mike Percy <[email protected]> wrote: > Remember that we need to build the docs and include them in the tarball > during the packaging step. I'd like to save build time by providing a flag > such as -DskipDocs to avoid building both the javadocs and the site docs (I > guess this would save around a minute or so). I think we would have to create > a special maven profile to do that. > > If the concern is about new devs, I think a FAQ or BUILDING file should > suffice for most of these things (such as the recent issues that have popped > up regarding memory and UTF-8, but in particular, an opt-out flag). But I > don't feel too strongly about it and I'm +0 on making it opt-in. > > Best, > Mike > > > > On Thursday, June 7, 2012 at 11:12 AM, Hari Shreedharan wrote: > >> I agree with Ralph. We should probably create a profile called "full-build" >> or something that generates the docs. There is no reason for these to be >> generated during a normal dev build. New contributors are likely to face the >> same problem, which might discourage them from contributing. I have filed >> FLUME-1262 for this(https://issues.apache.org/jira/browse/FLUME-1262). >> >> Thanks, >> Hari >> >> -- >> Hari Shreedharan >> >> >> On Thursday, June 7, 2012 at 7:14 AM, Ralph Goers wrote: >> >>> My build failed even with a MaxPermSize of 256M. Why is it necessary to >>> build the site and/or documentation during a "normal" build. Normally I >>> would expect that to only happen with when mvn site is invoked or possible >>> with mvn release. >>> >>> Ralph >>> >>> On Jun 6, 2012, at 11:13 PM, Arvind Prabhakar wrote: >>> >>>> Hi Inder, >>>> >>>> Try setting the MAVEN_OPTS so that the perm space is set to 128m. For >>>> example: >>>> >>>> $ export MAVEN_OPTS=-XX:MaxPermSize=128m >>>> >>>> Thanks, >>>> Arvind Prabhakar >>>> >>>> On Wed, Jun 6, 2012 at 11:06 PM, Inder Pall <[email protected] >>>> (mailto:[email protected])> wrote: >>>> >>>>> Folks, >>>>> >>>>> i did a fresh svn co and hitting build failure related to documentation >>>>> generation. >>>>> Exception Details - http://pastebin.com/c1STnMaJ >>>>> >>>>> Anything obvious i am missing? >>>>> >>>>> -- >>>>> Thanks, >>>>> - Inder >>>>> Tech Platforms @Inmobi >>>>> Linkedin - http://goo.gl/eR4Ub >>>>> >>>> >>>> >>> >>> >> >> >> > >
