/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: 2009-06-18 18:18:36 UTC
  • mto: This revision was merged to the branch mainline in revision 4461.
  • Revision ID: john@arbash-meinel.com-20090618181836-biodfkat9a8eyzjz
The new add_inventory_by_delta is returning a CHKInventory when mapping from NULL
Which is completely valid, but 'broke' one of the tests.
So to fix it, changed the test to use CHKInventories on both sides, and add an __eq__
member. The nice thing is that CHKInventory.__eq__ is fairly cheap, since it only
has to check the root keys.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
 
1
# Copyright 2005 Canonical Ltd.
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
"""man.py - create man page from built-in bzr help and static text
 
18
 
 
19
TODO:
 
20
  * use usage information instead of simple "bzr foo" in COMMAND OVERVIEW
 
21
  * add command aliases
 
22
"""
 
23
 
 
24
import os
 
25
import sys
 
26
import textwrap
 
27
import time
 
28
 
 
29
import bzrlib
 
30
import bzrlib.help
 
31
import bzrlib.help_topics
 
32
import bzrlib.commands
 
33
 
 
34
 
 
35
def get_filename(options):
 
36
    """Provides name of manpage"""
 
37
    return "%s.1" % (options.bzr_name)
 
38
 
 
39
 
 
40
def infogen(options, outfile):
 
41
    """Assembles a man page"""
 
42
    t = time.time()
 
43
    tt = time.gmtime(t)
 
44
    params = \
 
45
           { "bzrcmd": options.bzr_name,
 
46
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
47
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
48
             "version": bzrlib.__version__,
 
49
             }
 
50
    outfile.write(man_preamble % params)
 
51
    outfile.write(man_escape(man_head % params))
 
52
    outfile.write(man_escape(getcommand_list(params)))
 
53
    outfile.write(man_escape(getcommand_help(params)))
 
54
    outfile.write(man_escape(man_foot % params))
 
55
 
 
56
 
 
57
def man_escape(string):
 
58
    """Escapes strings for man page compatibility"""
 
59
    result = string.replace("\\","\\\\")
 
60
    result = result.replace("`","\\`")
 
61
    result = result.replace("'","\\'")
 
62
    result = result.replace("-","\\-")
 
63
    return result
 
64
 
 
65
 
 
66
def command_name_list():
 
67
    """Builds a list of command names from bzrlib"""
 
68
    command_names = bzrlib.commands.builtin_command_names()
 
69
    command_names.sort()
 
70
    return command_names
 
71
 
 
72
 
 
73
def getcommand_list (params):
 
74
    """Builds summary help for command names in manpage format"""
 
75
    bzrcmd = params["bzrcmd"]
 
76
    output = '.SH "COMMAND OVERVIEW"\n'
 
77
    for cmd_name in command_name_list():
 
78
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
79
        if cmd_object.hidden:
 
80
            continue
 
81
        cmd_help = cmd_object.help()
 
82
        if cmd_help:
 
83
            firstline = cmd_help.split('\n', 1)[0]
 
84
            usage = cmd_object._usage()
 
85
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
 
86
            output = output + tmp
 
87
        else:
 
88
            raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
 
89
    return output
 
90
 
 
91
 
 
92
def getcommand_help(params):
 
93
    """Shows individual options for a bzr command"""
 
94
    output='.SH "COMMAND REFERENCE"\n'
 
95
    formatted = {}
 
96
    for cmd_name in command_name_list():
 
97
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
98
        if cmd_object.hidden:
 
99
            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]
 
105
    return output
 
106
 
 
107
 
 
108
def format_command (params, cmd):
 
109
    """Provides long help for each public command"""
 
110
    subsection_header = '.SS "%s"\n' % (cmd._usage())
 
111
    doc = "%s\n" % (cmd.__doc__)
 
112
    doc = bzrlib.help_topics.help_as_plain_text(cmd.help())
 
113
 
 
114
    option_str = ""
 
115
    options = cmd.options()
 
116
    if options:
 
117
        option_str = "\nOptions:\n"
 
118
        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
                    assert len(short_name) == 1
 
127
                    l += ', -' + short_name
 
128
                l += (30 - len(l)) * ' ' + (help or '')
 
129
                wrapped = textwrap.fill(l, initial_indent='',
 
130
                                        subsequent_indent=30*' ')
 
131
                option_str = option_str + wrapped + '\n'       
 
132
 
 
133
    aliases_str = ""
 
134
    if cmd.aliases:
 
135
        if len(cmd.aliases) > 1:
 
136
            aliases_str += '\nAliases: '
 
137
        else:
 
138
            aliases_str += '\nAlias: '
 
139
        aliases_str += ', '.join(cmd.aliases)
 
140
        aliases_str += '\n'
 
141
 
 
142
    see_also_str = ""
 
143
    see_also = cmd.get_see_also()
 
144
    if see_also:
 
145
        see_also_str += '\nSee also: '
 
146
        see_also_str += ', '.join(see_also)
 
147
        see_also_str += '\n'
 
148
 
 
149
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
150
 
 
151
 
 
152
def format_alias(params, alias, cmd_name):
 
153
    help = '.SS "bzr %s"\n' % alias
 
154
    help += 'Alias for "%s", see "bzr %s".\n' % (cmd_name, cmd_name)
 
155
    return help
 
156
 
 
157
 
 
158
man_preamble = """\
 
159
.\\\"Man page for Bazaar (%(bzrcmd)s)
 
160
.\\\"
 
161
.\\\" Large parts of this file are autogenerated from the output of
 
162
.\\\"     \"%(bzrcmd)s help commands\"
 
163
.\\\"     \"%(bzrcmd)s help <cmd>\"
 
164
.\\\"
 
165
.\\\" Generation time: %(timestamp)s
 
166
.\\\"
 
167
"""
 
168
 
 
169
 
 
170
man_head = """\
 
171
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
 
172
.SH "NAME"
 
173
Bazaar (%(bzrcmd)s) - next-generation distributed version control
 
174
.SH "SYNOPSIS"
 
175
.B "%(bzrcmd)s"
 
176
.I "command"
 
177
[
 
178
.I "command_options"
 
179
]
 
180
.br
 
181
.B "%(bzrcmd)s"
 
182
.B "help"
 
183
.br
 
184
.B "%(bzrcmd)s"
 
185
.B "help"
 
186
.I "command"
 
187
.SH "DESCRIPTION"
 
188
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
 
189
distributed version control system that is powerful, friendly, and scalable.
 
190
Version control means a system that keeps track of previous revisions
 
191
of software source code or similar information and helps people work on it in teams.
 
192
"""
 
193
 
 
194
man_foot = """\
 
195
.SH "ENVIRONMENT"
 
196
.TP
 
197
.I "BZRPATH"
 
198
Path where
 
199
.B "%(bzrcmd)s"
 
200
is to look for shell plugin external commands.
 
201
.TP
 
202
.I "BZR_EMAIL"
 
203
E-Mail address of the user. Overrides default user config.
 
204
.TP
 
205
.I "EMAIL"
 
206
E-Mail address of the user. Overrides default user config.
 
207
.TP
 
208
.I "BZR_EDITOR"
 
209
Editor for editing commit messages
 
210
.TP
 
211
.I "EDITOR"
 
212
Editor for editing commit messages
 
213
.TP
 
214
.I "BZR_PLUGIN_PATH"
 
215
Paths where bzr should look for plugins
 
216
.TP
 
217
.I "BZR_HOME"
 
218
Home directory for bzr
 
219
.SH "FILES"
 
220
.TP
 
221
.I "~/.bazaar/bazaar.conf"
 
222
Contains the user's default configuration. The section
 
223
.B [DEFAULT]
 
224
is used to define general configuration that will be applied everywhere.
 
225
The section
 
226
.B [ALIASES]
 
227
can be used to create command aliases for
 
228
commonly used options.
 
229
 
 
230
A typical config file might look something like:
 
231
 
 
232
.br
 
233
[DEFAULT]
 
234
.br
 
235
email=John Doe <jdoe@isp.com>
 
236
.br
 
237
[ALIASES]
 
238
.br
 
239
commit = commit --strict
 
240
.br
 
241
log10 = log --short -r -10..-1
 
242
.SH "SEE ALSO"
 
243
.UR http://www.bazaar-vcs.org/
 
244
.BR http://www.bazaar-vcs.org/
 
245
"""
 
246