Update Cache component doc for 4.2 #11477
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicolas-grekas
force-pushed
the
cache-contracts
branch
from
d16268c to
57c5910
Compare
nicolas-grekas
force-pushed
the
cache-contracts
branch
4 times, most recently
from
92a31ac to
c4d8431
Compare
nicolas-grekas
commented
Apr 24, 2019
cache.rst
Outdated
| Each pool will manage a set of independent cache keys: keys of different pools | ||
| never collide even if they share the same backend. This is achieved by prefixing | ||
| keys with a namespace. This namespace is generated by hashing the name of the | ||
| pool, the name of the compiled container class and a configurable seed that XXX HOWTO LINK TO reference/configuration/framework.rst#prefix_seed? XXX |
There was a problem hiding this comment.
RST expert needed :)
There was a problem hiding this comment.
Will take care of this tomorrow 👌🏻
There was a problem hiding this comment.
Add this to reference/configuration.framework.rst file:
+ .. _reference-cache-prefix-seed
prefix_seed
...........
**type**: ``string`` **default**: ``null``
If defined, this value is used as part of the "namespace" generated for the
cache item keys. A common practice is to use the unique name of the application
(e.g. ``symfony.com``) because that prevents naming collisions when deploying
multiple applications into the same path (on different servers) that share the
same cache backend.
It's also useful when using `blue/green deployment`_ strategies and more
generally, when you need to abstract out the actual deployment directory (for
example, when warming caches offline).
And link it like this:
Suggested change
| pool, the name of the compiled container class and a configurable seed that XXX HOWTO LINK TO reference/configuration/framework.rst#prefix_seed? XXX | |
| pool, the name of the compiled container class and a :ref:`configurable seed <reference-cache-prefix-seed>`. |
nicolas-grekas
force-pushed
the
cache-contracts
branch
from
c4d8431 to
808453a
Compare
|
Ok, I made some changes and hopefully added that link correctly ;). This is ready for review! |
nicolas-grekas
commented
Apr 25, 2019
|
Thank you Nicolas! |
weaverryan
added a commit
that referenced
this pull request
Apr 25, 2019
…averryan) This PR was merged into the 4.2 branch. Discussion ---------- Update Cache component doc for 4.2 From the plane to SymfonyLive Tunis :) Fixes #9851 Commits ------- 3209040 typo 4f7b9c4 Merge branch '4.2' into cache-contracts 50736c7 clarifying d413993 tweaks b2bb888 adding anchor 67243ff proofing cache chapter updates 808453a Update Cache component doc for 4.2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From the plane to SymfonyLive Tunis :)
Fixes #9851