This is an archive of the discontinued Mercurial Phabricator instance.

Differential D523

revset: improve documentation about ordering handling
ClosedPublic

Authored by quark on Aug 25 2017, 8:14 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHGdcfdf4d09663: revset: improve documentation about ordering handling
rHG1ad55da94b5b: revset: improve documentation about ordering handling
Summary

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.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

quark created this revision.Aug 25 2017, 8:14 PM
yuja accepted this revision.Aug 27 2017, 8:46 AM
This revision is now accepted and ready to land.Aug 27 2017, 8:46 AM
quark updated this revision to Diff 1390.Aug 29 2017, 10:02 AM
Closed by commit rHG1ad55da94b5b: revset: improve documentation about ordering handling (authored by quark). · Explain WhyAug 30 2017, 9:53 AM
This revision was automatically updated to reflect the committed changes.
martinvonz added a subscriber: martinvonz.Aug 30 2017, 1:15 PM
martinvonz added inline comments.
mercurial/revsetlang.py
285

Fixing the two misspelled ancesotrs here in flight

Revision Contents
Changeset List

PathPackages
Mmercurial/revsetlang.py (36 lines)

Diff 1433

mercurial/revsetlang.py

is also None. Use _isnamedfunc() instead. is also None. Use _isnamedfunc() instead.
""" """
if not _isnamedfunc(x, funcname): if not _isnamedfunc(x, funcname):
return return
return x[2] return x[2]
# Constants for ordering requirement, used in getset(): # Constants for ordering requirement, used in getset():
# #
# If 'define', any nested functions and operations can change the ordering of # If 'define', any nested functions and operations MAY change the ordering of
# the entries in the set. If 'follow', any nested functions and operations # the entries in the set (but if changes the ordering, it MUST ALWAYS change
# should take the ordering specified by the first operand to the '&' operator. # it). If 'follow', any nested functions and operations MUST take the ordering
# specified by the first operand to the '&' operator.
# #
# For instance, # For instance,
# #
# X & (Y | Z) # X & (Y | Z)
# ^ ^^^^^^^ # ^ ^^^^^^^
# | follow # | follow
# define # define
# #
# will be evaluated as 'or(y(x()), z(x()))', where 'x()' can change the order # will be evaluated as 'or(y(x()), z(x()))', where 'x()' can change the order
# of the entries in the set, but 'y()', 'z()' and 'or()' shouldn't. # of the entries in the set, but 'y()', 'z()' and 'or()' shouldn't.
# #
# 'any' means the order doesn't matter. For instance, # 'any' means the order doesn't matter. For instance,
# #
# X & !Y # (X & Y) | ancestors(Z)
# ^ # ^ ^
# any # any any
# #
# 'y()' can either enforce its ordering requirement or take the ordering # For 'X & Y', 'X' decides order so the order of 'Y' does not matter. For
# specified by 'x()' because 'not()' doesn't care the order. # 'ancesotrs(Z)', Z's order does not matter since 'ancesotrs' does not care
martinvonzUnsubmitted
Not Done

Fixing the two misspelled ancesotrs here in flight

martinvonz: Fixing the two misspelled ancesotrs here in flight
anyorder = 'any' # don't care the order # about the order of its argument.
defineorder = 'define' # should define the order #
followorder = 'follow' # must follow the current order # 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): def _matchonly(revs, bases):
""" """
>>> f = lambda *args: _matchonly(*map(parse, args)) >>> f = lambda *args: _matchonly(*map(parse, args))
>>> f('ancestors(A)', 'not ancestors(B)') >>> f('ancestors(A)', 'not ancestors(B)')
('list', ('symbol', 'A'), ('symbol', 'B')) ('list', ('symbol', 'A'), ('symbol', 'B'))
""" """
ta = _matchnamedfunc(revs, 'ancestors') ta = _matchnamedfunc(revs, 'ancestors')