Mercurial > hg
changeset 16528:5d803620ca05 stable
doc: flatten description of 'matching()' predicate to be formatted well
current description of 'matching()' revset predicate can't be
formatted well on "hg help revset" output.
each descriptions for revset predicates (or something like them) are
split-ed into lines, and spaces on left side of them are stripped
before minirst processing. so, bullet list can't be nested.
this patch just flattens description of 'matching()' predicate to be
formatted well.
| author | FUJIWARA Katsunori <foozy@lares.dti.ne.jp> |
|---|---|
| date | Thu, 26 Apr 2012 21:32:48 +0900 |
| parents | 17a1f7690b49 |
| children | 3d5d204a08c7 |
| files | mercurial/revset.py |
| diffstat | 1 files changed, 16 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/revset.py Fri Apr 27 11:02:16 2012 +0200 +++ b/mercurial/revset.py Thu Apr 26 21:32:48 2012 +0900 @@ -914,19 +914,23 @@ """``matching(revision [, field])`` Changesets in which a given set of fields match the set of fields in the selected revision or set. + To match more than one field pass the list of fields to match separated - by spaces (e.g. 'author description'). - Valid fields are most regular revision fields and some special fields: - * regular fields: - - description, author, branch, date, files, phase, parents, - substate, user. - Note that author and user are synonyms. - * special fields: summary, metadata. - - summary: matches the first line of the description. - - metatadata: It is equivalent to matching 'description user date' - (i.e. it matches the main metadata fields). - metadata is the default field which is used when no fields are specified. - You can match more than one field at a time. + by spaces (e.g. ``author description``). + + Valid fields are most regular revision fields and some special fields. + + Regular revision fields are ``description``, ``author``, ``branch``, + ``date``, ``files``, ``phase``, ``parents``, ``substate`` and ``user``. + Note that ``author`` and ``user`` are synonyms. + + Special fields are ``summary`` and ``metadata``: + ``summary`` matches the first line of the description. + ``metatadata`` is equivalent to matching ``description user date`` + (i.e. it matches the main metadata fields). + + ``metadata`` is the default field which is used when no fields are + specified. You can match more than one field at a time. """ l = getargs(x, 1, 2, _("matching takes 1 or 2 arguments"))