/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 bzr-man.py

  • Committer: Robert Collins
  • Date: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzr-man.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
#!/usr/bin/python
 
2
 
 
3
# Copyright (C) 2005 by Hans Ulrich Niedermann
 
4
# Portions Copyright (C) 2005 by Canonical Ltd
2
5
 
3
6
# This program is free software; you can redistribute it and/or modify
4
7
# it under the terms of the GNU General Public License as published by
5
8
# the Free Software Foundation; either version 2 of the License, or
6
9
# (at your option) any later version.
7
 
#
 
10
 
8
11
# This program is distributed in the hope that it will be useful,
9
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
14
# GNU General Public License for more details.
12
 
#
 
15
 
13
16
# You should have received a copy of the GNU General Public License
14
17
# 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 brz help and static text
18
 
 
19
 
TODO:
20
 
  * use usage information instead of simple "brz foo" in COMMAND OVERVIEW
21
 
  * add command aliases
22
 
"""
23
 
 
24
 
from __future__ import absolute_import
25
 
 
26
 
PLUGINS_TO_DOCUMENT = ["launchpad"]
27
 
 
28
 
import textwrap
29
 
 
30
 
import breezy
31
 
import breezy.help
32
 
import breezy.help_topics
33
 
import breezy.commands
34
 
from breezy.doc_generate import get_autodoc_datetime
35
 
 
36
 
from breezy.plugin import load_plugins
37
 
load_plugins()
38
 
 
39
 
 
40
 
def get_filename(options):
41
 
    """Provides name of manpage"""
42
 
    return "%s.1" % (options.brz_name)
43
 
 
44
 
 
45
 
def infogen(options, outfile):
46
 
    """Assembles a man page"""
47
 
    d = get_autodoc_datetime()
48
 
    params = \
49
 
        {"brzcmd": options.brz_name,
50
 
         "datestamp": d.strftime("%Y-%m-%d"),
51
 
         "timestamp": d.strftime("%Y-%m-%d %H:%M:%S +0000"),
52
 
         "version": breezy.__version__,
53
 
         }
54
 
    outfile.write(man_preamble % params)
55
 
    outfile.write(man_escape(man_head % params))
56
 
    outfile.write(man_escape(getcommand_list(params)))
57
 
    outfile.write(man_escape(getcommand_help(params)))
58
 
    outfile.write("".join(environment_variables()))
59
 
    outfile.write(man_escape(man_foot % params))
 
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
if hasattr(os, "unsetenv"):
 
46
    os.unsetenv(REINVOKE)
 
47
 
 
48
import bzrlib, bzrlib.help
 
49
 
 
50
#>>> code taken from bzr (C) Canonical
 
51
 
 
52
#<<< code by HUN
 
53
 
 
54
import time
 
55
import re
60
56
 
61
57
 
62
58
def man_escape(string):
63
 
    """Escapes strings for man page compatibility"""
64
 
    result = string.replace("\\", "\\\\")
65
 
    result = result.replace("`", "\\'")
66
 
    result = result.replace("'", "\\*(Aq")
67
 
    result = result.replace("-", "\\-")
 
59
    result = string.replace("\\","\\\\")
 
60
    result = result.replace("`","\\`")
 
61
    result = result.replace("'","\\'")
 
62
    result = result.replace("-","\\-")
68
63
    return result
69
64
 
70
65
 
71
 
def command_name_list():
72
 
    """Builds a list of command names from breezy"""
73
 
    command_names = breezy.commands.builtin_command_names()
74
 
    for cmdname in breezy.commands.plugin_command_names():
75
 
        cmd_object = breezy.commands.get_cmd_object(cmdname)
76
 
        if (PLUGINS_TO_DOCUMENT is None or
77
 
                cmd_object.plugin_name() in PLUGINS_TO_DOCUMENT):
78
 
            command_names.append(cmdname)
79
 
    command_names.sort()
80
 
    return command_names
81
 
 
82
 
 
83
 
def getcommand_list(params):
84
 
    """Builds summary help for command names in manpage format"""
85
 
    brzcmd = params["brzcmd"]
86
 
    output = '.SH "COMMAND OVERVIEW"\n'
87
 
    for cmd_name in command_name_list():
88
 
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
89
 
        if cmd_object.hidden:
90
 
            continue
91
 
        cmd_help = cmd_object.help()
92
 
        if cmd_help:
93
 
            firstline = cmd_help.split('\n', 1)[0]
94
 
            usage = cmd_object._usage()
95
 
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
96
 
            output = output + tmp
97
 
        else:
98
 
            raise RuntimeError("Command '%s' has no help text" % (cmd_name))
99
 
    return output
100
 
 
101
 
 
102
 
def getcommand_help(params):
103
 
    """Shows individual options for a brz command"""
104
 
    output = '.SH "COMMAND REFERENCE"\n'
105
 
    formatted = {}
106
 
    for cmd_name in command_name_list():
107
 
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
108
 
        if cmd_object.hidden:
109
 
            continue
110
 
        formatted[cmd_name] = format_command(params, cmd_object)
111
 
        for alias in cmd_object.aliases:
112
 
            formatted[alias] = format_alias(params, alias, cmd_name)
113
 
    for cmd_name in sorted(formatted):
114
 
        output += formatted[cmd_name]
115
 
    return output
116
 
 
117
 
 
118
 
def format_command(params, cmd):
119
 
    """Provides long help for each public command"""
120
 
    subsection_header = '.SS "%s"\n' % (cmd._usage())
121
 
    doc = "%s\n" % (cmd.__doc__)
122
 
    doc = breezy.help_topics.help_as_plain_text(cmd.help())
123
 
 
124
 
    # A dot at the beginning of a line is interpreted as a macro.
125
 
    # Simply join lines that begin with a dot with the previous
126
 
    # line to work around this.
127
 
    doc = doc.replace("\n.", ".")
128
 
 
129
 
    option_str = ""
130
 
    options = cmd.options()
131
 
    if options:
132
 
        option_str = "\nOptions:\n"
133
 
        for option_name, option in sorted(options.items()):
134
 
            for name, short_name, argname, help in option.iter_switches():
135
 
                if option.is_hidden(name):
136
 
                    continue
137
 
                l = '    --' + name
138
 
                if argname is not None:
139
 
                    l += ' ' + argname
140
 
                if short_name:
141
 
                    l += ', -' + short_name
142
 
                l += (30 - len(l)) * ' ' + (help or '')
143
 
                wrapped = textwrap.fill(l, initial_indent='',
144
 
                                        subsequent_indent=30 * ' ',
145
 
                                        break_long_words=False,
146
 
                                        )
147
 
                option_str += wrapped + '\n'
148
 
 
149
 
    aliases_str = ""
150
 
    if cmd.aliases:
151
 
        if len(cmd.aliases) > 1:
152
 
            aliases_str += '\nAliases: '
153
 
        else:
154
 
            aliases_str += '\nAlias: '
155
 
        aliases_str += ', '.join(cmd.aliases)
156
 
        aliases_str += '\n'
157
 
 
158
 
    see_also_str = ""
159
 
    see_also = cmd.get_see_also()
160
 
    if see_also:
161
 
        see_also_str += '\nSee also: '
162
 
        see_also_str += ', '.join(see_also)
163
 
        see_also_str += '\n'
164
 
 
165
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
166
 
 
167
 
 
168
 
def format_alias(params, alias, cmd_name):
169
 
    help = '.SS "brz %s"\n' % alias
170
 
    help += 'Alias for "%s", see "brz %s".\n' % (cmd_name, cmd_name)
171
 
    return help
172
 
 
173
 
 
174
 
def environment_variables():
175
 
    yield ".SH \"ENVIRONMENT\"\n"
176
 
 
177
 
    from breezy.help_topics import known_env_variables
178
 
    for k, desc in known_env_variables:
179
 
        yield ".TP\n"
180
 
        yield ".I \"%s\"\n" % k
181
 
        yield man_escape(desc) + "\n"
 
66
class Parser:
 
67
 
 
68
    def parse_line(self, line):
 
69
        pass
 
70
 
 
71
 
 
72
class CommandListParser(Parser):
 
73
 
 
74
    """Parser for output of "bzr help commands".
 
75
 
 
76
    The parsed content can then be used to
 
77
    - write a "COMMAND OVERVIEW" section into a man page
 
78
    - provide a list of all commands
 
79
    """
 
80
 
 
81
    def __init__(self,params):
 
82
        self.params = params
 
83
        self.command_usage = []
 
84
        self.all_commands = []
 
85
        self.usage_exp = re.compile("([a-z0-9-]+).*")
 
86
        self.descr_exp = re.compile("    ([A-Z].*)\s*")
 
87
        self.state = 0
 
88
        self.command = None
 
89
        self.usage = None
 
90
        self.descr = None
 
91
 
 
92
    def parse_line(self, line):
 
93
        m = self.usage_exp.match(line)
 
94
        if line == '':
 
95
                return
 
96
        if m:
 
97
            if self.state == 0:
 
98
                if self.usage:
 
99
                    self.command_usage.append((self.command,self.usage,self.descr))
 
100
                    self.all_commands.append(self.command)
 
101
                self.usage = " ".join(line.split(" ")[1:])
 
102
                self.command = m.groups()[0]
 
103
            else:
 
104
                raise RuntimeError, "matching usage line in state %d" % state
 
105
            self.state = 1
 
106
            return
 
107
        m = self.descr_exp.match(line)
 
108
        if m:
 
109
            if self.state == 1:
 
110
                self.descr = m.groups()[0]
 
111
            else:
 
112
                raise RuntimeError, "matching descr line in state %d" % state
 
113
            self.state = 0
 
114
            return
 
115
        raise RuntimeError, "Cannot parse this line ('%s')." % line
 
116
 
 
117
    def end_parse(self):
 
118
        if self.state == 0:
 
119
            if self.usage:
 
120
                self.command_usage.append((self.command,self.usage,self.descr))
 
121
                self.all_commands.append(self.command)
 
122
        else:
 
123
            raise RuntimeError, "ending parse in state %d" % state
 
124
 
 
125
    def write_to_manpage(self, outfile):
 
126
        bzrcmd = self.params["bzrcmd"]
 
127
        outfile.write('.SH "COMMAND OVERVIEW"\n')
 
128
        for (command,usage,descr) in self.command_usage:
 
129
            outfile.write('.TP\n.B "%s %s"\n%s\n\n' % (bzrcmd, usage, descr))
 
130
 
 
131
 
 
132
class HelpReader:
 
133
 
 
134
    def __init__(self, parser):
 
135
        self.parser = parser
 
136
 
 
137
    def write(self, data):
 
138
        if data[-1] == '\n':
 
139
            data = data[:-1]
 
140
        for line in data.split('\n'):
 
141
            self.parser.parse_line(line)
 
142
 
 
143
 
 
144
def write_command_details(params, command, usage, descr, outfile):
 
145
    x = ('.SS "%s %s"\n.B "%s"\n.PP\n.B "Usage:"\n%s %s\n\n' %
 
146
         (params["bzrcmd"],
 
147
          command,
 
148
          descr,
 
149
          params["bzrcmd"],
 
150
          usage))
 
151
    outfile.write(man_escape(x))
182
152
 
183
153
 
184
154
man_preamble = """\
185
 
.\\\"Man page for Breezy (%(brzcmd)s)
 
155
.\\\" Man page for %(bzrcmd)s (bazaar-ng)
186
156
.\\\"
187
157
.\\\" Large parts of this file are autogenerated from the output of
188
 
.\\\"     \"%(brzcmd)s help commands\"
189
 
.\\\"     \"%(brzcmd)s help <cmd>\"
190
 
.\\\"
191
 
 
192
 
.ie \\n(.g .ds Aq \\(aq
193
 
.el .ds Aq '
 
158
.\\\"     \"%(bzrcmd)s help commands\"
 
159
.\\\"     \"%(bzrcmd)s help <cmd>\"
 
160
.\\\"
 
161
.\\\" Generation time: %(timestamp)s
 
162
.\\\"
194
163
"""
195
164
 
196
 
 
 
165
# The DESCRIPTION text was taken from http://www.bazaar-ng.org/
 
166
# and is thus (C) Canonical
197
167
man_head = """\
198
 
.TH brz 1 "%(datestamp)s" "%(version)s" "Breezy"
 
168
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
199
169
.SH "NAME"
200
 
%(brzcmd)s - Breezy next-generation distributed version control
 
170
%(bzrcmd)s - bazaar-ng next-generation distributed version control
201
171
.SH "SYNOPSIS"
202
 
.B "%(brzcmd)s"
 
172
.B "%(bzrcmd)s"
203
173
.I "command"
204
174
[
205
175
.I "command_options"
206
176
]
207
177
.br
208
 
.B "%(brzcmd)s"
 
178
.B "%(bzrcmd)s"
209
179
.B "help"
210
180
.br
211
 
.B "%(brzcmd)s"
 
181
.B "%(bzrcmd)s"
212
182
.B "help"
213
183
.I "command"
214
184
.SH "DESCRIPTION"
215
 
 
216
 
Breezy (or %(brzcmd)s) is a distributed version control system that is powerful,
217
 
friendly, and scalable.  Breezy is a fork of the Bazaar version control system.
218
 
 
219
 
Breezy keeps track of changes to software source code (or similar information);
220
 
lets you explore who changed it, when, and why; merges concurrent changes; and
221
 
helps people work together in a team.
 
185
bazaar-ng (or
 
186
.B "%(bzrcmd)s"
 
187
) 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.
 
188
.SS "Warning"
 
189
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.
222
190
"""
223
191
 
224
192
man_foot = """\
 
193
.SH "ENVIRONMENT"
 
194
.TP
 
195
.I "BZRPATH"
 
196
Path where
 
197
.B "%(bzrcmd)s"
 
198
is to look for external command.
 
199
 
 
200
.TP
 
201
.I "BZREMAIL"
 
202
E-Mail address of the user. Overrides
 
203
.I "~/.bzr.conf/email" and
 
204
.IR "EMAIL" .
 
205
Example content:
 
206
.I "John Doe <john@example.com>"
 
207
 
 
208
.TP
 
209
.I "EMAIL"
 
210
E-Mail address of the user. Overridden by the content of the file
 
211
.I "~/.bzr.conf/email"
 
212
and of the environment variable
 
213
.IR "BZREMAIL" .
 
214
 
225
215
.SH "FILES"
226
216
.TP
227
 
.I "~/.config/breezy/breezy.conf"
228
 
Contains the user's default configuration. The section
229
 
.B [DEFAULT]
230
 
is used to define general configuration that will be applied everywhere.
231
 
The section
232
 
.B [ALIASES]
233
 
can be used to create command aliases for
234
 
commonly used options.
235
 
 
236
 
A typical config file might look something like:
237
 
 
238
 
.br
239
 
[DEFAULT]
240
 
.br
241
 
email=John Doe <jdoe@isp.com>
242
 
.br
243
 
[ALIASES]
244
 
.br
245
 
commit = commit --strict
246
 
.br
247
 
log10 = log --short -r -10..-1
 
217
.I "~/.bzr.conf/"
 
218
Directory where all the user\'s settings are stored.
 
219
.TP
 
220
.I "~/.bzr.conf/email"
 
221
Stores name and email address of the user. Overrides content of
 
222
.I "EMAIL"
 
223
environment variable. Example content:
 
224
.I "John Doe <john@example.com>"
 
225
 
248
226
.SH "SEE ALSO"
249
 
.UR https://www.breezy-vcs.org/
250
 
.BR https://www.breezy-vcs.org/
 
227
.UR http://www.bazaar-ng.org/
 
228
.BR http://www.bazaar-ng.org/,
 
229
.UR http://www.bazaar-ng.org/doc/
 
230
.BR http://www.bazaar-ng.org/doc/
251
231
"""
 
232
 
 
233
def main():
 
234
    t = time.time()
 
235
    tt = time.gmtime(t)
 
236
    params = \
 
237
           { "bzrcmd": "bzr",
 
238
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
239
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
240
             "version": bzrlib.__version__,
 
241
             }
 
242
 
 
243
    clp = CommandListParser(params)
 
244
    bzrlib.help.help("commands", outfile=HelpReader(clp))
 
245
    clp.end_parse()
 
246
 
 
247
    filename = "bzr.1"
 
248
    if len(sys.argv) == 2:
 
249
        filename = sys.argv[1]
 
250
    if filename == "-":
 
251
        outfile = sys.stdout
 
252
    else:
 
253
        outfile = open(filename,"w")
 
254
 
 
255
    outfile.write(man_preamble % params)
 
256
    outfile.write(man_escape(man_head % params))
 
257
    clp.write_to_manpage(outfile)
 
258
 
 
259
    # FIXME:
 
260
    #   This doesn't do more than the summary so far.
 
261
    #outfile.write('.SH "DETAILED COMMAND DESCRIPTION"\n')
 
262
    #for (command,usage,descr) in clp.command_usage:
 
263
    #    write_command_details(params, command, usage, descr, outfile = outfile)
 
264
 
 
265
    outfile.write(man_escape(man_foot % params))
 
266
 
 
267
 
 
268
if __name__ == '__main__':
 
269
    main()
 
270
 
 
271
 
 
272
#>>> code by HUN