branching: merge stable into default

mercurial/help.py

@@ -1,1232 +1,1232 b''
 # help.py - help data for mercurial
 #
 # Copyright 2006 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import itertools
 import re
 import textwrap
 
 from typing import (
     Callable,
     Dict,
     Iterable,
     List,
     Optional,
     Set,
     Tuple,
     Union,
     cast,
 )
 
 from .i18n import (
     _,
     gettext,
 )
 from .pycompat import getattr
 from . import (
     cmdutil,
     encoding,
     error,
     extensions,
     fancyopts,
     filemerge,
     fileset,
     minirst,
     pycompat,
     registrar,
     revset,
     templatefilters,
     templatefuncs,
     templatekw,
     ui as uimod,
     util,
 )
 from .hgweb import webcommands
 from .utils import (
     compression,
     resourceutil,
     stringutil,
 )
 
 _DocLoader = Callable[[uimod.ui], bytes]
 # Old extensions may not register with a category
 _HelpEntry = Union["_HelpEntryNoCategory", "_HelpEntryWithCategory"]
 _HelpEntryNoCategory = Tuple[List[bytes], bytes, _DocLoader]
 _HelpEntryWithCategory = Tuple[List[bytes], bytes, _DocLoader, bytes]
 _SelectFn = Callable[[object], bool]
 _SynonymTable = Dict[bytes, List[bytes]]
 _TopicHook = Callable[[uimod.ui, bytes, bytes], bytes]
 
 _exclkeywords: Set[bytes] = {
     b"(ADVANCED)",
     b"(DEPRECATED)",
     b"(EXPERIMENTAL)",
     # i18n: "(ADVANCED)" is a keyword, must be translated consistently
     _(b"(ADVANCED)"),
     # i18n: "(DEPRECATED)" is a keyword, must be translated consistently
     _(b"(DEPRECATED)"),
     # i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently
     _(b"(EXPERIMENTAL)"),
 }
 
 # The order in which command categories will be displayed.
 # Extensions with custom categories should insert them into this list
 # after/before the appropriate item, rather than replacing the list or
 # assuming absolute positions.
 CATEGORY_ORDER: List[bytes] = [
     registrar.command.CATEGORY_REPO_CREATION,
     registrar.command.CATEGORY_REMOTE_REPO_MANAGEMENT,
     registrar.command.CATEGORY_COMMITTING,
     registrar.command.CATEGORY_CHANGE_MANAGEMENT,
     registrar.command.CATEGORY_CHANGE_ORGANIZATION,
     registrar.command.CATEGORY_FILE_CONTENTS,
     registrar.command.CATEGORY_CHANGE_NAVIGATION,
     registrar.command.CATEGORY_WORKING_DIRECTORY,
     registrar.command.CATEGORY_IMPORT_EXPORT,
     registrar.command.CATEGORY_MAINTENANCE,
     registrar.command.CATEGORY_HELP,
     registrar.command.CATEGORY_MISC,
     registrar.command.CATEGORY_NONE,
 ]
 
 # Human-readable category names. These are translated.
 # Extensions with custom categories should add their names here.
 CATEGORY_NAMES: Dict[bytes, bytes] = {
     registrar.command.CATEGORY_REPO_CREATION: b'Repository creation',
     registrar.command.CATEGORY_REMOTE_REPO_MANAGEMENT: b'Remote repository management',
     registrar.command.CATEGORY_COMMITTING: b'Change creation',
     registrar.command.CATEGORY_CHANGE_NAVIGATION: b'Change navigation',
     registrar.command.CATEGORY_CHANGE_MANAGEMENT: b'Change manipulation',
     registrar.command.CATEGORY_CHANGE_ORGANIZATION: b'Change organization',
     registrar.command.CATEGORY_WORKING_DIRECTORY: b'Working directory management',
     registrar.command.CATEGORY_FILE_CONTENTS: b'File content management',
     registrar.command.CATEGORY_IMPORT_EXPORT: b'Change import/export',
     registrar.command.CATEGORY_MAINTENANCE: b'Repository maintenance',
     registrar.command.CATEGORY_HELP: b'Help',
     registrar.command.CATEGORY_MISC: b'Miscellaneous commands',
     registrar.command.CATEGORY_NONE: b'Uncategorized commands',
 }
 
 # Topic categories.
 TOPIC_CATEGORY_IDS = b'ids'
 TOPIC_CATEGORY_OUTPUT = b'output'
 TOPIC_CATEGORY_CONFIG = b'config'
 TOPIC_CATEGORY_CONCEPTS = b'concepts'
 TOPIC_CATEGORY_MISC = b'misc'
 TOPIC_CATEGORY_NONE = b'none'
 
 # The order in which topic categories will be displayed.
 # Extensions with custom categories should insert them into this list
 # after/before the appropriate item, rather than replacing the list or
 # assuming absolute positions.
 TOPIC_CATEGORY_ORDER: List[bytes] = [
     TOPIC_CATEGORY_IDS,
     TOPIC_CATEGORY_OUTPUT,
     TOPIC_CATEGORY_CONFIG,
     TOPIC_CATEGORY_CONCEPTS,
     TOPIC_CATEGORY_MISC,
     TOPIC_CATEGORY_NONE,
 ]
 
 # Human-readable topic category names. These are translated.
 TOPIC_CATEGORY_NAMES: Dict[bytes, bytes] = {
     TOPIC_CATEGORY_IDS: b'Mercurial identifiers',
     TOPIC_CATEGORY_OUTPUT: b'Mercurial output',
     TOPIC_CATEGORY_CONFIG: b'Mercurial configuration',
     TOPIC_CATEGORY_CONCEPTS: b'Concepts',
     TOPIC_CATEGORY_MISC: b'Miscellaneous',
     TOPIC_CATEGORY_NONE: b'Uncategorized topics',
 }
 
 
 def listexts(
     header: bytes,
     exts: Dict[bytes, bytes],
     indent: int = 1,
     showdeprecated: bool = False,
 ) -> List[bytes]:
     '''return a text listing of the given extensions'''
     rst = []
     if exts:
         for name, desc in sorted(exts.items()):
             if not showdeprecated and any(w in desc for w in _exclkeywords):
                 continue
             rst.append(b'%s:%s: %s\n' % (b' ' * indent, name, desc))
     if rst:
         rst.insert(0, b'\n%s\n\n' % header)
     return rst
 
 
 def extshelp(ui: uimod.ui) -> bytes:
     rst = loaddoc(b'extensions')(ui).splitlines(True)
     rst.extend(
         listexts(
             _(b'enabled extensions:'), extensions.enabled(), showdeprecated=True
         )
     )
     rst.extend(
         listexts(
             _(b'disabled extensions:'),
             extensions.disabled(),
             showdeprecated=ui.verbose,
         )
     )
     doc = b''.join(rst)
     return doc
 
 
 def parsedefaultmarker(text: bytes) -> Optional[Tuple[bytes, List[bytes]]]:
     """given a text 'abc (DEFAULT: def.ghi)',
     returns (b'abc', (b'def', b'ghi')). Otherwise return None"""
     if text[-1:] == b')':
         marker = b' (DEFAULT: '
         pos = text.find(marker)
         if pos >= 0:
             item = text[pos + len(marker) : -1]
             return text[:pos], item.split(b'.', 2)
 
 
 def optrst(header: bytes, options, verbose: bool, ui: uimod.ui) -> bytes:
     data = []
     multioccur = False
     for option in options:
         if len(option) == 5:
             shortopt, longopt, default, desc, optlabel = option
         else:
             shortopt, longopt, default, desc = option
             optlabel = _(b"VALUE")  # default label
 
         if not verbose and any(w in desc for w in _exclkeywords):
             continue
         defaultstrsuffix = b''
         if default is None:
             parseresult = parsedefaultmarker(desc)
             if parseresult is not None:
                 (desc, (section, name)) = parseresult
                 if ui.configbool(section, name):
                     default = True
                     defaultstrsuffix = _(b' from config')
         so = b''
         if shortopt:
             so = b'-' + shortopt
         lo = b'--' + longopt
         if default is True:
             lo = b'--[no-]' + longopt
 
         if isinstance(default, fancyopts.customopt):
             default = default.getdefaultvalue()
         if default and not callable(default):
             # default is of unknown type, and in Python 2 we abused
             # the %s-shows-repr property to handle integers etc. To
             # match that behavior on Python 3, we do str(default) and
             # then convert it to bytes.
             defaultstr = pycompat.bytestr(default)
             if default is True:
                 defaultstr = _(b"on")
             desc += _(b" (default: %s)") % (defaultstr + defaultstrsuffix)
 
         if isinstance(default, list):
             lo += b" %s [+]" % optlabel
             multioccur = True
         elif (default is not None) and not isinstance(default, bool):
             lo += b" %s" % optlabel
 
         data.append((so, lo, desc))
 
     if multioccur:
         header += _(b" ([+] can be repeated)")
 
     rst = [b'\n%s:\n\n' % header]
     rst.extend(minirst.maketable(data, 1))
 
     return b''.join(rst)
 
 
 def indicateomitted(
     rst: List[bytes], omitted: bytes, notomitted: Optional[bytes] = None
 ) -> None:
     rst.append(b'\n\n.. container:: omitted\n\n    %s\n\n' % omitted)
     if notomitted:
         rst.append(b'\n\n.. container:: notomitted\n\n    %s\n\n' % notomitted)
 
 
 def filtercmd(ui: uimod.ui, cmd: bytes, func, kw: bytes, doc: bytes) -> bool:
     if not ui.debugflag and cmd.startswith(b"debug") and kw != b"debug":
         # Debug command, and user is not looking for those.
         return True
     if not ui.verbose:
         if not kw and not doc:
             # Command had no documentation, no point in showing it by default.
             return True
         if getattr(func, 'alias', False) and not getattr(func, 'owndoc', False):
             # Alias didn't have its own documentation.
             return True
         if doc and any(w in doc for w in _exclkeywords):
             # Documentation has excluded keywords.
             return True
     if kw == b"shortlist" and not getattr(func, 'helpbasic', False):
         # We're presenting the short list but the command is not basic.
         return True
     if ui.configbool(b'help', b'hidden-command.%s' % cmd):
         # Configuration explicitly hides the command.
         return True
     return False
 
 
 def filtertopic(ui: uimod.ui, topic: bytes) -> bool:
     return ui.configbool(b'help', b'hidden-topic.%s' % topic, False)
 
 
 def topicmatch(
     ui: uimod.ui, commands, kw: bytes
 ) -> Dict[bytes, List[Tuple[bytes, bytes]]]:
     """Return help topics matching kw.
 
     Returns {'section': [(name, summary), ...], ...} where section is
     one of topics, commands, extensions, or extensioncommands.
     """
     kw = encoding.lower(kw)
 
     def lowercontains(container):
         return kw in encoding.lower(container)  # translated in helptable
 
     results = {
         b'topics': [],
         b'commands': [],
         b'extensions': [],
         b'extensioncommands': [],
     }
     for topic in helptable:
         names, header, doc = topic[0:3]
         # Old extensions may use a str as doc.
         if (
             sum(map(lowercontains, names))
             or lowercontains(header)
             or (callable(doc) and lowercontains(doc(ui)))
         ):
             name = names[0]
             if not filtertopic(ui, name):
                 results[b'topics'].append((names[0], header))
     for cmd, entry in commands.table.items():
         if len(entry) == 3:
             summary = entry[2]
         else:
             summary = b''
         # translate docs *before* searching there
         func = entry[0]
         docs = _(pycompat.getdoc(func)) or b''
         if kw in cmd or lowercontains(summary) or lowercontains(docs):
             if docs:
                 summary = stringutil.firstline(docs)
             cmdname = cmdutil.parsealiases(cmd)[0]
             if filtercmd(ui, cmdname, func, kw, docs):
                 continue
             results[b'commands'].append((cmdname, summary))
     for name, docs in itertools.chain(
         extensions.enabled(False).items(),
         extensions.disabled().items(),
     ):
         if not docs:
             continue
         name = name.rpartition(b'.')[-1]
         if lowercontains(name) or lowercontains(docs):
             # extension docs are already translated
             results[b'extensions'].append((name, stringutil.firstline(docs)))
         try:
             mod = extensions.load(ui, name, b'')
         except ImportError:
             # debug message would be printed in extensions.load()
             continue
         for cmd, entry in getattr(mod, 'cmdtable', {}).items():
             if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
                 cmdname = cmdutil.parsealiases(cmd)[0]
                 func = entry[0]
                 cmddoc = pycompat.getdoc(func)
                 if cmddoc:
                     cmddoc = stringutil.firstline(gettext(cmddoc))
                 else:
                     cmddoc = _(b'(no help text available)')
                 if filtercmd(ui, cmdname, func, kw, cmddoc):
                     continue
                 results[b'extensioncommands'].append((cmdname, cmddoc))
     return results
 
 
 def loaddoc(topic: bytes, subdir: Optional[bytes] = None) -> _DocLoader:
     """Return a delayed loader for help/topic.txt."""
 
     def loader(ui: uimod.ui) -> bytes:
         package = b'mercurial.helptext'
         if subdir:
             package += b'.' + subdir
         with resourceutil.open_resource(package, topic + b'.txt') as fp:
             doc = gettext(fp.read())
         for rewriter in helphooks.get(topic, []):
             doc = rewriter(ui, topic, doc)
         return doc
 
     return loader
 
 
 internalstable: List[_HelpEntryNoCategory] = sorted(
     [
         (
             [b'bid-merge'],
             _(b'Bid Merge Algorithm'),
             loaddoc(b'bid-merge', subdir=b'internals'),
         ),
         ([b'bundle2'], _(b'Bundle2'), loaddoc(b'bundle2', subdir=b'internals')),
         ([b'bundles'], _(b'Bundles'), loaddoc(b'bundles', subdir=b'internals')),
         ([b'cbor'], _(b'CBOR'), loaddoc(b'cbor', subdir=b'internals')),
         ([b'censor'], _(b'Censor'), loaddoc(b'censor', subdir=b'internals')),
         (
             [b'changegroups'],
             _(b'Changegroups'),
             loaddoc(b'changegroups', subdir=b'internals'),
         ),
         (
             [b'config'],
             _(b'Config Registrar'),
             loaddoc(b'config', subdir=b'internals'),
         ),
         (
             [b'dirstate-v2'],
             _(b'dirstate-v2 file format'),
             loaddoc(b'dirstate-v2', subdir=b'internals'),
         ),
         (
             [b'extensions', b'extension'],
             _(b'Extension API'),
             loaddoc(b'extensions', subdir=b'internals'),
         ),
         (
             [b'mergestate'],
             _(b'Mergestate'),
             loaddoc(b'mergestate', subdir=b'internals'),
         ),
         (
             [b'requirements'],
             _(b'Repository Requirements'),
             loaddoc(b'requirements', subdir=b'internals'),
         ),
         (
             [b'revlogs'],
             _(b'Revision Logs'),
             loaddoc(b'revlogs', subdir=b'internals'),
         ),
         (
             [b'wireprotocol'],
             _(b'Wire Protocol'),
             loaddoc(b'wireprotocol', subdir=b'internals'),
         ),
         (
             [b'wireprotocolrpc'],
             _(b'Wire Protocol RPC'),
             loaddoc(b'wireprotocolrpc', subdir=b'internals'),
         ),
         (
             [b'wireprotocolv2'],
             _(b'Wire Protocol Version 2'),
             loaddoc(b'wireprotocolv2', subdir=b'internals'),
         ),
     ]
 )
 
 
 def internalshelp(ui: uimod.ui) -> bytes:
     """Generate the index for the "internals" topic."""
     lines = [
         b'To access a subtopic, use "hg help internals.{subtopic-name}"\n',
         b'\n',
     ]
     for names, header, doc in internalstable:
         lines.append(b' :%s: %s\n' % (names[0], header))
 
     return b''.join(lines)
 
 
 helptable: List[_HelpEntryWithCategory] = sorted(
     [
         (
             [b'bundlespec'],
             _(b"Bundle File Formats"),
             loaddoc(b'bundlespec'),
             TOPIC_CATEGORY_CONCEPTS,
         ),
         (
             [b'color'],
             _(b"Colorizing Outputs"),
             loaddoc(b'color'),
             TOPIC_CATEGORY_OUTPUT,
         ),
         (
             [b"config", b"hgrc"],
             _(b"Configuration Files"),
             loaddoc(b'config'),
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [b'deprecated'],
             _(b"Deprecated Features"),
             loaddoc(b'deprecated'),
             TOPIC_CATEGORY_MISC,
         ),
         (
             [b"dates"],
             _(b"Date Formats"),
             loaddoc(b'dates'),
             TOPIC_CATEGORY_OUTPUT,
         ),
         (
             [b"flags"],
             _(b"Command-line flags"),
             loaddoc(b'flags'),
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [b"patterns"],
             _(b"File Name Patterns"),
             loaddoc(b'patterns'),
             TOPIC_CATEGORY_IDS,
         ),
         (
             [b'environment', b'env'],
             _(b'Environment Variables'),
             loaddoc(b'environment'),
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [
                 b'revisions',
                 b'revs',
                 b'revsets',
                 b'revset',
                 b'multirevs',
                 b'mrevs',
             ],
             _(b'Specifying Revisions'),
             loaddoc(b'revisions'),
             TOPIC_CATEGORY_IDS,
         ),
         (
             [
                 b'rust',
                 b'rustext',
                 b'rhg',
             ],
             _(b'Rust in Mercurial'),
             loaddoc(b'rust'),
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [b'filesets', b'fileset'],
             _(b"Specifying File Sets"),
             loaddoc(b'filesets'),
             TOPIC_CATEGORY_IDS,
         ),
         (
             [b'diffs'],
             _(b'Diff Formats'),
             loaddoc(b'diffs'),
             TOPIC_CATEGORY_OUTPUT,
         ),
         (
             [b'merge-tools', b'mergetools', b'mergetool'],
             _(b'Merge Tools'),
             loaddoc(b'merge-tools'),
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [b'templating', b'templates', b'template', b'style'],
             _(b'Template Usage'),
             loaddoc(b'templates'),
             TOPIC_CATEGORY_OUTPUT,
         ),
         ([b'urls'], _(b'URL Paths'), loaddoc(b'urls'), TOPIC_CATEGORY_IDS),
         (
             [b"extensions"],
             _(b"Using Additional Features"),
             extshelp,
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [b"subrepos", b"subrepo"],
             _(b"Subrepositories"),
             loaddoc(b'subrepos'),
             TOPIC_CATEGORY_CONCEPTS,
         ),
         (
             [b"hgweb"],
             _(b"Configuring hgweb"),
             loaddoc(b'hgweb'),
             TOPIC_CATEGORY_CONFIG,
         ),
         (
             [b"glossary"],
             _(b"Glossary"),
             loaddoc(b'glossary'),
             TOPIC_CATEGORY_CONCEPTS,
         ),
         (
             [b"hgignore", b"ignore"],
             _(b"Syntax for Mercurial Ignore Files"),
             loaddoc(b'hgignore'),
             TOPIC_CATEGORY_IDS,
         ),
         (
             [b"phases"],
             _(b"Working with Phases"),
             loaddoc(b'phases'),
             TOPIC_CATEGORY_CONCEPTS,
         ),
         (
             [b"evolution"],
             _(b"Safely rewriting history (EXPERIMENTAL)"),
             loaddoc(b'evolution'),
             TOPIC_CATEGORY_CONCEPTS,
         ),
         (
             [b'scripting'],
             _(b'Using Mercurial from scripts and automation'),
             loaddoc(b'scripting'),
             TOPIC_CATEGORY_MISC,
         ),
         (
             [b'internals'],
             _(b"Technical implementation topics"),
             internalshelp,
             TOPIC_CATEGORY_MISC,
         ),
         (
             [b'pager'],
             _(b"Pager Support"),
             loaddoc(b'pager'),
             TOPIC_CATEGORY_CONFIG,
         ),
     ]
 )
 
 # Maps topics with sub-topics to a list of their sub-topics.
 subtopics: Dict[bytes, List[_HelpEntryNoCategory]] = {
     b'internals': internalstable,
 }
 
 # Map topics to lists of callable taking the current topic help and
 # returning the updated version
 helphooks: Dict[bytes, List[_TopicHook]] = {}
 
 
 def addtopichook(topic: bytes, rewriter: _TopicHook) -> None:
     helphooks.setdefault(topic, []).append(rewriter)
 
 
 def makeitemsdoc(
     ui: uimod.ui,
     topic: bytes,
     doc: bytes,
     marker: bytes,
     items: Dict[bytes, bytes],
     dedent: bool = False,
 ) -> bytes:
     """Extract docstring from the items key to function mapping, build a
     single documentation block and use it to overwrite the marker in doc.
     """
     entries = []
     for name in sorted(items):
         text = (pycompat.getdoc(items[name]) or b'').rstrip()
         if not text or not ui.verbose and any(w in text for w in _exclkeywords):
             continue
         text = gettext(text)
         if dedent:
             # Abuse latin1 to use textwrap.dedent() on bytes.
             text = textwrap.dedent(text.decode('latin1')).encode('latin1')
         lines = text.splitlines()
         doclines = [lines[0]]
         for l in lines[1:]:
             # Stop once we find some Python doctest
             if l.strip().startswith(b'>>>'):
                 break
             if dedent:
                 doclines.append(l.rstrip())
             else:
                 doclines.append(b'  ' + l.strip())
         entries.append(b'\n'.join(doclines))
     entries = b'\n\n'.join(entries)
     return doc.replace(marker, entries)
 
 
 def addtopicsymbols(
     topic: bytes, marker: bytes, symbols, dedent: bool = False
 ) -> None:
     def add(ui: uimod.ui, topic: bytes, doc: bytes):
         return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent)
 
     addtopichook(topic, add)
 
 
 addtopicsymbols(
     b'bundlespec',
     b'.. bundlecompressionmarker',
     compression.bundlecompressiontopics(),
 )
 addtopicsymbols(b'filesets', b'.. predicatesmarker', fileset.symbols)
 addtopicsymbols(
     b'merge-tools', b'.. internaltoolsmarker', filemerge.internalsdoc
 )
 addtopicsymbols(b'revisions', b'.. predicatesmarker', revset.symbols)
 addtopicsymbols(b'templates', b'.. keywordsmarker', templatekw.keywords)
 addtopicsymbols(b'templates', b'.. filtersmarker', templatefilters.filters)
 addtopicsymbols(b'templates', b'.. functionsmarker', templatefuncs.funcs)
 addtopicsymbols(
     b'hgweb', b'.. webcommandsmarker', webcommands.commands, dedent=True
 )
 
 
 def inserttweakrc(ui: uimod.ui, topic: bytes, doc: bytes) -> bytes:
     marker = b'.. tweakdefaultsmarker'
     repl = uimod.tweakrc
 
     def sub(m):
         lines = [m.group(1) + s for s in repl.splitlines()]
         return b'\n'.join(lines)
 
     return re.sub(br'( *)%s' % re.escape(marker), sub, doc)
 
 
 def _getcategorizedhelpcmds(
     ui: uimod.ui, cmdtable, name: bytes, select: Optional[_SelectFn] = None
 ) -> Tuple[Dict[bytes, List[bytes]], Dict[bytes, bytes], _SynonymTable]:
     # Category -> list of commands
     cats = {}
     # Command -> short description
     h = {}
     # Command -> string showing synonyms
     syns = {}
     for c, e in cmdtable.items():
         fs = cmdutil.parsealiases(c)
         f = fs[0]
         syns[f] = fs
         func = e[0]
         if select and not select(f):
             continue
         doc = pycompat.getdoc(func)
         if filtercmd(ui, f, func, name, doc):
             continue
         doc = gettext(doc)
         if not doc:
             doc = _(b"(no help text available)")
         h[f] = stringutil.firstline(doc).rstrip()
 
         cat = getattr(func, 'helpcategory', None) or (
             registrar.command.CATEGORY_NONE
         )
         cats.setdefault(cat, []).append(f)
     return cats, h, syns
 
 
 def _getcategorizedhelptopics(
     ui: uimod.ui, topictable: List[_HelpEntry]
 ) -> Tuple[Dict[bytes, List[Tuple[bytes, bytes]]], Dict[bytes, List[bytes]]]:
     # Group commands by category.
     topiccats = {}
     syns = {}
     for topic in topictable:
         names, header, doc = topic[0:3]
         if len(topic) > 3 and topic[3]:
             category: bytes = cast(bytes, topic[3])  # help pytype
         else:
             category: bytes = TOPIC_CATEGORY_NONE
 
         topicname = names[0]
         syns[topicname] = list(names)
         if not filtertopic(ui, topicname):
             topiccats.setdefault(category, []).append((topicname, header))
     return topiccats, syns
 
 
 addtopichook(b'config', inserttweakrc)
 
 
 def help_(
     ui: uimod.ui,
     commands,
     name: bytes,
     unknowncmd: bool = False,
     full: bool = True,
     subtopic: Optional[bytes] = None,
     fullname: Optional[bytes] = None,
     **opts
 ) -> bytes:
     """
     Generate the help for 'name' as unformatted restructured text. If
     'name' is None, describe the commands available.
     """
 
     opts = pycompat.byteskwargs(opts)
 
     def helpcmd(name: bytes, subtopic: Optional[bytes]) -> List[bytes]:
         try:
             aliases, entry = cmdutil.findcmd(
                 name, commands.table, strict=unknowncmd
             )
         except error.AmbiguousCommand as inst:
             # py3 fix: except vars can't be used outside the scope of the
             # except block, nor can be used inside a lambda. python issue4617
             prefix = inst.prefix
             select = lambda c: cmdutil.parsealiases(c)[0].startswith(prefix)
             rst = helplist(select)
             return rst
 
         rst = []
 
         # check if it's an invalid alias and display its error if it is
         if getattr(entry[0], 'badalias', None):
             rst.append(entry[0].badalias + b'\n')
             if entry[0].unknowncmd:
                 try:
                     rst.extend(helpextcmd(entry[0].cmdname))
                 except error.UnknownCommand:
                     pass
             return rst
 
         # synopsis
         if len(entry) > 2:
             if entry[2].startswith(b'hg'):
                 rst.append(b"%s\n" % entry[2])
             else:
                 rst.append(b'hg %s %s\n' % (aliases[0], entry[2]))
         else:
             rst.append(b'hg %s\n' % aliases[0])
         # aliases
         if full and not ui.quiet and len(aliases) > 1:
             rst.append(_(b"\naliases: %s\n") % b', '.join(aliases[1:]))
         rst.append(b'\n')
 
         # description
         doc = gettext(pycompat.getdoc(entry[0]))
         if not doc:
             doc = _(b"(no help text available)")
         if util.safehasattr(entry[0], b'definition'):  # aliased command
             source = entry[0].source
             if entry[0].definition.startswith(b'!'):  # shell alias
                 doc = _(b'shell alias for: %s\n\n%s\n\ndefined by: %s\n') % (
                     entry[0].definition[1:],
                     doc,
                     source,
                 )
             else:
                 doc = _(b'alias for: hg %s\n\n%s\n\ndefined by: %s\n') % (
                     entry[0].definition,
                     doc,
                     source,
                 )
         doc = doc.splitlines(True)
         if ui.quiet or not full:
             rst.append(doc[0])
         else:
             rst.extend(doc)
         rst.append(b'\n')
 
         # check if this command shadows a non-trivial (multi-line)
         # extension help text
         try:
             mod = extensions.find(name)
             doc = gettext(pycompat.getdoc(mod)) or b''
             if b'\n' in doc.strip():
                 msg = _(
                     b"(use 'hg help -e %s' to show help for "
                     b"the %s extension)"
                 ) % (name, name)
                 rst.append(b'\n%s\n' % msg)
         except KeyError:
             pass
 
         # options
         if not ui.quiet and entry[1]:
             rst.append(optrst(_(b"options"), entry[1], ui.verbose, ui))
 
         if ui.verbose:
             rst.append(
                 optrst(
                     _(b"global options"), commands.globalopts, ui.verbose, ui
                 )
             )
 
         if not ui.verbose:
             if not full:
                 rst.append(_(b"\n(use 'hg %s -h' to show more help)\n") % name)
             elif not ui.quiet:
                 rst.append(
                     _(
                         b'\n(some details hidden, use --verbose '
                         b'to show complete help)'
                     )
                 )
 
         return rst
 
     def helplist(select: Optional[_SelectFn] = None, **opts) -> List[bytes]:
         cats, h, syns = _getcategorizedhelpcmds(
             ui, commands.table, name, select
         )
 
         rst = []
         if not h:
             if not ui.quiet:
                 rst.append(_(b'no commands defined\n'))
             return rst
 
         # Output top header.
         if not ui.quiet:
             if name == b"shortlist":
                 rst.append(_(b'basic commands:\n\n'))
             elif name == b"debug":
                 rst.append(_(b'debug commands (internal and unsupported):\n\n'))
             else:
                 rst.append(_(b'list of commands:\n'))
 
         def appendcmds(cmds: Iterable[bytes]) -> None:
             cmds = sorted(cmds)
             for c in cmds:
                 display_cmd = c
                 if ui.verbose:
                     display_cmd = b', '.join(syns[c])
                 display_cmd = display_cmd.replace(b':', br'\:')
                 rst.append(b' :%s: %s\n' % (display_cmd, h[c]))
 
         if name in (b'shortlist', b'debug'):
             # List without categories.
             appendcmds(h)
         else:
             # Check that all categories have an order.
             missing_order = set(cats.keys()) - set(CATEGORY_ORDER)
             if missing_order:
                 ui.develwarn(
                     b'help categories missing from CATEGORY_ORDER: %s'
-                    % missing_order
+                    % stringutil.forcebytestr(missing_order)
                 )
 
             # List per category.
             for cat in CATEGORY_ORDER:
                 catfns = cats.get(cat, [])
                 if catfns:
                     if len(cats) > 1:
                         catname = gettext(CATEGORY_NAMES[cat])
                         rst.append(b"\n%s:\n" % catname)
                     rst.append(b"\n")
                     appendcmds(catfns)
 
         ex = opts.get
         anyopts = ex('keyword') or not (ex('command') or ex('extension'))
         if not name and anyopts:
             exts = listexts(
                 _(b'enabled extensions:'),
                 extensions.enabled(),
                 showdeprecated=ui.verbose,
             )
             if exts:
                 rst.append(b'\n')
                 rst.extend(exts)
 
             rst.append(_(b"\nadditional help topics:\n"))
             topiccats, topicsyns = _getcategorizedhelptopics(ui, helptable)
 
             # Check that all categories have an order.
             missing_order = set(topiccats.keys()) - set(TOPIC_CATEGORY_ORDER)
             if missing_order:
                 ui.develwarn(
                     b'help categories missing from TOPIC_CATEGORY_ORDER: %s'
-                    % missing_order
+                    % stringutil.forcebytestr(missing_order)
                 )
 
             # Output topics per category.
             for cat in TOPIC_CATEGORY_ORDER:
                 topics = topiccats.get(cat, [])
                 if topics:
                     if len(topiccats) > 1:
                         catname = gettext(TOPIC_CATEGORY_NAMES[cat])
                         rst.append(b"\n%s:\n" % catname)
                     rst.append(b"\n")
                     for t, desc in topics:
                         rst.append(b" :%s: %s\n" % (t, desc))
 
         if ui.quiet:
             pass
         elif ui.verbose:
             rst.append(
                 b'\n%s\n'
                 % optrst(
                     _(b"global options"), commands.globalopts, ui.verbose, ui
                 )
             )
             if name == b'shortlist':
                 rst.append(
                     _(b"\n(use 'hg help' for the full list of commands)\n")
                 )
         else:
             if name == b'shortlist':
                 rst.append(
                     _(
                         b"\n(use 'hg help' for the full list of commands "
                         b"or 'hg -v' for details)\n"
                     )
                 )
             elif name and not full:
                 rst.append(
                     _(b"\n(use 'hg help %s' to show the full help text)\n")
                     % name
                 )
             elif name and syns and name in syns.keys():
                 rst.append(
                     _(
                         b"\n(use 'hg help -v -e %s' to show built-in "
                         b"aliases and global options)\n"
                     )
                     % name
                 )
             else:
                 rst.append(
                     _(
                         b"\n(use 'hg help -v%s' to show built-in aliases "
                         b"and global options)\n"
                     )
                     % (name and b" " + name or b"")
                 )
         return rst
 
     def helptopic(name: bytes, subtopic: Optional[bytes] = None) -> List[bytes]:
         # Look for sub-topic entry first.
         header, doc = None, None
         if subtopic and name in subtopics:
             for names, header, doc in subtopics[name]:
                 if subtopic in names:
                     break
             if not any(subtopic in s[0] for s in subtopics[name]):
                 raise error.UnknownCommand(name)
 
         if not header:
             for topic in helptable:
                 names, header, doc = topic[0:3]
                 if name in names:
                     break
             else:
                 raise error.UnknownCommand(name)
 
         rst = [minirst.section(header)]
 
         # description
         if not doc:
             rst.append(b"    %s\n" % _(b"(no help text available)"))
         if callable(doc):
             rst += [b"    %s\n" % l for l in doc(ui).splitlines()]
 
         if not ui.verbose:
             omitted = _(
                 b'(some details hidden, use --verbose'
                 b' to show complete help)'
             )
             indicateomitted(rst, omitted)
 
         try:
             cmdutil.findcmd(name, commands.table)
             rst.append(
                 _(b"\nuse 'hg help -c %s' to see help for the %s command\n")
                 % (name, name)
             )
         except error.UnknownCommand:
             pass
         return rst
 
     def helpext(name: bytes, subtopic: Optional[bytes] = None) -> List[bytes]:
         try:
             mod = extensions.find(name)
             doc = gettext(pycompat.getdoc(mod)) or _(b'no help text available')
         except KeyError:
             mod = None
             doc = extensions.disabled_help(name)
             if not doc:
                 raise error.UnknownCommand(name)
 
         if b'\n' not in doc:
             head, tail = doc, b""
         else:
             head, tail = doc.split(b'\n', 1)
         rst = [_(b'%s extension - %s\n\n') % (name.rpartition(b'.')[-1], head)]
         if tail:
             rst.extend(tail.splitlines(True))
             rst.append(b'\n')
 
         if not ui.verbose:
             omitted = _(
                 b'(some details hidden, use --verbose'
                 b' to show complete help)'
             )
             indicateomitted(rst, omitted)
 
         if mod:
             try:
                 ct = mod.cmdtable
             except AttributeError:
                 ct = {}
             modcmds = {c.partition(b'|')[0] for c in ct}
             rst.extend(helplist(modcmds.__contains__))
         else:
             rst.append(
                 _(
                     b"(use 'hg help extensions' for information on enabling"
                     b" extensions)\n"
                 )
             )
         return rst
 
     def helpextcmd(
         name: bytes, subtopic: Optional[bytes] = None
     ) -> List[bytes]:
         cmd, ext, doc = extensions.disabledcmd(
             ui, name, ui.configbool(b'ui', b'strict')
         )
         doc = stringutil.firstline(doc)
 
         rst = listexts(
             _(b"'%s' is provided by the following extension:") % cmd,
             {ext: doc},
             indent=4,
             showdeprecated=True,
         )
         rst.append(b'\n')
         rst.append(
             _(
                 b"(use 'hg help extensions' for information on enabling "
                 b"extensions)\n"
             )
         )
         return rst
 
     rst = []
     kw = opts.get(b'keyword')
     if kw or name is None and any(opts[o] for o in opts):
         matches = topicmatch(ui, commands, name or b'')
         helpareas = []
         if opts.get(b'extension'):
             helpareas += [(b'extensions', _(b'Extensions'))]
         if opts.get(b'command'):
             helpareas += [(b'commands', _(b'Commands'))]
         if not helpareas:
             helpareas = [
                 (b'topics', _(b'Topics')),
                 (b'commands', _(b'Commands')),
                 (b'extensions', _(b'Extensions')),
                 (b'extensioncommands', _(b'Extension Commands')),
             ]
         for t, title in helpareas:
             if matches[t]:
                 rst.append(b'%s:\n\n' % title)
                 rst.extend(minirst.maketable(sorted(matches[t]), 1))
                 rst.append(b'\n')
         if not rst:
             msg = _(b'no matches')
             hint = _(b"try 'hg help' for a list of topics")
             raise error.InputError(msg, hint=hint)
     elif name and name != b'shortlist':
         queries = []
         if unknowncmd:
             queries += [helpextcmd]
         if opts.get(b'extension'):
             queries += [helpext]
         if opts.get(b'command'):
             queries += [helpcmd]
         if not queries:
             queries = (helptopic, helpcmd, helpext, helpextcmd)
         for f in queries:
             try:
                 rst = f(name, subtopic)
                 break
             except error.UnknownCommand:
                 pass
         else:
             if unknowncmd:
                 raise error.UnknownCommand(name)
             else:
                 if fullname:
                     formatname = fullname
                 else:
                     formatname = name
                 if subtopic:
                     hintname = subtopic
                 else:
                     hintname = name
                 msg = _(b'no such help topic: %s') % formatname
                 hint = _(b"try 'hg help --keyword %s'") % hintname
                 raise error.InputError(msg, hint=hint)
     else:
         # program name
         if not ui.quiet:
             rst = [_(b"Mercurial Distributed SCM\n"), b'\n']
         rst.extend(helplist(None, **pycompat.strkwargs(opts)))
 
     return b''.join(rst)
 
 
 def formattedhelp(
     ui: uimod.ui,
     commands,
     fullname: Optional[bytes],
     keep: Optional[Iterable[bytes]] = None,
     unknowncmd: bool = False,
     full: bool = True,
     **opts
 ) -> bytes:
     """get help for a given topic (as a dotted name) as rendered rst
 
     Either returns the rendered help text or raises an exception.
     """
     if keep is None:
         keep = []
     else:
         keep = list(keep)  # make a copy so we can mutate this later
 
     # <fullname> := <name>[.<subtopic][.<section>]
     name = subtopic = section = None
     if fullname is not None:
         nameparts = fullname.split(b'.')
         name = nameparts.pop(0)
         if nameparts and name in subtopics:
             subtopic = nameparts.pop(0)
         if nameparts:
             section = encoding.lower(b'.'.join(nameparts))
 
     textwidth = ui.configint(b'ui', b'textwidth')
     termwidth = ui.termwidth() - 2
     if textwidth <= 0 or termwidth < textwidth:
         textwidth = termwidth
     text = help_(
         ui,
         commands,
         name,
         fullname=fullname,
         subtopic=subtopic,
         unknowncmd=unknowncmd,
         full=full,
         **opts
     )
 
     blocks, pruned = minirst.parse(text, keep=keep)
     if b'verbose' in pruned:
         keep.append(b'omitted')
     else:
         keep.append(b'notomitted')
     blocks, pruned = minirst.parse(text, keep=keep)
     if section:
         blocks = minirst.filtersections(blocks, section)
 
     # We could have been given a weird ".foo" section without a name
     # to look for, or we could have simply failed to found "foo.bar"
     # because bar isn't a section of foo
     if section and not (blocks and name):
         raise error.InputError(_(b"help section not found: %s") % fullname)
 
     return minirst.formatplain(blocks, textwidth)

mercurial/match.py

@@ -1,1664 +1,1664 b''
 # match.py - filename matching
 #
 #  Copyright 2008, 2009 Olivia Mackall <[e-mail]> and others
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import bisect
 import copy
 import itertools
 import os
 import re
 
 from .i18n import _
 from .pycompat import open
 from . import (
     encoding,
     error,
     pathutil,
     policy,
     pycompat,
     util,
 )
 from .utils import stringutil
 
 rustmod = policy.importrust('dirstate')
 
 allpatternkinds = (
     b're',
     b'glob',
     b'path',
     b'relglob',
     b'relpath',
     b'relre',
     b'rootglob',
     b'listfile',
     b'listfile0',
     b'set',
     b'include',
     b'subinclude',
     b'rootfilesin',
 )
 cwdrelativepatternkinds = (b'relpath', b'glob')
 
 propertycache = util.propertycache
 
 
 def _rematcher(regex):
     """compile the regexp with the best available regexp engine and return a
     matcher function"""
     m = util.re.compile(regex)
     try:
         # slightly faster, provided by facebook's re2 bindings
         return m.test_match
     except AttributeError:
         return m.match
 
 
 def _expandsets(cwd, kindpats, ctx=None, listsubrepos=False, badfn=None):
     '''Returns the kindpats list with the 'set' patterns expanded to matchers'''
     matchers = []
     other = []
 
     for kind, pat, source in kindpats:
         if kind == b'set':
             if ctx is None:
                 raise error.ProgrammingError(
                     b"fileset expression with no context"
                 )
             matchers.append(ctx.matchfileset(cwd, pat, badfn=badfn))
 
             if listsubrepos:
                 for subpath in ctx.substate:
                     sm = ctx.sub(subpath).matchfileset(cwd, pat, badfn=badfn)
                     pm = prefixdirmatcher(subpath, sm, badfn=badfn)
                     matchers.append(pm)
 
             continue
         other.append((kind, pat, source))
     return matchers, other
 
 
 def _expandsubinclude(kindpats, root):
     """Returns the list of subinclude matcher args and the kindpats without the
     subincludes in it."""
     relmatchers = []
     other = []
 
     for kind, pat, source in kindpats:
         if kind == b'subinclude':
             sourceroot = pathutil.dirname(util.normpath(source))
             pat = util.pconvert(pat)
             path = pathutil.join(sourceroot, pat)
 
             newroot = pathutil.dirname(path)
             matcherargs = (newroot, b'', [], [b'include:%s' % path])
 
             prefix = pathutil.canonpath(root, root, newroot)
             if prefix:
                 prefix += b'/'
             relmatchers.append((prefix, matcherargs))
         else:
             other.append((kind, pat, source))
 
     return relmatchers, other
 
 
 def _kindpatsalwaysmatch(kindpats):
     """Checks whether the kindspats match everything, as e.g.
     'relpath:.' does.
     """
     for kind, pat, source in kindpats:
         if pat != b'' or kind not in [b'relpath', b'glob']:
             return False
     return True
 
 
 def _buildkindpatsmatcher(
     matchercls,
     root,
     cwd,
     kindpats,
     ctx=None,
     listsubrepos=False,
     badfn=None,
 ):
     matchers = []
     fms, kindpats = _expandsets(
         cwd,
         kindpats,
         ctx=ctx,
         listsubrepos=listsubrepos,
         badfn=badfn,
     )
     if kindpats:
         m = matchercls(root, kindpats, badfn=badfn)
         matchers.append(m)
     if fms:
         matchers.extend(fms)
     if not matchers:
         return nevermatcher(badfn=badfn)
     if len(matchers) == 1:
         return matchers[0]
     return unionmatcher(matchers)
 
 
 def match(
     root,
     cwd,
     patterns=None,
     include=None,
     exclude=None,
     default=b'glob',
     auditor=None,
     ctx=None,
     listsubrepos=False,
     warn=None,
     badfn=None,
     icasefs=False,
 ):
     r"""build an object to match a set of file patterns
 
     arguments:
     root - the canonical root of the tree you're matching against
     cwd - the current working directory, if relevant
     patterns - patterns to find
     include - patterns to include (unless they are excluded)
     exclude - patterns to exclude (even if they are included)
     default - if a pattern in patterns has no explicit type, assume this one
     auditor - optional path auditor
     ctx - optional changecontext
     listsubrepos - if True, recurse into subrepositories
     warn - optional function used for printing warnings
     badfn - optional bad() callback for this matcher instead of the default
     icasefs - make a matcher for wdir on case insensitive filesystems, which
         normalizes the given patterns to the case in the filesystem
 
     a pattern is one of:
     'glob:<glob>' - a glob relative to cwd
     're:<regexp>' - a regular expression
     'path:<path>' - a path relative to repository root, which is matched
                     recursively
     'rootfilesin:<path>' - a path relative to repository root, which is
                     matched non-recursively (will not match subdirectories)
     'relglob:<glob>' - an unrooted glob (*.c matches C files in all dirs)
     'relpath:<path>' - a path relative to cwd
     'relre:<regexp>' - a regexp that needn't match the start of a name
     'set:<fileset>' - a fileset expression
     'include:<path>' - a file of patterns to read and include
     'subinclude:<path>' - a file of patterns to match against files under
                           the same directory
     '<something>' - a pattern of the specified default type
 
     >>> def _match(root, *args, **kwargs):
     ...     return match(util.localpath(root), *args, **kwargs)
 
     Usually a patternmatcher is returned:
     >>> _match(b'/foo', b'.', [b're:.*\.c$', b'path:foo/a', b'*.py'])
     <patternmatcher patterns='.*\\.c$|foo/a(?:/|$)|[^/]*\\.py$'>
 
     Combining 'patterns' with 'include' (resp. 'exclude') gives an
     intersectionmatcher (resp. a differencematcher):
     >>> type(_match(b'/foo', b'.', [b're:.*\.c$'], include=[b'path:lib']))
     <class 'mercurial.match.intersectionmatcher'>
     >>> type(_match(b'/foo', b'.', [b're:.*\.c$'], exclude=[b'path:build']))
     <class 'mercurial.match.differencematcher'>
 
     Notice that, if 'patterns' is empty, an alwaysmatcher is returned:
     >>> _match(b'/foo', b'.', [])
     <alwaysmatcher>
 
     The 'default' argument determines which kind of pattern is assumed if a
     pattern has no prefix:
     >>> _match(b'/foo', b'.', [b'.*\.c$'], default=b're')
     <patternmatcher patterns='.*\\.c$'>
     >>> _match(b'/foo', b'.', [b'main.py'], default=b'relpath')
     <patternmatcher patterns='main\\.py(?:/|$)'>
     >>> _match(b'/foo', b'.', [b'main.py'], default=b're')
     <patternmatcher patterns='main.py'>
 
     The primary use of matchers is to check whether a value (usually a file
     name) matches againset one of the patterns given at initialization. There
     are two ways of doing this check.
 
     >>> m = _match(b'/foo', b'', [b're:.*\.c$', b'relpath:a'])
 
     1. Calling the matcher with a file name returns True if any pattern
     matches that file name:
     >>> m(b'a')
     True
     >>> m(b'main.c')
     True
     >>> m(b'test.py')
     False
 
     2. Using the exact() method only returns True if the file name matches one
     of the exact patterns (i.e. not re: or glob: patterns):
     >>> m.exact(b'a')
     True
     >>> m.exact(b'main.c')
     False
     """
     assert os.path.isabs(root)
     cwd = os.path.join(root, util.localpath(cwd))
     normalize = _donormalize
     if icasefs:
         dirstate = ctx.repo().dirstate
         dsnormalize = dirstate.normalize
 
         def normalize(patterns, default, root, cwd, auditor, warn):
             kp = _donormalize(patterns, default, root, cwd, auditor, warn)
             kindpats = []
             for kind, pats, source in kp:
                 if kind not in (b're', b'relre'):  # regex can't be normalized
                     p = pats
                     pats = dsnormalize(pats)
 
                     # Preserve the original to handle a case only rename.
                     if p != pats and p in dirstate:
                         kindpats.append((kind, p, source))
 
                 kindpats.append((kind, pats, source))
             return kindpats
 
     if patterns:
         kindpats = normalize(patterns, default, root, cwd, auditor, warn)
         if _kindpatsalwaysmatch(kindpats):
             m = alwaysmatcher(badfn)
         else:
             m = _buildkindpatsmatcher(
                 patternmatcher,
                 root,
                 cwd,
                 kindpats,
                 ctx=ctx,
                 listsubrepos=listsubrepos,
                 badfn=badfn,
             )
     else:
         # It's a little strange that no patterns means to match everything.
         # Consider changing this to match nothing (probably using nevermatcher).
         m = alwaysmatcher(badfn)
 
     if include:
         kindpats = normalize(include, b'glob', root, cwd, auditor, warn)
         im = _buildkindpatsmatcher(
             includematcher,
             root,
             cwd,
             kindpats,
             ctx=ctx,
             listsubrepos=listsubrepos,
             badfn=None,
         )
         m = intersectmatchers(m, im)
     if exclude:
         kindpats = normalize(exclude, b'glob', root, cwd, auditor, warn)
         em = _buildkindpatsmatcher(
             includematcher,
             root,
             cwd,
             kindpats,
             ctx=ctx,
             listsubrepos=listsubrepos,
             badfn=None,
         )
         m = differencematcher(m, em)
     return m
 
 
 def exact(files, badfn=None):
     return exactmatcher(files, badfn=badfn)
 
 
 def always(badfn=None):
     return alwaysmatcher(badfn)
 
 
 def never(badfn=None):
     return nevermatcher(badfn)
 
 
 def badmatch(match, badfn):
     """Make a copy of the given matcher, replacing its bad method with the given
     one.
     """
     m = copy.copy(match)
     m.bad = badfn
     return m
 
 
 def _donormalize(patterns, default, root, cwd, auditor=None, warn=None):
     """Convert 'kind:pat' from the patterns list to tuples with kind and
     normalized and rooted patterns and with listfiles expanded."""
     kindpats = []
     for kind, pat in [_patsplit(p, default) for p in patterns]:
         if kind in cwdrelativepatternkinds:
             pat = pathutil.canonpath(root, cwd, pat, auditor=auditor)
         elif kind in (b'relglob', b'path', b'rootfilesin', b'rootglob'):
             pat = util.normpath(pat)
         elif kind in (b'listfile', b'listfile0'):
             try:
                 files = util.readfile(pat)
                 if kind == b'listfile0':
                     files = files.split(b'\0')
                 else:
                     files = files.splitlines()
                 files = [f for f in files if f]
             except EnvironmentError:
                 raise error.Abort(_(b"unable to read file list (%s)") % pat)
             for k, p, source in _donormalize(
                 files, default, root, cwd, auditor, warn
             ):
                 kindpats.append((k, p, pat))
             continue
         elif kind == b'include':
             try:
                 fullpath = os.path.join(root, util.localpath(pat))
                 includepats = readpatternfile(fullpath, warn)
                 for k, p, source in _donormalize(
                     includepats, default, root, cwd, auditor, warn
                 ):
                     kindpats.append((k, p, source or pat))
             except error.Abort as inst:
                 raise error.Abort(
                     b'%s: %s'
                     % (
                         pat,
                         inst.message,
                     )  # pytype: disable=unsupported-operands
                 )
             except IOError as inst:
                 if warn:
                     warn(
                         _(b"skipping unreadable pattern file '%s': %s\n")
                         % (pat, stringutil.forcebytestr(inst.strerror))
                     )
             continue
         # else: re or relre - which cannot be normalized
         kindpats.append((kind, pat, b''))
     return kindpats
 
 
 class basematcher:
     def __init__(self, badfn=None):
         if badfn is not None:
             self.bad = badfn
 
     def __call__(self, fn):
         return self.matchfn(fn)
 
     # Callbacks related to how the matcher is used by dirstate.walk.
     # Subscribers to these events must monkeypatch the matcher object.
     def bad(self, f, msg):
         """Callback from dirstate.walk for each explicit file that can't be
         found/accessed, with an error message."""
 
     # If an traversedir is set, it will be called when a directory discovered
     # by recursive traversal is visited.
     traversedir = None
 
     @propertycache
     def _files(self):
         return []
 
     def files(self):
         """Explicitly listed files or patterns or roots:
         if no patterns or .always(): empty list,
         if exact: list exact files,
         if not .anypats(): list all files and dirs,
         else: optimal roots"""
         return self._files
 
     @propertycache
     def _fileset(self):
         return set(self._files)
 
     def exact(self, f):
         '''Returns True if f is in .files().'''
         return f in self._fileset
 
     def matchfn(self, f):
         return False
 
     def visitdir(self, dir):
         """Decides whether a directory should be visited based on whether it
         has potential matches in it or one of its subdirectories. This is
         based on the match's primary, included, and excluded patterns.
 
         Returns the string 'all' if the given directory and all subdirectories
         should be visited. Otherwise returns True or False indicating whether
         the given directory should be visited.
         """
         return True
 
     def visitchildrenset(self, dir):
         """Decides whether a directory should be visited based on whether it
         has potential matches in it or one of its subdirectories, and
         potentially lists which subdirectories of that directory should be
         visited. This is based on the match's primary, included, and excluded
         patterns.
 
         This function is very similar to 'visitdir', and the following mapping
         can be applied:
 
              visitdir | visitchildrenlist
             ----------+-------------------
              False    | set()
              'all'    | 'all'
              True     | 'this' OR non-empty set of subdirs -or files- to visit
 
         Example:
           Assume matchers ['path:foo/bar', 'rootfilesin:qux'], we would return
           the following values (assuming the implementation of visitchildrenset
           is capable of recognizing this; some implementations are not).
 
           '' -> {'foo', 'qux'}
           'baz' -> set()
           'foo' -> {'bar'}
           # Ideally this would be 'all', but since the prefix nature of matchers
           # is applied to the entire matcher, we have to downgrade this to
           # 'this' due to the non-prefix 'rootfilesin'-kind matcher being mixed
           # in.
           'foo/bar' -> 'this'
           'qux' -> 'this'
 
         Important:
           Most matchers do not know if they're representing files or
           directories. They see ['path:dir/f'] and don't know whether 'f' is a
           file or a directory, so visitchildrenset('dir') for most matchers will
           return {'f'}, but if the matcher knows it's a file (like exactmatcher
           does), it may return 'this'. Do not rely on the return being a set
           indicating that there are no files in this dir to investigate (or
           equivalently that if there are files to investigate in 'dir' that it
           will always return 'this').
         """
         return b'this'
 
     def always(self):
         """Matcher will match everything and .files() will be empty --
         optimization might be possible."""
         return False
 
     def isexact(self):
         """Matcher will match exactly the list of files in .files() --
         optimization might be possible."""
         return False
 
     def prefix(self):
         """Matcher will match the paths in .files() recursively --
         optimization might be possible."""
         return False
 
     def anypats(self):
         """None of .always(), .isexact(), and .prefix() is true --
         optimizations will be difficult."""
         return not self.always() and not self.isexact() and not self.prefix()
 
 
 class alwaysmatcher(basematcher):
     '''Matches everything.'''
 
     def __init__(self, badfn=None):
         super(alwaysmatcher, self).__init__(badfn)
 
     def always(self):
         return True
 
     def matchfn(self, f):
         return True
 
     def visitdir(self, dir):
         return b'all'
 
     def visitchildrenset(self, dir):
         return b'all'
 
     def __repr__(self):
         return r'<alwaysmatcher>'
 
 
 class nevermatcher(basematcher):
     '''Matches nothing.'''
 
     def __init__(self, badfn=None):
         super(nevermatcher, self).__init__(badfn)
 
     # It's a little weird to say that the nevermatcher is an exact matcher
     # or a prefix matcher, but it seems to make sense to let callers take
     # fast paths based on either. There will be no exact matches, nor any
     # prefixes (files() returns []), so fast paths iterating over them should
     # be efficient (and correct).
     def isexact(self):
         return True
 
     def prefix(self):
         return True
 
     def visitdir(self, dir):
         return False
 
     def visitchildrenset(self, dir):
         return set()
 
     def __repr__(self):
         return r'<nevermatcher>'
 
 
 class predicatematcher(basematcher):
     """A matcher adapter for a simple boolean function"""
 
     def __init__(self, predfn, predrepr=None, badfn=None):
         super(predicatematcher, self).__init__(badfn)
         self.matchfn = predfn
         self._predrepr = predrepr
 
     @encoding.strmethod
     def __repr__(self):
         s = stringutil.buildrepr(self._predrepr) or pycompat.byterepr(
             self.matchfn
         )
         return b'<predicatenmatcher pred=%s>' % s
 
 
 def path_or_parents_in_set(path, prefix_set):
     """Returns True if `path` (or any parent of `path`) is in `prefix_set`."""
     l = len(prefix_set)
     if l == 0:
         return False
     if path in prefix_set:
         return True
     # If there's more than 5 paths in prefix_set, it's *probably* quicker to
     # "walk up" the directory hierarchy instead, with the assumption that most
     # directory hierarchies are relatively shallow and hash lookup is cheap.
     if l > 5:
         return any(
             parentdir in prefix_set for parentdir in pathutil.finddirs(path)
         )
 
     # FIXME: Ideally we'd never get to this point if this is the case - we'd
     # recognize ourselves as an 'always' matcher and skip this.
     if b'' in prefix_set:
         return True
 
     sl = ord(b'/')
 
     # We already checked that path isn't in prefix_set exactly, so
     # `path[len(pf)] should never raise IndexError.
     return any(path.startswith(pf) and path[len(pf)] == sl for pf in prefix_set)
 
 
 class patternmatcher(basematcher):
     r"""Matches a set of (kind, pat, source) against a 'root' directory.
 
     >>> kindpats = [
     ...     (b're', br'.*\.c$', b''),
     ...     (b'path', b'foo/a', b''),
     ...     (b'relpath', b'b', b''),
     ...     (b'glob', b'*.h', b''),
     ... ]
     >>> m = patternmatcher(b'foo', kindpats)
     >>> m(b'main.c')  # matches re:.*\.c$
     True
     >>> m(b'b.txt')
     False
     >>> m(b'foo/a')  # matches path:foo/a
     True
     >>> m(b'a')  # does not match path:b, since 'root' is 'foo'
     False
     >>> m(b'b')  # matches relpath:b, since 'root' is 'foo'
     True
     >>> m(b'lib.h')  # matches glob:*.h
     True
 
     >>> m.files()
     ['', 'foo/a', 'b', '']
     >>> m.exact(b'foo/a')
     True
     >>> m.exact(b'b')
     True
     >>> m.exact(b'lib.h')  # exact matches are for (rel)path kinds
     False
     """
 
     def __init__(self, root, kindpats, badfn=None):
         super(patternmatcher, self).__init__(badfn)
 
         self._files = _explicitfiles(kindpats)
         self._prefix = _prefix(kindpats)
         self._pats, self.matchfn = _buildmatch(kindpats, b'$', root)
 
     @propertycache
     def _dirs(self):
         return set(pathutil.dirs(self._fileset))
 
     def visitdir(self, dir):
         if self._prefix and dir in self._fileset:
             return b'all'
         return dir in self._dirs or path_or_parents_in_set(dir, self._fileset)
 
     def visitchildrenset(self, dir):
         ret = self.visitdir(dir)
         if ret is True:
             return b'this'
         elif not ret:
             return set()
         assert ret == b'all'
         return b'all'
 
     def prefix(self):
         return self._prefix
 
     @encoding.strmethod
     def __repr__(self):
         return b'<patternmatcher patterns=%r>' % pycompat.bytestr(self._pats)
 
 
 # This is basically a reimplementation of pathutil.dirs that stores the
 # children instead of just a count of them, plus a small optional optimization
 # to avoid some directories we don't need.
 class _dirchildren:
     def __init__(self, paths, onlyinclude=None):
         self._dirs = {}
         self._onlyinclude = onlyinclude or []
         addpath = self.addpath
         for f in paths:
             addpath(f)
 
     def addpath(self, path):
         if path == b'':
             return
         dirs = self._dirs
         findsplitdirs = _dirchildren._findsplitdirs
         for d, b in findsplitdirs(path):
             if d not in self._onlyinclude:
                 continue
             dirs.setdefault(d, set()).add(b)
 
     @staticmethod
     def _findsplitdirs(path):
         # yields (dirname, basename) tuples, walking back to the root.  This is
         # very similar to pathutil.finddirs, except:
         #  - produces a (dirname, basename) tuple, not just 'dirname'
         # Unlike manifest._splittopdir, this does not suffix `dirname` with a
         # slash.
         oldpos = len(path)
         pos = path.rfind(b'/')
         while pos != -1:
             yield path[:pos], path[pos + 1 : oldpos]
             oldpos = pos
             pos = path.rfind(b'/', 0, pos)
         yield b'', path[:oldpos]
 
     def get(self, path):
         return self._dirs.get(path, set())
 
 
 class includematcher(basematcher):
     def __init__(self, root, kindpats, badfn=None):
         super(includematcher, self).__init__(badfn)
         if rustmod is not None:
             # We need to pass the patterns to Rust because they can contain
             # patterns from the user interface
             self._kindpats = kindpats
         self._pats, self.matchfn = _buildmatch(kindpats, b'(?:/|$)', root)
         self._prefix = _prefix(kindpats)
         roots, dirs, parents = _rootsdirsandparents(kindpats)
         # roots are directories which are recursively included.
         self._roots = set(roots)
         # dirs are directories which are non-recursively included.
         self._dirs = set(dirs)
         # parents are directories which are non-recursively included because
         # they are needed to get to items in _dirs or _roots.
         self._parents = parents
 
     def visitdir(self, dir):
         if self._prefix and dir in self._roots:
             return b'all'
         return (
             dir in self._dirs
             or dir in self._parents
             or path_or_parents_in_set(dir, self._roots)
         )
 
     @propertycache
     def _allparentschildren(self):
         # It may seem odd that we add dirs, roots, and parents, and then
         # restrict to only parents. This is to catch the case of:
         #   dirs = ['foo/bar']
         #   parents = ['foo']
         # if we asked for the children of 'foo', but had only added
         # self._parents, we wouldn't be able to respond ['bar'].
         return _dirchildren(
             itertools.chain(self._dirs, self._roots, self._parents),
             onlyinclude=self._parents,
         )
 
     def visitchildrenset(self, dir):
         if self._prefix and dir in self._roots:
             return b'all'
         # Note: this does *not* include the 'dir in self._parents' case from
         # visitdir, that's handled below.
         if (
             b'' in self._roots
             or dir in self._dirs
             or path_or_parents_in_set(dir, self._roots)
         ):
             return b'this'
 
         if dir in self._parents:
             return self._allparentschildren.get(dir) or set()
         return set()
 
     @encoding.strmethod
     def __repr__(self):
         return b'<includematcher includes=%r>' % pycompat.bytestr(self._pats)
 
 
 class exactmatcher(basematcher):
     r"""Matches the input files exactly. They are interpreted as paths, not
     patterns (so no kind-prefixes).
 
     >>> m = exactmatcher([b'a.txt', br're:.*\.c$'])
     >>> m(b'a.txt')
     True
     >>> m(b'b.txt')
     False
 
     Input files that would be matched are exactly those returned by .files()
     >>> m.files()
     ['a.txt', 're:.*\\.c$']
 
     So pattern 're:.*\.c$' is not considered as a regex, but as a file name
     >>> m(b'main.c')
     False
     >>> m(br're:.*\.c$')
     True
     """
 
     def __init__(self, files, badfn=None):
         super(exactmatcher, self).__init__(badfn)
 
         if isinstance(files, list):
             self._files = files
         else:
             self._files = list(files)
 
     matchfn = basematcher.exact
 
     @propertycache
     def _dirs(self):
         return set(pathutil.dirs(self._fileset))
 
     def visitdir(self, dir):
         return dir in self._dirs
 
     @propertycache
     def _visitchildrenset_candidates(self):
         """A memoized set of candidates for visitchildrenset."""
         return self._fileset | self._dirs - {b''}
 
     @propertycache
     def _sorted_visitchildrenset_candidates(self):
         """A memoized sorted list of candidates for visitchildrenset."""
         return sorted(self._visitchildrenset_candidates)
 
     def visitchildrenset(self, dir):
         if not self._fileset or dir not in self._dirs:
             return set()
 
         if dir == b'':
             candidates = self._visitchildrenset_candidates
         else:
             candidates = self._sorted_visitchildrenset_candidates
             d = dir + b'/'
             # Use bisect to find the first element potentially starting with d
             # (i.e. >= d). This should always find at least one element (we'll
             # assert later if this is not the case).
             first = bisect.bisect_left(candidates, d)
             # We need a representation of the first element that is > d that
             # does not start with d, so since we added a `/` on the end of dir,
             # we'll add whatever comes after slash (we could probably assume
             # that `0` is after `/`, but let's not) to the end of dir instead.
             dnext = dir + encoding.strtolocal(chr(ord(b'/') + 1))
             # Use bisect to find the first element >= d_next
             last = bisect.bisect_left(candidates, dnext, lo=first)
             dlen = len(d)
             candidates = {c[dlen:] for c in candidates[first:last]}
         # self._dirs includes all of the directories, recursively, so if
         # we're attempting to match foo/bar/baz.txt, it'll have '', 'foo',
         # 'foo/bar' in it. Thus we can safely ignore a candidate that has a
         # '/' in it, indicating a it's for a subdir-of-a-subdir; the
         # immediate subdir will be in there without a slash.
         ret = {c for c in candidates if b'/' not in c}
         # We really do not expect ret to be empty, since that would imply that
         # there's something in _dirs that didn't have a file in _fileset.
         assert ret
         return ret
 
     def isexact(self):
         return True
 
     @encoding.strmethod
     def __repr__(self):
         return b'<exactmatcher files=%r>' % self._files
 
 
 class differencematcher(basematcher):
     """Composes two matchers by matching if the first matches and the second
     does not.
 
     The second matcher's non-matching-attributes (bad, traversedir) are ignored.
     """
 
     def __init__(self, m1, m2):
         super(differencematcher, self).__init__()
         self._m1 = m1
         self._m2 = m2
         self.bad = m1.bad
         self.traversedir = m1.traversedir
 
     def matchfn(self, f):
         return self._m1(f) and not self._m2(f)
 
     @propertycache
     def _files(self):
         if self.isexact():
             return [f for f in self._m1.files() if self(f)]
         # If m1 is not an exact matcher, we can't easily figure out the set of
         # files, because its files() are not always files. For example, if
         # m1 is "path:dir" and m2 is "rootfileins:.", we don't
         # want to remove "dir" from the set even though it would match m2,
         # because the "dir" in m1 may not be a file.
         return self._m1.files()
 
     def visitdir(self, dir):
         if self._m2.visitdir(dir) == b'all':
             return False
         elif not self._m2.visitdir(dir):
             # m2 does not match dir, we can return 'all' here if possible
             return self._m1.visitdir(dir)
         return bool(self._m1.visitdir(dir))
 
     def visitchildrenset(self, dir):
         m2_set = self._m2.visitchildrenset(dir)
         if m2_set == b'all':
             return set()
         m1_set = self._m1.visitchildrenset(dir)
         # Possible values for m1: 'all', 'this', set(...), set()
         # Possible values for m2:        'this', set(...), set()
         # If m2 has nothing under here that we care about, return m1, even if
         # it's 'all'. This is a change in behavior from visitdir, which would
         # return True, not 'all', for some reason.
         if not m2_set:
             return m1_set
         if m1_set in [b'all', b'this']:
             # Never return 'all' here if m2_set is any kind of non-empty (either
             # 'this' or set(foo)), since m2 might return set() for a
             # subdirectory.
             return b'this'
         # Possible values for m1:         set(...), set()
         # Possible values for m2: 'this', set(...)
         # We ignore m2's set results. They're possibly incorrect:
         #  m1 = path:dir/subdir, m2=rootfilesin:dir, visitchildrenset(''):
         #    m1 returns {'dir'}, m2 returns {'dir'}, if we subtracted we'd
         #    return set(), which is *not* correct, we still need to visit 'dir'!
         return m1_set
 
     def isexact(self):
         return self._m1.isexact()
 
     @encoding.strmethod
     def __repr__(self):
         return b'<differencematcher m1=%r, m2=%r>' % (self._m1, self._m2)
 
 
 def intersectmatchers(m1, m2):
     """Composes two matchers by matching if both of them match.
 
     The second matcher's non-matching-attributes (bad, traversedir) are ignored.
     """
     if m1 is None or m2 is None:
         return m1 or m2
     if m1.always():
         m = copy.copy(m2)
         # TODO: Consider encapsulating these things in a class so there's only
         # one thing to copy from m1.
         m.bad = m1.bad
         m.traversedir = m1.traversedir
         return m
     if m2.always():
         m = copy.copy(m1)
         return m
     return intersectionmatcher(m1, m2)
 
 
 class intersectionmatcher(basematcher):
     def __init__(self, m1, m2):
         super(intersectionmatcher, self).__init__()
         self._m1 = m1
         self._m2 = m2
         self.bad = m1.bad
         self.traversedir = m1.traversedir
 
     @propertycache
     def _files(self):
         if self.isexact():
             m1, m2 = self._m1, self._m2
             if not m1.isexact():
                 m1, m2 = m2, m1
             return [f for f in m1.files() if m2(f)]
         # It neither m1 nor m2 is an exact matcher, we can't easily intersect
         # the set of files, because their files() are not always files. For
         # example, if intersecting a matcher "-I glob:foo.txt" with matcher of
         # "path:dir2", we don't want to remove "dir2" from the set.
         return self._m1.files() + self._m2.files()
 
     def matchfn(self, f):
         return self._m1(f) and self._m2(f)
 
     def visitdir(self, dir):
         visit1 = self._m1.visitdir(dir)
         if visit1 == b'all':
             return self._m2.visitdir(dir)
         # bool() because visit1=True + visit2='all' should not be 'all'
         return bool(visit1 and self._m2.visitdir(dir))
 
     def visitchildrenset(self, dir):
         m1_set = self._m1.visitchildrenset(dir)
         if not m1_set:
             return set()
         m2_set = self._m2.visitchildrenset(dir)
         if not m2_set:
             return set()
 
         if m1_set == b'all':
             return m2_set
         elif m2_set == b'all':
             return m1_set
 
         if m1_set == b'this' or m2_set == b'this':
             return b'this'
 
         assert isinstance(m1_set, set) and isinstance(m2_set, set)
         return m1_set.intersection(m2_set)
 
     def always(self):
         return self._m1.always() and self._m2.always()
 
     def isexact(self):
         return self._m1.isexact() or self._m2.isexact()
 
     @encoding.strmethod
     def __repr__(self):
         return b'<intersectionmatcher m1=%r, m2=%r>' % (self._m1, self._m2)
 
 
 class subdirmatcher(basematcher):
     """Adapt a matcher to work on a subdirectory only.
 
     The paths are remapped to remove/insert the path as needed:
 
     >>> from . import pycompat
     >>> m1 = match(util.localpath(b'/root'), b'', [b'a.txt', b'sub/b.txt'], auditor=lambda name: None)
     >>> m2 = subdirmatcher(b'sub', m1)
     >>> m2(b'a.txt')
     False
     >>> m2(b'b.txt')
     True
     >>> m2.matchfn(b'a.txt')
     False
     >>> m2.matchfn(b'b.txt')
     True
     >>> m2.files()
     ['b.txt']
     >>> m2.exact(b'b.txt')
     True
     >>> def bad(f, msg):
     ...     print(pycompat.sysstr(b"%s: %s" % (f, msg)))
     >>> m1.bad = bad
     >>> m2.bad(b'x.txt', b'No such file')
     sub/x.txt: No such file
     """
 
     def __init__(self, path, matcher):
         super(subdirmatcher, self).__init__()
         self._path = path
         self._matcher = matcher
         self._always = matcher.always()
 
         self._files = [
             f[len(path) + 1 :]
             for f in matcher._files
             if f.startswith(path + b"/")
         ]
 
         # If the parent repo had a path to this subrepo and the matcher is
         # a prefix matcher, this submatcher always matches.
         if matcher.prefix():
             self._always = any(f == path for f in matcher._files)
 
     def bad(self, f, msg):
         self._matcher.bad(self._path + b"/" + f, msg)
 
     def matchfn(self, f):
         # Some information is lost in the superclass's constructor, so we
         # can not accurately create the matching function for the subdirectory
         # from the inputs. Instead, we override matchfn() and visitdir() to
         # call the original matcher with the subdirectory path prepended.
         return self._matcher.matchfn(self._path + b"/" + f)
 
     def visitdir(self, dir):
         if dir == b'':
             dir = self._path
         else:
             dir = self._path + b"/" + dir
         return self._matcher.visitdir(dir)
 
     def visitchildrenset(self, dir):
         if dir == b'':
             dir = self._path
         else:
             dir = self._path + b"/" + dir
         return self._matcher.visitchildrenset(dir)
 
     def always(self):
         return self._always
 
     def prefix(self):
         return self._matcher.prefix() and not self._always
 
     @encoding.strmethod
     def __repr__(self):
         return b'<subdirmatcher path=%r, matcher=%r>' % (
             self._path,
             self._matcher,
         )
 
 
 class prefixdirmatcher(basematcher):
     """Adapt a matcher to work on a parent directory.
 
     The matcher's non-matching-attributes (bad, traversedir) are ignored.
 
     The prefix path should usually be the relative path from the root of
     this matcher to the root of the wrapped matcher.
 
     >>> m1 = match(util.localpath(b'/root/d/e'), b'f', [b'../a.txt', b'b.txt'], auditor=lambda name: None)
     >>> m2 = prefixdirmatcher(b'd/e', m1)
     >>> m2(b'a.txt')
     False
     >>> m2(b'd/e/a.txt')
     True
     >>> m2(b'd/e/b.txt')
     False
     >>> m2.files()
     ['d/e/a.txt', 'd/e/f/b.txt']
     >>> m2.exact(b'd/e/a.txt')
     True
     >>> m2.visitdir(b'd')
     True
     >>> m2.visitdir(b'd/e')
     True
     >>> m2.visitdir(b'd/e/f')
     True
     >>> m2.visitdir(b'd/e/g')
     False
     >>> m2.visitdir(b'd/ef')
     False
     """
 
     def __init__(self, path, matcher, badfn=None):
         super(prefixdirmatcher, self).__init__(badfn)
         if not path:
             raise error.ProgrammingError(b'prefix path must not be empty')
         self._path = path
         self._pathprefix = path + b'/'
         self._matcher = matcher
 
     @propertycache
     def _files(self):
         return [self._pathprefix + f for f in self._matcher._files]
 
     def matchfn(self, f):
         if not f.startswith(self._pathprefix):
             return False
         return self._matcher.matchfn(f[len(self._pathprefix) :])
 
     @propertycache
     def _pathdirs(self):
         return set(pathutil.finddirs(self._path))
 
     def visitdir(self, dir):
         if dir == self._path:
             return self._matcher.visitdir(b'')
         if dir.startswith(self._pathprefix):
             return self._matcher.visitdir(dir[len(self._pathprefix) :])
         return dir in self._pathdirs
 
     def visitchildrenset(self, dir):
         if dir == self._path:
             return self._matcher.visitchildrenset(b'')
         if dir.startswith(self._pathprefix):
             return self._matcher.visitchildrenset(dir[len(self._pathprefix) :])
         if dir in self._pathdirs:
             return b'this'
         return set()
 
     def isexact(self):
         return self._matcher.isexact()
 
     def prefix(self):
         return self._matcher.prefix()
 
     @encoding.strmethod
     def __repr__(self):
         return b'<prefixdirmatcher path=%r, matcher=%r>' % (
             pycompat.bytestr(self._path),
             self._matcher,
         )
 
 
 class unionmatcher(basematcher):
     """A matcher that is the union of several matchers.
 
     The non-matching-attributes (bad, traversedir) are taken from the first
     matcher.
     """
 
     def __init__(self, matchers):
         m1 = matchers[0]
         super(unionmatcher, self).__init__()
         self.traversedir = m1.traversedir
         self._matchers = matchers
 
     def matchfn(self, f):
         for match in self._matchers:
             if match(f):
                 return True
         return False
 
     def visitdir(self, dir):
         r = False
         for m in self._matchers:
             v = m.visitdir(dir)
             if v == b'all':
                 return v
             r |= v
         return r
 
     def visitchildrenset(self, dir):
         r = set()
         this = False
         for m in self._matchers:
             v = m.visitchildrenset(dir)
             if not v:
                 continue
             if v == b'all':
                 return v
             if this or v == b'this':
                 this = True
                 # don't break, we might have an 'all' in here.
                 continue
             assert isinstance(v, set)
             r = r.union(v)
         if this:
             return b'this'
         return r
 
     @encoding.strmethod
     def __repr__(self):
         return b'<unionmatcher matchers=%r>' % self._matchers
 
 
 def patkind(pattern, default=None):
     r"""If pattern is 'kind:pat' with a known kind, return kind.
 
     >>> patkind(br're:.*\.c$')
     're'
     >>> patkind(b'glob:*.c')
     'glob'
     >>> patkind(b'relpath:test.py')
     'relpath'
     >>> patkind(b'main.py')
     >>> patkind(b'main.py', default=b're')
     're'
     """
     return _patsplit(pattern, default)[0]
 
 
 def _patsplit(pattern, default):
     """Split a string into the optional pattern kind prefix and the actual
     pattern."""
     if b':' in pattern:
         kind, pat = pattern.split(b':', 1)
         if kind in allpatternkinds:
             return kind, pat
     return default, pattern
 
 
 def _globre(pat):
     r"""Convert an extended glob string to a regexp string.
 
     >>> from . import pycompat
     >>> def bprint(s):
     ...     print(pycompat.sysstr(s))
     >>> bprint(_globre(br'?'))
     .
     >>> bprint(_globre(br'*'))
     [^/]*
     >>> bprint(_globre(br'**'))
     .*
     >>> bprint(_globre(br'**/a'))
     (?:.*/)?a
     >>> bprint(_globre(br'a/**/b'))
     a/(?:.*/)?b
     >>> bprint(_globre(br'[a*?!^][^b][!c]'))
     [a*?!^][\^b][^c]
     >>> bprint(_globre(br'{a,b}'))
     (?:a|b)
     >>> bprint(_globre(br'.\*\?'))
     \.\*\?
     """
     i, n = 0, len(pat)
     res = b''
     group = 0
     escape = util.stringutil.regexbytesescapemap.get
 
     def peek():
         return i < n and pat[i : i + 1]
 
     while i < n:
         c = pat[i : i + 1]
         i += 1
         if c not in b'*?[{},\\':
             res += escape(c, c)
         elif c == b'*':
             if peek() == b'*':
                 i += 1
                 if peek() == b'/':
                     i += 1
                     res += b'(?:.*/)?'
                 else:
                     res += b'.*'
             else:
                 res += b'[^/]*'
         elif c == b'?':
             res += b'.'
         elif c == b'[':
             j = i
             if j < n and pat[j : j + 1] in b'!]':
                 j += 1
             while j < n and pat[j : j + 1] != b']':
                 j += 1
             if j >= n:
                 res += b'\\['
             else:
                 stuff = pat[i:j].replace(b'\\', b'\\\\')
                 i = j + 1
                 if stuff[0:1] == b'!':
                     stuff = b'^' + stuff[1:]
                 elif stuff[0:1] == b'^':
                     stuff = b'\\' + stuff
                 res = b'%s[%s]' % (res, stuff)
         elif c == b'{':
             group += 1
             res += b'(?:'
         elif c == b'}' and group:
             res += b')'
             group -= 1
         elif c == b',' and group:
             res += b'|'
         elif c == b'\\':
             p = peek()
             if p:
                 i += 1
                 res += escape(p, p)
             else:
                 res += escape(c, c)
         else:
             res += escape(c, c)
     return res
 
 
-FLAG_RE = util.re.compile(b'^\(\?([aiLmsux]+)\)(.*)')
+FLAG_RE = util.re.compile(br'^\(\?([aiLmsux]+)\)(.*)')
 
 
 def _regex(kind, pat, globsuffix):
     """Convert a (normalized) pattern of any kind into a
     regular expression.
     globsuffix is appended to the regexp of globs."""
     if not pat and kind in (b'glob', b'relpath'):
         return b''
     if kind == b're':
         return pat
     if kind in (b'path', b'relpath'):
         if pat == b'.':
             return b''
         return util.stringutil.reescape(pat) + b'(?:/|$)'
     if kind == b'rootfilesin':
         if pat == b'.':
             escaped = b''
         else:
             # Pattern is a directory name.
             escaped = util.stringutil.reescape(pat) + b'/'
         # Anything after the pattern must be a non-directory.
         return escaped + b'[^/]+$'
     if kind == b'relglob':
         globre = _globre(pat)
         if globre.startswith(b'[^/]*'):
             # When pat has the form *XYZ (common), make the returned regex more
             # legible by returning the regex for **XYZ instead of **/*XYZ.
             return b'.*' + globre[len(b'[^/]*') :] + globsuffix
         return b'(?:|.*/)' + globre + globsuffix
     if kind == b'relre':
         flag = None
         m = FLAG_RE.match(pat)
         if m:
             flag, pat = m.groups()
         if not pat.startswith(b'^'):
             pat = b'.*' + pat
         if flag is not None:
             pat = br'(?%s:%s)' % (flag, pat)
         return pat
     if kind in (b'glob', b'rootglob'):
         return _globre(pat) + globsuffix
     raise error.ProgrammingError(b'not a regex pattern: %s:%s' % (kind, pat))
 
 
 def _buildmatch(kindpats, globsuffix, root):
     """Return regexp string and a matcher function for kindpats.
     globsuffix is appended to the regexp of globs."""
     matchfuncs = []
 
     subincludes, kindpats = _expandsubinclude(kindpats, root)
     if subincludes:
         submatchers = {}
 
         def matchsubinclude(f):
             for prefix, matcherargs in subincludes:
                 if f.startswith(prefix):
                     mf = submatchers.get(prefix)
                     if mf is None:
                         mf = match(*matcherargs)
                         submatchers[prefix] = mf
 
                     if mf(f[len(prefix) :]):
                         return True
             return False
 
         matchfuncs.append(matchsubinclude)
 
     regex = b''
     if kindpats:
         if all(k == b'rootfilesin' for k, p, s in kindpats):
             dirs = {p for k, p, s in kindpats}
 
             def mf(f):
                 i = f.rfind(b'/')
                 if i >= 0:
                     dir = f[:i]
                 else:
                     dir = b'.'
                 return dir in dirs
 
             regex = b'rootfilesin: %s' % stringutil.pprint(list(sorted(dirs)))
             matchfuncs.append(mf)
         else:
             regex, mf = _buildregexmatch(kindpats, globsuffix)
             matchfuncs.append(mf)
 
     if len(matchfuncs) == 1:
         return regex, matchfuncs[0]
     else:
         return regex, lambda f: any(mf(f) for mf in matchfuncs)
 
 
 MAX_RE_SIZE = 20000
 
 
 def _joinregexes(regexps):
     """gather multiple regular expressions into a single one"""
     return b'|'.join(regexps)
 
 
 def _buildregexmatch(kindpats, globsuffix):
     """Build a match function from a list of kinds and kindpats,
     return regexp string and a matcher function.
 
     Test too large input
     >>> _buildregexmatch([
     ...     (b'relglob', b'?' * MAX_RE_SIZE, b'')
     ... ], b'$')
     Traceback (most recent call last):
     ...
     Abort: matcher pattern is too long (20009 bytes)
     """
     try:
         allgroups = []
         regexps = [_regex(k, p, globsuffix) for (k, p, s) in kindpats]
         fullregexp = _joinregexes(regexps)
 
         startidx = 0
         groupsize = 0
         for idx, r in enumerate(regexps):
             piecesize = len(r)
             if piecesize > MAX_RE_SIZE:
                 msg = _(b"matcher pattern is too long (%d bytes)") % piecesize
                 raise error.Abort(msg)
             elif (groupsize + piecesize) > MAX_RE_SIZE:
                 group = regexps[startidx:idx]
                 allgroups.append(_joinregexes(group))
                 startidx = idx
                 groupsize = 0
             groupsize += piecesize + 1
 
         if startidx == 0:
             matcher = _rematcher(fullregexp)
             func = lambda s: bool(matcher(s))
         else:
             group = regexps[startidx:]
             allgroups.append(_joinregexes(group))
             allmatchers = [_rematcher(g) for g in allgroups]
             func = lambda s: any(m(s) for m in allmatchers)
         return fullregexp, func
     except re.error:
         for k, p, s in kindpats:
             try:
                 _rematcher(_regex(k, p, globsuffix))
             except re.error:
                 if s:
                     raise error.Abort(
                         _(b"%s: invalid pattern (%s): %s") % (s, k, p)
                     )
                 else:
                     raise error.Abort(_(b"invalid pattern (%s): %s") % (k, p))
         raise error.Abort(_(b"invalid pattern"))
 
 
 def _patternrootsanddirs(kindpats):
     """Returns roots and directories corresponding to each pattern.
 
     This calculates the roots and directories exactly matching the patterns and
     returns a tuple of (roots, dirs) for each. It does not return other
     directories which may also need to be considered, like the parent
     directories.
     """
     r = []
     d = []
     for kind, pat, source in kindpats:
         if kind in (b'glob', b'rootglob'):  # find the non-glob prefix
             root = []
             for p in pat.split(b'/'):
                 if b'[' in p or b'{' in p or b'*' in p or b'?' in p:
                     break
                 root.append(p)
             r.append(b'/'.join(root))
         elif kind in (b'relpath', b'path'):
             if pat == b'.':
                 pat = b''
             r.append(pat)
         elif kind in (b'rootfilesin',):
             if pat == b'.':
                 pat = b''
             d.append(pat)
         else:  # relglob, re, relre
             r.append(b'')
     return r, d
 
 
 def _roots(kindpats):
     '''Returns root directories to match recursively from the given patterns.'''
     roots, dirs = _patternrootsanddirs(kindpats)
     return roots
 
 
 def _rootsdirsandparents(kindpats):
     """Returns roots and exact directories from patterns.
 
     `roots` are directories to match recursively, `dirs` should
     be matched non-recursively, and `parents` are the implicitly required
     directories to walk to items in either roots or dirs.
 
     Returns a tuple of (roots, dirs, parents).
 
     >>> r = _rootsdirsandparents(
     ...     [(b'glob', b'g/h/*', b''), (b'glob', b'g/h', b''),
     ...      (b'glob', b'g*', b'')])
     >>> print(r[0:2], sorted(r[2])) # the set has an unstable output
     (['g/h', 'g/h', ''], []) ['', 'g']
     >>> r = _rootsdirsandparents(
     ...     [(b'rootfilesin', b'g/h', b''), (b'rootfilesin', b'', b'')])
     >>> print(r[0:2], sorted(r[2])) # the set has an unstable output
     ([], ['g/h', '']) ['', 'g']
     >>> r = _rootsdirsandparents(
     ...     [(b'relpath', b'r', b''), (b'path', b'p/p', b''),
     ...      (b'path', b'', b'')])
     >>> print(r[0:2], sorted(r[2])) # the set has an unstable output
     (['r', 'p/p', ''], []) ['', 'p']
     >>> r = _rootsdirsandparents(
     ...     [(b'relglob', b'rg*', b''), (b're', b're/', b''),
     ...      (b'relre', b'rr', b'')])
     >>> print(r[0:2], sorted(r[2])) # the set has an unstable output
     (['', '', ''], []) ['']
     """
     r, d = _patternrootsanddirs(kindpats)
 
     p = set()
     # Add the parents as non-recursive/exact directories, since they must be
     # scanned to get to either the roots or the other exact directories.
     p.update(pathutil.dirs(d))
     p.update(pathutil.dirs(r))
 
     # FIXME: all uses of this function convert these to sets, do so before
     # returning.
     # FIXME: all uses of this function do not need anything in 'roots' and
     # 'dirs' to also be in 'parents', consider removing them before returning.
     return r, d, p
 
 
 def _explicitfiles(kindpats):
     """Returns the potential explicit filenames from the patterns.
 
     >>> _explicitfiles([(b'path', b'foo/bar', b'')])
     ['foo/bar']
     >>> _explicitfiles([(b'rootfilesin', b'foo/bar', b'')])
     []
     """
     # Keep only the pattern kinds where one can specify filenames (vs only
     # directory names).
     filable = [kp for kp in kindpats if kp[0] not in (b'rootfilesin',)]
     return _roots(filable)
 
 
 def _prefix(kindpats):
     '''Whether all the patterns match a prefix (i.e. recursively)'''
     for kind, pat, source in kindpats:
         if kind not in (b'path', b'relpath'):
             return False
     return True
 
 
 _commentre = None
 
 
 def readpatternfile(filepath, warn, sourceinfo=False):
     """parse a pattern file, returning a list of
     patterns. These patterns should be given to compile()
     to be validated and converted into a match function.
 
     trailing white space is dropped.
     the escape character is backslash.
     comments start with #.
     empty lines are skipped.
 
     lines can be of the following formats:
 
     syntax: regexp # defaults following lines to non-rooted regexps
     syntax: glob   # defaults following lines to non-rooted globs
     re:pattern     # non-rooted regular expression
     glob:pattern   # non-rooted glob
     rootglob:pat   # rooted glob (same root as ^ in regexps)
     pattern        # pattern of the current default type
 
     if sourceinfo is set, returns a list of tuples:
     (pattern, lineno, originalline).
     This is useful to debug ignore patterns.
     """
 
     syntaxes = {
         b're': b'relre:',
         b'regexp': b'relre:',
         b'glob': b'relglob:',
         b'rootglob': b'rootglob:',
         b'include': b'include',
         b'subinclude': b'subinclude',
     }
     syntax = b'relre:'
     patterns = []
 
     fp = open(filepath, b'rb')
     for lineno, line in enumerate(fp, start=1):
         if b"#" in line:
             global _commentre
             if not _commentre:
                 _commentre = util.re.compile(br'((?:^|[^\\])(?:\\\\)*)#.*')
             # remove comments prefixed by an even number of escapes
             m = _commentre.search(line)
             if m:
                 line = line[: m.end(1)]
             # fixup properly escaped comments that survived the above
             line = line.replace(b"\\#", b"#")
         line = line.rstrip()
         if not line:
             continue
 
         if line.startswith(b'syntax:'):
             s = line[7:].strip()
             try:
                 syntax = syntaxes[s]
             except KeyError:
                 if warn:
                     warn(
                         _(b"%s: ignoring invalid syntax '%s'\n") % (filepath, s)
                     )
             continue
 
         linesyntax = syntax
         for s, rels in syntaxes.items():
             if line.startswith(rels):
                 linesyntax = rels
                 line = line[len(rels) :]
                 break
             elif line.startswith(s + b':'):
                 linesyntax = rels
                 line = line[len(s) + 1 :]
                 break
         if sourceinfo:
             patterns.append((linesyntax + line, lineno, line))
         else:
             patterns.append(linesyntax + line)
     fp.close()
     return patterns

mercurial/setdiscovery.py

@@ -1,526 +1,526 b''
 # setdiscovery.py - improved discovery of common nodeset for mercurial
 #
 # Copyright 2010 Benoit Boissinot <[e-mail]>
 # and Peter Arrenbrecht <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 """
 Algorithm works in the following way. You have two repository: local and
 remote. They both contains a DAG of changelists.
 
 The goal of the discovery protocol is to find one set of node *common*,
 the set of nodes shared by local and remote.
 
 One of the issue with the original protocol was latency, it could
 potentially require lots of roundtrips to discover that the local repo was a
 subset of remote (which is a very common case, you usually have few changes
 compared to upstream, while upstream probably had lots of development).
 
 The new protocol only requires one interface for the remote repo: `known()`,
 which given a set of changelists tells you if they are present in the DAG.
 
 The algorithm then works as follow:
 
  - We will be using three sets, `common`, `missing`, `unknown`. Originally
  all nodes are in `unknown`.
  - Take a sample from `unknown`, call `remote.known(sample)`
    - For each node that remote knows, move it and all its ancestors to `common`
    - For each node that remote doesn't know, move it and all its descendants
    to `missing`
  - Iterate until `unknown` is empty
 
 There are a couple optimizations, first is instead of starting with a random
 sample of missing, start by sending all heads, in the case where the local
 repo is a subset, you computed the answer in one round trip.
 
 Then you can do something similar to the bisecting strategy used when
 finding faulty changesets. Instead of random samples, you can try picking
 nodes that will maximize the number of nodes that will be
 classified with it (since all ancestors or descendants will be marked as well).
 """
 
 
 import collections
 import random
 
 from .i18n import _
 from .node import nullrev
 from . import (
     error,
     policy,
     util,
 )
 
 
 def _updatesample(revs, heads, sample, parentfn, quicksamplesize=0):
     """update an existing sample to match the expected size
 
     The sample is updated with revs exponentially distant from each head of the
     <revs> set. (H~1, H~2, H~4, H~8, etc).
 
     If a target size is specified, the sampling will stop once this size is
     reached. Otherwise sampling will happen until roots of the <revs> set are
     reached.
 
     :revs:  set of revs we want to discover (if None, assume the whole dag)
     :heads: set of DAG head revs
     :sample: a sample to update
     :parentfn: a callable to resolve parents for a revision
     :quicksamplesize: optional target size of the sample"""
     dist = {}
     visit = collections.deque(heads)
     seen = set()
     factor = 1
     while visit:
         curr = visit.popleft()
         if curr in seen:
             continue
         d = dist.setdefault(curr, 1)
         if d > factor:
             factor *= 2
         if d == factor:
             sample.add(curr)
             if quicksamplesize and (len(sample) >= quicksamplesize):
                 return
         seen.add(curr)
 
         for p in parentfn(curr):
             if p != nullrev and (not revs or p in revs):
                 dist.setdefault(p, d + 1)
                 visit.append(p)
 
 
 def _limitsample(sample, desiredlen, randomize=True):
     """return a random subset of sample of at most desiredlen item.
 
     If randomize is False, though, a deterministic subset is returned.
     This is meant for integration tests.
     """
     if len(sample) <= desiredlen:
         return sample
+    sample = list(sample)
     if randomize:
         return set(random.sample(sample, desiredlen))
-    sample = list(sample)
     sample.sort()
     return set(sample[:desiredlen])
 
 
 class partialdiscovery:
     """an object representing ongoing discovery
 
     Feed with data from the remote repository, this object keep track of the
     current set of changeset in various states:
 
     - common:    revs also known remotely
     - undecided: revs we don't have information on yet
     - missing:   revs missing remotely
     (all tracked revisions are known locally)
     """
 
     def __init__(self, repo, targetheads, respectsize, randomize=True):
         self._repo = repo
         self._targetheads = targetheads
         self._common = repo.changelog.incrementalmissingrevs()
         self._undecided = None
         self.missing = set()
         self._childrenmap = None
         self._respectsize = respectsize
         self.randomize = randomize
 
     def addcommons(self, commons):
         """register nodes known as common"""
         self._common.addbases(commons)
         if self._undecided is not None:
             self._common.removeancestorsfrom(self._undecided)
 
     def addmissings(self, missings):
         """register some nodes as missing"""
         newmissing = self._repo.revs(b'%ld::%ld', missings, self.undecided)
         if newmissing:
             self.missing.update(newmissing)
             self.undecided.difference_update(newmissing)
 
     def addinfo(self, sample):
         """consume an iterable of (rev, known) tuples"""
         common = set()
         missing = set()
         for rev, known in sample:
             if known:
                 common.add(rev)
             else:
                 missing.add(rev)
         if common:
             self.addcommons(common)
         if missing:
             self.addmissings(missing)
 
     def hasinfo(self):
         """return True is we have any clue about the remote state"""
         return self._common.hasbases()
 
     def iscomplete(self):
         """True if all the necessary data have been gathered"""
         return self._undecided is not None and not self._undecided
 
     @property
     def undecided(self):
         if self._undecided is not None:
             return self._undecided
         self._undecided = set(self._common.missingancestors(self._targetheads))
         return self._undecided
 
     def stats(self):
         return {
             'undecided': len(self.undecided),
         }
 
     def commonheads(self):
         """the heads of the known common set"""
         # heads(common) == heads(common.bases) since common represents
         # common.bases and all its ancestors
         return self._common.basesheads()
 
     def _parentsgetter(self):
         getrev = self._repo.changelog.index.__getitem__
 
         def getparents(r):
             return getrev(r)[5:7]
 
         return getparents
 
     def _childrengetter(self):
 
         if self._childrenmap is not None:
             # During discovery, the `undecided` set keep shrinking.
             # Therefore, the map computed for an iteration N will be
             # valid for iteration N+1. Instead of computing the same
             # data over and over we cached it the first time.
             return self._childrenmap.__getitem__
 
         # _updatesample() essentially does interaction over revisions to look
         # up their children. This lookup is expensive and doing it in a loop is
         # quadratic. We precompute the children for all relevant revisions and
         # make the lookup in _updatesample() a simple dict lookup.
         self._childrenmap = children = {}
 
         parentrevs = self._parentsgetter()
         revs = self.undecided
 
         for rev in sorted(revs):
             # Always ensure revision has an entry so we don't need to worry
             # about missing keys.
             children[rev] = []
             for prev in parentrevs(rev):
                 if prev == nullrev:
                     continue
                 c = children.get(prev)
                 if c is not None:
                     c.append(rev)
         return children.__getitem__
 
     def takequicksample(self, headrevs, size):
         """takes a quick sample of size <size>
 
         It is meant for initial sampling and focuses on querying heads and close
         ancestors of heads.
 
         :headrevs: set of head revisions in local DAG to consider
         :size: the maximum size of the sample"""
         revs = self.undecided
         if len(revs) <= size:
             return list(revs)
         sample = set(self._repo.revs(b'heads(%ld)', revs))
 
         if len(sample) >= size:
             return _limitsample(sample, size, randomize=self.randomize)
 
         _updatesample(
             None, headrevs, sample, self._parentsgetter(), quicksamplesize=size
         )
         return sample
 
     def takefullsample(self, headrevs, size):
         revs = self.undecided
         if len(revs) <= size:
             return list(revs)
         repo = self._repo
         sample = set(repo.revs(b'heads(%ld)', revs))
         parentrevs = self._parentsgetter()
 
         # update from heads
         revsheads = sample.copy()
         _updatesample(revs, revsheads, sample, parentrevs)
 
         # update from roots
         revsroots = set(repo.revs(b'roots(%ld)', revs))
         childrenrevs = self._childrengetter()
         _updatesample(revs, revsroots, sample, childrenrevs)
         assert sample
 
         if not self._respectsize:
             size = max(size, min(len(revsroots), len(revsheads)))
 
         sample = _limitsample(sample, size, randomize=self.randomize)
         if len(sample) < size:
             more = size - len(sample)
             takefrom = list(revs - sample)
             if self.randomize:
                 sample.update(random.sample(takefrom, more))
             else:
                 takefrom.sort()
                 sample.update(takefrom[:more])
         return sample
 
 
 pure_partialdiscovery = partialdiscovery
 
 partialdiscovery = policy.importrust(
     'discovery', member='PartialDiscovery', default=partialdiscovery
 )
 
 
 def findcommonheads(
     ui,
     local,
     remote,
     abortwhenunrelated=True,
     ancestorsof=None,
     audit=None,
 ):
     """Return a tuple (common, anyincoming, remoteheads) used to identify
     missing nodes from or in remote.
 
     The audit argument is an optional dictionnary that a caller can pass. it
     will be updated with extra data about the discovery, this is useful for
     debug.
     """
 
     samplegrowth = float(ui.config(b'devel', b'discovery.grow-sample.rate'))
 
     if audit is not None:
         audit[b'total-queries'] = 0
 
     start = util.timer()
 
     roundtrips = 0
     cl = local.changelog
     clnode = cl.node
     clrev = cl.rev
 
     if ancestorsof is not None:
         ownheads = [clrev(n) for n in ancestorsof]
     else:
         ownheads = [rev for rev in cl.headrevs() if rev != nullrev]
 
     initial_head_exchange = ui.configbool(b'devel', b'discovery.exchange-heads')
     initialsamplesize = ui.configint(b'devel', b'discovery.sample-size.initial')
     fullsamplesize = ui.configint(b'devel', b'discovery.sample-size')
     # We also ask remote about all the local heads. That set can be arbitrarily
     # large, so we used to limit it size to `initialsamplesize`. We no longer
     # do as it proved counter productive. The skipped heads could lead to a
     # large "undecided" set, slower to be clarified than if we asked the
     # question for all heads right away.
     #
     # We are already fetching all server heads using the `heads` commands,
     # sending a equivalent number of heads the other way should not have a
     # significant impact.  In addition, it is very likely that we are going to
     # have to issue "known" request for an equivalent amount of revisions in
     # order to decide if theses heads are common or missing.
     #
     # find a detailled analysis below.
     #
     # Case A: local and server both has few heads
     #
     #     Ownheads is below initialsamplesize, limit would not have any effect.
     #
     # Case B: local has few heads and server has many
     #
     #     Ownheads is below initialsamplesize, limit would not have any effect.
     #
     # Case C: local and server both has many heads
     #
     #     We now transfert some more data, but not significantly more than is
     #     already transfered to carry the server heads.
     #
     # Case D: local has many heads, server has few
     #
     #   D.1 local heads are mostly known remotely
     #
     #     All the known head will have be part of a `known` request at some
     #     point for the discovery to finish. Sending them all earlier is
     #     actually helping.
     #
     #     (This case is fairly unlikely, it requires the numerous heads to all
     #     be merged server side in only a few heads)
     #
     #   D.2 local heads are mostly missing remotely
     #
     #     To determine that the heads are missing, we'll have to issue `known`
     #     request for them or one of their ancestors. This amount of `known`
     #     request will likely be in the same order of magnitude than the amount
     #     of local heads.
     #
     #     The only case where we can be more efficient using `known` request on
     #     ancestors are case were all the "missing" local heads are based on a
     #     few changeset, also "missing".  This means we would have a "complex"
     #     graph (with many heads) attached to, but very independant to a the
     #     "simple" graph on the server. This is a fairly usual case and have
     #     not been met in the wild so far.
     if initial_head_exchange:
         if remote.limitedarguments:
             sample = _limitsample(ownheads, initialsamplesize)
             # indices between sample and externalized version must match
             sample = list(sample)
         else:
             sample = ownheads
 
         ui.debug(b"query 1; heads\n")
         roundtrips += 1
         with remote.commandexecutor() as e:
             fheads = e.callcommand(b'heads', {})
             if audit is not None:
                 audit[b'total-queries'] += len(sample)
             fknown = e.callcommand(
                 b'known',
                 {
                     b'nodes': [clnode(r) for r in sample],
                 },
             )
 
         srvheadhashes, yesno = fheads.result(), fknown.result()
 
         if audit is not None:
             audit[b'total-roundtrips'] = 1
 
         if cl.tiprev() == nullrev:
             if srvheadhashes != [cl.nullid]:
                 return [cl.nullid], True, srvheadhashes
             return [cl.nullid], False, []
     else:
         # we still need the remote head for the function return
         with remote.commandexecutor() as e:
             fheads = e.callcommand(b'heads', {})
         srvheadhashes = fheads.result()
 
     # start actual discovery (we note this before the next "if" for
     # compatibility reasons)
     ui.status(_(b"searching for changes\n"))
 
     knownsrvheads = []  # revnos of remote heads that are known locally
     for node in srvheadhashes:
         if node == cl.nullid:
             continue
 
         try:
             knownsrvheads.append(clrev(node))
         # Catches unknown and filtered nodes.
         except error.LookupError:
             continue
 
     if initial_head_exchange:
         # early exit if we know all the specified remote heads already
         if len(knownsrvheads) == len(srvheadhashes):
             ui.debug(b"all remote heads known locally\n")
             return srvheadhashes, False, srvheadhashes
 
         if len(sample) == len(ownheads) and all(yesno):
             ui.note(_(b"all local changesets known remotely\n"))
             ownheadhashes = [clnode(r) for r in ownheads]
             return ownheadhashes, True, srvheadhashes
 
     # full blown discovery
 
     # if the server has a limit to its arguments size, we can't grow the sample.
     configbool = local.ui.configbool
     grow_sample = configbool(b'devel', b'discovery.grow-sample')
     grow_sample = grow_sample and not remote.limitedarguments
 
     dynamic_sample = configbool(b'devel', b'discovery.grow-sample.dynamic')
     hard_limit_sample = not (dynamic_sample or remote.limitedarguments)
 
     randomize = ui.configbool(b'devel', b'discovery.randomize')
     if cl.index.rust_ext_compat:
         pd = partialdiscovery
     else:
         pd = pure_partialdiscovery
     disco = pd(local, ownheads, hard_limit_sample, randomize=randomize)
     if initial_head_exchange:
         # treat remote heads (and maybe own heads) as a first implicit sample
         # response
         disco.addcommons(knownsrvheads)
         disco.addinfo(zip(sample, yesno))
 
     full = not initial_head_exchange
     progress = ui.makeprogress(_(b'searching'), unit=_(b'queries'))
     while not disco.iscomplete():
 
         if full or disco.hasinfo():
             if full:
                 ui.note(_(b"sampling from both directions\n"))
             else:
                 ui.debug(b"taking initial sample\n")
             samplefunc = disco.takefullsample
             targetsize = fullsamplesize
             if grow_sample:
                 fullsamplesize = int(fullsamplesize * samplegrowth)
         else:
             # use even cheaper initial sample
             ui.debug(b"taking quick initial sample\n")
             samplefunc = disco.takequicksample
             targetsize = initialsamplesize
         sample = samplefunc(ownheads, targetsize)
 
         roundtrips += 1
         progress.update(roundtrips)
         stats = disco.stats()
         ui.debug(
             b"query %i; still undecided: %i, sample size is: %i\n"
             % (roundtrips, stats['undecided'], len(sample))
         )
 
         # indices between sample and externalized version must match
         sample = list(sample)
 
         with remote.commandexecutor() as e:
             if audit is not None:
                 audit[b'total-queries'] += len(sample)
             yesno = e.callcommand(
                 b'known',
                 {
                     b'nodes': [clnode(r) for r in sample],
                 },
             ).result()
 
         full = True
 
         disco.addinfo(zip(sample, yesno))
 
     result = disco.commonheads()
     elapsed = util.timer() - start
     progress.complete()
     ui.debug(b"%d total queries in %.4fs\n" % (roundtrips, elapsed))
     msg = (
         b'found %d common and %d unknown server heads,'
         b' %d roundtrips in %.4fs\n'
     )
     missing = set(result) - set(knownsrvheads)
     ui.log(b'discovery', msg, len(result), len(missing), roundtrips, elapsed)
 
     if audit is not None:
         audit[b'total-roundtrips'] = roundtrips
 
     if not result and srvheadhashes != [cl.nullid]:
         if abortwhenunrelated:
             raise error.Abort(_(b"repository is unrelated"))
         else:
             ui.warn(_(b"warning: repository is unrelated\n"))
         return (
             {cl.nullid},
             True,
             srvheadhashes,
         )
 
     anyincoming = srvheadhashes != [cl.nullid]
     result = {clnode(r) for r in result}
     return result, anyincoming, srvheadhashes

tests/test-push-race.t

@@ -1,1892 +1,1900 b''
 ============================================================================================
 Test cases where there are race condition between two clients pushing to the same repository
 ============================================================================================
 
 This file tests cases where two clients push to a server at the same time. The
 "raced" client is done preparing it push bundle when the "racing" client
 perform its push. The "raced" client starts its actual push after the "racing"
 client push is fully complete.
 
 A set of extension and shell functions ensures this scheduling.
 
   $ cat >> delaypush.py << EOF
   > """small extension orchestrate push race
   > 
   > Client with the extensions will create a file when ready and get stuck until
   > a file is created."""
   > 
   > import errno
   > import os
   > import time
   > 
   > from mercurial import (
   >     exchange,
   >     extensions,
   >     registrar,
   > )
   > 
   > configtable = {}
   > configitem = registrar.configitem(configtable)
   > 
   > configitem(b'delaypush', b'ready-path',
   >     default=None,
   > )
   > configitem(b'delaypush', b'release-path',
   >     default=None,
   > )
   > 
   > def delaypush(orig, pushop):
   >     # notify we are done preparing
   >     ui = pushop.repo.ui
   >     readypath = ui.config(b'delaypush', b'ready-path')
   >     if readypath is not None:
   >         with open(readypath, 'w') as r:
   >             r.write('foo')
   >         ui.status(b'wrote ready: %s\n' % readypath)
   >     # now wait for the other process to be done
   >     watchpath = ui.config(b'delaypush', b'release-path')
   >     if watchpath is not None:
   >         ui.status(b'waiting on: %s\n' % watchpath)
   >         limit = 100
+  >         test_default_timeout = os.environ.get('HGTEST_TIMEOUT_DEFAULT')
+  >         test_timeout = os.environ.get('HGTEST_TIMEOUT')
+  >         if (
+  >             test_default_timeout is not None
+  >             and test_timeout is not None
+  >             and test_default_timeout < test_timeout
+  >         ):
+  >             limit = int(limit * (test_timeout / test_default_timeout))
   >         while 0 < limit and not os.path.exists(watchpath):
   >             limit -= 1
   >             time.sleep(0.1)
   >         if limit <= 0:
   >             ui.warn(b'exiting without watchfile: %s' % watchpath)
   >         else:
   >             # delete the file at the end of the push
   >             def delete():
   >                 try:
   >                     os.unlink(watchpath)
   >                 except FileNotFoundError:
   >                     pass
   >             ui.atexit(delete)
   >     return orig(pushop)
   > 
   > def uisetup(ui):
   >     extensions.wrapfunction(exchange, b'_pushbundle2', delaypush)
   > EOF
 
   $ waiton () {
   >     # wait for a file to be created (then delete it)
   >     count=100
   >     while [ ! -f $1 ] ;
   >     do
   >         sleep 0.1;
   >         count=`expr $count - 1`;
   >         if [ $count -lt 0 ];
   >         then
   >              break
   >         fi;
   >     done
   >     [ -f $1 ] || echo "ready file still missing: $1"
   >     rm -f $1
   > }
 
   $ release () {
   >     # create a file and wait for it be deleted
   >     count=100
   >     touch $1
   >     while [ -f $1 ] ;
   >     do
   >         sleep 0.1;
   >         count=`expr $count - 1`;
   >         if [ $count -lt 0 ];
   >         then
   >              break
   >         fi;
   >     done
   >     [ ! -f $1 ] || echo "delay file still exist: $1"
   > }
 
   $ cat >> $HGRCPATH << EOF
   > [ui]
   > # simplify output
   > logtemplate = {node|short} {desc} ({branch})
   > [phases]
   > publish = no
   > [experimental]
   > evolution=true
   > [alias]
   > graph = log -G --rev 'sort(all(), "topo")'
   > EOF
 
 We tests multiple cases:
 * strict: no race detected,
 * unrelated: race on unrelated heads are allowed.
 
 #testcases strict unrelated
 
 #if strict
 
   $ cat >> $HGRCPATH << EOF
   > [server]
   > concurrent-push-mode = strict
   > EOF
 
 #endif
 
 Setup
 -----
 
 create a repo with one root
 
   $ hg init server
   $ cd server
   $ echo root > root
   $ hg ci -Am "C-ROOT"
   adding root
   $ cd ..
 
 clone it in two clients
 
   $ hg clone ssh://user@dummy/server client-racy
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets 842e2fac6304 (1 drafts)
   updating to branch default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg clone ssh://user@dummy/server client-other
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets 842e2fac6304 (1 drafts)
   updating to branch default
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 setup one to allow race on push
 
   $ cat >> client-racy/.hg/hgrc << EOF
   > [extensions]
   > delaypush = $TESTTMP/delaypush.py
   > [delaypush]
   > ready-path = $TESTTMP/readyfile
   > release-path = $TESTTMP/watchfile
   > EOF
 
 Simple race, both try to push to the server at the same time
 ------------------------------------------------------------
 
 Both try to replace the same head
 
 #  a
 #  | b
 #  |/
 #  *
 
 Creating changesets
 
   $ echo b > client-other/a
   $ hg -R client-other/ add client-other/a
   $ hg -R client-other/ commit -m "C-A"
   $ echo b > client-racy/b
   $ hg -R client-racy/ add client-racy/b
   $ hg -R client-racy/ commit -m "C-B"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -r 'tip'
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  98217d5a1659 C-A (default)
   |
   @  842e2fac6304 C-ROOT (default)
   
 
 Pushing on two different heads
 ------------------------------
 
 Both try to replace a different head
 
 #  a b
 #  | |
 #  * *
 #  |/
 #  *
 
 (resync-all)
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets a9149a1428e2 (1 drafts)
   (run 'hg heads' to see heads, 'hg merge' to merge)
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets a9149a1428e2 (1 drafts)
   (run 'hg heads' to see heads, 'hg merge' to merge)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets 98217d5a1659 (1 drafts)
   (run 'hg heads' to see heads, 'hg merge' to merge)
 
   $ hg -R server graph
   o  a9149a1428e2 C-B (default)
   |
   | o  98217d5a1659 C-A (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
   $ echo aa >> client-other/a
   $ hg -R client-other/ commit -m "C-C"
   $ echo bb >> client-racy/b
   $ hg -R client-racy/ commit -m "C-D"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -r 'tip'
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
 #if strict
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  51c544a58128 C-C (default)
   |
   o  98217d5a1659 C-A (default)
   |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 #endif
 #if unrelated
 
 (The two heads are unrelated, push should be allowed)
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ hg -R server graph
   o  59e76faf78bd C-D (default)
   |
   o  a9149a1428e2 C-B (default)
   |
   | o  51c544a58128 C-C (default)
   | |
   | o  98217d5a1659 C-A (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 #endif
 
 Pushing while someone creates a new head
 -----------------------------------------
 
 Pushing a new changeset while someone creates a new branch.
 
 #  a (raced)
 #  |
 #  * b
 #  |/
 #  *
 
 (resync-all)
 
 #if strict
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets 59e76faf78bd (1 drafts)
   (run 'hg update' to get a working copy)
 
 #endif
 #if unrelated
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   no changes found
 
 #endif
 
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets 59e76faf78bd (1 drafts)
   (run 'hg update' to get a working copy)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets 51c544a58128 (1 drafts)
   (run 'hg update' to get a working copy)
 
   $ hg -R server graph
   o  59e76faf78bd C-D (default)
   |
   o  a9149a1428e2 C-B (default)
   |
   | o  51c544a58128 C-C (default)
   | |
   | o  98217d5a1659 C-A (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (new head)
 
   $ hg -R client-other/ up 'desc("C-A")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo aaa >> client-other/a
   $ hg -R client-other/ commit -m "C-E"
   created new head
 
 (children of existing head)
 
   $ hg -R client-racy/ up 'desc("C-C")'
   1 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo bbb >> client-racy/a
   $ hg -R client-racy/ commit -m "C-F"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip'
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files (+1 heads)
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
 #if strict
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  d603e2c0cdd7 C-E (default)
   |
   | o  51c544a58128 C-C (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 #endif
 
 #if unrelated
 
 (The racing new head do not affect existing heads, push should go through)
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ hg -R server graph
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 #endif
 
 Pushing touching different named branch (same topo): new branch raced
 ---------------------------------------------------------------------
 
 Pushing two children on the same head, one is a different named branch
 
 #  a (raced, branch-a)
 #  |
 #  | b (default branch)
 #  |/
 #  *
 
 (resync-all)
 
 #if strict
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets d9e379a8c432 (1 drafts)
   (run 'hg update' to get a working copy)
 
 #endif
 #if unrelated
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   no changes found
 
 #endif
 
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   new changesets d9e379a8c432 (1 drafts)
   (run 'hg update' to get a working copy)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets d603e2c0cdd7 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
 
   $ hg -R server graph
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (update existing head)
 
   $ hg -R client-other/ up 'desc("C-F")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo aaa >> client-other/a
   $ hg -R client-other/ commit -m "C-G"
 
 (new named branch from that existing head)
 
   $ hg -R client-racy/ up 'desc("C-F")'
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bbb >> client-racy/a
   $ hg -R client-racy/ branch my-first-test-branch
   marked working directory as branch my-first-test-branch
   (branches are permanent and global, did you want a bookmark?)
   $ hg -R client-racy/ commit -m "C-H"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' --new-branch > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip'
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
 #if strict
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  75d69cba5402 C-G (default)
   |
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 #endif
 #if unrelated
 
 (unrelated named branches are unrelated)
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files (+1 heads)
 
   $ hg -R server graph
   o  833be552cfe6 C-H (my-first-test-branch)
   |
   | o  75d69cba5402 C-G (default)
   |/
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 #endif
 
 The racing new head do not affect existing heads, push should go through
 
 pushing touching different named branch (same topo): old branch raced
 ---------------------------------------------------------------------
 
 Pushing two children on the same head, one is a different named branch
 
 #  a (raced, default-branch)
 #  |
 #  | b (new branch)
 #  |/
 #  * (default-branch)
 
 (resync-all)
 
 #if strict
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets 833be552cfe6 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
 
 #endif
 #if unrelated
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   no changes found
 
 #endif
 
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets 833be552cfe6 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets 75d69cba5402 (1 drafts)
   (run 'hg heads' to see heads)
 
   $ hg -R server graph
   o  833be552cfe6 C-H (my-first-test-branch)
   |
   | o  75d69cba5402 C-G (default)
   |/
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (new named branch from one head)
 
   $ hg -R client-other/ up 'desc("C-G")'
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo aaa >> client-other/a
   $ hg -R client-other/ branch my-second-test-branch
   marked working directory as branch my-second-test-branch
   $ hg -R client-other/ commit -m "C-I"
 
 (children "updating" that same head)
 
   $ hg -R client-racy/ up 'desc("C-G")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bbb >> client-racy/a
   $ hg -R client-racy/ commit -m "C-J"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
 #if strict
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  b35ed749f288 C-I (my-second-test-branch)
   |
   o  75d69cba5402 C-G (default)
   |
   | o  833be552cfe6 C-H (my-first-test-branch)
   |/
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 #endif
 
 #if unrelated
 
 (unrelated named branches are unrelated)
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files (+1 heads)
 
   $ hg -R server graph
   o  89420bf00fae C-J (default)
   |
   | o  b35ed749f288 C-I (my-second-test-branch)
   |/
   o  75d69cba5402 C-G (default)
   |
   | o  833be552cfe6 C-H (my-first-test-branch)
   |/
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 #endif
 
 pushing racing push touch multiple heads
 ----------------------------------------
 
 There are multiple heads, but the racing push touch all of them
 
 #  a (raced)
 #  | b
 #  |/|
 #  * *
 #  |/
 #  *
 
 (resync-all)
 
 #if strict
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets 89420bf00fae (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
 
 #endif
 
 #if unrelated
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   no changes found
 
 #endif
 
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets 89420bf00fae (1 drafts)
   (run 'hg heads' to see heads)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets b35ed749f288 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
 
   $ hg -R server graph
   o  89420bf00fae C-J (default)
   |
   | o  b35ed749f288 C-I (my-second-test-branch)
   |/
   o  75d69cba5402 C-G (default)
   |
   | o  833be552cfe6 C-H (my-first-test-branch)
   |/
   o  d9e379a8c432 C-F (default)
   |
   o  51c544a58128 C-C (default)
   |
   | o  d603e2c0cdd7 C-E (default)
   |/
   o  98217d5a1659 C-A (default)
   |
   | o  59e76faf78bd C-D (default)
   | |
   | o  a9149a1428e2 C-B (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (merges heads)
 
   $ hg -R client-other/ up 'desc("C-E")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R client-other/ merge 'desc("C-D")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (branch merge, don't forget to commit)
   $ hg -R client-other/ commit -m "C-K"
 
 (update one head)
 
   $ hg -R client-racy/ up 'desc("C-D")'
   1 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo bbb >> client-racy/b
   $ hg -R client-racy/ commit -m "C-L"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 0 changes to 0 files (-1 heads)
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o    be705100c623 C-K (default)
   |\
   | o  d603e2c0cdd7 C-E (default)
   | |
   o |  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   | | o  51c544a58128 C-C (default)
   | |/
   o |  a9149a1428e2 C-B (default)
   | |
   | o  98217d5a1659 C-A (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 pushing raced push touch multiple heads
 ---------------------------------------
 
 There are multiple heads, the raced push touch all of them
 
 #  b
 #  | a (raced)
 #  |/|
 #  * *
 #  |/
 #  *
 
 (resync-all)
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets cac2cead0ff0 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets cac2cead0ff0 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 0 changes to 0 files
   new changesets be705100c623 (1 drafts)
   (run 'hg update' to get a working copy)
 
   $ hg -R server graph
   o  cac2cead0ff0 C-L (default)
   |
   | o  be705100c623 C-K (default)
   |/|
   | o  d603e2c0cdd7 C-E (default)
   | |
   o |  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   | | o  51c544a58128 C-C (default)
   | |/
   o |  a9149a1428e2 C-B (default)
   | |
   | o  98217d5a1659 C-A (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (update existing head)
 
   $ echo aaa >> client-other/a
   $ hg -R client-other/ commit -m "C-M"
 
 (merge heads)
 
   $ hg -R client-racy/ merge 'desc("C-K")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (branch merge, don't forget to commit)
   $ hg -R client-racy/ commit -m "C-N"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  6fd3090135df C-M (default)
   |
   o    be705100c623 C-K (default)
   |\
   | o  d603e2c0cdd7 C-E (default)
   | |
   +---o  cac2cead0ff0 C-L (default)
   | |
   o |  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   | | o  51c544a58128 C-C (default)
   | |/
   o |  a9149a1428e2 C-B (default)
   | |
   | o  98217d5a1659 C-A (default)
   |/
   @  842e2fac6304 C-ROOT (default)
   
 
 racing commit push a new head behind another named branch
 ---------------------------------------------------------
 
 non-continuous branch are valid case, we tests for them.
 
 #  b (branch default)
 #  |
 #  o (branch foo)
 #  |
 #  | a (raced, branch default)
 #  |/
 #  * (branch foo)
 #  |
 #  * (branch default)
 
 (resync-all + other branch)
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 0 changes to 0 files
   new changesets 866a66e18630 (1 drafts)
   (run 'hg update' to get a working copy)
 
 (creates named branch on head)
 
   $ hg -R ./server/ up 'desc("C-N")'
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R ./server/ branch other
   marked working directory as branch other
   $ hg -R ./server/ ci -m "C-Z"
   $ hg -R ./server/ up null
   0 files updated, 0 files merged, 3 files removed, 0 files unresolved
 
 (sync client)
 
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 0 changes to 0 files
   new changesets 866a66e18630:55a6f1c01b48 (2 drafts)
   (run 'hg update' to get a working copy)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 1 changes to 1 files (+1 heads)
   new changesets 6fd3090135df:55a6f1c01b48 (2 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
 
   $ hg -R server graph
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (update default head through another named branch one)
 
   $ hg -R client-other/ up 'desc("C-Z")'
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo aaa >> client-other/a
   $ hg -R client-other/ commit -m "C-O"
   $ echo aaa >> client-other/a
   $ hg -R client-other/ branch --force default
   marked working directory as branch default
   $ hg -R client-other/ commit -m "C-P"
   created new head
 
 (update default head)
 
   $ hg -R client-racy/ up 'desc("C-Z")'
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bbb >> client-other/a
   $ hg -R client-racy/ branch --force default
   marked working directory as branch default
   $ hg -R client-racy/ commit -m "C-Q"
   created new head
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 2 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  1b58ee3f79e5 C-P (default)
   |
   o  d0a85b2252a9 C-O (other)
   |
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 raced commit push a new head behind another named branch
 ---------------------------------------------------------
 
 non-continuous branch are valid case, we tests for them.
 
 #  b (raced branch default)
 #  |
 #  o (branch foo)
 #  |
 #  | a (branch default)
 #  |/
 #  * (branch foo)
 #  |
 #  * (branch default)
 
 (resync-all)
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 0 changes to 0 files (+1 heads)
   new changesets b0ee3d6f51bc (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 0 changes to 0 files (+1 heads)
   new changesets b0ee3d6f51bc (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 1 changes to 1 files (+1 heads)
   new changesets d0a85b2252a9:1b58ee3f79e5 (2 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
 
   $ hg -R server graph
   o  b0ee3d6f51bc C-Q (default)
   |
   | o  1b58ee3f79e5 C-P (default)
   | |
   | o  d0a85b2252a9 C-O (other)
   |/
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets
 
 (update 'other' named branch head)
 
   $ hg -R client-other/ up 'desc("C-P")'
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo aaa >> client-other/a
   $ hg -R client-other/ branch --force other
   marked working directory as branch other
   $ hg -R client-other/ commit -m "C-R"
   created new head
 
 (update 'other named brnach through a 'default' changeset')
 
   $ hg -R client-racy/ up 'desc("C-P")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bbb >> client-racy/a
   $ hg -R client-racy/ commit -m "C-S"
   $ echo bbb >> client-racy/a
   $ hg -R client-racy/ branch --force other
   marked working directory as branch other
   $ hg -R client-racy/ commit -m "C-T"
   created new head
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 1 changes to 1 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server graph
   o  de7b9e2ba3f6 C-R (other)
   |
   o  1b58ee3f79e5 C-P (default)
   |
   o  d0a85b2252a9 C-O (other)
   |
   | o  b0ee3d6f51bc C-Q (default)
   |/
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 raced commit push a new head obsoleting the one touched by the racing push
 --------------------------------------------------------------------------
 
 #  b (racing)
 #  |
 #  ø⇠◔ a (raced)
 #  |/
 #  *
 
 (resync-all)
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 1 files (+1 heads)
   new changesets 2efd43f7b5ba:3d57ed3c1091 (2 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 1 files (+1 heads)
   new changesets 2efd43f7b5ba:3d57ed3c1091 (2 drafts)
   (run 'hg heads' to see heads, 'hg merge' to merge)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   new changesets de7b9e2ba3f6 (1 drafts)
   (run 'hg heads' to see heads, 'hg merge' to merge)
 
   $ hg -R server graph
   o  3d57ed3c1091 C-T (other)
   |
   o  2efd43f7b5ba C-S (default)
   |
   | o  de7b9e2ba3f6 C-R (other)
   |/
   o  1b58ee3f79e5 C-P (default)
   |
   o  d0a85b2252a9 C-O (other)
   |
   | o  b0ee3d6f51bc C-Q (default)
   |/
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets and markers
 
 (continue existing head)
 
   $ hg -R client-other/ up 'desc("C-Q")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo aaa >> client-other/a
   $ hg -R client-other/ commit -m "C-U"
 
 (new topo branch obsoleting that same head)
 
   $ hg -R client-racy/ up 'desc("C-Z")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bbb >> client-racy/a
   $ hg -R client-racy/ branch --force default
   marked working directory as branch default
   $ hg -R client-racy/ commit -m "C-V"
   created new head
   $ ID_Q=`hg -R client-racy log -T '{node}\n' -r 'desc("C-Q")'`
   $ ID_V=`hg -R client-racy log -T '{node}\n' -r 'desc("C-V")'`
   $ hg -R client-racy debugobsolete $ID_Q $ID_V
   1 new obsolescence markers
   obsoleted 1 changesets
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 0 changes to 0 files
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server debugobsolete
   $ hg -R server graph
   o  a98a47d8b85b C-U (default)
   |
   o  b0ee3d6f51bc C-Q (default)
   |
   | o  3d57ed3c1091 C-T (other)
   | |
   | o  2efd43f7b5ba C-S (default)
   | |
   | | o  de7b9e2ba3f6 C-R (other)
   | |/
   | o  1b58ee3f79e5 C-P (default)
   | |
   | o  d0a85b2252a9 C-O (other)
   |/
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 racing commit push a new head obsoleting the one touched by the raced push
 --------------------------------------------------------------------------
 
 (mirror test case of the previous one
 
 #  a (raced branch default)
 #  |
 #  ø⇠◔ b (racing)
 #  |/
 #  *
 
 (resync-all)
 
   $ hg -R ./server pull ./client-racy
   pulling from ./client-racy
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   1 new obsolescence markers
   obsoleted 1 changesets
   1 new orphan changesets
   new changesets 720c5163ecf6 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-other pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files (+1 heads)
   1 new obsolescence markers
   obsoleted 1 changesets
   1 new orphan changesets
   new changesets 720c5163ecf6 (1 drafts)
   (run 'hg heads .' to see heads, 'hg merge' to merge)
   $ hg -R ./client-racy pull
   pulling from ssh://user@dummy/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 0 changes to 0 files
   1 new orphan changesets
   new changesets a98a47d8b85b (1 drafts)
   (run 'hg update' to get a working copy)
 
   $ hg -R server debugobsolete
   b0ee3d6f51bc4c0ca6d4f2907708027a6c376233 720c5163ecf64dcc6216bee2d62bf3edb1882499 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
   $ hg -R server graph
   o  720c5163ecf6 C-V (default)
   |
   | *  a98a47d8b85b C-U (default)
   | |
   | x  b0ee3d6f51bc C-Q (default)
   |/
   | o  3d57ed3c1091 C-T (other)
   | |
   | o  2efd43f7b5ba C-S (default)
   | |
   | | o  de7b9e2ba3f6 C-R (other)
   | |/
   | o  1b58ee3f79e5 C-P (default)
   | |
   | o  d0a85b2252a9 C-O (other)
   |/
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)
   
 
 Creating changesets and markers
 
 (new topo branch obsoleting that same head)
 
   $ hg -R client-other/ up 'desc("C-Q")'
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bbb >> client-other/a
   $ hg -R client-other/ branch --force default
   marked working directory as branch default
   $ hg -R client-other/ commit -m "C-W"
   1 new orphan changesets
   created new head
   $ ID_V=`hg -R client-other log -T '{node}\n' -r 'desc("C-V")'`
   $ ID_W=`hg -R client-other log -T '{node}\n' -r 'desc("C-W")'`
   $ hg -R client-other debugobsolete $ID_V $ID_W
   1 new obsolescence markers
   obsoleted 1 changesets
 
 (continue the same head)
 
   $ echo aaa >> client-racy/a
   $ hg -R client-racy/ commit -m "C-X"
 
 Pushing
 
   $ hg -R client-racy push -r 'tip' > ./push-log 2>&1 &
 
   $ waiton $TESTTMP/readyfile
 
   $ hg -R client-other push -fr 'tip' --new-branch
   pushing to ssh://user@dummy/server
   searching for changes
   remote: adding changesets
   remote: adding manifests
   remote: adding file changes
   remote: added 1 changesets with 0 changes to 1 files (+1 heads)
   remote: 1 new obsolescence markers
   remote: obsoleted 1 changesets
   remote: 1 new orphan changesets
 
   $ release $TESTTMP/watchfile
 
 Check the result of the push
 
   $ cat ./push-log
   pushing to ssh://user@dummy/server
   searching for changes
   wrote ready: $TESTTMP/readyfile
   waiting on: $TESTTMP/watchfile
   abort: push failed:
   'remote repository changed while pushing - please try again'
 
   $ hg -R server debugobsolete
   b0ee3d6f51bc4c0ca6d4f2907708027a6c376233 720c5163ecf64dcc6216bee2d62bf3edb1882499 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
   720c5163ecf64dcc6216bee2d62bf3edb1882499 39bc0598afe90ab18da460bafecc0fa953b77596 0 (Thu Jan 01 00:00:00 1970 +0000) {'user': 'test'}
   $ hg -R server graph --hidden
   *  39bc0598afe9 C-W (default)
   |
   | *  a98a47d8b85b C-U (default)
   |/
   x  b0ee3d6f51bc C-Q (default)
   |
   | o  3d57ed3c1091 C-T (other)
   | |
   | o  2efd43f7b5ba C-S (default)
   | |
   | | o  de7b9e2ba3f6 C-R (other)
   | |/
   | o  1b58ee3f79e5 C-P (default)
   | |
   | o  d0a85b2252a9 C-O (other)
   |/
   | x  720c5163ecf6 C-V (default)
   |/
   o  55a6f1c01b48 C-Z (other)
   |
   o    866a66e18630 C-N (default)
   |\
   +---o  6fd3090135df C-M (default)
   | |
   | o  cac2cead0ff0 C-L (default)
   | |
   o |  be705100c623 C-K (default)
   |\|
   o |  d603e2c0cdd7 C-E (default)
   | |
   | o  59e76faf78bd C-D (default)
   | |
   | | o  89420bf00fae C-J (default)
   | | |
   | | | o  b35ed749f288 C-I (my-second-test-branch)
   | | |/
   | | o  75d69cba5402 C-G (default)
   | | |
   | | | o  833be552cfe6 C-H (my-first-test-branch)
   | | |/
   | | o  d9e379a8c432 C-F (default)
   | | |
   +---o  51c544a58128 C-C (default)
   | |
   | o  a9149a1428e2 C-B (default)
   | |
   o |  98217d5a1659 C-A (default)
   |/
   o  842e2fac6304 C-ROOT (default)