~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

Update news and readme

- better explanation of dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
 
1
# Copyright (C) 2004, 2005 by 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
20
20
# executable files with reasonable names.
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
 
import textwrap
24
23
 
25
24
global_help = \
26
25
"""Bazaar-NG -- a free distributed version-control tool
27
 
http://bazaar-vcs.org/
 
26
http://bazaar-ng.org/
 
27
 
 
28
WARNING: This is an unstable development version.
 
29
         Please keep backups.
28
30
 
29
31
Basic commands:
30
32
 
110
112
    outfile.write(doc)
111
113
    if doc[-1] != '\n':
112
114
        outfile.write('\n')
113
 
    help_on_command_options(cmd_object, outfile)
 
115
    help_on_command_options(cmd_object, outfile=None)
114
116
 
115
117
 
116
118
def help_on_command_options(cmd, outfile=None):
128
130
        short_name = option.short_name()
129
131
        if short_name:
130
132
            assert len(short_name) == 1
131
 
            l += ', -' + short_name
 
133
            l += ', -' + shortname
132
134
        l += (30 - len(l)) * ' ' + option.help
133
135
        # TODO: split help over multiple lines with correct indenting and 
134
136
        # wrapping
135
 
        wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
136
 
        outfile.write(wrapped + '\n')
 
137
        outfile.write(l + '\n')
137
138
 
138
139
 
139
140
def help_commands(outfile=None):
159
160
        cmd_help = cmd_object.help()
160
161
        if cmd_help:
161
162
            firstline = cmd_help.split('\n', 1)[0]
162
 
            print >>outfile, '        ' + firstline
 
163
            print >>outfile, '    ' + firstline
163
164