You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2021/02/09 15:22:38 UTC
[lucenenet] branch master updated: README.md/lucene-cli docs: Added
note about matching the version number of the CLI to Lucene.NET
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/master by this push:
new 1ff46c0 README.md/lucene-cli docs: Added note about matching the version number of the CLI to Lucene.NET
1ff46c0 is described below
commit 1ff46c0f45803b16a0ee48b5e3a96f6bef59d597
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Tue Feb 9 22:22:12 2021 +0700
README.md/lucene-cli docs: Added note about matching the version number of the CLI to Lucene.NET
---
README.md | 2 ++
src/dotnet/tools/lucene-cli/docs/index.md | 10 ++++++----
2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 0e4902f..b3d8fa0 100644
--- a/README.md
+++ b/README.md
@@ -120,6 +120,8 @@ There is also a dotnet command line tool available on NuGet. It contains all of
dotnet tool install lucene-cli -g --version 4.8.0-beta00012
```
+> NOTE: The version of the CLI you install should match the version of Lucene.NET you use.
+
Once installed, you can explore the commands and options that are available by entering the command `lucene`.
[lucene-cli Documentation](https://github.com/apache/lucenenet/blob/master/src/dotnet/tools/lucene-cli/docs/index.md)
diff --git a/src/dotnet/tools/lucene-cli/docs/index.md b/src/dotnet/tools/lucene-cli/docs/index.md
index 303f5d7..66f4071 100644
--- a/src/dotnet/tools/lucene-cli/docs/index.md
+++ b/src/dotnet/tools/lucene-cli/docs/index.md
@@ -1,6 +1,6 @@
-# Lucene.Net command line interface (CLI) tools
+# Lucene.NET command line interface (CLI) tools
-The Lucene.Net command line interface (CLI) is a new cross-platform toolchain with utilities for maintaining Lucene.Net and demos for learning basic Lucene.Net functionality.
+The Lucene.NET command line interface (CLI) is a new cross-platform toolchain with utilities for maintaining Lucene.NET and demos for learning basic Lucene.NET functionality.
## Prerequisites
@@ -14,7 +14,9 @@ Perform a one-time install of the lucene-cli tool using the following dotnet CLI
dotnet tool install lucene-cli -g --version [EnvVar:LuceneNetVersion]
```
-You may then use the lucene-cli tool to analyze and update Lucene.Net indexes and use its demos.
+> NOTE: The version of the CLI you install should match the version of Lucene.NET you use.
+
+You may then use the lucene-cli tool to analyze and update Lucene.NET indexes and use its demos.
## CLI Commands
@@ -27,7 +29,7 @@ The following commands are installed:
## Command structure
-CLI command structure consists of the driver ("lucene"), the command, and possibly command arguments and options. You see this pattern in most CLI operations, such as checking a Lucene.Net index for problematic segments and fixing (removing) them:
+CLI command structure consists of the driver ("lucene"), the command, and possibly command arguments and options. You see this pattern in most CLI operations, such as checking a Lucene.NET index for problematic segments and fixing (removing) them:
```
lucene index check C:\my-index --verbose