NAME
        lcov-report.sh


DESCRIPTION

        A small script to create gcov/lcov code coverage reports of
        tests run on the libreoffice source code.


SYNOPSIS

	lcov-report.sh -s [DIRECTORY] -t [DIRECTORY] -r [DIRECTORY] \
	-b [DIRECTORY]

-s
	Specify the location where the libreoffice source code is
	located. This is expected to be a git repository. This option
	is mandatory.

-t
	Specifies the directory in which to put the lcov tracefile's.
	This option is mandatory.

-r
	Specifies the directory in which to contain the generated HTML
	report files. This option is mandatory.

-b
	Specify a directory in which to build the libreoffice project,
	in case you want to perform a 'out-of-source' build. This option
	is optional: if you omit this option, a 'in-source-tree' build
	is performed, and the build will be done in the same dirctory
	that you specified with the '-s' option.


EXAMPLE

	Running the script could be as easy as running the following
	command :

	./lcov-report.sh -s ~/src/core -t ~/tmp/traces -r ~/tmp/html

	The '-s' option in this example tells the script to go look for
	the libreoffice source code in '~/src/core', the '-t' option
	to put the lcov 'tracefiles' in '~/tmp/traces', and  the '-r'
	option to put the final html report in '~/tmp/html'. Because the
	'-b' option is omitted in this example, a 'in-source-tree' build
	will be performed. If you would like to perform an out-of-tree
	build instead, you would only need to add someting like '-b
	~/tmp/build' to the commandline example above.