From: Julien Danjou <julien@danjou.info>
To: emacs-devel@gnu.org
Cc: Julien Danjou <julien@danjou.info>
Subject: [PATCH] Fix URL documentation
Date: Thu, 23 Sep 2010 11:46:51 +0200 [thread overview]
Message-ID: <1285235211-15680-1-git-send-email-julien@danjou.info> (raw)
In-Reply-To: <ock4mdyab1.fsf@fencepost.gnu.org>
Signed-off-by: Julien Danjou <julien@danjou.info>
---
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
-@c Fixme: function v. option, but neither used.
-@c @findex url-cache-expired
-@c @defopt url-cache-expired
-@c This is a function to decide whether or not a cache entry has expired.
-@c It takes two times as it parameters and returns non-@code{nil} if the
-@c second time is ``too old'' when compared with the first time.
-@c @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
+@defopt 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}.
+@end 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
+@defun 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 non-@code{nil} 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.
+@end defun
+
+@defun 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.
+@end defun
+
@c Fixme: never actually used currently?
@c @defopt url-standalone-mode
@c @cindex Relying on cache
--
1.7.1
next prev parent reply other threads:[~2010-09-23 9:46 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-09-15 8:51 Enhance url-cache Julien Danjou
2010-09-15 8:51 ` [PATCH 1/5] url-cache.el (url-cache-expired): Handle any type of cached object Julien Danjou
2010-09-15 8:51 ` [PATCH 2/5] url-cache.el: (url-fetch-from-cache): Add new function Julien Danjou
2010-09-19 18:50 ` Glenn Morris
2010-09-15 8:51 ` [PATCH 3/5] url-cache.el: (url-is-cached): Enhance docstring Julien Danjou
2010-09-18 20:44 ` Glenn Morris
2010-09-15 8:51 ` [PATCH 4/5] url-vars.el: Remove useless variable `url-cache-expired' Julien Danjou
2010-09-18 20:50 ` Glenn Morris
2010-09-15 8:51 ` [PATCH 5/5] url-cache: add url-cache-expire-time Julien Danjou
2010-09-22 16:29 ` Enhance url-cache Julien Danjou
2010-09-22 17:09 ` Glenn Morris
2010-09-23 9:46 ` Julien Danjou [this message]
2010-09-24 2:38 ` [PATCH] Fix URL documentation Glenn Morris
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1285235211-15680-1-git-send-email-julien@danjou.info \
--to=julien@danjou.info \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).