From: Eric S. Raymond Date: Mon, 14 May 2012 04:15:25 +0000 (-0400) Subject: Documentation. X-Git-Tag: 1.0~9 X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=08dc8f2af5af5e2bbcdbea3b6b032e37211afa82;p=coverity-submit.git Documentation. --- diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..1d5d681 --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +# The xmlto formatter is required to format XML intto display documentation. + +coverity-submit.html: coverity-submit.xml + xmlto xhtml-nochunks coverity-submit.xml + +coverity-submit.1: coverity-submit.xml + xmlto man coverity-submit.xml + +clean: + rm -f coverity-submit.html coverity-submit.1 diff --git a/coverity-submit.xml b/coverity-submit.xml new file mode 100644 index 0000000..b46428a --- /dev/null +++ b/coverity-submit.xml @@ -0,0 +1,131 @@ + + +]> + +9 Aug 2004 + +gpsd +8 +Coverity +Coverity Documentation + + +coverity-submit +interface daemon for GPS receivers + + + + + + coverity-submit + -n + + project-name + + + + +DESCRIPTION + +This tool aims to make submitting projects for code auditing on +the demonstration Coverity server into a one-step operation. It +automates the sequence of (a) running cov-build locally, (b) bundling +the results into a tarball with a properly formatted README, (c) +uploading the result to a public drop area of your choice, a(d) +submitting an analysis request to the server, and (e) retrieving the +request status. + + +CONFIGURATION + +To use this tool, you need to set up a configuration file named +.coverity-submit in your home directory. This +configuration file is best explained by example. + + +[DEFAULT] + name=Eric S. Raymond + userid=esr + email=esr@thyrsus.com + tools=/usr/local/coverity/bin + upload=scp %s esr@login.ibiblio.org:/public/html/catb/esr + advertise=http://catb.org/~esr/%s +[gpsd] + password=XXXXXX + prebuild=scons -c + build=scons + postbuild= +[giflib] + password=YYYYYYY + prebuild=autogen.sh && make clean + build=make -k + postbuild= + + +Begin with a [DEFAULT] section giving your name and userid on the +Coverity server. You may specify the email address to which success +or failure notifications should be mailed for all other projects here, +or specify different addresses per-project. + +If cov-build is not in your execution path, you may use the +'tools' option to tell coverity-submit +where to find it. + +The 'upload' and 'advertise' option are required. They tell +coverity-submit how to ship your tarball to +a public drop area where the Coverity server can see it, and the URL +the Coverity server can use to fetch it. Each of these options must +contain the string '%s' indicating where the generated name of the +tarball should be spliced in. Note that, like 'email', there can also +be specified in a per-project entry in case you want to have separate +per-project drop areas. + +This configuration describes two different (real) projects, one +with an scons-based build and one with an autotools-based build. For +each project you must specifty the Coverity build password and the +local build command to pass to cov-build. You may optionally specify +local prebuild and postbuild commands. + + +OPERATION + +The first thing coverity-submit does when +invoked is figure out which project profile to use. If no argument is +specified but the basename of the current directory matches a project, +it is selected. Otherwise, a command-line argument can specify the project +name (it is a fatal error for it not to match one of the configured +project profiles). + +There is just one option; , which says to display +all the commands that would be run without actually executing them. + +Once coverity-submit has determined +which project profile to use, it then performs the following steps: + + +The project's local prebuild command, if specified. +The project's local build command. +The project's local prebuild command, if specified. +Generating a README and bundling it into a tarball with the scan results. +Copying the tarball to the upload location. +Sending an analysis job request to the Coverity server. + + +The script will report the result of the job request by dumping the +server's HTML response. + + +PREREQUISITES + +Requires Python 3, curl, and cov-build. + + +AUTHOR + +Eric S. Raymond + + +