← 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: John Arbash Meinel
  • Date: 2006-10-24 14:12:53 UTC
  • mto: This revision was merged to the branch mainline in revision 2095.
  • Revision ID: john@arbash-meinel.com-20061024141253-783fba812b197b70
(John Arbash Meinel) Update version information for 0.13 development

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
80
80
        cmd_help = cmd_object.help()
81
81
        if cmd_help:
82
82
            firstline = cmd_help.split('\n', 1)[0]
83
 
            usage = cmd_object._usage()
 
83
            usage = bzrlib.help.command_usage(cmd_object)
84
84
            tmp = '.TP\n.B "%s"\n%s\n' % (usage, firstline)
85
85
            output = output + tmp
86
86
        else:
101
101
 
102
102
def format_command (params, cmd):
103
103
    """Provides long help for each public command"""
104
 
    subsection_header = '.SS "%s"\n' % (cmd._usage())
 
104
    subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
105
105
    doc = "%s\n" % (cmd.__doc__)
106
106
    doc = cmd.help()
107
107
 
117
117
                if short_name:
118
118
                    assert len(short_name) == 1
119
119
                    l += ', -' + short_name
120
 
                l += (30 - len(l)) * ' ' + (help or '')
 
120
                l += (30 - len(l)) * ' ' + help
 
121
                # TODO: Split help over multiple lines with
 
122
                # correct indenting and wrapping.
121
123
                wrapped = textwrap.fill(l, initial_indent='',
122
124
                                        subsequent_indent=30*' ')
123
125
                option_str = option_str + wrapped + '\n'       
131
133
        aliases_str += ', '.join(cmd.aliases)
132
134
        aliases_str += '\n'
133
135
 
134
 
    see_also_str = ""
135
 
    see_also = cmd.get_see_also()
136
 
    if see_also:
137
 
        see_also_str += '\nSee also: '
138
 
        see_also_str += ', '.join(see_also)
139
 
        see_also_str += '\n'
140
 
 
141
 
    return subsection_header + option_str + aliases_str + see_also_str + "\n" + doc + "\n"
 
136
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
142
137
 
143
138
 
144
139
man_preamble = """\
183
178
.I "BZRPATH"
184
179
Path where
185
180
.B "%(bzrcmd)s"
186
 
is to look for shell plugin external commands.
 
181
is to look for external command.
187
182
.TP
188
183
.I "BZR_EMAIL"
189
184
E-Mail address of the user. Overrides default user config.
190
185
.TP
191
186
.I "EMAIL"
192
 
E-Mail address of the user. Overrides default user config.
 
187
E-Mail address of the user. Overriddes default user config.
193
188
.TP
194
189
.I "BZR_EDITOR"
195
190
Editor for editing commit messages
205
200
.SH "FILES"
206
201
.TP
207
202
.I "~/.bazaar/bazaar.conf"
208
 
Contains the user's default configuration. The section
 
203
Contains the users default configuration. The section
209
204
.B [DEFAULT]
210
205
is used to define general configuration that will be applied everywhere.
211
206
The section