emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Fix URL documentation


From: Julien Danjou
Subject: [PATCH] Fix URL documentation
Date: Thu, 23 Sep 2010 11:46:51 +0200

Signed-off-by: Julien Danjou <address@hidden>
---
 doc/misc/url.texi |   26 ++++++++++++++++++--------
 1 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index a6bbf0b..dcb8f5c 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
 @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 @@ corresponding cache file.  The two supplied possibilities 
are
 @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 @@ more likely to conflict with other files.
 @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
-- 
1.7.1




reply via email to

[Prev in Thread] Current Thread [Next in Thread]