Skip to content

Commit f03602f

Browse files
authored
Merge pull request #8877 from kenjis/docs-config-caching-add-notes
docs: add notes for Config Caching
2 parents 6cb01b1 + c6c370d commit f03602f

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

user_guide_src/source/concepts/factories.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,10 @@ Config Caching
270270

271271
.. versionadded:: 4.4.0
272272

273+
.. important:: Do not use this feature unless you have carefully read this section
274+
and understand how this feature works. Otherwise, your application will not
275+
function properly.
276+
273277
To improve performance, Config Caching has been implemented.
274278

275279
Prerequisite
@@ -287,6 +291,9 @@ Prerequisite
287291
How It Works
288292
============
289293

294+
.. important:: Once cached, configuration values are never changed until the cache
295+
is deleted, even if the configuration file or **.env** is changed.
296+
290297
- Save the all Config instances in Factories into a cache file before shutdown,
291298
if the state of the Config instances in Factories changes.
292299
- Restore cached Config instances before CodeIgniter initialization if a cache

user_guide_src/source/installation/deployment.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ See :ref:`modules-specify-composer-packages`.
5656
Config Caching
5757
==============
5858

59+
.. important:: Once cached, configuration values are never changed until the cache
60+
is deleted, even if the configuration file or **.env** is changed.
61+
5962
Caching the Config objects can improve performance. However, the cache must be
6063
manually deleted when changing Config values.
6164

0 commit comments

Comments
 (0)