[ https://issues.apache.org/jira/browse/LUCENE-8768?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16821992#comment-16821992 ]
Uwe Schindler commented on LUCENE-8768: --------------------------------------- I checked the Javascript files, jQuery would have been fine, but the code developed by OpenJDK contributors is incompatible: search.js as shipped in Javadocs violates ASF licensing: {code:javascript} /* * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ {code} So we cannot ship artifacts with the search engine enabled. I am looking for the correct mail, but there was already a discussion on some ASF mailing list already... I will commit the attached patch to fix the warning for those, who want to create javadocs index, but I will also add a coment to the "javadocs.noindex" setting that changing it violates ASF licensing: [^LUCENE-8768.patch] IMHO: A cool thing would be to maybe install SOLR on the Lucene/Solr web page and index our Javadocs. > Javadoc search support > ---------------------- > > Key: LUCENE-8768 > URL: https://issues.apache.org/jira/browse/LUCENE-8768 > Project: Lucene - Core > Issue Type: New Feature > Reporter: Namgyu Kim > Priority: Major > Attachments: LUCENE-8768.patch, LUCENE-8768.patch, > javadoc-nightly.png, new-javadoc.png > > Time Spent: 10m > Remaining Estimate: 0h > > Javadoc search is a new feature since Java 9. > ([https://openjdk.java.net/jeps/225]) > I think there is no reason not to use it if the current Lucene Java version > is 11. > It can be a great help to developers looking at API documentation. > (The elastic search also supports it now! > > [https://artifacts.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/7.0.0/org/elasticsearch/client/package-summary.html]) > > ■ Before (Lucene Nightly Core Module Javadoc) > !javadoc-nightly.png! > ■ After > *!new-javadoc.png!* > > I'll change two lines for this. > 1) change Javadoc's noindex option from true to false. > {code:java} > // common-build.xml line 182 > <property name="javadoc.noindex" value="false"/>{code} > 2) add javadoc argument "--no-module-directories" > {code:java} > // common-build.xml line 2100 > <javadoc > overview="@{overview}" > additionalparam="--no-module-directories" // NEW CODE > packagenames="org.apache.lucene.*,org.apache.solr.*" > ... > maxmemory="${javadoc.maxmemory}"> > {code} > Currently there is an issue like the following link in JDK 11, so we need > "--no-module-directories" option. > ([https://bugs.openjdk.java.net/browse/JDK-8215291]) > > ■ How to test > I did +"ant javadocs-modules"+ on lucene project and check Javadoc. > > -- This message was sent by Atlassian JIRA (v7.6.3#76005) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org