##// END OF EJS Templates
obsolete: improve English of successorssets
timeless@mozdev.org -
r26204:54875a6c default
parent child Browse files
Show More
@@ -843,13 +843,13 b' def foreground(repo, nodes):'
843 843 def successorssets(repo, initialnode, cache=None):
844 844 """Return all set of successors of initial nodes
845 845
846 The successors set of a changeset A are a group of revisions that succeed
846 The successors set of a changeset A are the group of revisions that succeed
847 847 A. It succeeds A as a consistent whole, each revision being only a partial
848 848 replacement. The successors set contains non-obsolete changesets only.
849 849
850 850 This function returns the full list of successor sets which is why it
851 851 returns a list of tuples and not just a single tuple. Each tuple is a valid
852 successors set. Not that (A,) may be a valid successors set for changeset A
852 successors set. Note that (A,) may be a valid successors set for changeset A
853 853 (see below).
854 854
855 855 In most cases, a changeset A will have a single element (e.g. the changeset
@@ -865,7 +865,7 b' def successorssets(repo, initialnode, ca'
865 865
866 866 If a changeset A is not obsolete, then it will conceptually have no
867 867 successors set. To distinguish this from a pruned changeset, the successor
868 set will only contain itself, i.e. [(A,)].
868 set will contain itself only, i.e. [(A,)].
869 869
870 870 Finally, successors unknown locally are considered to be pruned (obsoleted
871 871 without any successors).
@@ -873,9 +873,9 b' def successorssets(repo, initialnode, ca'
873 873 The optional `cache` parameter is a dictionary that may contain precomputed
874 874 successors sets. It is meant to reuse the computation of a previous call to
875 875 `successorssets` when multiple calls are made at the same time. The cache
876 dictionary is updated in place. The caller is responsible for its live
877 spawn. Code that makes multiple calls to `successorssets` *must* use this
878 cache mechanism or suffer terrible performances.
876 dictionary is updated in place. The caller is responsible for its life
877 span. Code that makes multiple calls to `successorssets` *must* use this
878 cache mechanism or suffer terrible performance.
879 879
880 880 """
881 881
General Comments 0
You need to be logged in to leave comments. Login now