Mercurial > hg
view contrib/lock-checker.py @ 20689:401f9b661a2d
doc: show short description of each commands in generated documents
Before this patch, short description of each commands is not shown in
generated documents (HTML file and UNIX man page). This omitting may
prevent users from understanding about commands.
This patch show it as the 1st paragraph in the help section of each
commands. This style is chosen because:
- showing it as the section title in "command - short desc" style
disallows referencing by "#command" in HTML file: in "en" locale,
hyphen concatenated title is used as the section ID in HTML file
for this style
- showing it as the 1st paragraph in "command - short desc" style
seems to be redundant: "command" appears also just before as the
section title
- showing it just after synopsis like "hg help command" seems not to
be reasonable in UNIX man page
This patch just writes short description ("d['desc'][0]") before "::",
because it should be already "strip()"-ed in "get_desc()", or empty
string for the command without description.
author | FUJIWARA Katsunori <foozy@lares.dti.ne.jp> |
---|---|
date | Tue, 11 Mar 2014 14:36:40 +0900 |
parents | 47d0843647d1 |
children |
line wrap: on
line source
"""Extension to verify locks are obtained in the required places. This works by wrapping functions that should be surrounded by a lock and asserting the lock is held. Missing locks are called out with a traceback printed to stderr. This currently only checks store locks, not working copy locks. """ import os from mercurial import util def _checklock(repo): l = repo._lockref and repo._lockref() if l is None or not l.held: util.debugstacktrace('missing lock', skip=1) def reposetup(ui, repo): orig = repo.__class__ class lockcheckrepo(repo.__class__): def _writejournal(self, *args, **kwargs): _checklock(self) return orig._writejournal(self, *args, **kwargs) def transaction(self, *args, **kwargs): _checklock(self) return orig.transaction(self, *args, **kwargs) # TODO(durin42): kiilerix had a commented-out lock check in # _writebranchcache and _writerequirements def _tag(self, *args, **kwargs): _checklock(self) return orig._tag(self, *args, **kwargs) def write(self, *args, **kwargs): assert os.path.lexists(self._join('.hg/wlock')) return orig.write(self, *args, **kwargs) repo.__class__ = lockcheckrepo