2008-10-21 14:00:00 +00:00
|
|
|
#
|
|
|
|
# Copyright (C) 2008 The Android Open Source Project
|
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
|
2009-03-04 22:26:50 +00:00
|
|
|
import re
|
2008-10-21 14:00:00 +00:00
|
|
|
import sys
|
|
|
|
from formatter import AbstractFormatter, DumbWriter
|
|
|
|
|
|
|
|
from color import Coloring
|
2009-03-04 01:47:06 +00:00
|
|
|
from command import PagedCommand, MirrorSafeCommand
|
2008-10-21 14:00:00 +00:00
|
|
|
|
2009-03-04 01:47:06 +00:00
|
|
|
class Help(PagedCommand, MirrorSafeCommand):
|
2008-10-21 14:00:00 +00:00
|
|
|
common = False
|
|
|
|
helpSummary = "Display detailed help on a command"
|
|
|
|
helpUsage = """
|
|
|
|
%prog [--all|command]
|
|
|
|
"""
|
|
|
|
helpDescription = """
|
|
|
|
Displays detailed usage information about a command.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def _PrintAllCommands(self):
|
|
|
|
print 'usage: repo COMMAND [ARGS]'
|
|
|
|
print """
|
|
|
|
The complete list of recognized repo commands are:
|
|
|
|
"""
|
|
|
|
commandNames = self.commands.keys()
|
|
|
|
commandNames.sort()
|
|
|
|
|
|
|
|
maxlen = 0
|
|
|
|
for name in commandNames:
|
|
|
|
maxlen = max(maxlen, len(name))
|
|
|
|
fmt = ' %%-%ds %%s' % maxlen
|
|
|
|
|
|
|
|
for name in commandNames:
|
|
|
|
command = self.commands[name]
|
|
|
|
try:
|
|
|
|
summary = command.helpSummary.strip()
|
|
|
|
except AttributeError:
|
|
|
|
summary = ''
|
|
|
|
print fmt % (name, summary)
|
|
|
|
print """
|
|
|
|
See 'repo help <command>' for more information on a specific command.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def _PrintCommonCommands(self):
|
|
|
|
print 'usage: repo COMMAND [ARGS]'
|
|
|
|
print """
|
|
|
|
The most commonly used repo commands are:
|
|
|
|
"""
|
|
|
|
commandNames = [name
|
|
|
|
for name in self.commands.keys()
|
|
|
|
if self.commands[name].common]
|
|
|
|
commandNames.sort()
|
|
|
|
|
|
|
|
maxlen = 0
|
|
|
|
for name in commandNames:
|
|
|
|
maxlen = max(maxlen, len(name))
|
|
|
|
fmt = ' %%-%ds %%s' % maxlen
|
|
|
|
|
|
|
|
for name in commandNames:
|
|
|
|
command = self.commands[name]
|
|
|
|
try:
|
|
|
|
summary = command.helpSummary.strip()
|
|
|
|
except AttributeError:
|
|
|
|
summary = ''
|
|
|
|
print fmt % (name, summary)
|
|
|
|
print """
|
|
|
|
See 'repo help <command>' for more information on a specific command.
|
2009-03-04 22:03:16 +00:00
|
|
|
See 'repo help --all' for a complete list of recognized commands.
|
2008-10-21 14:00:00 +00:00
|
|
|
"""
|
|
|
|
|
|
|
|
def _PrintCommandHelp(self, cmd):
|
|
|
|
class _Out(Coloring):
|
|
|
|
def __init__(self, gc):
|
|
|
|
Coloring.__init__(self, gc, 'help')
|
|
|
|
self.heading = self.printer('heading', attr='bold')
|
|
|
|
|
|
|
|
self.wrap = AbstractFormatter(DumbWriter())
|
|
|
|
|
|
|
|
def _PrintSection(self, heading, bodyAttr):
|
|
|
|
try:
|
|
|
|
body = getattr(cmd, bodyAttr)
|
|
|
|
except AttributeError:
|
|
|
|
return
|
|
|
|
|
|
|
|
self.nl()
|
|
|
|
|
|
|
|
self.heading('%s', heading)
|
|
|
|
self.nl()
|
|
|
|
|
|
|
|
self.heading('%s', ''.ljust(len(heading), '-'))
|
|
|
|
self.nl()
|
|
|
|
|
|
|
|
me = 'repo %s' % cmd.NAME
|
|
|
|
body = body.strip()
|
|
|
|
body = body.replace('%prog', me)
|
|
|
|
|
2009-04-21 15:01:17 +00:00
|
|
|
asciidoc_hdr = re.compile(r'^\n?([^\n]{1,})\n([=~-]{2,})$')
|
2008-10-21 14:00:00 +00:00
|
|
|
for para in body.split("\n\n"):
|
|
|
|
if para.startswith(' '):
|
|
|
|
self.write('%s', para)
|
|
|
|
self.nl()
|
|
|
|
self.nl()
|
2009-03-04 22:26:50 +00:00
|
|
|
continue
|
|
|
|
|
|
|
|
m = asciidoc_hdr.match(para)
|
|
|
|
if m:
|
2009-04-21 15:01:17 +00:00
|
|
|
title = m.group(1)
|
|
|
|
type = m.group(2)
|
|
|
|
if type[0] in ('=', '-'):
|
|
|
|
p = self.heading
|
|
|
|
else:
|
|
|
|
def _p(fmt, *args):
|
|
|
|
self.write(' ')
|
|
|
|
self.heading(fmt, *args)
|
|
|
|
p = _p
|
|
|
|
|
|
|
|
p('%s', title)
|
2009-03-04 22:26:50 +00:00
|
|
|
self.nl()
|
2009-04-21 15:01:17 +00:00
|
|
|
p('%s', ''.ljust(len(title),type[0]))
|
2009-03-04 22:26:50 +00:00
|
|
|
self.nl()
|
|
|
|
continue
|
|
|
|
|
|
|
|
self.wrap.add_flowing_data(para)
|
|
|
|
self.wrap.end_paragraph(1)
|
2008-10-21 14:00:00 +00:00
|
|
|
self.wrap.end_paragraph(0)
|
|
|
|
|
|
|
|
out = _Out(self.manifest.globalConfig)
|
|
|
|
out._PrintSection('Summary', 'helpSummary')
|
2009-04-18 18:44:00 +00:00
|
|
|
cmd.OptionParser.print_help()
|
2008-10-21 14:00:00 +00:00
|
|
|
out._PrintSection('Description', 'helpDescription')
|
|
|
|
|
|
|
|
def _Options(self, p):
|
|
|
|
p.add_option('-a', '--all',
|
|
|
|
dest='show_all', action='store_true',
|
|
|
|
help='show the complete list of commands')
|
|
|
|
|
|
|
|
def Execute(self, opt, args):
|
|
|
|
if len(args) == 0:
|
|
|
|
if opt.show_all:
|
|
|
|
self._PrintAllCommands()
|
|
|
|
else:
|
|
|
|
self._PrintCommonCommands()
|
|
|
|
|
|
|
|
elif len(args) == 1:
|
|
|
|
name = args[0]
|
|
|
|
|
|
|
|
try:
|
|
|
|
cmd = self.commands[name]
|
|
|
|
except KeyError:
|
|
|
|
print >>sys.stderr, "repo: '%s' is not a repo command." % name
|
|
|
|
sys.exit(1)
|
|
|
|
|
2009-06-03 23:01:11 +00:00
|
|
|
cmd.repodir = self.repodir
|
2008-10-21 14:00:00 +00:00
|
|
|
self._PrintCommandHelp(cmd)
|
|
|
|
|
|
|
|
else:
|
|
|
|
self._PrintCommandHelp(self)
|