[TS-4112] Docs: Caching Cookied Objects for any-content type

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: Docs
• Component/s: Documentation
• Assignee: Jon Sime
• Reporter: Hiroaki Nakamura
• Created: 05/Jan/16 02:13
• Updated: 12/May/16 16:58
• Resolved: 15/Feb/16 16:55

Description

At http://trafficserver.readthedocs.org/en/latest/admin-guide/configuration/cache-basics.en.html#caching-cookied-objects
the doc says:

By default, Traffic Server caches objects served in response to requests that contain cookies. This is true for all types of objects except for text.

However, at http://trafficserver.readthedocs.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-cache-responses-to-cookies

Default: 1
1 = cache for any content-type

Also I see the default values is 1 for the config "proxy.config.http.cache.cache_responses_to_cookies" at the source code https://github.com/apache/trafficserver/blob/d197d75601772139ea489dc5686fd041dc3c257a/mgmt/RecordsConfig.cc#L643-L650

// # cache responses to cookies has 4 options
// #
// # 0 - do not cache any responses to cookies
// # 1 - cache for any content-type (ignore cookies)
// # 2 - cache only for image types
// # 3 - cache for all but text content-types
// # 4 - cache for all but text content-types except OS response without "Set-Cookie" or with "Cache-Control: public"

Unknown macro: {RECT_CONFIG, "proxy.config.http.cache.cache_responses_to_cookies", RECD_INT, "1", RECU_DYNAMIC, RR_NULL, RECC_INT, "[0-4]", RECA_NULL}

So we should fix the docs at http://trafficserver.readthedocs.org/en/latest/admin-guide/configuration/cache-basics.en.html#caching-cookied-objects
with something like:

By default, Traffic Server caches objects served in response to requests that contain cookies. This is true for all types of objects (including text content-type).