You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Hoss Man (JIRA)" <ji...@apache.org> on 2017/03/01 22:13:45 UTC
[jira] [Comment Edited] (LUCENE-7294) Figure out why building
Javadocs fails with "unknown error" in Java 9 build 118
[ https://issues.apache.org/jira/browse/LUCENE-7294?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15891167#comment-15891167 ]
Hoss Man edited comment on LUCENE-7294 at 3/1/17 10:13 PM:
-----------------------------------------------------------
As of jdk9-ea-b158, {{ant documentation}} seems to build the core javadocs just fine, but fails on the {{lucene/memory/}} javadocs...
{noformat}
javadocs:
[mkdir] Created dir: /home/hossman/lucene/dev/lucene/build/docs/memory
download-java8-javadoc-packagelist:
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package org.apache.lucene.index.memory...
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 9-ea
[javadoc] Building tree for all the packages and classes...
[javadoc] javadoc: warning - invalid usage of tag &pa
[javadoc] javadoc: warning - invalid usage of tag &pid
[javadoc] javadoc: warning - invalid usage of tag &page
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[javadoc] Generating /home/hossman/lucene/dev/lucene/build/docs/memory/help-doc.html...
[javadoc] Note: Custom tags that were not seen: @lucene.internal
[javadoc] 3 warnings
BUILD FAILED
/home/hossman/lucene/dev/build.xml:93: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/build.xml:251: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/common-build.xml:2179: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/module-build.xml:549: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/module-build.xml:65: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/module-build.xml:78: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/common-build.xml:2155: Javadocs warnings were found!
Total time: 1 minute 0 seconds
{noformat}
looking at the generated html files turns up this...
{noformat}
hossman@tray:~/lucene/dev [master] $ find lucene/build/docs/memory -name \*.html | xargs grep -C5 "&pa"
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- but rather thrown away immediately after tokenization.
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <p>
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- For some interesting background information on search technology, see Bob Wyman's
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <a target="_blank" href="http://bobwyman.pubsub.com/main/2005/05/mary_hodder_poi.html">Prospective Search</a>,
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- Jim Gray's
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html: <a target="_blank" href="http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=293&page=4">
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- A Call to Arms - Custom subscriptions</a>, and Tim Bray's
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <a target="_blank" href="http://www.tbray.org/ongoing/When/200x/2003/07/30/OnSearchTOC">On Search, the Series</a>.
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html-
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <p>
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <b>Example Usage</b>
{noformat}
The source java file has this...
{noformat}
* Jim Gray's
* <a target="_blank" href="http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=293&page=4">
* A Call to Arms - Custom subscriptions</a>, and Tim Bray's
{noformat}
...which does in fact seem to be invalid HTML ... aren't {{&}} always suppose to be encoded as {{&}} ... even in URLs?
I'm suprised the java8 javadocs/linter don't warn about this.
was (Author: hossman):
As of jdk9-ea-b148, {{ant documentation}} seems to build the core javadocs just fine, but fails on the {{lucene/memory/}} javadocs...
{noformat}
javadocs:
[mkdir] Created dir: /home/hossman/lucene/dev/lucene/build/docs/memory
download-java8-javadoc-packagelist:
[javadoc] Generating Javadoc
[javadoc] Javadoc execution
[javadoc] Loading source files for package org.apache.lucene.index.memory...
[javadoc] Constructing Javadoc information...
[javadoc] Standard Doclet version 9-ea
[javadoc] Building tree for all the packages and classes...
[javadoc] javadoc: warning - invalid usage of tag &pa
[javadoc] javadoc: warning - invalid usage of tag &pid
[javadoc] javadoc: warning - invalid usage of tag &page
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[javadoc] Generating /home/hossman/lucene/dev/lucene/build/docs/memory/help-doc.html...
[javadoc] Note: Custom tags that were not seen: @lucene.internal
[javadoc] 3 warnings
BUILD FAILED
/home/hossman/lucene/dev/build.xml:93: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/build.xml:251: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/common-build.xml:2179: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/module-build.xml:549: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/module-build.xml:65: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/module-build.xml:78: The following error occurred while executing this line:
/home/hossman/lucene/dev/lucene/common-build.xml:2155: Javadocs warnings were found!
Total time: 1 minute 0 seconds
{noformat}
looking at the generated html files turns up this...
{noformat}
hossman@tray:~/lucene/dev [master] $ find lucene/build/docs/memory -name \*.html | xargs grep -C5 "&pa"
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- but rather thrown away immediately after tokenization.
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <p>
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- For some interesting background information on search technology, see Bob Wyman's
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <a target="_blank" href="http://bobwyman.pubsub.com/main/2005/05/mary_hodder_poi.html">Prospective Search</a>,
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- Jim Gray's
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html: <a target="_blank" href="http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=293&page=4">
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- A Call to Arms - Custom subscriptions</a>, and Tim Bray's
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <a target="_blank" href="http://www.tbray.org/ongoing/When/200x/2003/07/30/OnSearchTOC">On Search, the Series</a>.
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html-
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <p>
lucene/build/docs/memory/org/apache/lucene/index/memory/MemoryIndex.html- <b>Example Usage</b>
{noformat}
The source java file has this...
{noformat}
* Jim Gray's
* <a target="_blank" href="http://www.acmqueue.org/modules.php?name=Content&pa=showpage&pid=293&page=4">
* A Call to Arms - Custom subscriptions</a>, and Tim Bray's
{noformat}
...which does in fact seem to be invalid HTML ... aren't {{&}} always suppose to be encoded as {{&}} ... even in URLs?
I'm suprised the java8 javadocs/linter don't warn about this.
> Figure out why building Javadocs fails with "unknown error" in Java 9 build 118
> -------------------------------------------------------------------------------
>
> Key: LUCENE-7294
> URL: https://issues.apache.org/jira/browse/LUCENE-7294
> Project: Lucene - Core
> Issue Type: Bug
> Affects Versions: 6.x, master (7.0)
> Reporter: Uwe Schindler
> Assignee: Uwe Schindler
> Labels: Java9
>
> When building Javadocs with java 9 it fails like:
> {noformat}
> [javadoc] Loading source files for package org.apache.lucene.util.mutable...
> [javadoc] Loading source files for package org.apache.lucene.util.packed...
> [javadoc] Constructing Javadoc information...
> [javadoc] Standard Doclet version 9-ea
> [javadoc] Building tree for all the packages and classes...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\org\apache\lucene\LucenePackage.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\org\apache\lucene\analysis\Analyzer.html...
> [...]
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\org\apache\lucene\util\bkd\package-use.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\org\apache\lucene\util\fst\package-use.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\org\apache\lucene\util\mutable\package-use.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\org\apache\lucene\util\packed\package-use.html...
> [javadoc] Building index for all the packages and classes...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\overview-tree.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\deprecated-list.html...
> [javadoc] Building index for all classes...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\allclasses-frame.html...
> [javadoc] javadoc: error - an unknown error has occurred
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\allclasses-noframe.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\index.html...
> [javadoc] Generating C:\Users\Uwe Schindler\Projects\lucene\trunk-lusolr1\lucene\build\docs\core\overview-summary.html...
> [javadoc] 1 error
> {noformat}
> This looks like a bug in "javadoc". I started a question on OpenJDK mailing list: [http://mail.openjdk.java.net/pipermail/javadoc-dev/2016-May/000244.html]
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org