# HG changeset patch
# User Augie Fackler <augie@google.com>
# Date 2015-12-03 15:56:05
# Node ID beb60a898dd0a5bb90eeec0701bc7019df0044fc
# Parent  de3335b4c8efb4ed279b00ba7526462b546fb64c

changegroup: document manifest linkrev callback some more

Martin and I just got super-confused reading some code here, so I
think it's time for some more documentation.

diff --git a/mercurial/changegroup.py b/mercurial/changegroup.py
--- a/mercurial/changegroup.py
+++ b/mercurial/changegroup.py
@@ -653,6 +653,18 @@ class cg1packer(object):
         # revisions.
         # Returns the linkrev node (collected in lookupcl).
         def lookupmflinknode(x):
+            """Callback for looking up the linknode for manifests.
+
+            Returns the linkrev node for the specified manifest.
+
+            SIDE EFFECT:
+
+              fclnodes gets populated with the list of relevant
+              file nodes if we're not using fastpathlinkrev.
+
+            Note that this means you can't trust fclnodes until
+            after manifests have been sent to the client.
+            """
             clnode = mfs[x]
             if not fastpathlinkrev:
                 mdata = ml.readfast(x)