Add notes about .NET roll-forward strategy to cli docs

apache · Mar 28, 2024 · 72a7ab0 · 72a7ab0
1 parent 0d2c711
commit 72a7ab0
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/src/dotnet/tools/lucene-cli/docs/index.md b/src/dotnet/tools/lucene-cli/docs/index.md
@@ -4,7 +4,7 @@ The Lucene.NET command line interface (CLI) is a new cross-platform toolchain wi
 
 ## Prerequisites
 
-- [.NET 6.0 Runtime or Higher](https://dotnet.microsoft.com/en-us/download/dotnet)
+- [.NET 6.0 Runtime or Higher](https://dotnet.microsoft.com/en-us/download/dotnet) (.NET 8.0 recommended)
 
 ## Installation
 
@@ -19,6 +19,14 @@ dotnet tool install lucene-cli -g --version 4.8.0-beta00016
 
 You may then use the lucene-cli tool to analyze and update Lucene.NET indexes and use its demos.
 
+The CLI is configured to [roll-forward](https://learn.microsoft.com/en-us/dotnet/core/versions/selection#control-roll-forward-behavior)
+to the next available major version of .NET installed on your machine, if only a newer one than .NET 8 is found.
+You can control this behavior by setting the `DOTNET_ROLL_FORWARD` environment variable or `--roll-forward`
+command-line argument to `Disable` to prevent rolling forward, or `LatestMajor` to always use the latest
+available major version, before running the CLI tool.
+
+
+
 ## CLI Commands
 
 The following commands are installed: