/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_man.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-07 22:00:11 UTC
  • mto: (1908.4.6 commit-perf)
  • mto: This revision was merged to the branch mainline in revision 1923.
  • Revision ID: john@arbash-meinel.com-20060807220011-b98533a8b1815b31
Update the benchmarks to actually use the cached trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright 2005 Canonical Ltd.
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""man.py - create man page from built-in bzr help and static text
18
18
 
28
28
 
29
29
import bzrlib
30
30
import bzrlib.help
31
 
import bzrlib.help_topics
32
31
import bzrlib.commands
33
32
 
34
33
 
81
80
        cmd_help = cmd_object.help()
82
81
        if cmd_help:
83
82
            firstline = cmd_help.split('\n', 1)[0]
84
 
            usage = cmd_object._usage()
 
83
            usage = bzrlib.help.command_usage(cmd_object)
85
84
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
86
85
            output = output + tmp
87
86
        else:
92
91
def getcommand_help(params):
93
92
    """Shows individual options for a bzr command"""
94
93
    output='.SH "COMMAND REFERENCE"\n'
95
 
    formatted = {}
96
94
    for cmd_name in command_name_list():
97
95
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
98
96
        if cmd_object.hidden:
99
97
            continue
100
 
        formatted[cmd_name] = format_command(params, cmd_object)
101
 
        for alias in cmd_object.aliases:
102
 
            formatted[alias] = format_alias(params, alias, cmd_name)
103
 
    for cmd_name in sorted(formatted):
104
 
        output += formatted[cmd_name]
 
98
        output = output + format_command(params, cmd_object)
105
99
    return output
106
100
 
107
101
 
108
102
def format_command (params, cmd):
109
103
    """Provides long help for each public command"""
110
 
    subsection_header = '.SS "%s"\n' % (cmd._usage())
 
104
    subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
111
105
    doc = "%s\n" % (cmd.__doc__)
112
 
    doc = bzrlib.help_topics.help_as_plain_text(cmd.help())
 
106
    doc = cmd.help()
113
107
 
114
108
    option_str = ""
115
109
    options = cmd.options()
116
110
    if options:
117
111
        option_str = "\nOptions:\n"
118
112
        for option_name, option in sorted(options.items()):
119
 
            for name, short_name, argname, help in option.iter_switches():
120
 
                if option.is_hidden(name):
121
 
                    continue
122
 
                l = '    --' + name
123
 
                if argname is not None:
124
 
                    l += ' ' + argname
125
 
                if short_name:
126
 
                    l += ', -' + short_name
127
 
                l += (30 - len(l)) * ' ' + (help or '')
128
 
                wrapped = textwrap.fill(l, initial_indent='',
129
 
                    subsequent_indent=30*' ',
130
 
                    break_long_words=False,
131
 
                    )
132
 
                option_str = option_str + wrapped + '\n'       
 
113
            l = '    --' + option_name
 
114
            if option.type is not None:
 
115
                l += ' ' + option.argname.upper()
 
116
            short_name = option.short_name()
 
117
            if short_name:
 
118
                assert len(short_name) == 1
 
119
                l += ', -' + short_name
 
120
            l += (30 - len(l)) * ' ' + option.help
 
121
            # TODO: Split help over multiple lines with
 
122
            # correct indenting and wrapping.
 
123
            wrapped = textwrap.fill(l, initial_indent='',
 
124
                                    subsequent_indent=30*' ')
 
125
            option_str = option_str + wrapped + '\n'       
133
126
 
134
127
    aliases_str = ""
135
128
    if cmd.aliases:
140
133
        aliases_str += ', '.join(cmd.aliases)
141
134
        aliases_str += '\n'
142
135
 
143
 
    see_also_str = ""
144
 
    see_also = cmd.get_see_also()
145
 
    if see_also:
146
 
        see_also_str += '\nSee also: '
147
 
        see_also_str += ', '.join(see_also)
148
 
        see_also_str += '\n'
149
 
 
150
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
151
 
 
152
 
 
153
 
def format_alias(params, alias, cmd_name):
154
 
    help = '.SS "bzr %s"\n' % alias
155
 
    help += 'Alias for "%s", see "bzr %s".\n' % (cmd_name, cmd_name)
156
 
    return help
 
136
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
157
137
 
158
138
 
159
139
man_preamble = """\
160
 
.\\\"Man page for Bazaar (%(bzrcmd)s)
 
140
Man page for Bazaar (%(bzrcmd)s)
161
141
.\\\"
162
142
.\\\" Large parts of this file are autogenerated from the output of
163
143
.\\\"     \"%(bzrcmd)s help commands\"
171
151
man_head = """\
172
152
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
173
153
.SH "NAME"
174
 
%(bzrcmd)s - Bazaar next-generation distributed version control
 
154
Bazaar (%(bzrcmd)s) - next-generation distributed version control
175
155
.SH "SYNOPSIS"
176
156
.B "%(bzrcmd)s"
177
157
.I "command"
198
178
.I "BZRPATH"
199
179
Path where
200
180
.B "%(bzrcmd)s"
201
 
is to look for shell plugin external commands.
 
181
is to look for external command.
202
182
.TP
203
183
.I "BZR_EMAIL"
204
184
E-Mail address of the user. Overrides default user config.
205
185
.TP
206
186
.I "EMAIL"
207
 
E-Mail address of the user. Overrides default user config.
 
187
E-Mail address of the user. Overriddes default user config.
208
188
.TP
209
189
.I "BZR_EDITOR"
210
190
Editor for editing commit messages
220
200
.SH "FILES"
221
201
.TP
222
202
.I "~/.bazaar/bazaar.conf"
223
 
Contains the user's default configuration. The section
 
203
Contains the users default configuration. The section
224
204
.B [DEFAULT]
225
205
is used to define general configuration that will be applied everywhere.
226
206
The section
241
221
.br
242
222
log10 = log --short -r -10..-1
243
223
.SH "SEE ALSO"
244
 
.UR http://www.bazaar.canonical.com/
245
 
.BR http://www.bazaar.canonical.com/
 
224
.UR http://www.bazaar-vcs.org/
 
225
.BR http://www.bazaar-vcs.org/
246
226
"""
247
227