Skip to content

Commit e51b974

Browse files
committed
Update guide docs for the evented file watcher
Having it be an extra point at the bottom looks out of place. Additionally, it implies that the watcher will be used simply by adding the listen gem to the gemfile which is not true.
1 parent 0e3e0d1 commit e51b974

File tree

1 file changed

+15
-22
lines changed

1 file changed

+15
-22
lines changed

guides/source/configuring.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,21 @@ end
399399

400400
#### `config.file_watcher`
401401

402-
Is the class used to detect file updates in the file system when `config.reload_classes_only_on_change` is `true`. Rails ships with `ActiveSupport::FileUpdateChecker`, the default, and `ActiveSupport::EventedFileUpdateChecker` (this one depends on the [listen](https://github.com/guard/listen) gem). Custom classes must conform to the `ActiveSupport::FileUpdateChecker` API.
402+
Is the class used to detect file updates in the file system when `config.reload_classes_only_on_change` is `true`. Rails ships with `ActiveSupport::FileUpdateChecker`, the default, and `ActiveSupport::EventedFileUpdateChecker`. Custom classes must conform to the `ActiveSupport::FileUpdateChecker` API.
403+
404+
Using `ActiveSupport::EventedFileUpdateChecker` depends on the [listen](https://github.com/guard/listen) gem:
405+
406+
```ruby
407+
group :development do
408+
gem "listen", "~> 3.5"
409+
end
410+
```
411+
412+
On Linux and macOS no additional gems are needed, but some are required
413+
[for *BSD](https://github.com/guard/listen#on-bsd) and
414+
[for Windows](https://github.com/guard/listen#on-windows).
415+
416+
Note that [some setups are unsupported](https://github.com/guard/listen#issues--limitations).
403417

404418
#### `config.filter_parameters`
405419

@@ -4034,24 +4048,3 @@ Disallow: /
40344048
40354049
To block just specific pages, it's necessary to use a more complex syntax. Learn
40364050
it on the [official documentation](https://www.robotstxt.org/robotstxt.html).
4037-
4038-
Evented File System Monitor
4039-
---------------------------
4040-
4041-
If the [listen gem](https://github.com/guard/listen) is loaded Rails uses an
4042-
evented file system monitor to detect changes when reloading is enabled:
4043-
4044-
```ruby
4045-
group :development do
4046-
gem "listen", "~> 3.5"
4047-
end
4048-
```
4049-
4050-
Otherwise, in every request Rails walks the application tree to check if
4051-
anything has changed.
4052-
4053-
On Linux and macOS no additional gems are needed, but some are required
4054-
[for *BSD](https://github.com/guard/listen#on-bsd) and
4055-
[for Windows](https://github.com/guard/listen#on-windows).
4056-
4057-
Note that [some setups are unsupported](https://github.com/guard/listen#issues--limitations).

0 commit comments

Comments
 (0)