[PATCH 1 of 5] merge: update comment for future devs

[Sean Farley]

# HG changeset patch
# User Sean Farley <sean.michael.farley at gmail.com>
# Date 1383755185 21600
#      Wed Nov 06 10:26:25 2013 -0600
# Node ID c660a47b8fdb184ad2933a852485af815a014dfe
# Parent  db0f8738d3d47dfd850349c0ce9c87a86251f36f
merge: update comment for future devs

diff --git a/mercurial/merge.py b/mercurial/merge.py
--- a/mercurial/merge.py
+++ b/mercurial/merge.py
@@ -678,11 +678,13 @@
     onode = node
     wlock = repo.wlock()
     try:
         wc = repo[None]
         if node is None:
-            # tip of current branch
+            # Here is where we should consider bookmarks, divergent bookmarks,
+            # foreground changesets (successors), and tip of current branch;
+            # but currently we are only checking the branch tips.
             try:
                 node = repo.branchtip(wc.branch())
             except error.RepoLookupError:
                 if wc.branch() == "default": # no default branch!
                     node = repo.lookup("tip") # update to tip