comparison mercurial/cmdutil.py @ 37603:678d760c71ff

export: extract function to write patch to file object (API)

This is common use case of cmdutil.export(), and we wouldn't want to handle
formatter thingy everywhere.

.. api::

   The ``fp`` argument is removed from ``cmdutil.export()``. Use
   ``cmdutil.exportfile()`` instead.

37602:52670eaa14b4

                fm.startitem()
                ctx = repo[rev]
                _exportsingle(repo, ctx, fm, match, switch_parent, seqno,
                              diffopts)

def export(repo, revs, fntemplate='hg-%h.patch', fp=None, switch_parent=False,
           opts=None, match=None):
    '''export changesets as hg patches

    Args:
      repo: The repository from which we're exporting revisions.
      revs: A list of revisions to export as revision numbers.
      fntemplate: An optional string to use for generating patch file names.
      fp: An optional file-like object to which patches should be written.
      switch_parent: If True, show diffs against second parent when not nullid.
                     Default is false, which always shows diff against p1.
      opts: diff options to use for generating the patch.
      match: If specified, only export changes to files matching this matcher.

      Nothing.

    Side Effect:
      "HG Changeset Patch" data is emitted to one of the following
      destinations:
        fp is specified: All revs are written to the specified
                         file-like object.
        fntemplate specified: Each rev is written to a unique file named using
                            the given template.
        Neither fp nor template specified: All revs written to repo.ui.write()
    '''
    if fp or not fntemplate:
        _exportfile(repo, revs, fp, switch_parent, opts, match)
    else:
        _exportfntemplate(repo, revs, fntemplate, switch_parent, opts, match)

def showmarker(fm, marker, index=None):
    """utility function to display obsolescence marker in a readable way

    To be used by debug function."""

37603:678d760c71ff

                fm.startitem()
                ctx = repo[rev]
                _exportsingle(repo, ctx, fm, match, switch_parent, seqno,
                              diffopts)

def export(repo, revs, fntemplate='hg-%h.patch', switch_parent=False,
           opts=None, match=None):
    '''export changesets as hg patches

    Args:
      repo: The repository from which we're exporting revisions.
      revs: A list of revisions to export as revision numbers.
      fntemplate: An optional string to use for generating patch file names.
      switch_parent: If True, show diffs against second parent when not nullid.
                     Default is false, which always shows diff against p1.
      opts: diff options to use for generating the patch.
      match: If specified, only export changes to files matching this matcher.

      Nothing.

    Side Effect:
      "HG Changeset Patch" data is emitted to one of the following
      destinations:
        fntemplate specified: Each rev is written to a unique file named using
                            the given template.
        Otherwise: All revs written to repo.ui.write()
    '''
    if not fntemplate:
        _exportfile(repo, revs, None, switch_parent, opts, match)
    else:
        _exportfntemplate(repo, revs, fntemplate, switch_parent, opts, match)

def exportfile(repo, revs, fp, switch_parent=False, opts=None, match=None):
    """Export changesets to the given file stream"""
    _exportfile(repo, revs, fp, switch_parent, opts, match)

def showmarker(fm, marker, index=None):
    """utility function to display obsolescence marker in a readable way

    To be used by debug function."""