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/07/20 23:16:03 UTC

[GitHub] [lucene-solr] ErickErickson opened a new pull request #1685: LUCENE-9433: Remove Ant support from trunk

ErickErickson opened a new pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685


   This adds the first pass at changing the documentation, especially README.md and ref guide files.
   
   lucene/README.md is a major question, currently it has a nocommit in it.


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



---------------------------------------------------------------------
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 #1685: LUCENE-9433: Remove Ant support from trunk

Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685#discussion_r458628616



##########
File path: lucene/BUILD.md
##########
@@ -2,78 +2,72 @@
 
 ## Basic steps:
   
-  0. Install OpenJDK 11 (or greater), Ant 1.8.2+, Ivy 2.2.0
-  1. Download Lucene from Apache and unpack it
-  2. Connect to the top-level of your Lucene installation
+  0. Install OpenJDK 11 (or greater), Gradle 6.4.1

Review comment:
       We have gradle wrapper in the repo, installing Gradle itself is still required?




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



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org


[GitHub] [lucene-solr] ErickErickson closed pull request #1685: LUCENE-9433: Remove Ant support from trunk

Posted by GitBox <gi...@apache.org>.
ErickErickson closed pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685


   


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



---------------------------------------------------------------------
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 #1685: LUCENE-9433: Remove Ant support from trunk

Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685#discussion_r458618400



##########
File path: lucene/BUILD.md
##########
@@ -86,7 +80,4 @@ Please join the Lucene-User mailing list by visiting this site:
 Please post suggestions, questions, corrections or additions to this
 document to the lucene-user mailing list.
 
-This file was originally written by Steven J. Owens <pu...@darksleep.com>.
-This file was modified by Jon S. Stevens <jo...@latchkey.com>.
-
 Copyright (c) 2001-2020 The Apache Software Foundation.  All rights reserved.

Review comment:
       Do we need copyright notice here? (I recently modified this line at https://github.com/apache/lucene-solr/pull/1449/files for the first time since 2005.)




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



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org


[GitHub] [lucene-solr] madrob commented on a change in pull request #1685: LUCENE-9433: Remove Ant support from trunk

Posted by GitBox <gi...@apache.org>.
madrob commented on a change in pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685#discussion_r458346227



##########
File path: README.md
##########
@@ -40,48 +40,31 @@ comprehensive documentation, visit:
 
 (You do not need to do this if you downloaded a pre-built package)
 
-### Building with Ant
-
-Lucene and Solr are built using [Apache Ant](http://ant.apache.org/).  To build
-Lucene and Solr, run:
-
-`ant compile`
-
-If you see an error about Ivy missing while invoking Ant (e.g., `.ant/lib does
-not exist`), run `ant ivy-bootstrap` and retry.
-
-Sometimes you may face issues with Ivy (e.g., an incompletely downloaded artifact).
-Cleaning up the Ivy cache and retrying is a workaround for most of such issues: 
-
-`rm -rf ~/.ivy2/cache`
-
-The Solr server can then be packaged and prepared for startup by running the
-following command from the `solr/` directory:
-
-`ant server`
 
 ### Building with Gradle
 
-There is ongoing work (see [LUCENE-9077](https://issues.apache.org/jira/browse/LUCENE-9077))
-to switch the legacy ant-based build system to [gradle](https://gradle.org/).
-Please give it a try!
-
-At the moment of writing, the gradle build requires precisely Java 11 
-(it may or may not work with newer Java versions).
+As of 9.0, Lucene/Solr uses [Gradle](https://gradle.org/) as the build
+system. Installatcion instructions [here](https://gradle.org/install/).
+Ant build support has been removed.
 
 To build Lucene and Solr, run (`./` can be omitted on Windows):
 
 `./gradlew assemble`
 
-The command above also packages a full distribution of Solr server; the 
+
+The command above packages a full distribution of Solr server; the 
 package can be located at:
 
 `solr/packaging/build/solr-*`
 
 Note that the gradle build does not create or copy binaries throughout the
-source repository (like ant build does) so you need to switch to the
+source repository (like ant build did) by default so you need to switch to the

Review comment:
       Do we want to remove this reference to ant build too?

##########
File path: lucene/BUILD.md
##########
@@ -2,78 +2,72 @@
 
 ## Basic steps:
   
-  0. Install OpenJDK 11 (or greater), Ant 1.8.2+, Ivy 2.2.0
-  1. Download Lucene from Apache and unpack it
-  2. Connect to the top-level of your Lucene installation
+  0. Install OpenJDK 11 (or greater), Gradle 6.4.1

Review comment:
       Same question about install.

##########
File path: README.md
##########
@@ -40,48 +40,31 @@ comprehensive documentation, visit:
 
 (You do not need to do this if you downloaded a pre-built package)
 
-### Building with Ant
-
-Lucene and Solr are built using [Apache Ant](http://ant.apache.org/).  To build
-Lucene and Solr, run:
-
-`ant compile`
-
-If you see an error about Ivy missing while invoking Ant (e.g., `.ant/lib does
-not exist`), run `ant ivy-bootstrap` and retry.
-
-Sometimes you may face issues with Ivy (e.g., an incompletely downloaded artifact).
-Cleaning up the Ivy cache and retrying is a workaround for most of such issues: 
-
-`rm -rf ~/.ivy2/cache`
-
-The Solr server can then be packaged and prepared for startup by running the
-following command from the `solr/` directory:
-
-`ant server`
 
 ### Building with Gradle
 
-There is ongoing work (see [LUCENE-9077](https://issues.apache.org/jira/browse/LUCENE-9077))
-to switch the legacy ant-based build system to [gradle](https://gradle.org/).
-Please give it a try!
-
-At the moment of writing, the gradle build requires precisely Java 11 
-(it may or may not work with newer Java versions).
+As of 9.0, Lucene/Solr uses [Gradle](https://gradle.org/) as the build
+system. Installatcion instructions [here](https://gradle.org/install/).

Review comment:
       s/Installatcion/Installation
   
   Do we need to install this at all? I thought we use the wrapper.

##########
File path: solr/README.md
##########
@@ -163,30 +163,22 @@ Instructions for Building Apache Solr from Source
    folder included on your command path. To test this, issue a "java -version" command
    from your shell (command prompt) and verify that the Java version is 11 or later.
 
-2. Download the Apache Ant binary distribution (1.8.2+) from
-   http://ant.apache.org/  You will need Ant installed and the $ANT_HOME/bin (Windows:
-   %ANT_HOME%\bin) folder included on your command path. To test this, issue a
-   "ant -version" command from your shell (command prompt) and verify that Ant is
-   available.
-
-   You will also need to install Apache Ivy binary distribution (2.2.0) from
-   http://ant.apache.org/ivy/ and place ivy-2.2.0.jar file in ~/.ant/lib -- if you skip
-   this step, the Solr build system will offer to do it for you.
+2. Install Gradle, see https://gradle.org/ The current version is 6.4.1. Installation

Review comment:
       Same question

##########
File path: lucene/BUILD.md
##########
@@ -2,78 +2,72 @@
 
 ## Basic steps:
   
-  0. Install OpenJDK 11 (or greater), Ant 1.8.2+, Ivy 2.2.0
-  1. Download Lucene from Apache and unpack it
-  2. Connect to the top-level of your Lucene installation
+  0. Install OpenJDK 11 (or greater), Gradle 6.4.1
+  1. Download Lucene/Solr from Apache and unpack it
+  2. Connect to the top-level of your installation (parent of the lucene top-level directory)
   3. Install JavaCC (optional)
-  4. Run ant
+  4. Run gradle
 
-## Step 0) Set up your development environment (OpenJDK 11 or greater, Ant 1.8.2+, Ivy 2.2.0)
+## Step 0) Set up your development environment (OpenJDK 11 or greater, Gradle 6.4.1)
 
 We'll assume that you know how to get and set up the JDK - if you
 don't, then we suggest starting at https://www.oracle.com/java/ and learning
 more about Java, before returning to this README. Lucene runs with
 Java 11 and later.
 
-Like many Open Source java projects, Lucene uses Apache Ant for build
-control.  Specifically, you MUST use Ant version 1.8.2+.
+Lucene uses Gradle for build control.  Specifically, you MUST use Gradle 6.4.1.
 
-Ant is "kind of like make without make's wrinkles".  Ant is
-implemented in java and uses XML-based configuration files.  You can
-get it at:
+NOTE: When Solr moves to a Top Level Project, it will no longer
+be necessary to download Solr to build Lucene. You can track
+progress at: https://issues.apache.org/jira/browse/SOLR-14497 
 
-  https://ant.apache.org
+NOTE: Lucene changed from Ant to Gradle as of release 9.0. Prior releases
+still use Ant.
 
-You'll need to download the Ant binary distribution.  Install it
-according to the instructions at:
+Gradle is implemented in groovy and uses configuration files with the
+extension ".gradle".  You can get Gradle at:
 
-  https://ant.apache.org/manual
+  https://gradle.org/
 
-Finally, you'll need to install ivy into your ant lib folder
-(~/.ant/lib). You can get it from http://ant.apache.org/ivy/.
-If you skip this step, the Lucene build system will offer to do it 
-for you.
+You'll need to install Gradle, see:

Review comment:
       Same question.

##########
File path: solr/README.md
##########
@@ -163,30 +163,22 @@ Instructions for Building Apache Solr from Source
    folder included on your command path. To test this, issue a "java -version" command
    from your shell (command prompt) and verify that the Java version is 11 or later.
 
-2. Download the Apache Ant binary distribution (1.8.2+) from
-   http://ant.apache.org/  You will need Ant installed and the $ANT_HOME/bin (Windows:
-   %ANT_HOME%\bin) folder included on your command path. To test this, issue a
-   "ant -version" command from your shell (command prompt) and verify that Ant is
-   available.
-
-   You will also need to install Apache Ivy binary distribution (2.2.0) from
-   http://ant.apache.org/ivy/ and place ivy-2.2.0.jar file in ~/.ant/lib -- if you skip
-   this step, the Solr build system will offer to do it for you.
+2. Install Gradle, see https://gradle.org/ The current version is 6.4.1. Installation
+   instructions are here: https://gradle.org/install/
 
 3. Download the Apache Solr distribution, linked from the above web site.
    Unzip the distribution to a folder of your choice, e.g. C:\solr or ~/solr
    Alternately, you can obtain a copy of the latest Apache Solr source code
    directly from the GIT repository:
 
-     https://lucene.apache.org/solr/versioncontrol.html
-
-4. Navigate to the "solr" folder and issue an "ant" command to see the available options
-   for building, testing, and packaging Solr.
+     https://lucene.apache.org/solr/community.html#version-control
 
-   NOTE:
-   To see Solr in action, you may want to use the "ant server" command to build
-   and package Solr into the server directory. See also server/README.md.
+4. Navigate to the root of your source tree folder and issue the "./gradlew tasks" 
+   command to see the available options for building, testing, and packaging Solr.
 
+   "./gradlew assemble" will create a Solr executable. 

Review comment:
       backticks?




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



---------------------------------------------------------------------
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 #1685: LUCENE-9433: Remove Ant support from trunk

Posted by GitBox <gi...@apache.org>.
dweiss commented on a change in pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685#discussion_r458636209



##########
File path: lucene/BUILD.md
##########
@@ -2,78 +2,72 @@
 
 ## Basic steps:
   
-  0. Install OpenJDK 11 (or greater), Ant 1.8.2+, Ivy 2.2.0
-  1. Download Lucene from Apache and unpack it
-  2. Connect to the top-level of your Lucene installation
+  0. Install OpenJDK 11 (or greater), Gradle 6.4.1

Review comment:
       No, it isn't. Gradle wrapper will download itself. We should *not* mention any external installation requirements because different branches will be on different gradle version (and may not be interoperable). The wrapper handles this transparently.




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



---------------------------------------------------------------------
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 #1685: LUCENE-9433: Remove Ant support from trunk

Posted by GitBox <gi...@apache.org>.
mocobeta commented on a change in pull request #1685:
URL: https://github.com/apache/lucene-solr/pull/1685#discussion_r459201621



##########
File path: lucene/BUILD.md
##########
@@ -2,78 +2,72 @@
 
 ## Basic steps:
   
-  0. Install OpenJDK 11 (or greater), Ant 1.8.2+, Ivy 2.2.0
-  1. Download Lucene from Apache and unpack it
-  2. Connect to the top-level of your Lucene installation
+  0. Install OpenJDK 11 (or greater), Gradle 6.4.1

Review comment:
       @ErickErickson 
   I opened a PR on your repository to refine lucene/BUILD.md: https://github.com/ErickErickson/lucene-solr/pull/1
   Could you check it?




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



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org