← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_man.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 16:58:03 UTC
  • mfrom: (3224.3.1 news-typo)
  • Revision ID: pqm@pqm.ubuntu.com-20080316165803-tisoc9mpob9z544o
(Matt Nordhoff) Trivial NEWS typo fix

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright 2005 Canonical Ltd.
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""man.py - create man page from built-in bzr help and static text
18
18
 
92
92
def getcommand_help(params):
93
93
    """Shows individual options for a bzr command"""
94
94
    output='.SH "COMMAND REFERENCE"\n'
95
 
    formatted = {}
96
95
    for cmd_name in command_name_list():
97
96
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
98
97
        if cmd_object.hidden:
99
98
            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]
 
99
        output = output + format_command(params, cmd_object)
105
100
    return output
106
101
 
107
102
 
123
118
                if argname is not None:
124
119
                    l += ' ' + argname
125
120
                if short_name:
 
121
                    assert len(short_name) == 1
126
122
                    l += ', -' + short_name
127
123
                l += (30 - len(l)) * ' ' + (help or '')
128
124
                wrapped = textwrap.fill(l, initial_indent='',
129
 
                    subsequent_indent=30*' ',
130
 
                    break_long_words=False,
131
 
                    )
 
125
                                        subsequent_indent=30*' ')
132
126
                option_str = option_str + wrapped + '\n'       
133
127
 
134
128
    aliases_str = ""
150
144
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
151
145
 
152
146
 
153
 
def format_alias(params, alias, cmd_name):
154
 
    help = '.SS "bzr %s"\n' % alias
155
 
    help += 'Alias for "%s", see "bzr %s".\n' % (cmd_name, cmd_name)
156
 
    return help
157
 
 
158
 
 
159
147
man_preamble = """\
160
 
.\\\"Man page for Bazaar (%(bzrcmd)s)
 
148
Man page for Bazaar (%(bzrcmd)s)
161
149
.\\\"
162
150
.\\\" Large parts of this file are autogenerated from the output of
163
151
.\\\"     \"%(bzrcmd)s help commands\"
171
159
man_head = """\
172
160
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
173
161
.SH "NAME"
174
 
%(bzrcmd)s - Bazaar next-generation distributed version control
 
162
Bazaar (%(bzrcmd)s) - next-generation distributed version control
175
163
.SH "SYNOPSIS"
176
164
.B "%(bzrcmd)s"
177
165
.I "command"
186
174
.B "help"
187
175
.I "command"
188
176
.SH "DESCRIPTION"
189
 
 
190
 
Bazaar (or %(bzrcmd)s) is a distributed version control system that is powerful, 
191
 
friendly, and scalable.  Bazaar is a project of Canonical Ltd and part of 
192
 
the GNU Project to develop a free operating system.
193
 
 
194
 
Bazaar keeps track of changes to software source code (or similar information);
195
 
lets you explore who changed it, when, and why; merges concurrent changes; and
196
 
helps people work together in a team.
 
177
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
 
178
distributed version control system that is powerful, friendly, and scalable.
 
179
Version control means a system that keeps track of previous revisions
 
180
of software source code or similar information and helps people work on it in teams.
197
181
"""
198
182
 
199
183
man_foot = """\
245
229
.br
246
230
log10 = log --short -r -10..-1
247
231
.SH "SEE ALSO"
248
 
.UR http://bazaar.canonical.com/
249
 
.BR http://bazaar.canonical.com/
 
232
.UR http://www.bazaar-vcs.org/
 
233
.BR http://www.bazaar-vcs.org/
250
234
"""
251
235