Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleanup readme file, doaps and copy build instructions from lucene subfolder (#6)

This commit is contained in:
Uwe Schindler 2021-03-10 16:10:06 +01:00 committed by GitHub
parent ee4871f24a
commit 5ade66059f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 70 additions and 1042 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,19 +1,17 @@
<!--
_(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:
Before creating a pull request, please file an issue in the ASF Jira system for Lucene:
* 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.
LUCENE 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. -->
@ -34,10 +32,9 @@ Please describe the tests you've developed or run to confirm this patch implemen
Please review the following and check all that apply:
- [ ] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [ ] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/lucene/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [ ] I have created a Jira issue and added the issue ID to my pull request title.
- [ ] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [ ] I have developed this patch against the `master` branch.
- [ ] I have given Lucene maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [ ] I have developed this patch against the `main` branch.
- [ ] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
- [ ] I have added documentation for the [Ref Guide](https://github.com/apache/lucene-solr/tree/master/solr/solr-ref-guide) (for Solr changes only).

2
.github/workflows/hunspell.yml vendored
View File

@ -3,7 +3,7 @@ name: Hunspell regression tests
on:
pull_request:
branches:
- 'master'
- 'main'
paths:
- '.github/workflows/hunspell.yml'
- 'lucene/analysis/common/**'

124
README.md
View File

@ -20,7 +20,7 @@
Apache Lucene is a high-performance, full featured text search engine library
written in Java.
[![Build Status](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-master/badge/icon?subject=Lucene)](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-master/) [![Build Status](https://ci-builds.apache.org/job/Lucene/job/Solr-Artifacts-master/badge/icon?subject=Solr)](https://ci-builds.apache.org/job/Lucene/job/Solr-Artifacts-master/)
[![Build Status](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-master/badge/icon?subject=Lucene)](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-master/)
## Online Documentation
@ -31,25 +31,58 @@ comprehensive documentation, visit:
## Building with Gradle
### Building Lucene
### Basic steps:
0. Install OpenJDK 11 (or greater)
1. Download Lucene from Apache and unpack it
2. Connect to the top-level of your installation (parent of the lucene top-level directory)
3. 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: Lucene changed from Ant to Gradle as of release 9.0. Prior releases
still use Ant.
`./gradlew assemble`
### Step 1) Checkout/Download Lucene source code
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:
https://lucene.apache.org/core/downloads.html
Download either a zip or a tarred/gzipped version of the archive, and
uncompress it into a directory of your choice.
### Step 2) Change directory (cd) into the top-level directory of the source tree
The parent directory for Lucene contains the base configuration file for the 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.
### Step 3) Run Gradle
Assuming you can exectue "./gradlew help" should show you the main tasks that
can be executed to show help sub-topics.
If you want to build Lucene, type:
```
./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.
@ -58,42 +91,18 @@ 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.
The command above packages a full distribution of Solr server; the
package can be located at:
`./gradlew check` will assemble Lucene and run all validation
tasks unit tests.
`solr/packaging/build/solr-*`
`./gradlew help` will print a list of help commands for high-level tasks. One
of these is `helpAnt` that shows the gradle tasks corresponding to ant
targets you may be familiar with.
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.
If you want to build the documentation, type:
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.
If you want to build the documentation, type `./gradlew -p solr documentation`.
## Running Solr
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).
To run Solr in standalone mode, run the following command from the `solr/`
directory:
`bin/solr start`
To run Solr in SolrCloud mode, run the following command from the `solr/`
directory:
`bin/solr start -c`
The `bin/solr` control script allows heavy modification of the started Solr.
Common options are described in some detail in solr/README.txt. For an
exhaustive treatment of options, run `bin/solr start -h` from the `solr/`
directory.
```
./gradlew documentation
```
### Gradle build and IDE support
@ -102,28 +111,15 @@ directory.
- *Eclipse* - Not tested.
- *Netbeans* - Not tested.
### Gradle build and tests
`./gradlew assemble` will build a runnable Solr as noted above.
`./gradlew check` will assemble Lucene/Solr and run all validation
tasks unit tests.
`./gradlew help` will print a list of help commands for high-level tasks. One
of these is `helpAnt` that shows the gradle tasks corresponding to ant
targets you may be familiar with.
## Contributing
Please review the [Contributing to Solr
Guide](https://cwiki.apache.org/confluence/display/solr/HowToContribute) for information on
Please review the [Contributing to Lucene
Guide](https://cwiki.apache.org/confluence/display/lucene/HowToContribute) for information on
contributing.
## Discussion and Support
- [Users Mailing List](http://lucene.apache.org/solr/community.html#solr-user-list-solr-userluceneapacheorg)
- [Developers Mailing List](http://lucene.apache.org/solr/community.html#developer-list-devluceneapacheorg)
- [Lucene Issue Tracker](https://issues.apache.org/jira/browse/LUCENE)
- [Solr Issue Tracker](https://issues.apache.org/jira/browse/SOLR)
- IRC: `#solr` and `#solr-dev` on freenode.net
- [Users Mailing List](https://lucene.apache.org/core/discussion.html#java-user-list-java-userluceneapacheorg)
- [Developers Mailing List](https://lucene.apache.org/core/discussion.html#developer-lists)
- [Issue Tracker](https://issues.apache.org/jira/browse/LUCENE)
- IRC: `#lucene` and `#lucene-dev` on freenode.net

6
dev-tools/doap/README.txt
View File

@ -1,8 +1,8 @@
This folder contains the DOAP[1] files for each project.
This folder contains the DOAP[1] file, which is parsed and displayed at https://projects.apache.org/project.html?lucene
Upon release, these files should be updated to include new release details.
Upon release, this file should be updated to include new release details.
NOTE: If this folder's contents are moved elsewhere, the website .htaccess
file will need to be updated.
[1] DOAP: https://github.com/edumbill/doap
[1] DOAP: https://github.com/edumbill/doap

794
dev-tools/doap/solr.rdf
View File

@ -1,794 +0,0 @@
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<rdf:RDF xml:lang="en"
xmlns="http://usefulinc.com/ns/doap#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:asfext="http://projects.apache.org/ns/asfext#"
xmlns:foaf="http://xmlns.com/foaf/0.1/">
<!--
This file's canonical URL is: http://lucene.apache.org/solr/doap.rdf
Note that the canonical URL may redirect to other non-canonical locations.
-->
<Project rdf:about="http://lucene.apache.org/solr/">
<created>2006-01-17</created>
<license rdf:resource="http://www.apache.org/licenses/LICENSE-2.0"/>
<name>Apache Solr</name>
<homepage rdf:resource="http://solr.apache.org" />
<asfext:pmc rdf:resource="http://solr.apache.org" />
<shortdesc>Solr is a full-text search server</shortdesc>
<description>Solr is an open source enterprise search server based on the Lucene Java search library, with Rest-like JSON/HTTP APIs, high performance, high availability, powerful analytics, hit highlighting, faceted search, caching, replication, and a web administration interface.
</description>
<bug-database rdf:resource="http://issues.apache.org/jira/browse/SOLR" />
<mailing-list rdf:resource="https://solr.apache.org/community.html#mailing-lists-chat" />
<download-page rdf:resource="https://solr.apache.org/downloads.html" />
<programming-language>Java</programming-language>
<!--
The ASF has a finite set of categories projects should use,
but the list does grow occasionally, and we should keep an eye
on it and adjust which ones we list as appropriate.
-->
<category rdf:resource="http://projects.apache.org/category/web-framework" />
<category rdf:resource="http://projects.apache.org/category/network-server" />
<category rdf:resource="http://projects.apache.org/category/search" />
<category rdf:resource="http://projects.apache.org/category/java" />
<wiki rdf:resource="https://cwiki.apache.org/confluence/display/SOLR/"/>
<repository>
<GitRepository>
<location rdf:resource="https://gitbox.apache.org/repos/asf?p=solr.git"/>
</GitRepository>
</repository>
<maintainer>
<foaf:Person>
<foaf:name>Apache Solr Team</foaf:name>
<foaf:mbox rdf:resource="mailto:dev@solr.apache.org"/>
</foaf:Person>
</maintainer>
<!-- NOTE: please insert releases in numeric order, NOT chronologically. -->
<release>
<Version>
<name>solr-8.8.1</name>
<created>2021-02-22</created>
<revision>8.8.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.8.0</name>
<created>2021-02-01</created>
<revision>8.8.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.7.0</name>
<created>2020-11-03</created>
<revision>8.7.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.6.3</name>
<created>2020-10-07</created>
<revision>8.6.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.6.2</name>
<created>2020-09-01</created>
<revision>8.6.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.6.1</name>
<created>2020-08-13</created>
<revision>8.6.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.6.0</name>
<created>2020-07-15</created>
<revision>8.6.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.5.2</name>
<created>2020-05-26</created>
<revision>8.5.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.5.1</name>
<created>2020-04-16</created>
<revision>8.5.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.5.0</name>
<created>2020-03-24</created>
<revision>8.5.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.4.1</name>
<created>2020-01-13</created>
<revision>8.4.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.4.0</name>
<created>2019-12-29</created>
<revision>8.4.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.3.1</name>
<created>2019-12-03</created>
<revision>8.3.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.3.0</name>
<created>2019-11-02</created>
<revision>8.3.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.2.0</name>
<created>2019-07-26</created>
<revision>8.2.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.1.1</name>
<created>2019-05-28</created>
<revision>8.1.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.1.0</name>
<created>2019-05-16</created>
<revision>8.1.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-8.0.0</name>
<created>2019-03-14</created>
<revision>8.0.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.7.3</name>
<created>2020-04-28</created>
<revision>7.7.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.7.2</name>
<created>2019-06-04</created>
<revision>7.7.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.7.1</name>
<created>2019-03-01</created>
<revision>7.7.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.7.0</name>
<created>2019-02-11</created>
<revision>7.7.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.6.0</name>
<created>2018-12-14</created>
<revision>7.6.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.5.0</name>
<created>2018-09-24</created>
<revision>7.5.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.4.0</name>
<created>2018-06-27</created>
<revision>7.4.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.3.1</name>
<created>2018-05-15</created>
<revision>7.3.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.3.0</name>
<created>2018-04-04</created>
<revision>7.3.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.2.1</name>
<created>2018-01-15</created>
<revision>7.2.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.2.0</name>
<created>2017-12-21</created>
<revision>7.2.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.1.0</name>
<created>2017-10-17</created>
<revision>7.1.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.0.1</name>
<created>2017-10-06</created>
<revision>7.0.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-7.0.0</name>
<created>2017-09-20</created>
<revision>7.0.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.6</name>
<created>2018-04-05</created>
<revision>6.6.6</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.5</name>
<created>2018-06-03</created>
<revision>6.6.5</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.4</name>
<created>2018-05-18</created>
<revision>6.6.4</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.3</name>
<created>2018-03-07</created>
<revision>6.6.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.2</name>
<created>2017-10-18</created>
<revision>6.6.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.1</name>
<created>2017-09-07</created>
<revision>6.6.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.6.0</name>
<created>2017-06-06</created>
<revision>6.6.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.5.1</name>
<created>2017-04-27</created>
<revision>6.5.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.5.0</name>
<created>2017-03-27</created>
<revision>6.5.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.4.2</name>
<created>2017-03-07</created>
<revision>6.4.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.4.1</name>
<created>2017-02-06</created>
<revision>6.4.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.4.0</name>
<created>2017-01-23</created>
<revision>6.4.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.3.0</name>
<created>2016-11-08</created>
<revision>6.3.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.2.1</name>
<created>2016-09-20</created>
<revision>6.2.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.2.0</name>
<created>2016-08-25</created>
<revision>6.2.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.1.0</name>
<created>2016-06-17</created>
<revision>6.1.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.0.1</name>
<created>2016-05-28</created>
<revision>6.0.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-6.0.0</name>
<created>2016-04-08</created>
<revision>6.0.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.5.5</name>
<created>2017-10-24</created>
<revision>5.5.5</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.5.4</name>
<created>2017-02-15</created>
<revision>5.5.4</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.5.3</name>
<created>2016-09-09</created>
<revision>5.5.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.5.2</name>
<created>2016-06-25</created>
<revision>5.5.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.5.1</name>
<created>2016-05-05</created>
<revision>5.5.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.5.0</name>
<created>2016-02-22</created>
<revision>5.5.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.4.1</name>
<created>2016-01-23</created>
<revision>5.4.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.4.0</name>
<created>2015-12-14</created>
<revision>5.4.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.3.2</name>
<created>2016-01-23</created>
<revision>5.3.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.3.1</name>
<created>2015-09-24</created>
<revision>5.3.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.3.0</name>
<created>2015-08-21</created>
<revision>5.3.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.2.1</name>
<created>2015-06-15</created>
<revision>5.2.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.2.0</name>
<created>2015-06-07</created>
<revision>5.2.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.1.0</name>
<created>2015-04-14</created>
<revision>5.1.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-5.0.0</name>
<created>2015-02-20</created>
<revision>5.0.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.10.4</name>
<created>2015-03-03</created>
<revision>4.10.4</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.10.3</name>
<created>2014-12-29</created>
<revision>4.10.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.10.2</name>
<created>2014-10-31</created>
<revision>4.10.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.10.1</name>
<created>2014-09-29</created>
<revision>4.10.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.10.0</name>
<created>2014-09-03</created>
<revision>4.10.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.9.1</name>
<created>2014-09-22</created>
<revision>4.9.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.9.0</name>
<created>2014-06-25</created>
<revision>4.9.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.8.1</name>
<created>2014-05-20</created>
<revision>4.8.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.8.0</name>
<created>2014-04-28</created>
<revision>4.8.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.7.2</name>
<created>2014-04-15</created>
<revision>4.7.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.7.1</name>
<created>2014-02-26</created>
<revision>4.7.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.7.0</name>
<created>2014-02-26</created>
<revision>4.7.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.6.1</name>
<created>2014-01-28</created>
<revision>4.6.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.6.0</name>
<created>2013-11-22</created>
<revision>4.6.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.5.1</name>
<created>2013-10-24</created>
<revision>4.5.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.5</name>
<created>2013-10-05</created>
<revision>4.5</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.4</name>
<created>2013-07-23</created>
<revision>4.4</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.3.1</name>
<created>2013-06-18</created>
<revision>4.3.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.3</name>
<created>2013-05-06</created>
<revision>4.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.2.1</name>
<created>2013-04-03</created>
<revision>4.2.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.2</name>
<created>2013-03-11</created>
<revision>4.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.1</name>
<created>2013-01-22</created>
<revision>4.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.0</name>
<created>2012-10-12</created>
<revision>4.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.0-BETA</name>
<created>2012-08-13</created>
<revision>4.0-BETA</revision>
</Version>
</release>
<release>
<Version>
<name>solr-4.0-ALPHA</name>
<created>2012-07-03</created>
<revision>4.0-ALPHA</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.6.2</name>
<created>2012-12-25</created>
<revision>3.6.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.6.1</name>
<created>2012-07-22</created>
<revision>3.6.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.6</name>
<created>2012-04-12</created>
<revision>3.6</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.5</name>
<created>2011-11-11</created>
<revision>3.5</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.4</name>
<created>2011-09-15</created>
<revision>3.4</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.3</name>
<created>2011-07-10</created>
<revision>3.3</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.2</name>
<created>2011-06-03</created>
<revision>3.2</revision>
</Version>
</release>
<release>
<Version>
<name>solr-3.1</name>
<created>2011-03-31</created>
<revision>3.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-1.4.1</name>
<created>2010-6-25</created>
<revision>1.4.1</revision>
</Version>
</release>
<release>
<Version>
<name>solr-1.4.0</name>
<created>2009-11-10</created>
<revision>1.4.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-1.3.0</name>
<created>2008-09-16</created>
<revision>1.3.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-1.2.0</name>
<created>2007-06-06</created>
<revision>1.2.0</revision>
</Version>
</release>
<release>
<Version>
<name>solr-1.1.0</name>
<created>2006-12-22</created>
<revision>1.1.0</revision>
</Version>
</release>
</Project>
</rdf:RDF>

87
dev-tools/scripts/archive-solr-ref-guide.sh
View File

@ -1,87 +0,0 @@
#!/bin/bash
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
####
# Convenience script to generates the SVN command line for you to run in order to
# remove old (archived) versions of the solr ref guide from the dist repo, and
# (if necessary) clean up any old RC files.
#
# See: https://cwiki.apache.org/confluence/display/solr/Internal+-+How+To+Publish+This+Documentation
if [ $# -ne 1 ] ; then
echo "Usage: $0 <X.Y>"
echo ""
echo "Where X.Y is the version of the ref guide that has recently been"
echo "published, and all previous versions have already been archived"
echo ""
echo "Example: "
echo " $0 4.5"
exit 1
fi
VERSION="$1"
DIST_PREFIX="apache-solr-ref-guide-$VERSION."
DIST_DIR_URL="https://dist.apache.org/repos/dist/release/lucene/solr/ref-guide"
RC_DIR_URL="https://dist.apache.org/repos/dist/dev/lucene/solr/ref-guide"
RM_OLD_CMD="svn rm -m 'removing archived ref guide files prior to $VERSION' "
RM_RC_CMD="svn rm -m 'cleaning up old RCs now that $VERSION has been released' "
NEW_COUNT=0
OLD_COUNT=0
RC_COUNT=0
for FILE in `svn list $DIST_DIR_URL`; do
if [[ $FILE == $DIST_PREFIX* ]] ; then
NEW_COUNT=`expr $NEW_COUNT + 1`
continue # one of our just published files
fi
OLD_COUNT=`expr $OLD_COUNT + 1`
RM_OLD_CMD="$RM_OLD_CMD $DIST_DIR_URL/$FILE"
done
if [ $NEW_COUNT -eq 0 ] ; then
echo "FAIL: Unable to find any current (ie: $DIST_PREFIX*) release files in $DIST_DIR_URL"
exit -1;
fi
if [ $OLD_COUNT -eq 0 ] ; then
echo "FAIL: Unable to find any releases to clean up in $DIST_DIR_URL"
exit -1;
fi
for FILE in `svn list $RC_DIR_URL`; do
RC_COUNT=`expr $RC_COUNT + 1`
RM_RC_CMD="$RM_RC_CMD $RC_DIR_URL/$FILE"
done
echo "## Run the following commands when ready..."
echo "# Delete old releases"
echo $RM_OLD_CMD
if [ $RC_COUNT -eq 0 ] ; then
echo "# No old RC files to clean up"
else
echo "# Delete old RC files"
echo $RM_RC_CMD
fi

84
lucene/BUILD.md
View File

@ -1,84 +0,0 @@
# Lucene Build Instructions
## 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
## 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. Lucene runs with
Java 11 and later.
Lucene uses [Gradle](https://gradle.org/) for build control.
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
NOTE: Lucene changed from Ant to Gradle as of release 9.0. Prior releases
still use Ant.
## Step 1) Checkout/Download Lucene source code
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-solr
Or Lucene source archives at particlar releases are available as part of Solr downloads:
https://lucene.apache.org/solr/downloads.html
Download either a zip or a tarred/gzipped version of the archive, and
uncompress it into a directory of your choice.
## Step 2) Change directory (cd) into the top-level directory of the source tree
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.
## Step 4) Run Gradle
Assuming you can exectue "./gradlew help" should show you the main tasks that
can be executed to show help sub-topics.
If you want to build Lucene independent of Solr, type:
```
./gradlew -p lucene 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.
If you want to build the documentation, type:
```
./gradlew -p lucene documentation
```
For further information on Lucene, go to:
https://lucene.apache.org/
Please join the Lucene-User mailing list by visiting this site:
https://lucene.apache.org/core/discussion.html
Please post suggestions, questions, corrections or additions to this
document to the lucene-user mailing list.

2
settings.gradle
View File

@ -15,7 +15,7 @@
* limitations under the License.
*/
rootProject.name = "lucene-solr"
rootProject.name = "lucene-root"
includeBuild("dev-tools/missing-doclet")