diff options
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/misc/url.texi | 26 |
2 files changed, 23 insertions, 8 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 3e723cd8c83..e3308497d5c 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2010-09-24 Julien Danjou <julien@danjou.info> | ||
| 2 | |||
| 3 | * url.texi (Disk Caching): Mention url-cache-expire-time, | ||
| 4 | url-cache-expired, and url-fetch-from-cache. | ||
| 5 | |||
| 1 | 2010-09-21 Lars Magne Ingebrigtsen <larsi@gnus.org> | 6 | 2010-09-21 Lars Magne Ingebrigtsen <larsi@gnus.org> |
| 2 | 7 | ||
| 3 | * gnus.texi (Expunging mailboxes): Update name of the expunging | 8 | * gnus.texi (Expunging mailboxes): Update name of the expunging |
diff --git a/doc/misc/url.texi b/doc/misc/url.texi index a6bbf0bd3eb..dcb8f5c268e 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi | |||
| @@ -731,14 +731,6 @@ directory to store the cache files. It defaults to sub-directory | |||
| 731 | @file{cache} of @code{url-configuration-directory}. | 731 | @file{cache} of @code{url-configuration-directory}. |
| 732 | @end defopt | 732 | @end defopt |
| 733 | 733 | ||
| 734 | @c Fixme: function v. option, but neither used. | ||
| 735 | @c @findex url-cache-expired | ||
| 736 | @c @defopt url-cache-expired | ||
| 737 | @c This is a function to decide whether or not a cache entry has expired. | ||
| 738 | @c It takes two times as it parameters and returns non-@code{nil} if the | ||
| 739 | @c second time is ``too old'' when compared with the first time. | ||
| 740 | @c @end defopt | ||
| 741 | |||
| 742 | @defopt url-cache-creation-function | 734 | @defopt url-cache-creation-function |
| 743 | The cache relies on a scheme for mapping URLs to files in the cache. | 735 | The cache relies on a scheme for mapping URLs to files in the cache. |
| 744 | This variable names a function which sets the type of cache to use. | 736 | This variable names a function which sets the type of cache to use. |
| @@ -748,6 +740,11 @@ corresponding cache file. The two supplied possibilities are | |||
| 748 | @code{url-cache-create-filename-human-readable}. | 740 | @code{url-cache-create-filename-human-readable}. |
| 749 | @end defopt | 741 | @end defopt |
| 750 | 742 | ||
| 743 | @defopt url-cache-expire-time | ||
| 744 | This variable defines a default time value to use as expire delay when | ||
| 745 | checking if an URL has expired with @code{url-cache-expired}. | ||
| 746 | @end defopt | ||
| 747 | |||
| 751 | @defun url-cache-create-filename-using-md5 url | 748 | @defun url-cache-create-filename-using-md5 url |
| 752 | Creates a cache file name from @var{url} using MD5 hashing. | 749 | Creates a cache file name from @var{url} using MD5 hashing. |
| 753 | This is creates entries with very few cache collisions and is fast. | 750 | This is creates entries with very few cache collisions and is fast. |
| @@ -768,6 +765,19 @@ more likely to conflict with other files. | |||
| 768 | @end smallexample | 765 | @end smallexample |
| 769 | @end defun | 766 | @end defun |
| 770 | 767 | ||
| 768 | @defun url-cache-expired | ||
| 769 | This is a function to decide whether or not a cache entry has expired. | ||
| 770 | It takes a an URL as it first parameters and a expiration delay in | ||
| 771 | second paramater. It returns non-@code{nil} if URL is not cached or is | ||
| 772 | cached for more than the give expiration delay. If the delay is not | ||
| 773 | used, @var{url-cache-expire-time} is used instead. | ||
| 774 | @end defun | ||
| 775 | |||
| 776 | @defun url-fetch-from-cache | ||
| 777 | This function takes an URL as its first argument and then returns a | ||
| 778 | buffer containing the data cached for the given URL. | ||
| 779 | @end defun | ||
| 780 | |||
| 771 | @c Fixme: never actually used currently? | 781 | @c Fixme: never actually used currently? |
| 772 | @c @defopt url-standalone-mode | 782 | @c @defopt url-standalone-mode |
| 773 | @c @cindex Relying on cache | 783 | @c @cindex Relying on cache |