summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2019-09-21 17:04:58 +0200
committerStefan Kangas <stefankangas@gmail.com>2019-09-22 01:30:01 +0200
commit14e7c01feeafd3852522c221187e7359d21079f5 (patch)
tree1e5f979576a81706d6325cbfc2d7ccd338b48dbf
parent2879c3ec1b91bcf3276c979155dd05494de20a0d (diff)
downloademacs-14e7c01feeafd3852522c221187e7359d21079f5.tar.gz
* src/fns.c (Fbuffer_hash): Improve doc string.
-rw-r--r--src/fns.c9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/fns.c b/src/fns.c
index 2314b4699e7..b800f1c47fe 100644
--- a/src/fns.c
+++ b/src/fns.c
@@ -5409,7 +5409,14 @@ of the other hash types instead, e.g. sha256 or sha512. */)
DEFUN ("buffer-hash", Fbuffer_hash, Sbuffer_hash, 0, 1, 0,
doc: /* Return a hash of the contents of BUFFER-OR-NAME.
This hash is performed on the raw internal format of the buffer,
-disregarding any coding systems. If nil, use the current buffer. */ )
+disregarding any coding systems. If nil, use the current buffer.
+
+This function is useful for comparing two buffers running in the same
+Emacs, but is not guaranteed to return the same hash between different
+Emacs versions.
+
+It should not be used for anything security-related. See
+`secure-hash' for these applications. */ )
(Lisp_Object buffer_or_name)
{
Lisp_Object buffer;