Patchwork [1,of,5] obsolete: small doc update for 'successorssets'

login
register
mail settings
Submitter Boris Feld
Date July 5, 2017, 8:53 p.m.
Message ID <9c95b4124cda97b0e257.1499288034@FB>
Download mbox | patch
Permalink /patch/22016/
State Accepted
Headers show

Comments

Boris Feld - July 5, 2017, 8:53 p.m.
# HG changeset patch
# User Boris Feld <boris.feld@octobus.net>
# Date 1498823244 -7200
#      Fri Jun 30 13:47:24 2017 +0200
# Node ID 9c95b4124cda97b0e257ff1a828053c5eb2014a5
# Parent  4d780d510b44ad2ae3bb39f3816c95598704d1eb
# EXP-Topic successorstemplate
obsolete: small doc update for 'successorssets'

Clarify successorssets documentation before we start updating the main function.

This patch serie will introduce the successorssets template, the opposite of
predecessor templates.

Successors will use successorssets function and requires some improvement so
before doing that, we clean up successorssets a bit.

Patch

diff -r 4d780d510b44 -r 9c95b4124cda mercurial/obsutil.py
--- a/mercurial/obsutil.py	Tue Jun 27 00:01:17 2017 -0700
+++ b/mercurial/obsutil.py	Fri Jun 30 13:47:24 2017 +0200
@@ -312,15 +312,16 @@ 
     successors set. To distinguish this from a pruned changeset, the successor
     set will contain itself only, i.e. [(A,)].
 
-    Finally, successors unknown locally are considered to be pruned (obsoleted
-    without any successors).
+    Finally, final successors unknown locally are considered to be pruned
+    (pruned: obsoleted without any successors). (Final: successors not affected
+    by markers).
 
-    The optional `cache` parameter is a dictionary that may contain precomputed
-    successors sets. It is meant to reuse the computation of a previous call to
-    `successorssets` when multiple calls are made at the same time. The cache
-    dictionary is updated in place. The caller is responsible for its life
-    span. Code that makes multiple calls to `successorssets` *must* use this
-    cache mechanism or suffer terrible performance.
+    The optional `cache` parameter is a dictionary that may contains
+    precomputed successors sets. It is meant to reuse the computation of a
+    previous call to `successorssets` when multiple calls are made at the same
+    time. The cache dictionary is updated in place. The caller is responsible
+    for its life span. Code that makes multiple calls to `successorssets`
+    *should* use this cache mechanism or risk a performance hit.
     """
 
     succmarkers = repo.obsstore.successors