Mercurial > hg
view hgext/show.py @ 32697:19b9fc40cc51
revlog: skeleton support for version 2 revlogs
There are a number of improvements we want to make to revlogs
that will require a new version - version 2. It is unclear what the
full set of improvements will be or when we'll be done with them.
What I do know is that the process will likely take longer than a
single release, will require input from various stakeholders to
evaluate changes, and will have many contentious debates and
bikeshedding.
It is unrealistic to develop revlog version 2 up front: there
are just too many uncertainties that we won't know until things
are implemented and experiments are run. Some changes will also
be invasive and prone to bit rot, so sitting on dozens of patches
is not practical.
This commit introduces skeleton support for version 2 revlogs in
a way that is flexible and not bound by backwards compatibility
concerns.
An experimental repo requirement for denoting revlog v2 has been
added. The requirement string has a sub-version component to it.
This will allow us to declare multiple requirements in the course
of developing revlog v2. Whenever we change the in-development
revlog v2 format, we can tweak the string, creating a new
requirement and locking out old clients. This will allow us to
make as many backwards incompatible changes and experiments to
revlog v2 as we want. In other words, we can land code and make
meaningful progress towards revlog v2 while still maintaining
extreme format flexibility up until the point we freeze the
format and remove the experimental labels.
To enable the new repo requirement, you must supply an experimental
and undocumented config option. But not just any boolean flag
will do: you need to explicitly use a value that no sane person
should ever type. This is an additional guard against enabling
revlog v2 on an installation it shouldn't be enabled on. The
specific scenario I'm trying to prevent is say a user with a
4.4 client with a frozen format enabling the option but then
downgrading to 4.3 and accidentally creating repos with an
outdated and unsupported repo format. Requiring a "challenge"
string should prevent this.
Because the format is not yet finalized and I don't want to take
any chances, revlog v2's version is currently 0xDEAD. I figure
squatting on a value we're likely never to use as an actual revlog
version to mean "internal testing only" is acceptable. And
"dead" is easily recognized as something meaningful.
There is a bunch of cleanup that is needed before work on revlog
v2 begins in earnest. I plan on doing that work once this patch
is accepted and we're comfortable with the idea of starting down
this path.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Fri, 19 May 2017 20:29:11 -0700 |
parents | 04baab18d60a |
children | 50586a0a946f |
line wrap: on
line source
# show.py - Extension implementing `hg show` # # Copyright 2017 Gregory Szorc <gregory.szorc@gmail.com> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. """unified command to show various repository information (EXPERIMENTAL) This extension provides the :hg:`show` command, which provides a central command for displaying commonly-accessed repository data and views of that data. """ from __future__ import absolute_import from mercurial.i18n import _ from mercurial.node import nullrev from mercurial import ( cmdutil, error, formatter, graphmod, pycompat, registrar, revset, revsetlang, ) # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # be specifying the version(s) of Mercurial they are tested with, or # leave the attribute unspecified. testedwith = 'ships-with-hg-core' cmdtable = {} command = registrar.command(cmdtable) revsetpredicate = registrar.revsetpredicate() class showcmdfunc(registrar._funcregistrarbase): """Register a function to be invoked for an `hg show <thing>`.""" # Used by _formatdoc(). _docformat = '%s -- %s' def _extrasetup(self, name, func, fmtopic=None): """Called with decorator arguments to register a show view. ``name`` is the sub-command name. ``func`` is the function being decorated. ``fmtopic`` is the topic in the style that will be rendered for this view. """ func._fmtopic = fmtopic showview = showcmdfunc() @command('show', [ # TODO: Switch this template flag to use cmdutil.formatteropts if # 'hg show' becomes stable before --template/-T is stable. For now, # we are putting it here without the '(EXPERIMENTAL)' flag because it # is an important part of the 'hg show' user experience and the entire # 'hg show' experience is experimental. ('T', 'template', '', ('display with template'), _('TEMPLATE')), ], _('VIEW')) def show(ui, repo, view=None, template=None): """show various repository information A requested view of repository data is displayed. If no view is requested, the list of available views is shown and the command aborts. .. note:: There are no backwards compatibility guarantees for the output of this command. Output may change in any future Mercurial release. Consumers wanting stable command output should specify a template via ``-T/--template``. List of available views: """ if ui.plain() and not template: hint = _('invoke with -T/--template to control output format') raise error.Abort(_('must specify a template in plain mode'), hint=hint) views = showview._table if not view: ui.pager('show') # TODO consider using formatter here so available views can be # rendered to custom format. ui.write(_('available views:\n')) ui.write('\n') for name, func in sorted(views.items()): ui.write(('%s\n') % func.__doc__) ui.write('\n') raise error.Abort(_('no view requested'), hint=_('use "hg show VIEW" to choose a view')) # TODO use same logic as dispatch to perform prefix matching. if view not in views: raise error.Abort(_('unknown view: %s') % view, hint=_('run "hg show" to see available views')) template = template or 'show' fmtopic = 'show%s' % views[view]._fmtopic ui.pager('show') with ui.formatter(fmtopic, {'template': template}) as fm: return views[view](ui, repo, fm) @showview('bookmarks', fmtopic='bookmarks') def showbookmarks(ui, repo, fm): """bookmarks and their associated changeset""" marks = repo._bookmarks if not len(marks): # This is a bit hacky. Ideally, templates would have a way to # specify an empty output, but we shouldn't corrupt JSON while # waiting for this functionality. if not isinstance(fm, formatter.jsonformatter): ui.write(_('(no bookmarks set)\n')) return active = repo._activebookmark longestname = max(len(b) for b in marks) # TODO consider exposing longest shortest(node). for bm, node in sorted(marks.items()): fm.startitem() fm.context(ctx=repo[node]) fm.write('bookmark', '%s', bm) fm.write('node', fm.hexfunc(node), fm.hexfunc(node)) fm.data(active=bm == active, longestbookmarklen=longestname) @revsetpredicate('_underway([commitage[, headage]])') def underwayrevset(repo, subset, x): args = revset.getargsdict(x, 'underway', 'commitage headage') if 'commitage' not in args: args['commitage'] = None if 'headage' not in args: args['headage'] = None # We assume callers of this revset add a topographical sort on the # result. This means there is no benefit to making the revset lazy # since the topographical sort needs to consume all revs. # # With this in mind, we build up the set manually instead of constructing # a complex revset. This enables faster execution. # Mutable changesets (non-public) are the most important changesets # to return. ``not public()`` will also pull in obsolete changesets if # there is a non-obsolete changeset with obsolete ancestors. This is # why we exclude obsolete changesets from this query. rs = 'not public() and not obsolete()' rsargs = [] if args['commitage']: rs += ' and date(%s)' rsargs.append(revsetlang.getstring(args['commitage'], _('commitage requires a string'))) mutable = repo.revs(rs, *rsargs) relevant = revset.baseset(mutable) # Add parents of mutable changesets to provide context. relevant += repo.revs('parents(%ld)', mutable) # We also pull in (public) heads if they a) aren't closing a branch # b) are recent. rs = 'head() and not closed()' rsargs = [] if args['headage']: rs += ' and date(%s)' rsargs.append(revsetlang.getstring(args['headage'], _('headage requires a string'))) relevant += repo.revs(rs, *rsargs) # Add working directory parent. wdirrev = repo['.'].rev() if wdirrev != nullrev: relevant += revset.baseset({wdirrev}) return subset & relevant @showview('work', fmtopic='work') def showwork(ui, repo, fm): """changesets that aren't finished""" # TODO support date-based limiting when calling revset. revs = repo.revs('sort(_underway(), topo)') revdag = graphmod.dagwalker(repo, revs) displayer = cmdutil.changeset_templater(ui, repo, None, None, tmpl=fm._t.load(fm._topic), mapfile=None, buffered=True) ui.setconfig('experimental', 'graphshorten', True) cmdutil.displaygraph(ui, repo, revdag, displayer, graphmod.asciiedges) # Adjust the docstring of the show command so it shows all registered views. # This is a bit hacky because it runs at the end of module load. When moved # into core or when another extension wants to provide a view, we'll need # to do this more robustly. # TODO make this more robust. def _updatedocstring(): longest = max(map(len, showview._table.keys())) entries = [] for key in sorted(showview._table.keys()): entries.append(pycompat.sysstr(' %s %s' % ( key.ljust(longest), showview._table[key]._origdoc))) cmdtable['show'][0].__doc__ = pycompat.sysstr('%s\n\n%s\n ') % ( cmdtable['show'][0].__doc__.rstrip(), pycompat.sysstr('\n\n').join(entries)) _updatedocstring()