From: Eric S. Raymond <esr@thyrsus.com>
Date: Thu, 26 Sep 2013 11:12:54 +0000 (-0400)
Subject: Documentation update.
X-Git-Tag: 1.11~3
X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=a9c42a3758ed3d90a233e348eccf37a251c0618a;p=coverity-submit.git

Documentation update.
---

diff --git a/coverity-submit.xml b/coverity-submit.xml
index 3813f2b..144b8b0 100644
--- a/coverity-submit.xml
+++ b/coverity-submit.xml
@@ -97,24 +97,15 @@ that is known to Coverity by a different name (in this case
 it in (in this case <quote>cvs-fast-export</quote>).  This can of
 course easily happen if your project's public name changes after
 you register it.</para>
-
-<para>The <option>build</option> and <option>advertise</option>
-options of versions 1.1 and previously are no longer needed, as
-Coverity has changed its submission form to support direct upload of
-the results tarball.</para>
-
-<para>For backward compatibity, 'password' is treated as a synonym for
-'token'; the change follows a change in the terminology of Coverity's
-configuration instructions.</para>
 </refsect1>
 <refsect1><title>OPERATION</title>
 
-<para>The first thing <application>coverity-submit</application> 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).</para>
+<para>The first thing <application>coverity-submit</application> 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 the argument, if
+given, not to match the name of one of the configured project profiles.</para>
 
 <para>The <option>-n</option> option says to display all the commands that
 would be run without actually executing them. The <option>-v</option> option 
@@ -122,11 +113,10 @@ enables slightly more verbose progress messages, and copies the Coverity
 build-log.txt from the run to your working directory.</para>
 
 <para>The <option>-b</option> option specifies an arbitrary build
-version to associate with the submission. A repository commit level
-would be a good thing to use for this. If coverity-submit is run 
+version to associate with the submission. If coverity-submit is run 
 at the top level of a version-control repository, the build version may 
 default to a description of the head commit; presently this feature
-is supported for git only.</para>
+is supported under git, hg, bzr, and svn.</para>
 
 <para>The <option>-t</option> option specifies an arbitrary project
 tag or description to associate with the submission. This text is
@@ -148,11 +138,28 @@ which project profile to use, it then performs the following steps:</para>
 <para>The script will report the result of the job request by dumping the
 server's HTML response.</para>
 
+</refsect1>
+<refsect1><title>BACKWARD COMPATIBILITY</title>
+
+<para>For backward compatibity, 'password' is treated as a synonym for
+'token'; the change follows a change in the terminology of Coverity's
+configuration instructions.</para>
+
+<para>The <option>build</option> and <option>advertise</option>
+options of versions 1.1 and previously are no longer needed, as
+Coverity has changed its submission form to support direct upload of
+the results tarball.</para>
+
 </refsect1>
 <refsect1><title>PREREQUISITES</title>
 
 <para>Requires Python, curl, and cov-build.</para>
 
+<para>The Coverity Scan facility has a home page:
+<ulink url="https://scan.coverity.com">https://scan.coverity.com</ulink>.
+You can find instructions on how to register projects for scanning there.
+</para>
+
 </refsect1>
 <refsect1 id='maintainer'><title>AUTHOR</title>