Package moap :: Package command :: Module cl :: Class Prepare
[hide private]
[frames] | no frames]

Class Prepare

source code

extern.command.command.Command --+    
                                 |    
       extern.log.log.Loggable --+    
                                 |    
              util.util.LogCommand --+
                                     |
                                    Prepare

Instance Methods [hide private]
 
getCTags(self)
Get a binary that is ctags-like.
source code
 
addOptions(self)
Override me to add options to the parser.
source code
 
do(self, args)
Override me to implement the functionality of the command.
source code

Inherited from util.util.LogCommand: __init__, debug

Inherited from extern.command.command.Command: getRootCommand, handleOptions, outputHelp, outputUsage, parse

Inherited from extern.log.log.Loggable: doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  summary = 'prepare ChangeLog entry from local diff'
short one-line summary of the command
  description = 'This command prepares a new ChangeLog entry by ...
longer paragraph explaining the command
  usage = '[path to directory or ChangeLog file]'
short one-line usage string; %command gets expanded to a sub-command or [commands] as appropriate.
list of str aliases = ['pr', 'prep']
list of alternative lowercase names recognized

Inherited from extern.command.command.Command: aliasedSubCommands, name, parentCommand, parser, subCommandClasses, subCommands

Inherited from extern.log.log.Loggable: logCategory

Method Details [hide private]

addOptions(self)

source code 

Override me to add options to the parser.

Overrides: extern.command.command.Command.addOptions
(inherited documentation)

do(self, args)

source code 

Override me to implement the functionality of the command.

Overrides: extern.command.command.Command.do
(inherited documentation)

Class Variable Details [hide private]

description

longer paragraph explaining the command
Value:
'''This command prepares a new ChangeLog entry by analyzing
the local changes gotten from the VCS system used.

It uses ctags to extract the tags affected by the changes, and adds th\
em
to the ChangeLog entries.

It decides your name based on your account settings, the REAL_NAME or
...