[
https://issues.apache.org/jira/browse/LUCENE-9278?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17059693#comment-17059693
]
Tomoko Uchida commented on LUCENE-9278:
---------------------------------------
I noticed there are "hard-coded" relative paths to another modules in
{{o.a.l.a.Analyzer}} javadoc.
[https://github.com/apache/lucene-solr/blob/master/lucene/core/src/java/org/apache/lucene/analysis/Analyzer.java#L66]
{code:java}
* <li><a
href="{@docRoot}/../analyzers-common/overview-summary.html">Common</a>:
* Analyzers for indexing content in different languages and domains.
* <li><a href="{@docRoot}/../analyzers-icu/overview-summary.html">ICU</a>:
* Exposes functionality from ICU to Apache Lucene.
* <li><a
href="{@docRoot}/../analyzers-kuromoji/overview-summary.html">Kuromoji</a>:
* Morphological analyzer for Japanese text.
* <li><a
href="{@docRoot}/../analyzers-morfologik/overview-summary.html">Morfologik</a>:
* Dictionary-driven lemmatization for the Polish language.
* <li><a
href="{@docRoot}/../analyzers-phonetic/overview-summary.html">Phonetic</a>:
* Analysis for indexing phonetic signatures (for sounds-alike search).
* <li><a href="{@docRoot}/../analyzers-smartcn/overview-summary.html">Smart
Chinese</a>:
* Analyzer for Simplified Chinese, which indexes words.
* <li><a
href="{@docRoot}/../analyzers-stempel/overview-summary.html">Stempel</a>:
{code}
As you see the links include ant project names. We need to keep them as long as
we use ant build as our primary build system, and change them to the gradle
project paths (analysis/common, etc.) soon after we switch to gradle build,
otherwise the links will be broken. I cannot figure out a feasible option to
make ant and gradle build co-exist here.
So far, we set two goals for gradle javadoc task.
([https://github.com/apache/lucene-solr/pull/1304])
- Not to use centralized output folder. Instead, docs should go to isolated,
per project build folder.
- Make the javadoc folder hierarchy obey gradle project paths, not ant ones.
While it would be certainly possible to achieve them without harming the
complexed inter-project links (the only problem what's puzzling me here is the
"hyperlinks" between modules), we may need a careful migration strategy (and
also a gradle version "broken links check" script) for that. I just got stuck
in the small pond... give me some time to find a better solution.
> 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
> Priority: Major
> Time Spent: 1.5h
> 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
