]> git.eshelyaron.com Git - emacs.git/commitdiff
* src/fns.c (Fbuffer_hash): Improve doc string.
authorStefan Kangas <stefankangas@gmail.com>
Sat, 21 Sep 2019 15:04:58 +0000 (17:04 +0200)
committerStefan Kangas <stefankangas@gmail.com>
Sat, 21 Sep 2019 23:30:01 +0000 (01:30 +0200)
src/fns.c

index 2314b4699e73f77a43ba9cdea11c550405e6835e..b800f1c47fe0ec5fb8be993543fbfc491c945125 100644 (file)
--- 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;