← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: aaron.bentley at utoronto
  • Date: 2005-08-27 04:42:41 UTC
  • mfrom: (1092.1.43)
  • mto: (1185.3.4)
  • mto: This revision was merged to the branch mainline in revision 1178.
  • Revision ID: aaron.bentley@utoronto.ca-20050827044241-23d676133b9fc981
Merge of robertc@robertcollins.net-20050826013321-52eee1f1da679ee9

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
 
 
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.
 
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
 
43
'bzr help commands' for all commands.
56
44
"""
57
45
 
58
46
 
59
 
 
60
 
def help(topic=None):
 
47
import sys
 
48
 
 
49
 
 
50
def help(topic=None, outfile = None):
 
51
    if outfile == None:
 
52
        outfile = sys.stdout
61
53
    if topic == None:
62
 
        print global_help
 
54
        outfile.write(global_help)
63
55
    elif topic == 'commands':
64
 
        help_commands()
 
56
        help_commands(outfile = outfile)
65
57
    else:
66
 
        help_on_command(topic)
 
58
        help_on_command(topic, outfile = outfile)
67
59
 
68
60
 
69
61
def command_usage(cmdname, cmdclass):
88
80
    return s
89
81
 
90
82
 
91
 
def help_on_command(cmdname):
 
83
def help_on_command(cmdname, outfile = None):
92
84
    cmdname = str(cmdname)
93
85
 
 
86
    if outfile == None:
 
87
        outfile = sys.stdout
 
88
 
94
89
    from inspect import getdoc
95
90
    import commands
96
91
    topic, cmdclass = commands.get_cmd_class(cmdname)
99
94
    if doc == None:
100
95
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
101
96
 
102
 
    if '\n' in doc:
103
 
        short, rest = doc.split('\n', 1)
104
 
    else:
105
 
        short = doc
106
 
        rest = ''
107
 
 
108
 
    print 'usage:', command_usage(topic, cmdclass)
 
97
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
109
98
 
110
99
    if cmdclass.aliases:
111
 
        print 'aliases: ' + ', '.join(cmdclass.aliases)
112
 
    
113
 
    if rest:
114
 
        print rest
115
 
 
116
 
    help_on_option(cmdclass.takes_options)
117
 
 
118
 
 
119
 
def help_on_option(options):
 
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):
120
110
    import commands
121
111
    
122
112
    if not options:
123
113
        return
124
114
    
125
 
    print
126
 
    print 'options:'
 
115
    if outfile == None:
 
116
        outfile = sys.stdout
 
117
 
 
118
    outfile.write('\noptions:\n')
127
119
    for on in options:
128
120
        l = '    --' + on
129
121
        for shortname, longname in commands.SHORT_OPTIONS.items():
130
122
            if longname == on:
131
123
                l += ', -' + shortname
132
124
                break
133
 
        print l
134
 
 
135
 
 
136
 
def help_commands():
 
125
        outfile.write(l + '\n')
 
126
 
 
127
 
 
128
def help_commands(outfile = None):
137
129
    """List all commands"""
138
130
    import inspect
139
131
    import commands
 
132
 
 
133
    if outfile == None:
 
134
        outfile = sys.stdout
140
135
    
141
136
    accu = []
142
137
    for cmdname, cmdclass in commands.get_all_cmds():
145
140
    for cmdname, cmdclass in accu:
146
141
        if cmdclass.hidden:
147
142
            continue
148
 
        print command_usage(cmdname, cmdclass)
 
143
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
149
144
        help = inspect.getdoc(cmdclass)
150
145
        if help:
151
 
            print "    " + help.split('\n', 1)[0]
 
146
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
 
147
 
152
148
            
153
149