/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 breezy/doc_generate/autodoc_man.py

  • Committer: Jelmer Vernooij
  • Date: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/doc_generate/autodoc_man.py
 
1
# Copyright (C) 2005-2010 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 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
PLUGINS_TO_DOCUMENT = ["launchpad"]
 
25
 
 
26
import textwrap
 
27
 
 
28
import breezy
 
29
import breezy.help
 
30
import breezy.help_topics
 
31
import breezy.commands
 
32
from breezy.doc_generate import get_autodoc_datetime
 
33
 
 
34
from breezy.plugin import load_plugins
 
35
load_plugins()
 
36
 
 
37
 
 
38
def get_filename(options):
 
39
    """Provides name of manpage"""
 
40
    return "%s.1" % (options.brz_name)
 
41
 
 
42
 
 
43
def infogen(options, outfile):
 
44
    """Assembles a man page"""
 
45
    d = get_autodoc_datetime()
 
46
    params = \
 
47
        {"brzcmd": options.brz_name,
 
48
         "datestamp": d.strftime("%Y-%m-%d"),
 
49
         "timestamp": d.strftime("%Y-%m-%d %H:%M:%S +0000"),
 
50
         "version": breezy.__version__,
 
51
         }
 
52
    outfile.write(man_preamble % params)
 
53
    outfile.write(man_escape(man_head % params))
 
54
    outfile.write(man_escape(getcommand_list(params)))
 
55
    outfile.write(man_escape(getcommand_help(params)))
 
56
    outfile.write("".join(environment_variables()))
 
57
    outfile.write(man_escape(man_foot % params))
 
58
 
 
59
 
 
60
def man_escape(string):
 
61
    """Escapes strings for man page compatibility"""
 
62
    result = string.replace("\\", "\\\\")
 
63
    result = result.replace("`", "\\'")
 
64
    result = result.replace("'", "\\*(Aq")
 
65
    result = result.replace("-", "\\-")
 
66
    return result
 
67
 
 
68
 
 
69
def command_name_list():
 
70
    """Builds a list of command names from breezy"""
 
71
    command_names = breezy.commands.builtin_command_names()
 
72
    for cmdname in breezy.commands.plugin_command_names():
 
73
        cmd_object = breezy.commands.get_cmd_object(cmdname)
 
74
        if (PLUGINS_TO_DOCUMENT is None or
 
75
                cmd_object.plugin_name() in PLUGINS_TO_DOCUMENT):
 
76
            command_names.append(cmdname)
 
77
    command_names.sort()
 
78
    return command_names
 
79
 
 
80
 
 
81
def getcommand_list(params):
 
82
    """Builds summary help for command names in manpage format"""
 
83
    brzcmd = params["brzcmd"]
 
84
    output = '.SH "COMMAND OVERVIEW"\n'
 
85
    for cmd_name in command_name_list():
 
86
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
 
87
        if cmd_object.hidden:
 
88
            continue
 
89
        cmd_help = cmd_object.help()
 
90
        if cmd_help:
 
91
            firstline = cmd_help.split('\n', 1)[0]
 
92
            usage = cmd_object._usage()
 
93
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
 
94
            output = output + tmp
 
95
        else:
 
96
            raise RuntimeError("Command '%s' has no help text" % (cmd_name))
 
97
    return output
 
98
 
 
99
 
 
100
def getcommand_help(params):
 
101
    """Shows individual options for a brz command"""
 
102
    output = '.SH "COMMAND REFERENCE"\n'
 
103
    formatted = {}
 
104
    for cmd_name in command_name_list():
 
105
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
 
106
        if cmd_object.hidden:
 
107
            continue
 
108
        formatted[cmd_name] = format_command(params, cmd_object)
 
109
        for alias in cmd_object.aliases:
 
110
            formatted[alias] = format_alias(params, alias, cmd_name)
 
111
    for cmd_name in sorted(formatted):
 
112
        output += formatted[cmd_name]
 
113
    return output
 
114
 
 
115
 
 
116
def format_command(params, cmd):
 
117
    """Provides long help for each public command"""
 
118
    subsection_header = '.SS "%s"\n' % (cmd._usage())
 
119
    doc = "%s\n" % (cmd.__doc__)
 
120
    doc = breezy.help_topics.help_as_plain_text(cmd.help())
 
121
 
 
122
    # A dot at the beginning of a line is interpreted as a macro.
 
123
    # Simply join lines that begin with a dot with the previous
 
124
    # line to work around this.
 
125
    doc = doc.replace("\n.", ".")
 
126
 
 
127
    option_str = ""
 
128
    options = cmd.options()
 
129
    if options:
 
130
        option_str = "\nOptions:\n"
 
131
        for option_name, option in sorted(options.items()):
 
132
            for name, short_name, argname, help in option.iter_switches():
 
133
                if option.is_hidden(name):
 
134
                    continue
 
135
                l = '    --' + name
 
136
                if argname is not None:
 
137
                    l += ' ' + argname
 
138
                if short_name:
 
139
                    l += ', -' + short_name
 
140
                l += (30 - len(l)) * ' ' + (help or '')
 
141
                wrapped = textwrap.fill(l, initial_indent='',
 
142
                                        subsequent_indent=30 * ' ',
 
143
                                        break_long_words=False,
 
144
                                        )
 
145
                option_str += wrapped + '\n'
 
146
 
 
147
    aliases_str = ""
 
148
    if cmd.aliases:
 
149
        if len(cmd.aliases) > 1:
 
150
            aliases_str += '\nAliases: '
 
151
        else:
 
152
            aliases_str += '\nAlias: '
 
153
        aliases_str += ', '.join(cmd.aliases)
 
154
        aliases_str += '\n'
 
155
 
 
156
    see_also_str = ""
 
157
    see_also = cmd.get_see_also()
 
158
    if see_also:
 
159
        see_also_str += '\nSee also: '
 
160
        see_also_str += ', '.join(see_also)
 
161
        see_also_str += '\n'
 
162
 
 
163
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
164
 
 
165
 
 
166
def format_alias(params, alias, cmd_name):
 
167
    help = '.SS "brz %s"\n' % alias
 
168
    help += 'Alias for "%s", see "brz %s".\n' % (cmd_name, cmd_name)
 
169
    return help
 
170
 
 
171
 
 
172
def environment_variables():
 
173
    yield ".SH \"ENVIRONMENT\"\n"
 
174
 
 
175
    from breezy.help_topics import known_env_variables
 
176
    for k, desc in known_env_variables:
 
177
        yield ".TP\n"
 
178
        yield ".I \"%s\"\n" % k
 
179
        yield man_escape(desc) + "\n"
 
180
 
 
181
 
 
182
man_preamble = """\
 
183
.\\\"Man page for Breezy (%(brzcmd)s)
 
184
.\\\"
 
185
.\\\" Large parts of this file are autogenerated from the output of
 
186
.\\\"     \"%(brzcmd)s help commands\"
 
187
.\\\"     \"%(brzcmd)s help <cmd>\"
 
188
.\\\"
 
189
 
 
190
.ie \\n(.g .ds Aq \\(aq
 
191
.el .ds Aq '
 
192
"""
 
193
 
 
194
 
 
195
man_head = """\
 
196
.TH brz 1 "%(datestamp)s" "%(version)s" "Breezy"
 
197
.SH "NAME"
 
198
%(brzcmd)s - Breezy next-generation distributed version control
 
199
.SH "SYNOPSIS"
 
200
.B "%(brzcmd)s"
 
201
.I "command"
 
202
[
 
203
.I "command_options"
 
204
]
 
205
.br
 
206
.B "%(brzcmd)s"
 
207
.B "help"
 
208
.br
 
209
.B "%(brzcmd)s"
 
210
.B "help"
 
211
.I "command"
 
212
.SH "DESCRIPTION"
 
213
 
 
214
Breezy (or %(brzcmd)s) is a distributed version control system that is powerful,
 
215
friendly, and scalable.  Breezy is a fork of the Bazaar version control system.
 
216
 
 
217
Breezy keeps track of changes to software source code (or similar information);
 
218
lets you explore who changed it, when, and why; merges concurrent changes; and
 
219
helps people work together in a team.
 
220
"""
 
221
 
 
222
man_foot = """\
 
223
.SH "FILES"
 
224
.TP
 
225
.I "~/.config/breezy/breezy.conf"
 
226
Contains the user's default configuration. The section
 
227
.B [DEFAULT]
 
228
is used to define general configuration that will be applied everywhere.
 
229
The section
 
230
.B [ALIASES]
 
231
can be used to create command aliases for
 
232
commonly used options.
 
233
 
 
234
A typical config file might look something like:
 
235
 
 
236
.br
 
237
[DEFAULT]
 
238
.br
 
239
email=John Doe <jdoe@isp.com>
 
240
.br
 
241
[ALIASES]
 
242
.br
 
243
commit = commit --strict
 
244
.br
 
245
log10 = log --short -r -10..-1
 
246
.SH "SEE ALSO"
 
247
.UR https://www.breezy-vcs.org/
 
248
.BR https://www.breezy-vcs.org/
 
249
"""