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 2021/03/10 14:55:05 UTC
[GitHub] [lucene] janhoy commented on a change in pull request #6: Cleanup readme file and copy build instructions from lucene subfolder…
janhoy commented on a change in pull request #6:
URL: https://github.com/apache/lucene/pull/6#discussion_r591580213
##########
File path: README.md
##########
@@ -31,25 +31,63 @@ comprehensive documentation, visit:
## Building with Gradle
-### Building Lucene
+### Basic steps:
+
+ 0. Install OpenJDK 11 (or greater)
+ 1. Download Lucene/Solr from Apache and unpack it
Review comment:
Download lucene... (well, we don't yet have a release with only lucene...)
Also on line 30 -don't need Lucene: as prefix
##########
File path: README.md
##########
@@ -31,69 +31,83 @@ comprehensive documentation, visit:
## Building with Gradle
-### Building Lucene
+### Basic steps:
+
+ 0. Install OpenJDK 11 (or greater)
+ 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 gradle
-See [lucene/BUILD.md](./lucene/BUILD.md).
-
-### Building Solr
-
-Firstly, you need to set up your development environment (OpenJDK 11 or greater).
+### Step 0) Set up your development environment (OpenJDK 11 or greater)
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. Solr runs with
+more about Java, before returning to this README. Lucene runs with
Java 11 and later.
-As of 9.0, Lucene/Solr uses [Gradle](https://gradle.org/) as the build
-system. Ant build support has been removed.
+Lucene uses [Gradle](https://gradle.org/) for build control.
-To build Lucene and Solr, run (`./` can be omitted on Windows):
+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
-`./gradlew assemble`
+NOTE: Lucene changed from Ant to Gradle as of release 9.0. Prior releases
+still use Ant.
-NOTE: DO NOT use `gradle` command that is already installed on your machine (unless you know what you'll do).
-The "gradle wrapper" (gradlew) does the job - downloads the correct version of it, setups necessary configurations.
+### Step 1) Checkout/Download Lucene source code
-The first time you run Gradle, it will create a file "gradle.properties" that
-contains machine-specific settings. Normally you can use this file as-is, but it
-can be modified if necessary.
+We'll assume you already did this, or you wouldn't be reading this
+file. However, you might have received this file by some alternate
+route, or you might have an incomplete copy of the Lucene, so: you
+can directly checkout the source code from GitHub:
+
+ https://github.com/apache/lucene
+
+Or Lucene source archives at particlar releases are available as part of Lucene downloads:
-The command above packages a full distribution of Solr server; the
-package can be located at:
+ https://lucene.apache.org/core/downloads.html
-`solr/packaging/build/solr-*`
+Download either a zip or a tarred/gzipped version of the archive, and
+uncompress it into a directory of your choice.
-Note that the gradle build does not create or copy binaries throughout the
-source repository so you need to switch to the packaging output folder above;
-the rest of the instructions below remain identical. The packaging directory
-is rewritten on each build.
+### Step 2) Change directory (cd) into the top-level directory of the source tree
-For development, especially when you have created test indexes etc, use
-the `./gradlew dev` task which will copy binaries to `./solr/packaging/build/dev`
-but _only_ overwrite the binaries which will preserve your test setup.
+The parent directory for both Lucene and Solr contains the base configuration
Review comment:
Solr is removed from this repo...
##########
File path: README.md
##########
@@ -31,25 +31,63 @@ comprehensive documentation, visit:
## Building with Gradle
-### Building Lucene
+### Basic steps:
+
+ 0. Install OpenJDK 11 (or greater)
+ 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 gradle
-See [lucene/BUILD.md](./lucene/BUILD.md).
-
-### Building Solr
-
-Firstly, you need to set up your development environment (OpenJDK 11 or greater).
+### Step 0) Set up your development environment (OpenJDK 11 or greater)
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. Solr runs with
+more about Java, before returning to this README. Lucene runs with
Java 11 and later.
-As of 9.0, Lucene/Solr uses [Gradle](https://gradle.org/) as the build
-system. Ant build support has been removed.
+Lucene uses [Gradle](https://gradle.org/) for build control.
+
+NOTE: When Solr moves to a Top Level Project, it will no longer
Review comment:
"When Solr moves to a Top Level Project" - has happened :)
Is it necessary to download Solr to build lucene now?
##########
File path: README.md
##########
@@ -31,69 +31,83 @@ comprehensive documentation, visit:
## Building with Gradle
-### Building Lucene
+### Basic steps:
+
+ 0. Install OpenJDK 11 (or greater)
+ 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 gradle
-See [lucene/BUILD.md](./lucene/BUILD.md).
-
-### Building Solr
-
-Firstly, you need to set up your development environment (OpenJDK 11 or greater).
+### Step 0) Set up your development environment (OpenJDK 11 or greater)
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. Solr runs with
+more about Java, before returning to this README. Lucene runs with
Java 11 and later.
-As of 9.0, Lucene/Solr uses [Gradle](https://gradle.org/) as the build
-system. Ant build support has been removed.
+Lucene uses [Gradle](https://gradle.org/) for build control.
-To build Lucene and Solr, run (`./` can be omitted on Windows):
+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
-`./gradlew assemble`
+NOTE: Lucene changed from Ant to Gradle as of release 9.0. Prior releases
+still use Ant.
-NOTE: DO NOT use `gradle` command that is already installed on your machine (unless you know what you'll do).
-The "gradle wrapper" (gradlew) does the job - downloads the correct version of it, setups necessary configurations.
+### Step 1) Checkout/Download Lucene source code
-The first time you run Gradle, it will create a file "gradle.properties" that
-contains machine-specific settings. Normally you can use this file as-is, but it
-can be modified if necessary.
+We'll assume you already did this, or you wouldn't be reading this
+file. However, you might have received this file by some alternate
+route, or you might have an incomplete copy of the Lucene, so: you
+can directly checkout the source code from GitHub:
+
+ https://github.com/apache/lucene
+
+Or Lucene source archives at particlar releases are available as part of Lucene downloads:
-The command above packages a full distribution of Solr server; the
-package can be located at:
+ https://lucene.apache.org/core/downloads.html
-`solr/packaging/build/solr-*`
+Download either a zip or a tarred/gzipped version of the archive, and
+uncompress it into a directory of your choice.
-Note that the gradle build does not create or copy binaries throughout the
-source repository so you need to switch to the packaging output folder above;
-the rest of the instructions below remain identical. The packaging directory
-is rewritten on each build.
+### Step 2) Change directory (cd) into the top-level directory of the source tree
-For development, especially when you have created test indexes etc, use
-the `./gradlew dev` task which will copy binaries to `./solr/packaging/build/dev`
-but _only_ overwrite the binaries which will preserve your test setup.
+The parent directory for both Lucene and Solr contains the base configuration
+file for the combined build. By default, you do not need to change any of
+the settings in this file, but you do need to run Gradle from this location so
+it knows where to find the necessary configurations.
-If you want to build the documentation, type `./gradlew -p solr documentation`.
+### Step 4) Run Gradle
-## Running Solr
+Assuming you can exectue "./gradlew help" should show you the main tasks that
+can be executed to show help sub-topics.
-After [building Solr](#building-lucene-solr), the server can be started using
-the `bin/solr` control scripts. Solr can be run in either standalone or
-distributed (SolrCloud mode).
+If you want to build Lucene, type:
-To run Solr in standalone mode, run the following command from the `solr/`
-directory:
+```
+./gradlew assemble
+```
+
+NOTE: DO NOT use `gradle` command that is already installed on your machine (unless you know what you'll do).
+The "gradle wrapper" (gradlew) does the job - downloads the correct version of it, setups necessary configurations.
+
+The first time you run Gradle, it will create a file "gradle.properties" that
+contains machine-specific settings. Normally you can use this file as-is, but it
+can be modified if necessary.
-`bin/solr start`
+`./gradlew check` will assemble Lucene/Solr and run all validation
Review comment:
remove solr
----------------------------------------------------------------
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