~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

• browse files at revision 1563.2.8
• compare with another revision
• download diff
• download tarball
• view history from revision 1563.2.8

• reverse the comparison (1563.2.8 to 2255.7.57)
• stop comparing with revision 2255.7.57

Show diffs side-by-side

added

removed

bzrlib/help.py

1

 

# Copyright (C) 2004, 2005, 2006 Canonical Ltd

2

 

#

 

1

# Copyright (C) 2004, 2005 by Canonical Ltd

 

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

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

20

20

# executable files with reasonable names.

21

21

 

22

22

# TODO: `help commands --all` should show hidden commands

 

23

import textwrap

 

24

 

 

25

global_help = \

 

26

"""Bazaar-NG -- a free distributed version-control tool

 

27

http://bazaar-ng.org/

 

28

 

 

29

WARNING: This is an unstable development version.

 

30

         Please keep backups.

 

31

 

 

32

Basic commands:

 

33

 

 

34

  bzr init           makes this directory a versioned branch

 

35

  bzr branch         make a copy of another branch

 

36

 

 

37

  bzr add            make files or directories versioned

 

38

  bzr ignore         ignore a file or pattern

 

39

  bzr mv             move or rename a versioned file

 

40

 

 

41

  bzr status         summarize changes in working copy

 

42

  bzr diff           show detailed diffs

 

43

 

 

44

  bzr merge          pull in changes from another branch

 

45

  bzr commit         save some or all changes

 

46

 

 

47

  bzr log            show history of changes

 

48

  bzr check          validate storage

 

49

 

 

50

  bzr help init      more help on e.g. init command

 

51

  bzr help commands  list all commands

 

52

"""

 

53

 

23

54

 

24

55

import sys

25

 

import textwrap

26

 

 

27

 

from bzrlib import (

28

 

    help_topics,

29

 

    osutils,

30

 

    )

31

 

 

32

 

 

33

 

def help(topic=None, outfile=None):

34

 

    """Write the help for the specific topic to outfile"""

35

 

    if outfile is None:

 

56

 

 

57

 

 

58

def help(topic=None, outfile = None):

 

59

    if outfile == None:

36

60

        outfile = sys.stdout

37

 

 

38

 

    if topic is None:

39

 

        topic = 'basic'

40

 

 

41

 

    if topic in help_topics.topic_registry:

42

 

        txt = help_topics.topic_registry.get_detail(topic)

43

 

        outfile.write(txt)

 

61

    if topic == None:

 

62

        outfile.write(global_help)

 

63

    elif topic == 'commands':

 

64

        help_commands(outfile = outfile)

44

65

    else:

45

 

        help_on_command(topic, outfile=outfile)

 

66

        help_on_command(topic, outfile = outfile)

46

67

 

47

68

 

48

69

def command_usage(cmd_object):

67

88

    return s

68

89

 

69

90

 

70

 

def print_command_plugin(cmd_object, outfile, format):

71

 

    """Print the plugin that provides a command object, if any.

72

 

 

73

 

    If the cmd_object is provided by a plugin, prints the plugin name to

74

 

    outfile using the provided format string.

75

 

    """

76

 

    plugin_name = cmd_object.plugin_name()

77

 

    if plugin_name is not None:

78

 

        out_str = '(From plugin "%s")' % plugin_name

79

 

        outfile.write(format % out_str)

80

 

 

81

 

 

82

91

def help_on_command(cmdname, outfile=None):

83

92

    from bzrlib.commands import get_cmd_object

84

93

 

85

94

    cmdname = str(cmdname)

86

95

 

87

 

    if outfile is None:

 

96

    if outfile == None:

88

97

        outfile = sys.stdout

89

98

 

90

99

    cmd_object = get_cmd_object(cmdname)

91

100

 

92

101

    doc = cmd_object.help()

93

 

    if doc is None:

 

102

    if doc == None:

94

103

        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)

95

104

 

96

 

    print >>outfile, 'usage:', command_usage(cmd_object)

 

105

    print >>outfile, 'usage:', command_usage(cmd_object) 

97

106

 

98

107

    if cmd_object.aliases:

99

108

        print >>outfile, 'aliases:',

101

110

 

102

111

    print >>outfile

103

112

 

104

 

    print_command_plugin(cmd_object, outfile, '%s\n\n')

105

 

 

106

113

    outfile.write(doc)

107

114

    if doc[-1] != '\n':

108

115

        outfile.write('\n')

110

117

 

111

118

 

112

119

def help_on_command_options(cmd, outfile=None):

113

 

    from bzrlib.option import Option, get_optparser

114

 

    if outfile is None:

115

 

        outfile = sys.stdout

 

120

    from bzrlib.option import Option

116

121

    options = cmd.options()

117

 

    outfile.write('\n')

118

 

    outfile.write(get_optparser(options).format_option_help())

 

122

    if not options:

 

123

        return

 

124

    if outfile == None:

 

125

        outfile = sys.stdout

 

126

    outfile.write('\noptions:\n')

 

127

    for option_name, option in sorted(options.items()):

 

128

        l = '    --' + option_name

 

129

        if option.type is not None:

 

130

            l += ' ' + option.argname.upper()

 

131

        short_name = option.short_name()

 

132

        if short_name:

 

133

            assert len(short_name) == 1

 

134

            l += ', -' + short_name

 

135

        l += (30 - len(l)) * ' ' + option.help

 

136

        # TODO: split help over multiple lines with correct indenting and 

 

137

        # wrapping

 

138

        wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')

 

139

        outfile.write(wrapped + '\n')

119

140

 

120

141

 

121

142

def help_commands(outfile=None):

122

143

    """List all commands"""

123

 

    if outfile is None:

124

 

        outfile = sys.stdout

125

 

    outfile.write(_help_commands_to_text('commands'))

126

 

 

127

 

 

128

 

def _help_commands_to_text(topic):

129

 

    """Generate the help text for the list of commands"""

130

144

    from bzrlib.commands import (builtin_command_names,

131

145

                                 plugin_command_names,

132

146

                                 get_cmd_object)

133

 

    out = []

134

 

    if topic == 'hidden-commands':

135

 

        hidden = True

136

 

    else:

137

 

        hidden = False

138

 

    names = set(builtin_command_names()) # to eliminate duplicates

 

147

 

 

148

    if outfile == None:

 

149

        outfile = sys.stdout

 

150

 

 

151

    names = set()                       # to eliminate duplicates

 

152

    names.update(builtin_command_names())

139

153

    names.update(plugin_command_names())

140

 

    commands = ((n, get_cmd_object(n)) for n in names)

141

 

    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]

142

 

    max_name = max(len(n) for n, o in shown_commands)

143

 

    indent = ' ' * (max_name + 1)

144

 

    width = osutils.terminal_width() - 1

145

 

 

146

 

    for cmd_name, cmd_object in sorted(shown_commands):

147

 

        plugin_name = cmd_object.plugin_name()

148

 

        if plugin_name is None:

149

 

            plugin_name = ''

150

 

        else:

151

 

            plugin_name = ' [%s]' % plugin_name

152

 

 

 

154

    names = list(names)

 

155

    names.sort()

 

156

 

 

157

    for cmd_name in names:

 

158

        cmd_object = get_cmd_object(cmd_name)

 

159

        if cmd_object.hidden:

 

160

            continue

 

161

        print >>outfile, command_usage(cmd_object)

153

162

        cmd_help = cmd_object.help()

154

163

        if cmd_help:

155

164

            firstline = cmd_help.split('\n', 1)[0]

156

 

        else:

157

 

            firstline = ''

158

 

        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)

159

 

        lines = textwrap.wrap(helpstring, subsequent_indent=indent,

160

 

                              width=width)

161

 

        for line in lines:

162

 

            out.append(line + '\n')

163

 

    return ''.join(out)

164

 

 

165

 

 

166

 

help_topics.topic_registry.register("commands",

167

 

                                    _help_commands_to_text,

168

 

                                    "Basic help for all commands")

169

 

help_topics.topic_registry.register("hidden-commands", 

170

 

                                    _help_commands_to_text,

171

 

                                    "All hidden commands")

 

165

            print >>outfile, '        ' + firstline

 

166

        

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1