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

  • Committer: Robert Collins
  • Date: 2007-07-15 15:40:37 UTC
  • mto: (2592.3.33 repository)
  • mto: This revision was merged to the branch mainline in revision 2624.
  • Revision ID: robertc@robertcollins.net-20070715154037-3ar8g89decddc9su
Make GraphIndex accept nodes as key, value, references, so that the method
signature is closer to what a simple key->value index delivers. Also
change the behaviour when the reference list count is zero to accept
key, value as nodes, and emit key, value to make it identical in that case
to a simple key->value index. This may not be a good idea, but for now it
seems ok.

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
 
28
28
 
29
29
import bzrlib
30
30
import bzrlib.help
31
 
import bzrlib.help_topics
32
31
import bzrlib.commands
33
32
 
34
33
 
92
91
def getcommand_help(params):
93
92
    """Shows individual options for a bzr command"""
94
93
    output='.SH "COMMAND REFERENCE"\n'
95
 
    formatted = {}
96
94
    for cmd_name in command_name_list():
97
95
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
98
96
        if cmd_object.hidden:
99
97
            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]
 
98
        output = output + format_command(params, cmd_object)
105
99
    return output
106
100
 
107
101
 
109
103
    """Provides long help for each public command"""
110
104
    subsection_header = '.SS "%s"\n' % (cmd._usage())
111
105
    doc = "%s\n" % (cmd.__doc__)
112
 
    doc = bzrlib.help_topics.help_as_plain_text(cmd.help())
 
106
    doc = cmd.help()
113
107
 
114
108
    option_str = ""
115
109
    options = cmd.options()
117
111
        option_str = "\nOptions:\n"
118
112
        for option_name, option in sorted(options.items()):
119
113
            for name, short_name, argname, help in option.iter_switches():
120
 
                if option.is_hidden(name):
121
 
                    continue
122
114
                l = '    --' + name
123
115
                if argname is not None:
124
116
                    l += ' ' + argname
125
117
                if short_name:
 
118
                    assert len(short_name) == 1
126
119
                    l += ', -' + short_name
127
120
                l += (30 - len(l)) * ' ' + (help or '')
128
121
                wrapped = textwrap.fill(l, initial_indent='',
129
 
                    subsequent_indent=30*' ',
130
 
                    break_long_words=False,
131
 
                    )
 
122
                                        subsequent_indent=30*' ')
132
123
                option_str = option_str + wrapped + '\n'       
133
124
 
134
125
    aliases_str = ""
150
141
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
151
142
 
152
143
 
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
144
man_preamble = """\
160
 
.\\\"Man page for Bazaar (%(bzrcmd)s)
 
145
Man page for Bazaar (%(bzrcmd)s)
161
146
.\\\"
162
147
.\\\" Large parts of this file are autogenerated from the output of
163
148
.\\\"     \"%(bzrcmd)s help commands\"
171
156
man_head = """\
172
157
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
173
158
.SH "NAME"
174
 
%(bzrcmd)s - Bazaar next-generation distributed version control
 
159
Bazaar (%(bzrcmd)s) - next-generation distributed version control
175
160
.SH "SYNOPSIS"
176
161
.B "%(bzrcmd)s"
177
162
.I "command"
241
226
.br
242
227
log10 = log --short -r -10..-1
243
228
.SH "SEE ALSO"
244
 
.UR http://www.bazaar.canonical.com/
245
 
.BR http://www.bazaar.canonical.com/
 
229
.UR http://www.bazaar-vcs.org/
 
230
.BR http://www.bazaar-vcs.org/
246
231
"""
247
232