# HG changeset patch
# User Nicolas Dumazet <nicdumz.commits@gmail.com>
# Date 2010-07-09 02:02:39
# Node ID a463e3c50212c6b2249fb55728425757da6ad8a9
# Parent  16fe98804fd80fb3424f3a6140a0aa92afbcac3e

cmp: document the fact that we return True if content is different

This is similar to the __builtin__.cmp behaviour, but still not
straightforward, as the dailylife meaning of a comparison usually is
"find out if they are different".

diff --git a/mercurial/context.py b/mercurial/context.py
--- a/mercurial/context.py
+++ b/mercurial/context.py
@@ -353,6 +353,10 @@ class filectx(object):
         return self._filelog.size(self._filerev)
 
     def cmp(self, text):
+        """compare text with stored file revision
+
+        returns True if text is different than what is stored.
+        """
         return self._filelog.cmp(self._filenode, text)
 
     def renamed(self):
@@ -932,6 +936,10 @@ class workingfilectx(filectx):
             return (t, tz)
 
     def cmp(self, text):
+        """compare text with disk content
+
+        returns True if text is different than what is on disk.
+        """
         return self._repo.wread(self._path) != text
 
 class memctx(object):
diff --git a/mercurial/filelog.py b/mercurial/filelog.py
--- a/mercurial/filelog.py
+++ b/mercurial/filelog.py
@@ -56,7 +56,10 @@ class filelog(revlog.revlog):
         return revlog.revlog.size(self, rev)
 
     def cmp(self, node, text):
-        """compare text with a given file revision"""
+        """compare text with a given file revision
+
+        returns True if text is different than what is stored.
+        """
 
         # for renames, we have to go the slow way
         if text.startswith('\1\n') or self.renamed(node):
diff --git a/mercurial/revlog.py b/mercurial/revlog.py
--- a/mercurial/revlog.py
+++ b/mercurial/revlog.py
@@ -943,7 +943,10 @@ class revlog(object):
         raise LookupError(id, self.indexfile, _('no match found'))
 
     def cmp(self, node, text):
-        """compare text with a given file revision"""
+        """compare text with a given file revision
+
+        returns True if text is different than what is stored.
+        """
         p1, p2 = self.parents(node)
         return hash(text, p1, p2) != node