Changeset 320 in tailor for vcpx/session.py


Ignore:
Timestamp:
05/24/05 00:46:24 (8 years ago)
Author:
lele@…
Hash name:
20050523224624-97f81-e906213864d4d963a7e5cec8c75bd6da11798de4
Message:

Better help with usage for the interactive commands

File:
1 edited

Legend:

Unmodified
Added
Removed

  • vcpx/session.py

    r319 r320  
    9696         
    9797    def do_exit(self, arg): 
    98         """Exit the interactive session.""" 
     98        """ 
     99        Usage: exit 
     100 
     101        Terminate the interactive session. This is the same thing 
     102        happening upon EOF (Ctrl-D). 
     103        """ 
    99104 
    100105        self.__log('Exiting...\n') 
    … …  
    104109 
    105110    def do_save(self, arg): 
    106         """Save the commands history on the specified file.""" 
     111        """ 
     112        Usage: save filename 
     113 
     114        Save the commands history on the specified file. 
     115        """ 
    107116 
    108117        import readline 
    … …  
    115124         
    116125    def do_cd(self, arg): 
    117         """Print or set current active directory.""" 
     126        """ 
     127        Usage: cd [dirname] 
     128 
     129        Print or set current active directory. 
     130        """ 
    118131 
    119132        if arg and self.current_directory <> arg: 
    … …  
    130143    def do_sub_directory(self, arg): 
    131144        """ 
    132         Print or set the subdirectory that actually contains the working copy. 
    133  
    134         This is desumed automatically to be the last component of 
    135         the upstream module or repository. 
     145        Usage: sub_directory dirname 
     146         
     147        Print or set the subdirectory that actually contains the 
     148        working copy. When not explicitly set, this is desumed from 
     149        the last component of the upstream module name or repository. 
    136150        """ 
    137151         
    … …  
    142156 
    143157    def do_logfile(self, arg): 
    144         """Print or set the logfile of operations.""" 
     158        """ 
     159        Usage: logfile [filename] 
     160         
     161        Print or set the logfile of operations. By default there's no log. 
     162        """ 
    145163 
    146164        import logging 
    … …  
    228246         
    229247    def do_source_kind(self, arg): 
    230         """Print or set the source repository kind.""" 
     248        """ 
     249        Usage: source_kind [svn|darcs|cvs] 
     250 
     251        Print or set the source repository kind. 
     252        """ 
    231253 
    232254        if arg and self.source_kind <> arg: 
    … …  
    236258         
    237259    def do_target_kind(self, arg): 
    238         """Print or set the target repository kind.""" 
     260        """ 
     261        Usage: target_kind [svn|darcs|cvs|monotone|cdv|bzr] 
     262 
     263        Print or set the target repository kind. 
     264        """ 
    239265 
    240266        if arg and self.target_kind <> arg: 
    … …  
    244270 
    245271    def do_source_repository(self, arg): 
    246         """Print or set the source repository.""" 
     272        """ 
     273        Usage: source_repository [repos] 
     274 
     275        Print or set the source repository. 
     276        """ 
    247277 
    248278        from os.path import sep 
    … …  
    256286 
    257287    def do_target_repository(self, arg): 
    258         """Print or set the target repository.""" 
     288        """ 
     289        Usage: target_repository [repos] 
     290 
     291        Print or set the target repository. This is currently unused. 
     292        """ 
    259293 
    260294        from os.path import sep 
    … …  
    268302 
    269303    def do_source_module(self, arg): 
    270         """Print or set the source module.""" 
     304        """ 
     305        Usage: source_module [module] 
     306         
     307        Print or set the source module. 
     308        """ 
    271309 
    272310        from os.path import sep 
    … …  
    280318 
    281319    def do_target_module(self, arg): 
    282         """Print or set the target module.""" 
     320        """ 
     321        Usage: target_module [module] 
     322 
     323        Print or set the target module. This is currently not used. 
     324        """ 
    283325 
    284326        from os.path import sep 
    … …  
    312354    def do_state_file(self, arg): 
    313355        """ 
    314         Print or set the current state_file. 
    315  
     356        Usage: state_file [filename] 
     357         
     358        Print or set the current state file, where tailor stores the 
     359        source revision that has been applied last. 
     360         
    316361        The argument must be a file name, possibly with the usual 
    317362        "~user/file" convention.         
    … …  
    361406    def do_bootstrap(self, arg): 
    362407        """ 
     408        Usage: bootstrap [revision] 
     409         
    363410        Checkout the initial upstream revision, by default HEAD (or 
    364411        specified by argument), then import the subtree into the 
Note: See TracChangeset for help on using the changeset viewer.