bug #3689 Fix cache warmer description (WouterJ)

weaverryan · weaverryan · commit 9dd8d962ea00 · 2014-03-18T08:38:06.000-05:00
This PR was merged into the 2.3 branch. Discussion ---------- Fix cache warmer description | Q | A | --- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - - The warmers are also executed on the first request: https://github.com/symfony/HttpKernel/blob/master/Kernel.php#L568-571 - Defining optional warmers has some effects, saying it has no effect is wrong. Commits ------- ac0f66d Updated the description of cache warmers
diff --git a/reference/dic_tags.rst b/reference/dic_tags.rst
@@ -406,7 +406,8 @@ kernel.cache_warmer
 **Purpose**: Register your service to be called during the cache warming process
 
 Cache warming occurs whenever you run the ``cache:warmup`` or ``cache:clear``
-task (unless you pass ``--no-warmup`` to ``cache:clear``). The purpose is
+task (unless you pass ``--no-warmup`` to ``cache:clear``). It is also run when
+handling the request, if it wasn't done by one of the commands yet. The purpose is
 to initialize any cache that will be needed by the application and prevent
 the first user from any significant "cache hit" where the cache is generated
 dynamically.
@@ -423,7 +424,7 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
     {
         public function warmUp($cacheDir)
         {
-            // do some sort of operations to "warm" your cache
+            // ... do some sort of operations to "warm" your cache
         }
 
         public function isOptional()
@@ -433,8 +434,9 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
     }
 
 The ``isOptional`` method should return true if it's possible to use the
-application without calling this cache warmer. In Symfony 2.0, optional warmers
-are always executed anyways, so this function has no real effect.
+application without calling this cache warmer. In Symfony, optional warmers
+are always executed by default (you can change this by using the
+``--no-optional-warmers`` option when executing the command).
 
 To register your warmer with Symfony, give it the ``kernel.cache_warmer`` tag:
 

Original file line number	Diff line number	Diff line change
`@@ -406,7 +406,8 @@ kernel.cache_warmer`
`406`	`406`	`Purpose: Register your service to be called during the cache warming process`
`407`	`407`
`408`	`408`	Cache warming occurs whenever you run the ``cache:warmup`` or ``cache:clear``
`409`		-task (unless you pass ``--no-warmup`` to ``cache:clear``). The purpose is
	`409`	+task (unless you pass ``--no-warmup`` to ``cache:clear``). It is also run when
	`410`	`+handling the request, if it wasn't done by one of the commands yet. The purpose is`
`410`	`411`	`to initialize any cache that will be needed by the application and prevent`
`411`	`412`	`the first user from any significant "cache hit" where the cache is generated`
`412`	`413`	`dynamically.`
@@ -423,7 +424,7 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
`423`	`424`	`{`
`424`	`425`	`public function warmUp($cacheDir)`
`425`	`426`	`{`
`426`		`- // do some sort of operations to "warm" your cache`
	`427`	`+ // ... do some sort of operations to "warm" your cache`
`427`	`428`	`}`
`428`	`429`
`429`	`430`	`public function isOptional()`
@@ -433,8 +434,9 @@ the :class:`Symfony\\Component\\HttpKernel\\CacheWarmer\\CacheWarmerInterface` i
`433`	`434`	`}`
`434`	`435`
`435`	`436`	The ``isOptional`` method should return true if it's possible to use the
`436`		`-application without calling this cache warmer. In Symfony 2.0, optional warmers`
`437`		`-are always executed anyways, so this function has no real effect.`
	`437`	`+application without calling this cache warmer. In Symfony, optional warmers`
	`438`	`+are always executed by default (you can change this by using the`
	`439`	+``--no-optional-warmers`` option when executing the command).
`438`	`440`
`439`	`441`	To register your warmer with Symfony, give it the ``kernel.cache_warmer`` tag:
`440`	`442`