|
|
# help.py - help data for mercurial
|
|
|
#
|
|
|
# Copyright 2006 Matt Mackall <mpm@selenic.com>
|
|
|
#
|
|
|
# This software may be used and distributed according to the terms of the
|
|
|
# GNU General Public License version 2 or any later version.
|
|
|
|
|
|
from i18n import gettext, _
|
|
|
import sys, os
|
|
|
import extensions
|
|
|
|
|
|
|
|
|
def moduledoc(file):
|
|
|
'''return the top-level python documentation for the given file
|
|
|
|
|
|
Loosely inspired by pydoc.source_synopsis(), but rewritten to
|
|
|
handle triple quotes and to return the whole text instead of just
|
|
|
the synopsis'''
|
|
|
result = []
|
|
|
|
|
|
line = file.readline()
|
|
|
while line[:1] == '#' or not line.strip():
|
|
|
line = file.readline()
|
|
|
if not line:
|
|
|
break
|
|
|
|
|
|
start = line[:3]
|
|
|
if start == '"""' or start == "'''":
|
|
|
line = line[3:]
|
|
|
while line:
|
|
|
if line.rstrip().endswith(start):
|
|
|
line = line.split(start)[0]
|
|
|
if line:
|
|
|
result.append(line)
|
|
|
break
|
|
|
elif not line:
|
|
|
return None # unmatched delimiter
|
|
|
result.append(line)
|
|
|
line = file.readline()
|
|
|
else:
|
|
|
return None
|
|
|
|
|
|
return ''.join(result)
|
|
|
|
|
|
def listexts(header, exts, maxlength, indent=1):
|
|
|
'''return a text listing of the given extensions'''
|
|
|
if not exts:
|
|
|
return ''
|
|
|
result = '\n%s\n\n' % header
|
|
|
for name, desc in sorted(exts.iteritems()):
|
|
|
result += '%s%-*s %s\n' % (' ' * indent, maxlength + 2,
|
|
|
':%s:' % name, desc)
|
|
|
return result
|
|
|
|
|
|
def extshelp():
|
|
|
doc = loaddoc('extensions')()
|
|
|
|
|
|
exts, maxlength = extensions.enabled()
|
|
|
doc += listexts(_('enabled extensions:'), exts, maxlength)
|
|
|
|
|
|
exts, maxlength = extensions.disabled()
|
|
|
doc += listexts(_('disabled extensions:'), exts, maxlength)
|
|
|
|
|
|
return doc
|
|
|
|
|
|
def loaddoc(topic):
|
|
|
"""Return a delayed loader for help/topic.txt."""
|
|
|
|
|
|
def loader():
|
|
|
if hasattr(sys, 'frozen'):
|
|
|
module = sys.executable
|
|
|
else:
|
|
|
module = __file__
|
|
|
base = os.path.dirname(module)
|
|
|
|
|
|
for dir in ('.', '..'):
|
|
|
docdir = os.path.join(base, dir, 'help')
|
|
|
if os.path.isdir(docdir):
|
|
|
break
|
|
|
|
|
|
path = os.path.join(docdir, topic + ".txt")
|
|
|
doc = gettext(open(path).read())
|
|
|
for rewriter in helphooks.get(topic, []):
|
|
|
doc = rewriter(topic, doc)
|
|
|
return doc
|
|
|
|
|
|
return loader
|
|
|
|
|
|
helptable = [
|
|
|
(["config", "hgrc"], _("Configuration Files"), loaddoc('config')),
|
|
|
(["dates"], _("Date Formats"), loaddoc('dates')),
|
|
|
(["patterns"], _("File Name Patterns"), loaddoc('patterns')),
|
|
|
(['environment', 'env'], _('Environment Variables'),
|
|
|
loaddoc('environment')),
|
|
|
(['revs', 'revisions'], _('Specifying Single Revisions'),
|
|
|
loaddoc('revisions')),
|
|
|
(['mrevs', 'multirevs'], _('Specifying Multiple Revisions'),
|
|
|
loaddoc('multirevs')),
|
|
|
(['revset', 'revsets'], _("Specifying Revision Sets"), loaddoc('revsets')),
|
|
|
(['diffs'], _('Diff Formats'), loaddoc('diffs')),
|
|
|
(['merge-tools'], _('Merge Tools'), loaddoc('merge-tools')),
|
|
|
(['templating', 'templates'], _('Template Usage'),
|
|
|
loaddoc('templates')),
|
|
|
(['urls'], _('URL Paths'), loaddoc('urls')),
|
|
|
(["extensions"], _("Using additional features"), extshelp),
|
|
|
(["subrepo", "subrepos"], _("Subrepositories"), loaddoc('subrepos')),
|
|
|
(["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
|
|
|
(["glossary"], _("Glossary"), loaddoc('glossary')),
|
|
|
]
|
|
|
|
|
|
# Map topics to lists of callable taking the current topic help and
|
|
|
# returning the updated version
|
|
|
helphooks = {
|
|
|
}
|
|
|
|
|
|
def addtopichook(topic, rewriter):
|
|
|
helphooks.setdefault(topic, []).append(rewriter)
|
|
|
|
|
|
def makeitemsdoc(topic, doc, marker, items):
|
|
|
"""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 = (items[name].__doc__ or '').rstrip()
|
|
|
if not text:
|
|
|
continue
|
|
|
text = gettext(text)
|
|
|
lines = text.splitlines()
|
|
|
lines[1:] = [(' ' + l.strip()) for l in lines[1:]]
|
|
|
entries.append('\n'.join(lines))
|
|
|
entries = '\n\n'.join(entries)
|
|
|
return doc.replace(marker, entries)
|
|
|
|
