[ 
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17034199#comment-17034199
 ] 

Dawid Weiss commented on LUCENE-9201:
-------------------------------------

bq. we would need a special task to collect all javadocs to one place for 
publishing documentation

It is my personal preference to have a project-scope granularity. This way you 
can run project-scoped task (like {{gradlew -p lucene/core javadoc}}). My 
personal take on assembling "distributions" is to have a separate project that 
just takes what it needs from other projects and puts it together (with any 
tweaks required). This makes it easier to reason about how a distribution is 
assembled and from where, while each project just takes care of itself. 

Again - the above isn't a convention. It's just a style I gradually developed 
that has been working for me in other projects. If you take a look at the 
current Solr packaging project it's pretty much what I have in mind:

https://github.com/apache/lucene-solr/blob/master/solr/packaging/build.gradle

Let me look at the patch again later today (digging myself out of the vacation 
hole).


> Port documentation-lint task to Gradle build
> --------------------------------------------
>
>                 Key: LUCENE-9201
>                 URL: https://issues.apache.org/jira/browse/LUCENE-9201
>             Project: Lucene - Core
>          Issue Type: Sub-task
>    Affects Versions: master (9.0)
>            Reporter: Tomoko Uchida
>            Assignee: Tomoko Uchida
>            Priority: Major
>         Attachments: javadocGRADLE.png, javadocHTML4.png, javadocHTML5.png
>
>          Time Spent: 40m
>  Remaining Estimate: 0h
>
> Ant build's "documentation-lint" target consists of those two sub targets.
>  * "-ecj-javadoc-lint" (Javadoc linting by ECJ)
>  * "-documentation-lint"(Missing javadocs / broken links check by python 
> scripts)



--
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

Reply via email to