Patchwork [1,of,6] repoview: update documentation of _getstatichidden

login
register
mail settings
Submitter Pierre-Yves David
Date April 3, 2015, 10:23 p.m.
Message ID <d99e07f199e8a0c597e0.1428099826@marginatus.alto.octopoid.net>
Download mbox | patch
Permalink /patch/8486/
State Accepted
Commit 9e558b788daa159df06de258478600e2bb60b77b
Headers show

Comments

Pierre-Yves David - April 3, 2015, 10:23 p.m.
# HG changeset patch
# User Pierre-Yves David <pierre-yves.david@fb.com>
# Date 1428094692 25200
#      Fri Apr 03 13:58:12 2015 -0700
# Node ID d99e07f199e8a0c597e09aa7dc19742b895a8774
# Parent  d7cf8102bf09a905662c1018e60a06e417a08af3
repoview: update documentation of _getstatichidden

In 2f7cb6e6acdd the function name, role and return was changed. But the
documentation was not. This fixes it.

Patch

diff --git a/mercurial/repoview.py b/mercurial/repoview.py
--- a/mercurial/repoview.py
+++ b/mercurial/repoview.py
@@ -21,14 +21,18 @@  def hideablerevs(repo):
 
     This is a standalone function to help extensions to wrap it."""
     return obsolete.getrevs(repo, 'obsolete')
 
 def _getstatichidden(repo):
-    """Cacheable revisions blocking hidden changesets from being filtered.
+    """Revision to be hidden (disregarding dynamic blocker)
 
-    Additional non-cached hidden blockers are computed in _getdynamicblockers.
-    This is a standalone function to help extensions to wrap it."""
+    To keep a consistent graph, we cannot hide any revisions with non-hidden
+    descendants. This function compute the set of revision that could be hidden
+    while keeping the graph consistent.
+
+    A second pass will be done to apply "dynamic blocker" like bookmarks or
+    working directory parents."""
     assert not repo.changelog.filteredrevs
     hideable = hideablerevs(repo)
     if hideable:
         actuallyhidden = {}
         getphase = repo._phasecache.phase