From: Eric S. Raymond <esr@thyrsus.com>
Date: Wed, 4 Jun 2014 16:53:08 +0000 (-0400)
Subject: Documentation improvements.
X-Git-Tag: 1.13~2
X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=cc8a476d38753c2c6650002ead0a3f387563fb29;p=coverity-submit.git

Documentation improvements.
---

diff --git a/NEWS b/NEWS
index ce5fd23..0551892 100644
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,8 @@
 			NEWS file for coverity-submit
 
+Repository head:
+    Documentation improvements. Code audited with new, stricter pylint.
+
 1.11 @ 2013-09-27
     Fix buggy Mercurial commit-id method.
     Include coverity-submit version in Submitted-by header.
diff --git a/coverity-submit.xml b/coverity-submit.xml
index 144b8b0..32122ee 100644
--- a/coverity-submit.xml
+++ b/coverity-submit.xml
@@ -36,6 +36,12 @@ the results into a tarball with a properly formatted README, (c)
 submitting a tarball and analysis request to the server, and (d)
 retrieving the request status.</para>
 
+<para>Once you have the enabling metadata data for a project set up,
+you can usually submit an analysis job just by running
+<command>coverity-submit</command> without arguments. The Coverity
+analyzer will email you as success or failure notification when the
+analysis results are available.</para>
+
 </refsect1>
 <refsect1><title>CONFIGURATION</title>
 
@@ -87,7 +93,7 @@ where to find it.</para>
 <para>This configuration describes three different (real) projects;
 one with an scons-based build, one with an autotools-based build, and
 one with a plain makefile build. For each project you must specify the
-project's autentication token and the local build command to pass to
+project's authentication token and the local build command to pass to
 cov-build. You may optionally specify local prebuild and postbuild
 commands.</para>