devtools.licenseupdater Namespace Reference

Functions
def	update_license (path, dry_run, show_diff)
def	update_license_in_source_directories (source_dirs, dry_run, show_diff)
def	main ()

Variables
string	LICENSE_BEGIN = "// Copyright "
string	BRIEF_LICENSE

Detailed Description

Updates the license text in source file.

Function Documentation

main()

def devtools.licenseupdater.main

(

void

)

update_license()

def devtools.licenseupdater.update_license	(		path,
			dry_run,
			show_diff
	)

Update the license statement in the specified file.
Parameters:
  path: path of the C++ source file to update.
  dry_run: if True, just print the path of the file that would be updated,
           but don't change it.
  show_diff: if True, print the path of the file that would be modified,
             as well as the change made to the file. 

update_license_in_source_directories()

def devtools.licenseupdater.update_license_in_source_directories	(		source_dirs,
			dry_run,
			show_diff
	)

Updates license text in C++ source files found in directory source_dirs.
Parameters:
  source_dirs: list of directory to scan for C++ sources. Directories are
               scanned recursively.
  dry_run: if True, just print the path of the file that would be updated,
           but don't change it.
  show_diff: if True, print the path of the file that would be modified,
             as well as the change made to the file. 

Variable Documentation

BRIEF_LICENSE

string devtools.licenseupdater.BRIEF_LICENSE

Initial value:

=  LICENSE_BEGIN + """2007-2010 Baptiste Lepilleur
// Distributed under MIT license, or public domain if desired and
// recognized in your jurisdiction.
// See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE

""".replace('\r\n','\n')

LICENSE_BEGIN

string devtools.licenseupdater.LICENSE_BEGIN = "// Copyright "