|author||Uwe Schindler <firstname.lastname@example.org>||Fri May 05 12:04:38 2023 +0200|
|committer||Uwe Schindler <email@example.com>||Mon May 15 16:24:11 2023 +0200|
Fix MMapDirectory documentation for Java 20 (#12265)
Apache Lucene is a high-performance, full-featured text search engine library written in Java.
This README file only contains basic setup instructions. For more comprehensive documentation, visit:
We‘ll assume that you know how to get and set up the JDK - if you don’t, then we suggest starting at https://jdk.java.net/ and learning more about Java, before returning to this README. Lucene runs with Java 11 or later.
Lucene uses Gradle for build control. Gradle is itself Java-based and may be incompatible with newer Java versions; you can still build and test Lucene with these Java releases, see jvms.txt for more information.
NOTE: Lucene changed from Apache Ant to Gradle as of release 9.0. Prior releases still use Apache Ant.
You can clone the source code from GitHub:
or get Lucene source archives for a particular release from:
Download the source archive and uncompress it into a directory of your choice.
Run “./gradlew help”, this will show the main tasks that can be executed to show help sub-topics.
If you want to build Lucene, type:
NOTE: DO NOT use the
gradle command that is perhaps installed on your machine. This may result in using a different gradle version than the project requires and this is known to lead to very cryptic errors. The “gradle wrapper” (gradlew script) does everything required to build the project from scratch: it downloads the correct version of gradle, sets up sane local configurations and is tested on multiple environments.
The first time you run gradlew, 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.
./gradlew check will assemble Lucene and run all validation tasks (including tests).
./gradlew help will print a list of help guides that introduce and explain various parts of the build system, including typical workflow tasks.
If you want to just build the documentation, type:
Bug fixes, improvements and new features are always welcome! Please review the Contributing to Lucene Guide for information on contributing.