~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzr-man.py

  • Committer: Martin Pool
  • Date: 2005-06-06 13:24:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050606132418-1082c87e2473e266
- manpage generator by Hans Ulrich Niedermann

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#!/usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 by Hans Ulrich Niedermann
 
4
# Portions Copyright (C) 2005 by Canonical Ltd
 
5
 
 
6
# This program is free software; you can redistribute it and/or modify
 
7
# it under the terms of the GNU General Public License as published by
 
8
# the Free Software Foundation; either version 2 of the License, or
 
9
# (at your option) any later version.
 
10
 
 
11
# This program is distributed in the hope that it will be useful,
 
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
# GNU General Public License for more details.
 
15
 
 
16
# You should have received a copy of the GNU General Public License
 
17
# along with this program; if not, write to the Free Software
 
18
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
19
 
 
20
#<<< code taken from bzr (C) Canonical
 
21
 
 
22
import os, sys
 
23
 
 
24
try:
 
25
    version_info = sys.version_info
 
26
except AttributeError:
 
27
    version_info = 1, 5 # 1.5 or older
 
28
 
 
29
 
 
30
REINVOKE = "__BZR_REINVOKE"    
 
31
NEED_VERS = (2, 3)
 
32
 
 
33
if version_info < NEED_VERS:
 
34
    if not os.environ.has_key(REINVOKE):
 
35
        # mutating os.environ doesn't work in old Pythons
 
36
        os.putenv(REINVOKE, "1")
 
37
        for python in 'python2.4', 'python2.3':
 
38
            try:
 
39
                os.execvp(python, [python] + sys.argv)
 
40
            except OSError:
 
41
                pass
 
42
    print >>sys.stderr, "bzr-man.py: error: cannot find a suitable python interpreter"
 
43
    print >>sys.stderr, "  (need %d.%d or later)" % NEED_VERS
 
44
    sys.exit(1)
 
45
os.unsetenv(REINVOKE)
 
46
 
 
47
import bzrlib, bzrlib.help
 
48
 
 
49
#>>> code taken from bzr (C) Canonical
 
50
 
 
51
#<<< code by HUN
 
52
 
 
53
import time
 
54
import re
 
55
 
 
56
 
 
57
def man_escape(string):
 
58
    result = string.replace("\\","\\\\")
 
59
    result = result.replace("`","\\`")
 
60
    result = result.replace("'","\\'")
 
61
    result = result.replace("-","\\-")
 
62
    return result
 
63
 
 
64
 
 
65
class Parser:
 
66
 
 
67
    def parse_line(self, line):
 
68
        pass
 
69
 
 
70
 
 
71
class CommandListParser(Parser):
 
72
 
 
73
    """Parser for output of "bzr help commands".
 
74
 
 
75
    The parsed content can then be used to
 
76
    - write a "COMMAND OVERVIEW" section into a man page
 
77
    - provide a list of all commands
 
78
    """
 
79
 
 
80
    def __init__(self,params):
 
81
        self.params = params
 
82
        self.command_usage = []
 
83
        self.all_commands = []
 
84
        self.usage_exp = re.compile("([a-z0-9-]+).*")
 
85
        self.descr_exp = re.compile("    ([A-Z].*)\s*")
 
86
        self.state = 0
 
87
        self.command = None
 
88
        self.usage = None
 
89
        self.descr = None
 
90
 
 
91
    def parse_line(self, line):
 
92
        m = self.usage_exp.match(line)
 
93
        if m:
 
94
            if self.state == 0:
 
95
                if self.usage:
 
96
                    self.command_usage.append((self.command,self.usage,self.descr))
 
97
                    self.all_commands.append(self.command)
 
98
                self.usage = line
 
99
                self.command = m.groups()[0]
 
100
            else:
 
101
                raise Error, "matching usage line in state %d" % state
 
102
            self.state = 1
 
103
            return
 
104
        m = self.descr_exp.match(line)
 
105
        if m:
 
106
            if self.state == 1:
 
107
                self.descr = m.groups()[0]
 
108
            else:
 
109
                raise Error, "matching descr line in state %d" % state
 
110
            self.state = 0
 
111
            return
 
112
        raise Error, "Cannot parse this line"
 
113
 
 
114
    def end_parse(self):
 
115
        if self.state == 0:
 
116
            if self.usage:
 
117
                self.command_usage.append((self.command,self.usage,self.descr))
 
118
                self.all_commands.append(self.command)
 
119
        else:
 
120
            raise Error, "ending parse in state %d" % state
 
121
 
 
122
    def write_to_manpage(self, outfile):
 
123
        bzrcmd = self.params["bzrcmd"]
 
124
        outfile.write('.SH "COMMAND OVERVIEW"\n')
 
125
        for (command,usage,descr) in self.command_usage:
 
126
            outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
 
127
 
 
128
 
 
129
class HelpReader:
 
130
 
 
131
    def __init__(self, parser):
 
132
        self.parser = parser
 
133
 
 
134
    def write(self, data):
 
135
        if data[-1] == '\n':
 
136
            data = data[:-1]
 
137
        for line in data.split('\n'):
 
138
            self.parser.parse_line(line)
 
139
 
 
140
 
 
141
def write_command_details(params, command, usage, descr, outfile):
 
142
    x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
 
143
         (params["bzrcmd"],
 
144
          command,
 
145
          descr,
 
146
          params["bzrcmd"],
 
147
          usage))
 
148
    outfile.write(man_escape(x))
 
149
 
 
150
 
 
151
man_preamble = """\
 
152
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
 
153
.\\\"
 
154
.\\\" Large parts of this file are autogenerated from the output of
 
155
.\\\"     \"%(bzrcmd)s help commands\"
 
156
.\\\"     \"%(bzrcmd)s help <cmd>\"
 
157
.\\\"
 
158
.\\\" Generation time: %(timestamp)s
 
159
.\\\"
 
160
"""
 
161
 
 
162
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
163
# and is thus (C) Canonical
 
164
man_head = """\
 
165
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
 
166
.SH "NAME"
 
167
%(bzrcmd)s - bazaar-ng next-generation distributed version control
 
168
.SH "SYNOPSIS"
 
169
.B "%(bzrcmd)s"
 
170
.I "command"
 
171
[
 
172
.I "command_options"
 
173
]
 
174
.br
 
175
.B "%(bzrcmd)s"
 
176
.B "help"
 
177
.br
 
178
.B "%(bzrcmd)s"
 
179
.B "help"
 
180
.I "command"
 
181
.SH "DESCRIPTION"
 
182
bazaar-ng (or
 
183
.B "%(bzrcmd)s"
 
184
) 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.
 
185
.SS "Warning"
 
186
bazaar-ng is at an early stage of development, and the design is still changing from week to week. This man page here may be inconsistent with itself, with other documentation or with the code, and sometimes refer to features that are planned but not yet written. Comments are still very welcome; please send them to bazaar-ng@lists.canonical.com.
 
187
"""
 
188
 
 
189
man_foot = """\
 
190
.SH "ENVIRONMENT"
 
191
.TP
 
192
.I "BZRPATH"
 
193
Path where
 
194
.B "%(bzrcmd)s"
 
195
is to look for external command.
 
196
 
 
197
.TP
 
198
.I "BZREMAIL"
 
199
E-Mail address of the user. Overrides
 
200
.I "~/.bzr.conf/email" and
 
201
.IR "EMAIL" .
 
202
Example content:
 
203
.I "John Doe <john@example.com>"
 
204
 
 
205
.TP
 
206
.I "EMAIL"
 
207
E-Mail address of the user. Overridden by the content of the file
 
208
.I "~/.bzr.conf/email"
 
209
and of the environment variable
 
210
.IR "BZREMAIL" .
 
211
 
 
212
.SH "FILES"
 
213
.TP
 
214
.I "~/.bzr.conf/"
 
215
Directory where all the user\'s settings are stored.
 
216
.TP
 
217
.I "~/.bzr.conf/email"
 
218
Stores name and email address of the user. Overrides content of
 
219
.I "EMAIL"
 
220
environment variable. Example content:
 
221
.I "John Doe <john@example.com>"
 
222
 
 
223
.SH "SEE ALSO"
 
224
.UR http://www.bazaar-ng.org/
 
225
.BR http://www.bazaar-ng.org/,
 
226
.UR http://www.bazaar-ng.org/doc/
 
227
.BR http://www.bazaar-ng.org/doc/
 
228
"""
 
229
 
 
230
def main():
 
231
    t = time.time()
 
232
    tt = time.gmtime(t)
 
233
    params = \
 
234
           { "bzrcmd": "bzr",
 
235
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
236
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
237
             "version": bzrlib.__version__,
 
238
             }
 
239
 
 
240
    clp = CommandListParser(params)
 
241
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
242
    clp.end_parse()
 
243
 
 
244
    filename = "bzr.1"
 
245
    if len(sys.argv) == 2:
 
246
        filename = sys.argv[1]
 
247
    if filename == "-":
 
248
        outfile = sys.stdout
 
249
    else:
 
250
        outfile = open(filename,"w")
 
251
 
 
252
    outfile.write(man_preamble % params)
 
253
    outfile.write(man_escape(man_head % params))
 
254
    clp.write_to_manpage(outfile)
 
255
 
 
256
    # FIXME:
 
257
    #   This doesn't do more than the summary so far.
 
258
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
259
    #for (command,usage,descr) in clp.command_usage:
 
260
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
261
 
 
262
    outfile.write(man_escape(man_foot % params))
 
263
 
 
264
 
 
265
if __name__ == '__main__':
 
266
    main()
 
267
 
 
268
 
 
269
#>>> code by HUN