Skip to content

Commit 4860942

Browse files
committed
Merge pull request rails#20736 from antoine-lizee/docs
[ci skip] docs: making clear that perform_caching has a limited impact
2 parents 0e8c045 + 89a55ed commit 4860942

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

actionpack/lib/action_controller/caching.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ module ActionController
88
#
99
# You can read more about each approach by clicking the modules below.
1010
#
11-
# Note: To turn off all caching, set
11+
# Note: To turn off all caching provided by Action Controller, set
1212
# config.action_controller.perform_caching = false
1313
#
1414
# == \Caching stores

guides/source/caching_with_rails.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ the relevant `config/environments/*.rb` file:
3131
config.action_controller.perform_caching = true
3232
```
3333

34+
NOTE: Changing the value of `config.action_controller.perform_caching` will
35+
only have an effect on the caching provided by the Action Controller component.
36+
For instance, it will not impact low-level caching, that we address
37+
[below](#low-level-caching).
38+
3439
### Page Caching
3540

3641
Page caching is a Rails mechanism which allows the request for a generated page

guides/source/configuring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ The schema dumper adds one additional configuration option:
326326

327327
* `config.action_controller.asset_host` sets the host for the assets. Useful when CDNs are used for hosting assets rather than the application server itself.
328328

329-
* `config.action_controller.perform_caching` configures whether the application should perform caching or not. Set to false in development mode, true in production.
329+
* `config.action_controller.perform_caching` configures whether the application should perform the caching features provided by the Action Controller component or not. Set to false in development mode, true in production.
330330

331331
* `config.action_controller.default_static_extension` configures the extension used for cached pages. Defaults to `.html`.
332332

0 commit comments

Comments
 (0)