8000 Improve doc · symfony/symfony-docs@c4f0e38 · GitHub
[go: up one dir, main page]

Skip to content

Commit c4f0e38

Browse files
geoffrey-brierxabbuh
authored andcommitted
Improve doc
1 parent 9b0e46e commit c4f0e38

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

components/cache/cache_pools.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
single: Redis Cache
66
single: PDO Cache, Doctrine DBAL Cache
77

8+
.. _component-cache-cache-pools:
9+
810
Cache Pools
911
===========
1012

reference/configuration/framework.rst

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1591,6 +1591,12 @@ app
15911591

15921592
The cache adapter used by the ``cache.app`` service.
15931593

1594+
.. tip::
1595+
1596+
It might be tough to understand at the beginning, so to avoid confusion remember that all pools perform the
1597+
same actions but on different medium given the adapter they are based on. Internally, a pool wraps the definition
1598+
of an adapter.
1599+
15941600
.. note::
15951601

15961602
The framework bundle ships with multiple adapters: apcu, doctrine, system,
@@ -1639,6 +1645,10 @@ pools
16391645

16401646
A list of cache pools to be created by the framework extension.
16411647

1648+
.. seealso::
1649+
1650+
For more information about how pools works, see :ref:`cache pools <component-cache-cache-pools>`.
1651+
16421652
.. _reference-cache-pools-name:
16431653

16441654
name
@@ -1657,7 +1667,11 @@ adapter
16571667

16581668
**type**: ``string`` **default**: ``cache.app``
16591669

1660-
A cache adapter.
1670+
The name of the adapter to use. You could also use your own implementation.
1671+
1672+
.. note::
1673+
1674+
Your service MUST implement the :class:`Psr\\Cache\\CacheItemPoolInterface` interface.
16611675

16621676
public
16631677
######
@@ -1689,7 +1703,7 @@ The cache clearer used to clear your PSR-6 cache.
16891703

16901704
.. seealso::
16911705

1692-
For more information, see :class:`Symfony\\Component\\HttpKernel\\CacheClearer\\Psr6CacheClearer`
1706+
For more information, see :class:`Symfony\\Component\\HttpKernel\\CacheClearer\\Psr6CacheClearer`.
16931707

16941708
prefix_seed
16951709
...........

0 commit comments

Comments
 (0)
0