You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Doug Cutting <cu...@apache.org> on 2005/02/04 20:47:46 UTC

whither sandbox

So, now that we've got the sandbox in the same source tree let's decide 
what we want to do with it.  I have previously argued that we should 
make sure that sandbox code should be tagged and released in parallel 
with core code (http://tinyurl.com/5d6tx).  Now that should be easy. 
But how should we do it?

Here's my proposal:
   1. Move sandbox/contributions to src/contrib;
   2. Change build.xml to build, test & package sandbox packages too.
   3. Change sandbox build.xml's to build in a top-level build/contrib 
directory, and package into a top-level dist/contrib directory, so that 
no files are written in src/contrib.

Once this is done, then:

  "ant compile" will compile all core and contributed code, building 
something like:

     build/
       classes/  -- core classes
       contrib/
         highlighter/ -- highlighter classes
         ...

  "ant test" will test all core and contributed code

  "ant dist" will create something like:

       dist/
         lucene-XX.tar.gz
         lucene-XX.zip
         contrib/
           highligher-XX.tar.gz
           ...

And so on.

Does this sound like a good plan?

Doug

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: whither sandbox

Posted by Erik Hatcher <er...@ehatchersolutions.com>.
On Feb 4, 2005, at 4:59 PM, Doug Cutting wrote:

> Erik Hatcher wrote:
>> Also, we should package a lucene-XX-all.zip/.tar.gz that includes all 
>> the contrib pieces also allowing someone to simply download Lucene 
>> and all the packaged contrib pieces at once.
>
> I'll go further: that should be the only download.  We should avoid 
> having a bunch of different downloads.  Ant used to require you to 
> separately download the optional tasks, but that was a pain.  Now 
> they're included.

Cool... I almost asked if that was your intention with the 
lucene-xxx.tar.gz/.zip you mentioned.  I'm totally fine with the only 
download being the whole enchilada.

I'll start on this refactoring soon unless I see others committing it.

	Erik


---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: whither sandbox

Posted by Erik Hatcher <er...@ehatchersolutions.com>.
On Feb 4, 2005, at 4:59 PM, Doug Cutting wrote:

> Erik Hatcher wrote:
>> Also, we should package a lucene-XX-all.zip/.tar.gz that includes all 
>> the contrib pieces also allowing someone to simply download Lucene 
>> and all the packaged contrib pieces at once.
>
> I'll go further: that should be the only download.  We should avoid 
> having a bunch of different downloads.  Ant used to require you to 
> separately download the optional tasks, but that was a pain.  Now 
> they're included.

And also, like Ant, we'll need some conditional tricks to get things to 
build properly without having all the dependencies present.  We do not 
want the build to fail if contrib/db's dependencies are not present, 
nor should (or possibly even can) we check these into svn.  So, without 
the dependencies the build will still work fine, but it'll only build 
what it can and omit the rest.    Same goes with building Ant yourself 
- it takes a lot of initial setup to get everything in place in order 
to build a full version of Ant.  It won't be nearly as tricky with the 
contrib components, but still an issue.

I'll work on also putting in an automatic download of the dependencies 
(with a switch to turn this off, or perhaps vice versa) so that 
building Lucene and the contrib pieces should work fully if you're 
online the first time.

I'm going to put a TODO.txt file at the root of contrib to jot down the 
wishlist and knock them out step-by-step.

	Erik


---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: whither sandbox

Posted by Doug Cutting <cu...@apache.org>.
Erik Hatcher wrote:
> Also, we should package a lucene-XX-all.zip/.tar.gz that includes all 
> the contrib pieces also allowing someone to simply download Lucene and 
> all the packaged contrib pieces at once.

I'll go further: that should be the only download.  We should avoid 
having a bunch of different downloads.  Ant used to require you to 
separately download the optional tasks, but that was a pain.  Now 
they're included.

So we will have at least:

   lucene-XX.tar.gz
   lucene-src-XX.tar.gz

But should we add the following?

   lucene-contrib-XX.tar.gz
   lucene-contrib-src-XX.tar.gz

Or should we just bundle these into the first two?  I vote for bundling. 
  There will still be separate jar files, so folks only have to deploy 
what they need.  Download size is not an issue these days.  Thoughts?

Also, we should combine the javadoc into a single tree, with a "Core" 
group followed by a "Contrib" group:

http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/javadoc.html#group

As an example, Nutch does this for "Core" and "Plugin":

http://www.nutch.org/docs/api/overview-summary.html

Doug

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: whither sandbox

Posted by Erik Hatcher <er...@ehatchersolutions.com>.
+1

I volunteer to tackle the initial restructuring (piecemeal over the 
next few weeks), unless someone is more eager to hop on it.

Also, we should package a lucene-XX-all.zip/.tar.gz that includes all 
the contrib pieces also allowing someone to simply download Lucene and 
all the packaged contrib pieces at once.

	Erik


On Feb 4, 2005, at 2:47 PM, Doug Cutting wrote:

> So, now that we've got the sandbox in the same source tree let's 
> decide what we want to do with it.  I have previously argued that we 
> should make sure that sandbox code should be tagged and released in 
> parallel with core code (http://tinyurl.com/5d6tx).  Now that should 
> be easy. But how should we do it?
>
> Here's my proposal:
>   1. Move sandbox/contributions to src/contrib;
>   2. Change build.xml to build, test & package sandbox packages too.
>   3. Change sandbox build.xml's to build in a top-level build/contrib 
> directory, and package into a top-level dist/contrib directory, so 
> that no files are written in src/contrib.
>
> Once this is done, then:
>
>  "ant compile" will compile all core and contributed code, building 
> something like:
>
>     build/
>       classes/  -- core classes
>       contrib/
>         highlighter/ -- highlighter classes
>         ...
>
>  "ant test" will test all core and contributed code
>
>  "ant dist" will create something like:
>
>       dist/
>         lucene-XX.tar.gz
>         lucene-XX.zip
>         contrib/
>           highligher-XX.tar.gz
>           ...
>
> And so on.
>
> Does this sound like a good plan?
>
> Doug
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: whither sandbox

Posted by ja...@thinkalong.com.
+1

On Fri, 04 Feb 2005 11:47:46 -0800
 Doug Cutting <cu...@apache.org> wrote:
>So, now that we've got the sandbox in the same source tree
>let's decide what we want to do with it.  I have
>previously argued that we should make sure that sandbox
>code should be tagged and released in parallel with core
>code (http://tinyurl.com/5d6tx).  Now that should be easy.
>But how should we do it?
>
>Here's my proposal:
>   1. Move sandbox/contributions to src/contrib;
>   2. Change build.xml to build, test & package sandbox
>packages too.
>   3. Change sandbox build.xml's to build in a top-level
>build/contrib 
>directory, and package into a top-level dist/contrib
>directory, so that no files are written in src/contrib.
>
>Once this is done, then:
>
>  "ant compile" will compile all core and contributed
>code, building 
>something like:
>
>     build/
>       classes/  -- core classes
>       contrib/
>         highlighter/ -- highlighter classes
>         ...
>
>  "ant test" will test all core and contributed code
>
>  "ant dist" will create something like:
>
>       dist/
>         lucene-XX.tar.gz
>         lucene-XX.zip
>         contrib/
>           highligher-XX.tar.gz
>           ...
>
>And so on.
>
>Does this sound like a good plan?
>
>Doug
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail:
>lucene-dev-unsubscribe@jakarta.apache.org
>For additional commands, e-mail:
>lucene-dev-help@jakarta.apache.org
>


---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Re: whither sandbox

Posted by Otis Gospodnetic <ot...@yahoo.com>.
Sounds good.  2. will force us to keep Sandbox pieces in sync with the
core.

Otis

--- Doug Cutting <cu...@apache.org> wrote:

> So, now that we've got the sandbox in the same source tree let's
> decide 
> what we want to do with it.  I have previously argued that we should 
> make sure that sandbox code should be tagged and released in parallel
> 
> with core code (http://tinyurl.com/5d6tx).  Now that should be easy. 
> But how should we do it?
> 
> Here's my proposal:
>    1. Move sandbox/contributions to src/contrib;
>    2. Change build.xml to build, test & package sandbox packages too.
>    3. Change sandbox build.xml's to build in a top-level
> build/contrib 
> directory, and package into a top-level dist/contrib directory, so
> that 
> no files are written in src/contrib.
> 
> Once this is done, then:
> 
>   "ant compile" will compile all core and contributed code, building 
> something like:
> 
>      build/
>        classes/  -- core classes
>        contrib/
>          highlighter/ -- highlighter classes
>          ...
> 
>   "ant test" will test all core and contributed code
> 
>   "ant dist" will create something like:
> 
>        dist/
>          lucene-XX.tar.gz
>          lucene-XX.zip
>          contrib/
>            highligher-XX.tar.gz
>            ...
> 
> And so on.
> 
> Does this sound like a good plan?
> 
> Doug
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: lucene-dev-help@jakarta.apache.org
> 
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org