From 9208f251198be56db5083d1ab022d5bde1cf59bd Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Thu, 14 Apr 2016 10:47:31 -0300 Subject: [PATCH] Bug 16229: (QA) POD fixes Signed-off-by: Tomas Cohen Arazi Signed-off-by: Brendan Gallagher (cherry picked from commit 40ec26dc6cbc2ac2634ca0e8111476bbd6f62fc7) Signed-off-by: Julian Maurice --- Koha/Cache.pm | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/Koha/Cache.pm b/Koha/Cache.pm index ca549b4c5d..3bf6db5df8 100644 --- a/Koha/Cache.pm +++ b/Koha/Cache.pm @@ -228,12 +228,12 @@ The possible options are: Expiry time of this cached entry in seconds. -=item deepcopy +=item unsafe -If set, this will perform a deep copy of the item when it's retrieved. This -means that it'll be safe if something later modifies the result of the -function. Will be ignored in situations where the same behaviour comes from -the caching layer anyway. +If set, this will avoid performing a deep copy of the item. This +means that it won't be safe if something later modifies the result of the +function. It should be used with caution, and could save processing time +in some situations where is safe to use it. =item cache @@ -293,10 +293,23 @@ sub set_in_cache { Retrieve the value stored under the specified key in the default cache. -The options can set an unsafe flag to avoid a deep copy. -When this flag is set, you have to know what you are doing! -If you are retrieving a structure and modify it, you will modify the contain -of the cache! +The possible options are: + +=over + +=item unsafe + +If set, this will avoid performing a deep copy of the item. This +means that it won't be safe if something later modifies the result of the +function. It should be used with caution, and could save processing time +in some situations where is safe to use it. Make sure you know what you are doing! + +=item cache + +The cache object to use if you want to provide your own. It should be an +instance of C and follow the same interface as L. + +=back =cut -- 2.39.5