lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Shai Erera <>
Subject Re: Facet examples javadoc missing in 4.0?
Date Sat, 24 Nov 2012 18:45:50 GMT
It's not that there were failures, but that you moved some tests under
demo/ that should belong under facet/. That's the dependency I'm talking
about. I tried to resolve it, but it wasn't trivial -- either these tests
will depend on demo/, or we rewrite them to use their own data, which will
take some time.

It's not really a hack, it worked like that ever since 3.4, only recently
removed. If you want, let's mark 3998 as a blocker for 4.1, but for now,
this is what I'd like to fix:

Index: lucene/facet/build.xml
--- lucene/facet/build.xml      (revision 1413130)
+++ lucene/facet/build.xml      (working copy)
@@ -75,11 +75,22 @@
   <target name="jar-core" depends="common.jar-core,jar-examples" />

   <target name="javadocs" depends="javadocs-analyzers-common,compile-core">
-    <invoke-module-javadoc>
-      <links>
-        <link href="../analyzers-common"/>
-      </links>
-    </invoke-module-javadoc>
+    <sequential>
+      <mkdir dir="${javadoc.dir}/${name}"/>
+      <invoke-javadoc
+         destdir="${javadoc.dir}/${name}"
+                title="${Name} ${version} ${name} API"
+         linksource="no">
+         <sources>
+           <link href="../core/"/>
+           <link href="../analyzers-common"/>
+           <link href=""/>
+           <packageset dir="${src.dir}"/>
+           <packageset dir="${examples.dir}"/>
+        </sources>
+      </invoke-javadoc>
+      <jarify basedir="${javadoc.dir}/${name}" destfile="${build.dir}/${}-javadoc.jar"/>
+    </sequential>


It's not the most pretty thing, but it does the work (I verified) and it'll
be easy to fix it back if and when we handle 3998. Otherwise I'm afraid
that 4.1 will be out without the examples javadocs again.


On Sat, Nov 24, 2012 at 8:39 PM, Robert Muir <> wrote:

> On Sat, Nov 24, 2012 at 10:35 AM, Shai Erera <> wrote:
>> You're probably right. The thing is, some facet tests rely on the data
>> that exists in the facet examples. The reason is that the examples already
>> contain some large number of documents and facets, so it was easy to test
>> certain features (I think TotalFacetCounts) with large set of documents,
>> without duplicating the information.
>> Is it necessary, probably not, but that's the current state of affairs. I
>> tend to agree that facet examples should be under demo/. It's just that I'm
>> not willing to lose facet (core) tests, or otherwise, the facet tests would
>> need to depend on demo  ... is it bad?
>> Really, currently the facet examples build are half broken. The
>> facet/build.xml takes care to generate the facet-examples.jar, compile them
>> and test them. The only piece that was removed, from what I can tell by
>> accident, are the javadocs ...
>> You know that I always prefer to get to a consensus before opening an
>> issue, but I want to get this fixed. It was my mistake that I didn't notice
>> that when inspecting the 4.0 artifacts .. a mistake which probably
>> demonstrates why it would be better if it were under demo/. But it doesn't
>> mean that until we resolve LUCENE-3998 (if we resolve it), the examples
>> javadocs should be missing from the build.
> I think it should be fixed too. But lets do the work to fix it right,
> otherwise the bug will resurface again and again.
> There is no failure in LUCENE-3998: I just did some of the work and
> stopped when I ran out of time.
> Lets fix it correctly and avoid hacks. Otherwise its impossible to know
> really that the release artifacts for facets are correct.

View raw message