← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to generated_docs.py

  • Committer: James Blackwell
  • Date: 2005-12-12 01:07:19 UTC
  • mto: (1185.50.63 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1554.
  • Revision ID: jblack@pluto-20051212010719-31777648cf2e762f
Better help for doc_generate

Show diffs side-by-side

added added

removed removed

Lines of Context:
generated_docs.py
19
19
"""bzr-infogen.py - generate information from built-in bzr help
20
20
 
21
21
bzr-infogen.py creates a file with information on bzr in one of
22
 
several different output formats:
 
22
several different output formats:\n
23
23
 
24
24
    man              man page
25
25
    bash_completion  bash completion script
56
56
import sys
57
57
import doc_generate
58
58
 
 
59
descr = """generated-docs.py creates a file with information on bzr in a variety
 
60
of output formats. Currently included: man and bash_completion.
 
61
 
 
62
Examples: 
 
63
 
 
64
    python2.4 generated-docs.py --man
 
65
    python2.4 generated-docs.py --bash_completion
 
66
    python2.4 generated-docs.py --all
 
67
"""
59
68
 
60
69
def main(argv):
61
70
    from optparse import OptionParser
62
71
    parser = OptionParser(usage="%prog [options] OUTPUT_FORMAT")
 
72
 
63
73
    parser.add_option("-s", "--show-filename",
64
74
                      action="store_true", dest="show_filename", default=False,
65
75
                      help="print default filename on stdout")
66
 
    parser.add_option("-o", "--output", dest="filename",
67
 
                      help="write output to FILE", metavar="FILE")
68
 
    parser.add_option("-b", "--bzr-name", dest="bzr_name", default="bzr",
69
 
                      help="name of bzr executable", metavar="EXEC_NAME")
70
 
    parser.add_option("-q", "--quiet",
71
 
                      action="store_false", dest="verbose", default=True,
72
 
                      help="don't print status messages to stdout")
 
76
 
 
77
    parser.add_option("-o", "--output", dest="filename", metavar="FILE",
 
78
                      help="write output to FILE")
 
79
 
 
80
    parser.add_option("-b", "--bzr-name",
 
81
                      dest="bzr_name", default="bzr", metavar="EXEC_NAME",
 
82
                      help="name of bzr executable")
 
83
 
 
84
    parser.add_option("-e", "--examples",
 
85
                       action="callback", callback=print_extended_help,
 
86
                       help="Examples of ways to call generate_doc")
 
87
 
 
88
 
73
89
    (options, args) = parser.parse_args(argv)
74
90
 
75
91
    if len(args) != 2:
76
 
        parser.error("incorrect number of arguments")
 
92
        parser.print_help()
 
93
        sys.exit(1)
77
94
 
78
95
    infogen_type = args[1]
79
96
    infogen_mod = doc_generate.generate(infogen_type)
93
110
    
94
111
    infogen_mod.infogen(options, outfile)
95
112
 
 
113
def print_extended_help(option, opt, value, parser):
 
114
    print >>sys.stdout, __doc__
 
115
    sys.exit(0)
 
116
 
96
117
 
97
118
if __name__ == '__main__':
98
119
    main(sys.argv)