← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Martin Pool
  • Date: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
18
18
"""Bazaar-NG -- a free distributed version-control tool
19
19
http://bazaar-ng.org/
20
20
 
21
 
WARNING: This is an unstable development version.
22
 
         Please keep backups.
23
 
 
24
 
Basic commands:
25
 
 
26
 
  bzr init      makes this branch versioned
27
 
  bzr branch    make a copy of another branch
28
 
 
29
 
  bzr add       make files or directories versioned
30
 
  bzr ignore    ignore a file or pattern
31
 
  bzr mv        move or rename a versioned file
32
 
 
33
 
  bzr status    summarize changes in working copy
34
 
  bzr diff      show detailed diffs
35
 
 
36
 
  bzr merge     pull in changes from another branch
37
 
  bzr commit    
38
 
 
39
 
  bzr log       show history of changes
40
 
  bzr check     validate storage
41
 
 
42
 
Use e.g. 'bzr help init' for more details, or 'bzr help commands' for
43
 
all commands.
 
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
 
22
 
 
23
* Metadata format is not stable yet -- you may need to
 
24
  discard history in the future.
 
25
 
 
26
* Many commands unimplemented or partially implemented.
 
27
 
 
28
* Space-inefficient storage.
 
29
 
 
30
* No merge operators yet.
 
31
 
 
32
 
 
33
To make a branch, use 'bzr init' in an existing directory, then 'bzr
 
34
add' to make files versioned.  'bzr add .' will recursively add all
 
35
non-ignored files.
 
36
 
 
37
'bzr status' describes files that are unknown, ignored, or modified.
 
38
'bzr diff' shows the text changes to the tree or named files.
 
39
'bzr commit -m <MESSAGE>' commits all changes in that branch.
 
40
 
 
41
'bzr move' and 'bzr rename' allow you to rename files or directories.
 
42
'bzr remove' makes a file unversioned but keeps the working copy;
 
43
to delete that too simply delete the file.
 
44
 
 
45
'bzr log' shows a history of changes, and
 
46
'bzr info' gives summary statistical information.
 
47
'bzr check' validates all files are stored safely.
 
48
 
 
49
Files can be ignored by giving a path or a glob in .bzrignore at the
 
50
top of the tree.  Use 'bzr ignored' to see what files are ignored and
 
51
why, and 'bzr unknowns' to see files that are neither versioned or
 
52
ignored.
 
53
 
 
54
For more help on any command, type 'bzr help COMMAND', or 'bzr help
 
55
commands' for a list.
44
56
"""
45
57
 
46
58
 
47
 
import sys
48
 
 
49
 
 
50
 
def help(topic=None, outfile = None):
51
 
    if outfile == None:
52
 
        outfile = sys.stdout
 
59
 
 
60
def help(topic=None):
53
61
    if topic == None:
54
 
        outfile.write(global_help)
 
62
        print global_help
55
63
    elif topic == 'commands':
56
 
        help_commands(outfile = outfile)
 
64
        help_commands()
57
65
    else:
58
 
        help_on_command(topic, outfile = outfile)
 
66
        help_on_command(topic)
59
67
 
60
68
 
61
69
def command_usage(cmdname, cmdclass):
80
88
    return s
81
89
 
82
90
 
83
 
def help_on_command(cmdname, outfile = None):
 
91
def help_on_command(cmdname):
84
92
    cmdname = str(cmdname)
85
93
 
86
 
    if outfile == None:
87
 
        outfile = sys.stdout
88
 
 
89
94
    from inspect import getdoc
90
95
    import commands
91
96
    topic, cmdclass = commands.get_cmd_class(cmdname)
94
99
    if doc == None:
95
100
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
101
 
97
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
 
102
    print 'usage:', command_usage(topic, cmdclass)
98
103
 
99
104
    if cmdclass.aliases:
100
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
101
 
    
102
 
    outfile.write(doc)
103
 
    if doc[-1] != '\n':
104
 
        outfile.write('\n')
105
 
    
106
 
    help_on_option(cmdclass.takes_options, outfile = None)
107
 
 
108
 
 
109
 
def help_on_option(options, outfile = None):
 
105
        print 'aliases: ' + ', '.join(cmdclass.aliases)
 
106
    
 
107
    print doc
 
108
    
 
109
    help_on_option(cmdclass.takes_options)
 
110
 
 
111
 
 
112
def help_on_option(options):
110
113
    import commands
111
114
    
112
115
    if not options:
113
116
        return
114
117
    
115
 
    if outfile == None:
116
 
        outfile = sys.stdout
117
 
 
118
 
    outfile.write('\noptions:\n')
 
118
    print
 
119
    print 'options:'
119
120
    for on in options:
120
121
        l = '    --' + on
121
122
        for shortname, longname in commands.SHORT_OPTIONS.items():
122
123
            if longname == on:
123
124
                l += ', -' + shortname
124
125
                break
125
 
        outfile.write(l + '\n')
126
 
 
127
 
 
128
 
def help_commands(outfile = None):
 
126
        print l
 
127
 
 
128
 
 
129
def help_commands():
129
130
    """List all commands"""
130
131
    import inspect
131
132
    import commands
132
 
 
133
 
    if outfile == None:
134
 
        outfile = sys.stdout
135
133
    
136
134
    accu = []
137
135
    for cmdname, cmdclass in commands.get_all_cmds():
140
138
    for cmdname, cmdclass in accu:
141
139
        if cmdclass.hidden:
142
140
            continue
143
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
 
141
        print command_usage(cmdname, cmdclass)
144
142
        help = inspect.getdoc(cmdclass)
145
143
        if help:
146
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
147
 
 
 
144
            print "    " + help.split('\n', 1)[0]
148
145
            
149
146