[
https://issues.apache.org/jira/browse/LUCENE-9278?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Uwe Schindler reopened LUCENE-9278:
-----------------------------------
Hi,
the renderJavadocs task does not work correctly under following circumstances:
- Windows: The backslash in path name has a special meaning for the javadocs
options.txt file
- Whitespace in build path: If there's whitespace in the build path, it won't
work at all
The combination of both issues leads to javadoc complaing about bad package
names.
To fix this, when writing the options file, all arguments must be correctly
escaped! There are 3 ways to do this:
- copy code from Ant's source code which has a very fancy optional esacping (if
it detects that there's whitespace or quotes inside the argument, it's not
escaped otherwise)
- use Gradle's internal package which has another sophisticated
JavaDocOptionsFileWriter:
https://github.com/gradle/gradle/tree/e975872ae2cf1d521b73f1107cae772ca09c63cd/subprojects/language-java/src/main/java/org/gradle/external/javadoc/internal
(many classes)
- do some simple escaping
I have choosen the last option, will submit a PR soon.
> Make javadoc folder structure follow Gradle project path
> --------------------------------------------------------
>
> Key: LUCENE-9278
> URL: https://issues.apache.org/jira/browse/LUCENE-9278
> Project: Lucene - Core
> Issue Type: Task
> Components: general/build
> Reporter: Tomoko Uchida
> Assignee: Tomoko Uchida
> Priority: Major
> Fix For: master (9.0)
>
> Time Spent: 6h 20m
> Remaining Estimate: 0h
>
> Current javadoc folder structure is derived from Ant project name. e.g.:
> [https://lucene.apache.org/core/8_4_1/analyzers-icu/index.html]
> [https://lucene.apache.org/solr/8_4_1/solr-solrj/index.html]
> For Gradle build, it should also follow gradle project structure (path)
> instead of ant one, to keep things simple to manage [1]. Hence, it will look
> like this:
> [https://lucene.apache.org/core/9_0_0/analysis/icu/index.html]
> [https://lucene.apache.org/solr/9_0_0/solr/solrj/index.html]
> [1] The change was suggested at the conversation between Dawid Weiss and I on
> a github pr: [https://github.com/apache/lucene-solr/pull/1304]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
