You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2020/03/14 06:38:19 UTC
[GitHub] [lucene-solr] mocobeta opened a new pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
mocobeta opened a new pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352
<!--
_(If you are a project committer then you may remove some/all of the following template.)_
Before creating a pull request, please file an issue in the ASF Jira system for Lucene or Solr:
* https://issues.apache.org/jira/projects/LUCENE
* https://issues.apache.org/jira/projects/SOLR
You will need to create an account in Jira in order to create an issue.
The title of the PR should reference the Jira issue number in the form:
* LUCENE-####: <short description of problem or changes>
* SOLR-####: <short description of problem or changes>
LUCENE and SOLR must be fully capitalized. A short description helps people scanning pull requests for items they can work on.
Properly referencing the issue in the title ensures that Jira is correctly updated with code review comments and commits. -->
# Description
See https://issues.apache.org/jira/browse/LUCENE-9278
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on issue #1352: LUCENE-9278: Make
javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta commented on issue #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#issuecomment-601614547
I mean to close this PR because we will eventually replace all relative paths here with absolute URLs, sooner or later. I'll try to make some changes to renderJavadoc task to drop all relative paths (and move all generated docs under _project_/build again).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta closed pull request #1352: LUCENE-9278: Make
javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta closed pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392571884
##########
File path: gradle/render-javadoc.gradle
##########
@@ -294,35 +305,41 @@ configure(project(':solr:core')) {
plugins.withType(JavaPlugin) {
// specialized to ONLY depend on solrj
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- linkHref += [ '../solr-solrj' ]
+ [':solr:solrj'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../" + pathToDocdir(path) ]
+ }
}
}
}
configure(subprojects.findAll { it.path.startsWith(':solr:contrib') }) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- dependsOn ':solr:core:renderJavadoc'
- linkHref += [ '../solr-solrj', '../solr-core' ]
+ [':solr:solrj', ':solr:core'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
configure(project(':solr:contrib:dataimporthandler-extras')) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:contrib:dataimporthandler:renderJavadoc'
- linkHref += [ '../solr-dataimporthandler' ]
+ [':solr:contrib:dataimporthandler'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
+
configure(project(':solr:contrib:extraction')) {
plugins.withType(JavaPlugin) {
ext {
- javadocDestDir = "${javadocRoot}/solr-cell"
+ javadocDestDir = "${javadocRoot}/contrib/cell"
Review comment:
I removed the entire configure block, so now the docs will go to `contrib/extraction`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392571898
##########
File path: gradle/render-javadoc.gradle
##########
@@ -17,11 +17,15 @@
// generate javadocs by using Ant javadoc task
+// utility function to convert project path to document output dir
+// e.g.: ':lucene:analysis:common' => 'analysis/common'
+def pathToDocdir = { path -> path.split(':').drop(2).join('/') }
+
allprojects {
plugins.withType(JavaPlugin) {
ext {
javadocRoot = project.path.startsWith(':lucene') ? project(':lucene').file("build/docs") : project(':solr').file("build/docs")
- javadocDestDir = "${javadocRoot}/${project.name}"
+ javadocDestDir = "${javadocRoot}/" + pathToDocdir(project.path)
Review comment:
Fixed, thanks.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] dweiss commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
dweiss commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392568764
##########
File path: gradle/render-javadoc.gradle
##########
@@ -294,35 +305,41 @@ configure(project(':solr:core')) {
plugins.withType(JavaPlugin) {
// specialized to ONLY depend on solrj
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- linkHref += [ '../solr-solrj' ]
+ [':solr:solrj'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../" + pathToDocdir(path) ]
+ }
}
}
}
configure(subprojects.findAll { it.path.startsWith(':solr:contrib') }) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- dependsOn ':solr:core:renderJavadoc'
- linkHref += [ '../solr-solrj', '../solr-core' ]
+ [':solr:solrj', ':solr:core'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
configure(project(':solr:contrib:dataimporthandler-extras')) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:contrib:dataimporthandler:renderJavadoc'
- linkHref += [ '../solr-dataimporthandler' ]
+ [':solr:contrib:dataimporthandler'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
+
configure(project(':solr:contrib:extraction')) {
plugins.withType(JavaPlugin) {
ext {
- javadocDestDir = "${javadocRoot}/solr-cell"
+ javadocDestDir = "${javadocRoot}/contrib/cell"
Review comment:
The "solr-cell" is what it's called in ant. I'm not sure why. I would prefer to stick to folder/ project path naming here too (so contrib/extraction for me).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392562835
##########
File path: gradle/render-javadoc.gradle
##########
@@ -294,35 +305,41 @@ configure(project(':solr:core')) {
plugins.withType(JavaPlugin) {
// specialized to ONLY depend on solrj
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- linkHref += [ '../solr-solrj' ]
+ [':solr:solrj'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../" + pathToDocdir(path) ]
+ }
}
}
}
configure(subprojects.findAll { it.path.startsWith(':solr:contrib') }) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- dependsOn ':solr:core:renderJavadoc'
- linkHref += [ '../solr-solrj', '../solr-core' ]
+ [':solr:solrj', ':solr:core'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
configure(project(':solr:contrib:dataimporthandler-extras')) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:contrib:dataimporthandler:renderJavadoc'
- linkHref += [ '../solr-dataimporthandler' ]
+ [':solr:contrib:dataimporthandler'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
+
configure(project(':solr:contrib:extraction')) {
plugins.withType(JavaPlugin) {
ext {
- javadocDestDir = "${javadocRoot}/solr-cell"
+ javadocDestDir = "${javadocRoot}/contrib/cell"
Review comment:
I'm not sure this tweak is needed for gradle build. Simply, "docs/contrib/extraction" (same as other contrib modules) may be okay?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] dweiss commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
dweiss commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392568830
##########
File path: gradle/render-javadoc.gradle
##########
@@ -17,11 +17,15 @@
// generate javadocs by using Ant javadoc task
+// utility function to convert project path to document output dir
+// e.g.: ':lucene:analysis:common' => 'analysis/common'
+def pathToDocdir = { path -> path.split(':').drop(2).join('/') }
+
allprojects {
plugins.withType(JavaPlugin) {
ext {
javadocRoot = project.path.startsWith(':lucene') ? project(':lucene').file("build/docs") : project(':solr').file("build/docs")
- javadocDestDir = "${javadocRoot}/${project.name}"
+ javadocDestDir = "${javadocRoot}/" + pathToDocdir(project.path)
Review comment:
You can call the function inside the evaluated string too; "${javadocRoot}/${pathToDocDir(project.path)}"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392562835
##########
File path: gradle/render-javadoc.gradle
##########
@@ -294,35 +305,41 @@ configure(project(':solr:core')) {
plugins.withType(JavaPlugin) {
// specialized to ONLY depend on solrj
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- linkHref += [ '../solr-solrj' ]
+ [':solr:solrj'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../" + pathToDocdir(path) ]
+ }
}
}
}
configure(subprojects.findAll { it.path.startsWith(':solr:contrib') }) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:solrj:renderJavadoc'
- dependsOn ':solr:core:renderJavadoc'
- linkHref += [ '../solr-solrj', '../solr-core' ]
+ [':solr:solrj', ':solr:core'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
configure(project(':solr:contrib:dataimporthandler-extras')) {
plugins.withType(JavaPlugin) {
renderJavadoc {
- dependsOn ':solr:contrib:dataimporthandler:renderJavadoc'
- linkHref += [ '../solr-dataimporthandler' ]
+ [':solr:contrib:dataimporthandler'].collect { path ->
+ dependsOn "${path}:renderJavadoc"
+ linkHref += [ "../../" + pathToDocdir(path) ]
+ }
}
}
}
+
configure(project(':solr:contrib:extraction')) {
plugins.withType(JavaPlugin) {
ext {
- javadocDestDir = "${javadocRoot}/solr-cell"
+ javadocDestDir = "${javadocRoot}/contrib/cell"
Review comment:
I'm not sure this tweak is needed for gradle build. Simply, "solr/contrib/extraction" (same as other contrib modules) may be okay?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] dweiss commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
dweiss commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392568691
##########
File path: gradle/render-javadoc.gradle
##########
@@ -17,11 +17,15 @@
// generate javadocs by using Ant javadoc task
+// utility function to convert project path to document output dir
+// e.g.: ':lucene:analysis:common' => 'analysis/common'
+def pathToDocdir = { path -> path.split(':').drop(2).join('/') }
Review comment:
This seems fine to me.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene-solr] mocobeta commented on a change in pull request #1352:
LUCENE-9278: Make javadoc folder structure follow Gradle project path
Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1352: LUCENE-9278: Make javadoc folder structure follow Gradle project path
URL: https://github.com/apache/lucene-solr/pull/1352#discussion_r392562400
##########
File path: gradle/render-javadoc.gradle
##########
@@ -17,11 +17,15 @@
// generate javadocs by using Ant javadoc task
+// utility function to convert project path to document output dir
+// e.g.: ':lucene:analysis:common' => 'analysis/common'
+def pathToDocdir = { path -> path.split(':').drop(2).join('/') }
Review comment:
There might be better way?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org