Skip to content

Commit 6087013

Browse files
committed
minor #20940 [Reference] Update the default values of some options (javiereguiluz)
This PR was merged into the 6.4 branch. Discussion ---------- [Reference] Update the default values of some options After merging #20852 I realized that some default option values were not following the format used in most options, so let's update them. Commits ------- 5028721 [Reference] Update the default values of some options
2 parents 6e0d1c3 + 5028721 commit 6087013

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

reference/configuration/framework.rst

+14-14
Original file line numberDiff line numberDiff line change
@@ -86,32 +86,32 @@ trace_level
8686

8787
For 'short', a concise trace of the main request will be added as an HTTP header.
8888
'full' will add traces for all requests (including ESI subrequests).
89-
(default: 'full' if in debug; 'none' otherwise)
89+
(default: ``'full'`` if in debug; ``'none'`` otherwise)
9090

9191
trace_header
9292
............
9393

94-
**type**: ``string``
94+
**type**: ``string`` **default**: ``'X-Symfony-Cache'``
9595

96-
Header name to use for traces. (default: X-Symfony-Cache)
96+
Header name to use for traces.
9797

9898
default_ttl
9999
...........
100100

101-
**type**: ``integer``
101+
**type**: ``integer`` **default**: ``0``
102102

103103
The number of seconds that a cache entry should be considered fresh when no
104104
explicit freshness information is provided in a response. Explicit
105-
Cache-Control or Expires headers override this value. (default: 0)
105+
Cache-Control or Expires headers override this value.
106106

107107
private_headers
108108
...............
109109

110-
**type**: ``array``
110+
**type**: ``array`` **default**: ``['Authorization', 'Cookie']``
111111

112112
Set of request headers that trigger "private" cache-control behavior on responses
113113
that don't explicitly state whether the response is public or private via a
114-
Cache-Control directive. (default: Authorization and Cookie)
114+
Cache-Control directive.
115115

116116
skip_response_headers
117117
.....................
@@ -132,7 +132,7 @@ allow_reload
132132

133133
Specifies whether the client can force a cache reload by including a
134134
Cache-Control "no-cache" directive in the request. Set it to ``true``
135-
for compliance with RFC 2616. (default: false)
135+
for compliance with RFC 2616.
136136

137137
allow_revalidate
138138
................
@@ -141,27 +141,27 @@ allow_revalidate
141141

142142
Specifies whether the client can force a cache revalidate by including a
143143
Cache-Control "max-age=0" directive in the request. Set it to ``true``
144-
for compliance with RFC 2616. (default: false)
144+
for compliance with RFC 2616.
145145

146146
stale_while_revalidate
147147
......................
148148

149-
**type**: ``integer``
149+
**type**: ``integer`` **default**: ``2``
150150

151151
Specifies the default number of seconds (the granularity is the second as the
152152
Response TTL precision is a second) during which the cache can immediately return
153-
a stale response while it revalidates it in the background (default: 2).
153+
a stale response while it revalidates it in the background.
154154
This setting is overridden by the stale-while-revalidate HTTP Cache-Control
155155
extension (see RFC 5861).
156156

157157
stale_if_error
158158
..............
159159

160-
**type**: ``integer``
160+
**type**: ``integer`` **default**: ``60``
161161

162162
Specifies the default number of seconds (the granularity is the second) during
163-
which the cache can serve a stale response when an error is encountered
164-
(default: 60). This setting is overridden by the stale-if-error HTTP
163+
which the cache can serve a stale response when an error is encountered.
164+
This setting is overridden by the stale-if-error HTTP
165165
Cache-Control extension (see RFC 5861).
166166

167167
terminate_on_cache_hit

0 commit comments

Comments
 (0)