[tools] gopls/doc/release: include server side file watching in release note
1 view
Skip to first unread message
Hongxiang Jiang (Gerrit)
3:57 PM (7 hours ago) 3:57 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Hongxiang Jiang has uploaded the change for review![]( "Open in Gerrit")
Commit message
gopls/doc/release: include server side file watching in release note
For golang/go#67995
Change-Id: I07ba89eeb8d2e59b707b85cdd099548942e44e07
Change diff
diff --git a/gopls/doc/release/v0.22.0.md b/gopls/doc/release/v0.22.0.md
index ae20a84..2f01df7 100644
--- a/gopls/doc/release/v0.22.0.md
+++ b/gopls/doc/release/v0.22.0.md
@@ -119,3 +119,14 @@
The `yield` analyzer, which detects problems in iterators that fail to
stop once `yield()` returns false, has been rewritten as a non-sparse
Killdall-style monotone dataflow analysis, improving its precision.
+
+## Server-side file watching
+
+Gopls introduces an experimental server-side file watching mechanism to monitor file system events directly. This feature supplements standard LSP file change notifications in environments or editor clients where client-side events may be unreliable or dropped. Because server-side watching operates alongside the language client's notifications, gopls may receive duplicate events for a single file system change.
+
+This feature is configured via the internal setting `fileWatcher`, which supports three strategies:
+- `"off"` for default client-driven watching
+- `"poll"` for periodic directory scanning
+- `"fsnotify"` for OS-level event notifications
+
+Users should note that the `"fsnotify"` strategy requires system file descriptors to watch the workspace in macOS or all BSD systems; when used against large workspaces, this can lead to [exhaust file descriptors issue](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems).
Change information
Files:
- M gopls/doc/release/v0.22.0.md
Change size: S
Delta: 1 file changed, 11 insertions(+), 0 deletions(-)
Related details
Attention set is empty
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Alan Donovan (Gerrit)
4:18 PM (7 hours ago) 4:18 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Attention needed from Hongxiang Jiang
Alan Donovan voted and added 4 comments![]( "Open in Gerrit")
Votes added by Alan Donovan
| Code-Review | +2 |
4 comments
Patchset-level comments
File gopls/doc/release/v0.22.0.md
Line 125, Patchset 1 (Latest):
Gopls introduces an experimental server-side file watching mechanism to monitor file system events directly. This feature supplements standard LSP file change notifications in environments or editor clients where client-side events may be unreliable or dropped. Because server-side watching operates alongside the language client's notifications, gopls may receive duplicate events for a single file system change.Alan Donovan . unresolved
Delete? I'm not sure what the user is supposed to do with this information.
Line 128, Patchset 1 (Latest):
- `"off"` for default client-driven watchingAlan Donovan . unresolved
- `"off"` (default): the client is solely responsible for change notification;
Line 132, Patchset 1 (Latest):
Users should note that the `"fsnotify"` strategy requires system file descriptors to watch the workspace in macOS or all BSD systems; when used against large workspaces, this can lead to [exhaust file descriptors issue](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems).Alan Donovan . unresolved
I suggest being a little vague about the details, since one problem with fsnotify is that it is different on every platform, and we want to nudge people toward "poll". Perhaps combine the warning with the last bullet point, and give a little positive spin on poll:
- `"poll"`: the server periodically scans workspace directories, using optimizations similar to `git status`.
- `"fsnotify"`: the server uses kernel support for file-change notification. This strategy is system dependent and may need to open many directories to watch a large workspace, risking [file descriptor exhaustion](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems).
Related details
Attention is currently required from:
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
4:24 PM (7 hours ago) 4:24 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Attention needed from Hongxiang Jiang
Hongxiang Jiang uploaded new patchset![]( "Open in Gerrit")
Hongxiang Jiang uploaded patch set #2 to this change.
Related details
Attention is currently required from:
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
4:24 PM (7 hours ago) 4:24 PM
to goph...@pubsubhelper.golang.org, Alan Donovan, golang-co...@googlegroups.com
Hongxiang Jiang voted and added 3 comments![]( "Open in Gerrit")
Votes added by Hongxiang Jiang
| Auto-Submit | +1 |
| Commit-Queue | +1 |
3 comments
File gopls/doc/release/v0.22.0.md
Line 125, Patchset 1:
Gopls introduces an experimental server-side file watching mechanism to monitor file system events directly. This feature supplements standard LSP file change notifications in environments or editor clients where client-side events may be unreliable or dropped. Because server-side watching operates alongside the language client's notifications, gopls may receive duplicate events for a single file system change.Alan Donovan . resolved
Delete? I'm not sure what the user is supposed to do with this information.
Hongxiang Jiang
Done
- `"off"` (default): the client is solely responsible for change notification;
Hongxiang Jiang
Done
Line 132, Patchset 1:
Users should note that the `"fsnotify"` strategy requires system file descriptors to watch the workspace in macOS or all BSD systems; when used against large workspaces, this can lead to [exhaust file descriptors issue](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems).Alan Donovan . resolved
I suggest being a little vague about the details, since one problem with fsnotify is that it is different on every platform, and we want to nudge people toward "poll". Perhaps combine the warning with the last bullet point, and give a little positive spin on poll:
- `"poll"`: the server periodically scans workspace directories, using optimizations similar to `git status`.
- `"fsnotify"`: the server uses kernel support for file-change notification. This strategy is system dependent and may need to open many directories to watch a large workspace, risking [file descriptor exhaustion](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems).
Hongxiang Jiang
Done
Related details
Attention set is empty
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Gopher Robot (Gerrit)
4:51 PM (6 hours ago) 4:51 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, golang-...@googlegroups.com, golang...@luci-project-accounts.iam.gserviceaccount.com, Alan Donovan, golang-co...@googlegroups.com
Gopher Robot submitted the change with unreviewed changes![]( "Open in Gerrit")
Unreviewed changes
1 is the latest approved patch-set.
The change was submitted with unreviewed changes in the following files:
```
The name of the file: gopls/doc/release/v0.22.0.md
Insertions: 4, Deletions: 6.
@@ -122,11 +122,9 @@
## Server-side file watching
-Gopls introduces an experimental server-side file watching mechanism to monitor file system events directly. This feature supplements standard LSP file change notifications in environments or editor clients where client-side events may be unreliable or dropped. Because server-side watching operates alongside the language client's notifications, gopls may receive duplicate events for a single file system change.
+Gopls introduces an experimental server-side file watching mechanism to monitor file system events directly. This feature supplements standard LSP file change notifications in environments or editor clients where client-side events may be unreliable or dropped.
This feature is configured via the internal setting `fileWatcher`, which supports three strategies:
-- `"off"` for default client-driven watching
-- `"poll"` for periodic directory scanning
-- `"fsnotify"` for OS-level event notifications
-
-Users should note that the `"fsnotify"` strategy requires system file descriptors to watch the workspace in macOS or all BSD systems; when used against large workspaces, this can lead to [exhaust file descriptors issue](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems).
+- `"off"` (default): the client is solely responsible for change notification
+- `"poll"`: the server periodically scans workspace directories, using optimizations similar to `git status`
+- `"fsnotify"`: the server uses kernel support for file-change notification. This strategy is system dependent and may need to open many directories to watch a large workspace, risking [file descriptor exhaustion](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems)
```
Change information
Commit message:
gopls/doc/release: include server side file watching in release note
For golang/go#67995
Change-Id: I07ba89eeb8d2e59b707b85cdd099548942e44e07
Reviewed-on: https://go-review.googlesource.com/c/tools/+/776881
Reviewed-by: Alan Donovan <adon...@google.com>
Auto-Submit: Hongxiang Jiang <hxj...@golang.org>
LUCI-TryBot-Result: golang...@luci-project-accounts.iam.gserviceaccount.com <golang...@luci-project-accounts.iam.gserviceaccount.com>
Files:
- M gopls/doc/release/v0.22.0.md
Change size: XS
Delta: 1 file changed, 9 insertions(+), 0 deletions(-)
Branch: refs/heads/master
Submit Requirements:
Code-Review: +2 by Alan Donovan
TryBots-Pass: LUCI-TryBot-Result+1 by golang...@luci-project-accounts.iam.gserviceaccount.com
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
4:58 PM (6 hours ago) 4:58 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Hongxiang Jiang has uploaded the change for review![]( "Open in Gerrit")
Commit message
gopls/doc/release: include server side file watching in release note
For golang/go#67995
Change-Id: I07ba89eeb8d2e59b707b85cdd099548942e44e07
Reviewed-on: https://go-review.googlesource.com/c/tools/+/776881
Reviewed-by: Alan Donovan <adon...@google.com>
Auto-Submit: Hongxiang Jiang <hxj...@golang.org>
LUCI-TryBot-Result: golang...@luci-project-accounts.iam.gserviceaccount.com <golang...@luci-project-accounts.iam.gserviceaccount.com>
(cherry picked from commit 29eabca57a7e91c06363a011be01b5fa18d795fa)
Change diff
diff --git a/gopls/doc/release/v0.22.0.md b/gopls/doc/release/v0.22.0.md
index de90949..2184ef3 100644
--- a/gopls/doc/release/v0.22.0.md
+++ b/gopls/doc/release/v0.22.0.md
@@ -122,3 +122,12 @@
The `yield` analyzer, which detects problems in iterators that fail to
stop once `yield()` returns false, has been rewritten as a non-sparse
Killdall-style monotone dataflow analysis, improving its precision.
+
+## Server-side file watching
+
+Gopls introduces an experimental server-side file watching mechanism to monitor file system events directly. This feature supplements standard LSP file change notifications in environments or editor clients where client-side events may be unreliable or dropped.
+
+This feature is configured via the internal setting `fileWatcher`, which supports three strategies:
+- `"off"` (default): the client is solely responsible for change notification
+- `"poll"`: the server periodically scans workspace directories, using optimizations similar to `git status`
+- `"fsnotify"`: the server uses kernel support for file-change notification. This strategy is system dependent and may need to open many directories to watch a large workspace, risking [file descriptor exhaustion](https://github.com/fsnotify/fsnotify#kqueue-macos-all-bsd-systems)
Change information
Files:
- M gopls/doc/release/v0.22.0.md
Change size: XS
Delta: 1 file changed, 9 insertions(+), 0 deletions(-)
Related details
Attention set is empty
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
5:00 PM (6 hours ago) 5:00 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Hongxiang Jiang uploaded new patchset![]( "Open in Gerrit")
Hongxiang Jiang uploaded patch set #2 to this change.
Related details
Attention set is empty
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
5:01 PM (6 hours ago) 5:01 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Hongxiang Jiang voted![]( "Open in Gerrit")
| Auto-Submit | +1 |
| Commit-Queue | +1 |
Related details
Attention set is empty
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Madeline Kalil (Gerrit)
5:02 PM (6 hours ago) 5:02 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, Alan Donovan, golang...@luci-project-accounts.iam.gserviceaccount.com, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Hongxiang Jiang
Madeline Kalil voted Code-Review+2![]( "Open in Gerrit")
| Code-Review | +2 |
Related details
Attention is currently required from:
- Alan Donovan
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Madeline Kalil (Gerrit)
5:04 PM (6 hours ago) 5:04 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, Alan Donovan, golang...@luci-project-accounts.iam.gserviceaccount.com, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Hongxiang Jiang
Madeline Kalil voted Code-Review+0![]( "Open in Gerrit")
| Code-Review | +0 |
Related details
Attention is currently required from:
- Alan Donovan
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Madeline Kalil (Gerrit)
5:05 PM (6 hours ago) 5:05 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, Alan Donovan, golang...@luci-project-accounts.iam.gserviceaccount.com, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Hongxiang Jiang
Madeline Kalil added 1 comment![]( "Open in Gerrit")
Patchset-level comments
File-level comment, Patchset 2 (Latest):
Madeline Kalil . unresolved
put [gopls-release-branch.0.22] in the commit message header before "gopls/doc/release"
Related details
Attention is currently required from:
- Alan Donovan
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
5:06 PM (6 hours ago) 5:06 PM
to goph...@pubsubhelper.golang.org, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Hongxiang Jiang
Hongxiang Jiang uploaded new patchset![]( "Open in Gerrit")
Hongxiang Jiang uploaded patch set #3 to this change.
Related details
Attention is currently required from:
- Alan Donovan
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
5:06 PM (6 hours ago) 5:06 PM
to goph...@pubsubhelper.golang.org, Madeline Kalil, Alan Donovan, golang...@luci-project-accounts.iam.gserviceaccount.com, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Madeline Kalil
Hongxiang Jiang voted and added 1 comment![]( "Open in Gerrit")
Votes added by Hongxiang Jiang
| Commit-Queue | +1 |
put [gopls-release-branch.0.22] in the commit message header before "gopls/doc/release"
Attention is currently required from:
- Alan Donovan
- Madeline Kalil
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
5:06 PM (6 hours ago) 5:06 PM
to goph...@pubsubhelper.golang.org, golang...@luci-project-accounts.iam.gserviceaccount.com, Madeline Kalil, Alan Donovan, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Madeline Kalil
Hongxiang Jiang voted Auto-Submit+1![]( "Open in Gerrit")
| Auto-Submit | +1 |
Related details
Attention is currently required from:
- Alan Donovan
- Madeline Kalil
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Madeline Kalil (Gerrit)
5:06 PM (6 hours ago) 5:06 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, golang...@luci-project-accounts.iam.gserviceaccount.com, Alan Donovan, golang-co...@googlegroups.com
Attention needed from Alan Donovan
Madeline Kalil voted Code-Review+2![]( "Open in Gerrit")
| Code-Review | +2 |
Related details
Attention is currently required from:
- Alan Donovan
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Madeline Kalil (Gerrit)
5:17 PM (6 hours ago) 5:17 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, golang...@luci-project-accounts.iam.gserviceaccount.com, Alan Donovan, golang-co...@googlegroups.com
Attention needed from Alan Donovan
Madeline Kalil voted Code-Review+0![]( "Open in Gerrit")
| Code-Review | +0 |
Related details
Attention is currently required from:
- Alan Donovan
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Madeline Kalil (Gerrit)
5:17 PM (6 hours ago) 5:17 PM
to Hongxiang Jiang, goph...@pubsubhelper.golang.org, golang...@luci-project-accounts.iam.gserviceaccount.com, Alan Donovan, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Hongxiang Jiang
Madeline Kalil added 1 comment![]( "Open in Gerrit")
File gopls/go.mod
Line 39, Patchset 3 (Latest):
replace golang.org/x/tools => ../Madeline Kalil . unresolved
Did you mean to modify this file?
Related details
Attention is currently required from:
- Alan Donovan
- Hongxiang Jiang
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Hongxiang Jiang (Gerrit)
6:22 PM (5 hours ago) 6:22 PM
to goph...@pubsubhelper.golang.org, Madeline Kalil, golang...@luci-project-accounts.iam.gserviceaccount.com, Alan Donovan, golang-co...@googlegroups.com
Attention needed from Alan Donovan and Madeline Kalil
Hongxiang Jiang voted and added 1 comment![]( "Open in Gerrit")
Votes added by Hongxiang Jiang
| Commit-Queue | +1 |
1 comment
File gopls/go.mod
Line 39, Patchset 3 (Latest):
replace golang.org/x/tools => ../Madeline Kalil . resolved
Did you mean to modify this file?
Hongxiang Jiang
It was intentional, but not necessary. This replace directive will be removed later when we release the pre.4 by the gopherbot like CL 776761.
Related details
Attention is currently required from:
- Alan Donovan
- Madeline Kalil
Submit Requirements:
Code-Review
No-Unresolved-Comments
Review-Enforcement
TryBots-Pass
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Reply all
Reply to author
Forward
0 new messages