gopls/doc: update manual documentation of the newDiff setting

Because we normally suppress internal options, the documentation for
this setting is managed manually, and was stale. Update it, and bring it
in-line with the actual setting docstring.

Change-Id: Id3ceaa7303df4ee2a6bf07c54d087451169962cf
Reviewed-on: https://go-review.googlesource.com/c/tools/+/444539
Run-TryBot: Robert Findley <rfindley@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
gopls-CI: kokoro <noreply+kokoro@google.com>
Reviewed-by: Peter Weinberger <pjw@google.com>
This commit is contained in:
Robert Findley 2022-10-20 16:39:41 -04:00
parent f112c43328
commit 06041c93ef
2 changed files with 11 additions and 11 deletions

View File

@ -510,13 +510,14 @@ Default: `false`.
#### **newDiff** *string*
newDiff enables the new diff implementation. If this is "both",
for now both diffs will be run and statistics will be generateted in
a file in $TMPDIR. This is a risky setting; help in trying it
is appreciated. If it is "old" the old implementation is used,
and if it is "new", just the new implementation is used.
newDiff enables the new diff implementation. If this is "both", for now both
diffs will be run and statistics will be generated in a file in $TMPDIR. This
is a risky setting; help in trying it is appreciated. If it is "old" the old
implementation is used, and if it is "new", just the new implementation is
used. This setting will eventually be deleted, once gopls has fully migrated to
the new diff algorithm.
Default: 'old'.
Default: 'both'.
## Code Lenses

View File

@ -613,11 +613,10 @@ type InternalOptions struct {
// This option applies only during initialization.
ShowBugReports bool
// NewDiff controls the choice of the new diff implementation.
// It can be 'new', 'checked', or 'old' which is the default.
// 'checked' computes diffs with both algorithms, checks
// that the new algorithm has worked, and write some summary
// statistics to a file in os.TmpDir()
// NewDiff controls the choice of the new diff implementation. It can be
// 'new', 'old', or 'both', which is the default. 'both' computes diffs with
// both algorithms, checks that the new algorithm has worked, and write some
// summary statistics to a file in os.TmpDir().
NewDiff string
// ChattyDiagnostics controls whether to report file diagnostics for each