← 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-08-15 15:50:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1927.
  • Revision ID: john@arbash-meinel.com-20060815155031-f1480d692d2cf9d2
There is no strict ordering file addition, other than directories are added before child files

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_man.py
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
103
103
    """Provides long help for each public command"""
104
104
    subsection_header = '.SS "%s"\n' % (bzrlib.help.command_usage(cmd))
105
105
    doc = "%s\n" % (cmd.__doc__)
106
 
    docsplit = cmd.__doc__.split('\n')
107
 
    doc = '\n'.join([docsplit[0]] + [line[4:] for line in docsplit[1:]])
 
106
    doc = cmd.help()
 
107
 
108
108
    option_str = ""
109
109
    options = cmd.options()
110
110
    if options:
123
123
            wrapped = textwrap.fill(l, initial_indent='',
124
124
                                    subsequent_indent=30*' ')
125
125
            option_str = option_str + wrapped + '\n'       
126
 
    return subsection_header + option_str + "\n" + doc + "\n"
 
126
 
 
127
    aliases_str = ""
 
128
    if cmd.aliases:
 
129
        if len(cmd.aliases) > 1:
 
130
            aliases_str += '\nAliases: '
 
131
        else:
 
132
            aliases_str += '\nAlias: '
 
133
        aliases_str += ', '.join(cmd.aliases)
 
134
        aliases_str += '\n'
 
135
 
 
136
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
127
137
 
128
138
 
129
139
man_preamble = """\
130
 
Man page for %(bzrcmd)s (bazaar-ng)
 
140
Man page for Bazaar (%(bzrcmd)s)
131
141
.\\\"
132
142
.\\\" Large parts of this file are autogenerated from the output of
133
143
.\\\"     \"%(bzrcmd)s help commands\"
139
149
 
140
150
 
141
151
man_head = """\
142
 
.TH bzr 1 "%(datestamp)s" "%(version)s" "bazaar-ng"
 
152
.TH bzr 1 "%(datestamp)s" "%(version)s" "Bazaar"
143
153
.SH "NAME"
144
 
%(bzrcmd)s - bazaar-ng next-generation distributed version control
 
154
Bazaar (%(bzrcmd)s) - next-generation distributed version control
145
155
.SH "SYNOPSIS"
146
156
.B "%(bzrcmd)s"
147
157
.I "command"
156
166
.B "help"
157
167
.I "command"
158
168
.SH "DESCRIPTION"
159
 
bazaar-ng (or
160
 
.B "%(bzrcmd)s"
161
 
) 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.
162
 
.SS "Warning"
163
 
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.
 
169
Bazaar (or %(bzrcmd)s) is a project of Canonical to develop an open source
 
170
distributed version control system that is powerful, friendly, and scalable.
 
171
Version control means a system that keeps track of previous revisions
 
172
of software source code or similar information and helps people work on it in teams.
164
173
"""
165
174
 
166
175
man_foot = """\
171
180
.B "%(bzrcmd)s"
172
181
is to look for external command.
173
182
.TP
174
 
.I "BZREMAIL"
 
183
.I "BZR_EMAIL"
175
184
E-Mail address of the user. Overrides default user config.
176
185
.TP
177
186
.I "EMAIL"
178
187
E-Mail address of the user. Overriddes default user config.
 
188
.TP
 
189
.I "BZR_EDITOR"
 
190
Editor for editing commit messages
 
191
.TP
 
192
.I "EDITOR"
 
193
Editor for editing commit messages
 
194
.TP
 
195
.I "BZR_PLUGIN_PATH"
 
196
Paths where bzr should look for plugins
 
197
.TP
 
198
.I "BZR_HOME"
 
199
Home directory for bzr
179
200
.SH "FILES"
180
201
.TP
181
 
.I "~/.bazaar/bazaar.conf/"
182
 
Contains the default user config. Only one section, [DEFAULT] is allowed. A 
183
 
typical default config file may be similiar to:
184
 
.br
185
 
.br
 
202
.I "~/.bazaar/bazaar.conf"
 
203
Contains the users default configuration. The section
186
204
.B [DEFAULT]
187
 
.br
188
 
.B email=John Doe <jdoe@isp.com>
 
205
is used to define general configuration that will be applied everywhere.
 
206
The section
 
207
.B [ALIASES]
 
208
can be used to create command aliases for
 
209
commonly used options.
 
210
 
 
211
A typical config file might look something like:
 
212
 
 
213
.br
 
214
[DEFAULT]
 
215
.br
 
216
email=John Doe <jdoe@isp.com>
 
217
.br
 
218
[ALIASES]
 
219
.br
 
220
commit = commit --strict
 
221
.br
 
222
log10 = log --short -r -10..-1
189
223
.SH "SEE ALSO"
190
 
.UR http://bazaar.canonical.com/
191
 
.BR http://bazaar.canonical.com/,
192
 
.UR http://www.bazaar-ng.org/
193
 
.BR http://www.bazaar-ng.org/
 
224
.UR http://www.bazaar-vcs.org/
 
225
.BR http://www.bazaar-vcs.org/
194
226
"""
195
227