facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-09 08:18:15 +03:00
Code Issues Projects Releases Wiki Activity

revset: improve documentation about ordering handling

Browse Source 
The old documentation is a bit confusing. Namely, it's unclear whether
`define` means "I should ALWAYS define a new order", or "I should SOMETIMES
define a new order", and if it's the latter, what's the difference between
`define` and `any`?

This patch clarifies that and adds more examples.

Differential Revision: https://phab.mercurial-scm.org/D523
This commit is contained in:
Jun Wu 2017-08-25 11:20:34 -07:00
parent 647a38e249
commit a2849aacae
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
mercurial/revsetlang.py
View File

@ -260,9 +260,10 @@ def _matchnamedfunc(x, funcname):
# Constants for ordering requirement, used in getset():
#
# If 'define', any nested functions and operations can change the ordering of
# the entries in the set. If 'follow', any nested functions and operations
# should take the ordering specified by the first operand to the '&' operator.
# If 'define', any nested functions and operations MAY change the ordering of
# the entries in the set (but if changes the ordering, it MUST ALWAYS change
# it). If 'follow', any nested functions and operations MUST take the ordering
# specified by the first operand to the '&' operator.
#
# For instance,
#
@ -276,15 +277,28 @@ def _matchnamedfunc(x, funcname):
#
# 'any' means the order doesn't matter. For instance,
#
# X & !Y
# ^
# any
# (X & Y) | ancestors(Z)
# ^ ^
# any any
#
# 'y()' can either enforce its ordering requirement or take the ordering
# specified by 'x()' because 'not()' doesn't care the order.
anyorder = 'any' # don't care the order
defineorder = 'define' # should define the order
followorder = 'follow' # must follow the current order
# For 'X & Y', 'X' decides order so the order of 'Y' does not matter. For
# 'ancestors(Z)', Z's order does not matter since 'ancestors' does not care
# about the order of its argument.
#
# Currently, most revsets do not care about the order, so 'define' is
# equivalent to 'follow' for them, and the resulting order is based on the
# 'subset' parameter passed down to them:
#
# m = revset.match(..., order=defineorder)
# m(repo, subset)
# ^^^^^^
# For most revsets, 'define' means using the order this subset provides
#
# There are a few revsets that always redefine the order if 'define' is
# specified: 'sort(X)', 'reverse(X)', 'x:y'.
anyorder = 'any' # don't care the order, could be even random-shuffled
defineorder = 'define' # ALWAYS redefine, or ALWAYS follow the current order
followorder = 'follow' # MUST follow the current order
def _matchonly(revs, bases):
"""