[lucene-solr] branch master updated: LUCENE-9278: Fix javadocs task to work on windows and with whitespace in project folder (#1476)

[us...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

uschindler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/master by this push:
     new 26b0b54  LUCENE-9278: Fix javadocs task to work on windows and with whitespace in project folder (#1476)
26b0b54 is described below

commit 26b0b54bd3740a43775fc3b6af5d02c70d6e3283
Author: Uwe Schindler <us...@apache.org>
AuthorDate: Fri May 1 17:49:47 2020 +0200

    LUCENE-9278: Fix javadocs task to work on windows and with whitespace in project folder (#1476)
---
 gradle/render-javadoc.gradle | 26 +++++++++++++++-----------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/gradle/render-javadoc.gradle b/gradle/render-javadoc.gradle
index 85b0a94..e573acd 100644
--- a/gradle/render-javadoc.gradle
+++ b/gradle/render-javadoc.gradle
@@ -60,16 +60,20 @@ allprojects {
       def solrDocUrl = "https://lucene.apache.org/solr/${project.version.replace(".", "_")}".toString()
 
       def javadocCmd = org.gradle.internal.jvm.Jvm.current().getJavadocExecutable()
+      
+      def escapeOption = { String s ->
+        return s.replace($/\/$, $/\\/$).replace($/'/$, $/\'/$);
+      }
 
       doFirst {
         def srcDirs = sourceSets.main.java.srcDirs.findAll { dir -> dir.exists() }
         def optionsFile = file("${getTemporaryDir()}/javadoc-options.txt")
 
         def opts = []
-        opts += [ "-overview ${file("src/java/overview.html").toString()}" ]
-        opts += [ "-sourcepath ${srcDirs.join(File.pathSeparator)}" ]
+        opts += [ "-overview '${escapeOption(file("src/java/overview.html").toString())}'" ]
+        opts += [ "-sourcepath '${escapeOption(srcDirs.join(File.pathSeparator))}'" ]
         opts += [ "-subpackages ${project.path.startsWith(':lucene') ? 'org.apache.lucene' : 'org.apache.solr'}"]
-        opts += [ "-d ${project.javadoc.destinationDir.toString()}" ]
+        opts += [ "-d '${escapeOption(project.javadoc.destinationDir.toString())}'" ]
         opts += [ "-protected" ]
         opts += [ "-encoding UTF-8" ]
         opts += [ "-charset UTF-8" ]
@@ -82,28 +86,28 @@ allprojects {
         }
         opts += [ "-use" ]
         opts += [ "-locale en_US" ]
-        opts += [ "-windowtitle '${title}'" ]
-        opts += [ "-doctitle '${title}'" ]
+        opts += [ "-windowtitle '${escapeOption(title)}'" ]
+        opts += [ "-doctitle '${escapeOption(title)}'" ]
         if (!sourceSets.main.compileClasspath.isEmpty()) {
-          opts += ["-classpath ${sourceSets.main.compileClasspath.asPath}" ]
+          opts += ["-classpath '${escapeOption(sourceSets.main.compileClasspath.asPath)}'" ]
         }
         opts += [ "-bottom '<i>Copyright &copy; 2000-${buildYear} Apache Software Foundation. All Rights Reserved.</i>'" ]
 
         opts += [ "-tag 'lucene.experimental:a:WARNING: This API is experimental and might change in incompatible ways in the next release.'" ]
         opts += [ "-tag 'lucene.internal:a:NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.'" ]
-        opts += [ "-tag 'lucene.spi:t:SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).'" ]
+        opts += [ "-tag '" + escapeOption("lucene.spi:t:SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).") + "'" ]
 
         // resolve links to JavaSE and JUnit API
-        opts += [ "-linkoffline ${javaSEDocUrl} ${project(':lucene').file('tools/javadoc/java11/').toString()}" ]
+        opts += [ "-linkoffline ${javaSEDocUrl} '${escapeOption(project(':lucene').file('tools/javadoc/java11/').toString())}'" ]
         if (linkJUnit) {
-          opts += [ "-linkoffline ${junitDocUrl} ${project(':lucene').file('tools/javadoc/junit').toURL()}" ]
+          opts += [ "-linkoffline ${junitDocUrl} '${escapeOption(project(':lucene').file('tools/javadoc/junit/').toString())}'" ]
         }
         // resolve inter-project links
         linkLuceneProjects.collect { path ->
-          opts += [ "-linkoffline ${luceneDocUrl}/${pathToDocdir(path)} ${file(project(path).javadoc.destinationDir).toString()}" ]
+          opts += [ "-linkoffline ${luceneDocUrl}/${pathToDocdir(path)} '${escapeOption(file(project(path).javadoc.destinationDir).toString())}'" ]
         }
         linkSorlProjects.collect { path ->
-          opts += [ "-linkoffline ${solrDocUrl}/${pathToDocdir(path)} ${file(project(path).javadoc.destinationDir).toString()}" ]
+          opts += [ "-linkoffline ${solrDocUrl}/${pathToDocdir(path)} '${escapeOption(file(project(path).javadoc.destinationDir).toString())}'" ]
         }
 
         opts += [ "--release 11" ]