Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

LUCENE-9475: Enhance the Gradle build as necessary after removing Ant support, some minor text changes to solr/README.md and help.gradle

Erick Erickson8c5ce090dd08
diff --git a/gradle/help.gradle b/gradle/help.gradle
index 51435e130dd..e03d7246a08 100644
--- a/gradle/help.gradle
+++ b/gradle/help.gradle
@@ -46,10 +46,13 @@ configure(rootProject) {
println ""
println "This is an experimental Lucene/Solr gradle build. See some"
println "guidelines, ant-equivalent commands etc. under help/*; or type:"
+ println ""
helpFiles.each { section, path, sectionInfo ->
println String.format(Locale.ROOT,
" gradlew :help%-16s # %s", section, sectionInfo)
}
+ println ""
+ println "For the impatient, build the project with 'gradlew assemble' or 'gradlew dev' "
}
}
diff --git a/solr/README.md b/solr/README.md
index fd775e1c91e..2401e2ba6ea 100644
--- a/solr/README.md
+++ b/solr/README.md
@@ -29,7 +29,9 @@ https://lucene.apache.org/solr
Getting Started
---------------
-To start Solr for the first time after installation, simply do:
+All the following commands are entered from the "solr" directory which should be just below the install directory
+
+To start Solr for the first time after installation, simply enter:
```
bin/solr start
@@ -38,20 +40,20 @@ To start Solr for the first time after installation, simply do:
This will launch a standalone Solr server in the background of your shell,
listening on port 8983. Alternatively, you can launch Solr in "cloud" mode,
which allows you to scale out using sharding and replication. To launch Solr
-in cloud mode, do:
+in cloud mode, enter:
```
bin/solr start -cloud
```
-To see all available options for starting Solr, please do:
+To see all available options for starting Solr, please enter:
```
bin/solr start -help
```
After starting Solr, create either a core or collection depending on whether
-Solr is running in standalone (core) or SolrCloud mode (collection) by doing:
+Solr is running in standalone (core) or SolrCloud mode (collection) by entering:
```
bin/solr create -c <name>
@@ -59,7 +61,7 @@ Solr is running in standalone (core) or SolrCloud mode (collection) by doing:
This will create a collection that uses a data-driven schema which tries to guess
the correct field type when you add documents to the index. To see all available
-options for creating a new collection, execute:
+options for creating a new collection, enter:
```
bin/solr create -help
@@ -84,7 +86,7 @@ where more than one Solr is running on the machine.
Solr Examples
---------------
-Solr includes a few examples to help you get started. To run a specific example, do:
+Solr includes a few examples to help you get started. To run a specific example, enter:
```
bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
@@ -94,7 +96,7 @@ Solr includes a few examples to help you get started. To run a specific example,
techproducts : Kitchen sink example providing comprehensive examples of Solr features
```
-For instance, if you want to run the SolrCloud example, do:
+For instance, if you want to run the SolrCloud example, enter:
```
bin/solr -e cloud
@@ -175,8 +177,15 @@ Instructions for Building Apache Solr from Source
cd to "./solr/packaging/build/solr-9.0.0-SNAPSHOT" and run the bin/solr script
to start Solr.
- NOTE: `gradlew` is the "Gradle Wrapper" and will automaticaly download and
+ NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
start using the correct version of Gradle.
+
+ NOTE: `./gradlew help` will print a list of high-level tasks. There are also a
+ number of plain-text files in <source folder root>/help.
+
+ NOTE: This CWiki page describes getting/building/testing Solr
+ in more detail:
+ `https://cwiki.apache.org/confluence/display/solr/HowToContribute`
Export control
-------------------------------------------------