1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
# Copyright 2006 Canonical Ltd.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Generate ReStructuredText source for manual.
Based on manpage generator autodoc_man.py
Written by Alexander Belchenko
"""
import os
import sys
import textwrap
import time
import bzrlib
import bzrlib.help
import bzrlib.commands
def get_filename(options):
"""Provides name of manual"""
return "%s_man.txt" % (options.bzr_name)
def infogen(options, outfile):
"""Create manual in RSTX format"""
t = time.time()
tt = time.gmtime(t)
params = \
{ "bzrcmd": options.bzr_name,
"datestamp": time.strftime("%Y-%m-%d",tt),
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
"version": bzrlib.__version__,
}
outfile.write(rstx_preamble % params)
outfile.write(rstx_head % params)
outfile.write(getcommand_list(params))
outfile.write(getcommand_help(params))
outfile.write(rstx_foot % params)
def command_name_list():
"""Builds a list of command names from bzrlib"""
command_names = bzrlib.commands.builtin_command_names()
command_names.sort()
return command_names
def getcommand_list (params):
"""Builds summary help for command names in RSTX format"""
bzrcmd = params["bzrcmd"]
output = """
Command overview
================
"""
for cmd_name in command_name_list():
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
if cmd_object.hidden:
continue
cmd_help = cmd_object.help()
if cmd_help:
firstline = cmd_help.split('\n', 1)[0]
usage = cmd_object._usage()
tmp = '**%s**\n\t%s\n\n' % (usage, firstline)
output = output + tmp
else:
raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
return output
def getcommand_help(params):
"""Shows individual options for a bzr command"""
output="""
Command reference
=================
"""
for cmd_name in command_name_list():
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
if cmd_object.hidden:
continue
output = output + format_command(params, cmd_object, cmd_name)
return output
def format_command (params, cmd, name):
"""Provides long help for each public command"""
usage = cmd._usage()
subsection_header = """
%s
%s
::
""" % (usage, '-'*len(usage))
docsplit = cmd.help().split('\n')
doc = '\n'.join([' '*4+line for line in docsplit])
option_str = ""
options = cmd.options()
if options:
option_str = "\n Options:\n"
for option_name, option in sorted(options.items()):
for name, short_name, argname, help in option.iter_switches():
l = ' --' + name
if argname is not None:
l += ' ' + argname
if short_name:
assert len(short_name) == 1
l += ', -' + short_name
l += (30 - len(l)) * ' ' + (help or '')
# TODO: Split help over multiple lines with
# correct indenting and wrapping.
wrapped = textwrap.fill(l, initial_indent='',
subsequent_indent=30*' ')
option_str = option_str + wrapped + '\n'
aliases_str = ""
if cmd.aliases:
if len(cmd.aliases) > 1:
aliases_str += '\n Aliases: '
else:
aliases_str += '\n Alias: '
aliases_str += ', '.join(cmd.aliases)
aliases_str += '\n'
see_also_str = ""
see_also = cmd.get_see_also()
if see_also:
see_also_str += '\n See also: '
see_also_str += ', '.join(see_also)
see_also_str += '\n'
return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
##
# TEMPLATES
rstx_preamble = """.. Large parts of this file are autogenerated from the output of
.. %(bzrcmd)s help commands
.. %(bzrcmd)s help <cmd>
..
.. Generation time: %(timestamp)s
=============================================
Man page for Bazaar (%(bzrcmd)s)
=============================================
:Date: %(datestamp)s
`Index <#id1>`_
-----
"""
rstx_head = """\
Name
====
Bazaar (%(bzrcmd)s) - next-generation distributed version control
Synopsis
========
**%(bzrcmd)s** *command* [ *command_options* ]
**%(bzrcmd)s help**
**%(bzrcmd)s help** *command*
Description
===========
Bazaar (or **%(bzrcmd)s**) is a project of Canonical to develop
an open source distributed version control system that is powerful,
friendly, and scalable. Version control means a system
that keeps track of previous revisions of software source code
or similar information and helps people work on it in teams.
"""
rstx_foot = """
Environment
===========
**BZRPATH**
Path where **%(bzrcmd)s** is to look for shell plugin external commands.
**BZR_EMAIL**
E-Mail address of the user. Overrides default user config.
**EMAIL**
E-Mail address of the user. Overrides default user config.
**BZR_EDITOR**
Editor for editing commit messages
**EDITOR**
Editor for editing commit messages
**BZR_PLUGIN_PATH**
Paths where bzr should look for plugins
**BZR_HOME**
Home directory for bzr
Files
=====
**On Linux**: ``~/.bazaar/bazaar.conf``
**On Windows**: ``C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf``
Contains the user's default configuration. The section ``[DEFAULT]`` is
used to define general configuration that will be applied everywhere.
The section ``[ALIASES]`` can be used to create command aliases for
commonly used options.
A typical config file might look something like::
[DEFAULT]
email=John Doe <jdoe@isp.com>
[ALIASES]
commit = commit --strict
log10 = log --short -r -10..-1
See also
========
http://www.bazaar-vcs.org/
--------------------
.. Contents::
**Index**
"""
|