[Emacs-diffs] /srv/bzr/emacs/trunk r101578: Minor url.texi update.

[Glenn Morris]

------------------------------------------------------------
revno: 101578
author: Julien Danjou <address@hidden>
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2010-09-23 19:34:56 -0700
message:
  Minor url.texi update.
  
  * doc/misc/url.texi (Disk Caching): Mention url-cache-expire-time,
  url-cache-expired, and url-fetch-from-cache.
modified:
  doc/misc/ChangeLog
  doc/misc/url.texi

=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog        2010-09-21 23:27:25 +0000
+++ b/doc/misc/ChangeLog        2010-09-24 02:34:56 +0000
@@ -1,3 +1,8 @@
+2010-09-24  Julien Danjou  <address@hidden>
+
+       * url.texi (Disk Caching): Mention url-cache-expire-time,
+       url-cache-expired, and url-fetch-from-cache.
+
 2010-09-21  Lars Magne Ingebrigtsen  <address@hidden>
 
        * gnus.texi (Expunging mailboxes): Update name of the expunging

=== modified file 'doc/misc/url.texi'
--- a/doc/misc/url.texi 2010-06-24 07:10:51 +0000
+++ b/doc/misc/url.texi 2010-09-24 02:34:56 +0000
@@ -731,14 +731,6 @@
 @file{cache} of @code{url-configuration-directory}.
 @end defopt
 
address@hidden Fixme: function v. option, but neither used.
address@hidden @findex url-cache-expired
address@hidden @defopt url-cache-expired
address@hidden This is a function to decide whether or not a cache entry has 
expired.
address@hidden It takes two times as it parameters and returns address@hidden 
if the
address@hidden second time is ``too old'' when compared with the first time.
address@hidden @end defopt
-
 @defopt url-cache-creation-function
 The cache relies on a scheme for mapping URLs to files in the cache.
 This variable names a function which sets the type of cache to use.
@@ -748,6 +740,11 @@
 @code{url-cache-create-filename-human-readable}.
 @end defopt
 
address@hidden url-cache-expire-time
+This variable defines a default time value to use as expire delay when
+checking if an URL has expired with @code{url-cache-expired}.
address@hidden defopt
+
 @defun url-cache-create-filename-using-md5 url
 Creates a cache file name from @var{url} using MD5 hashing.
 This is creates entries with very few cache collisions and is fast.
@@ -768,6 +765,19 @@
 @end smallexample
 @end defun
 
address@hidden url-cache-expired
+This is a function to decide whether or not a cache entry has expired.
+It takes a an URL as it first parameters and a expiration delay in
+second paramater. It returns address@hidden if URL is not cached or is
+cached for more than the give expiration delay. If the delay is not
+used, @var{url-cache-expire-time} is used instead.
address@hidden defun
+
address@hidden url-fetch-from-cache
+This function takes an URL as its first argument and then returns a
+buffer containing the data cached for the given URL.
address@hidden defun
+
 @c Fixme: never actually used currently?
 @c @defopt url-standalone-mode
 @c @cindex Relying on cache