[Emacs-diffs] master 14e7c01: * src/fns.c (Fbuffer_hash): Improve doc string.

[Stefan Kangas]

branch: master
commit 14e7c01feeafd3852522c221187e7359d21079f5
Author: Stefan Kangas <address@hidden>
Commit: Stefan Kangas <address@hidden>

    * src/fns.c (Fbuffer_hash): Improve doc string.
---
 src/fns.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/fns.c b/src/fns.c
index 2314b46..b800f1c 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;