New committers' help for Coverity Prevent.

New committers to FreeBSD may be interested about Coverity
Prevent, but it is not very easy to find out how they register,
what license terms Coverity Prevent SQS is available under, and
how they can use the web interface of the automated analysis
runs.

PR:		docs/105447
Submitted by:	bz
Reviewed by:	remko, netchild
This commit is contained in:
Giorgos Keramidas 2007-08-10 17:58:17 +00:00
parent b47322ecca
commit 4fb1aafd06
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=30623
2 changed files with 74 additions and 3 deletions

View file

@ -30,6 +30,7 @@
<legalnotice id="trademarks" role="trademarks">
&tm-attrib.freebsd;
&tm-attrib.coverity;
&tm-attrib.cvsup;
&tm-attrib.ibm;
&tm-attrib.intel;
@ -745,11 +746,11 @@ alias scvs cvs -d <replaceable>user</replaceable>@ncvs.FreeBSD.org:/home/ncvs</p
</itemizedlist>
<para>You will almost certainly get a conflict because
of the <literal>$Id: article.sgml,v 1.267 2007-07-06 16:37:13 chinsan Exp $</literal> (or in FreeBSD's case,
of the <literal>$Id: article.sgml,v 1.268 2007-08-10 17:58:16 keramida Exp $</literal> (or in FreeBSD's case,
<literal>$<!-- stop expansion -->FreeBSD<!-- stop expansion -->$</literal>)
lines, so you will have to edit the file to resolve the conflict
(remove the marker lines and the second <literal>$Id: article.sgml,v 1.267 2007-07-06 16:37:13 chinsan Exp $</literal> line,
leaving the original <literal>$Id: article.sgml,v 1.267 2007-07-06 16:37:13 chinsan Exp $</literal> line intact).</para>
(remove the marker lines and the second <literal>$Id: article.sgml,v 1.268 2007-08-10 17:58:16 keramida Exp $</literal> line,
leaving the original <literal>$Id: article.sgml,v 1.268 2007-08-10 17:58:16 keramida Exp $</literal> line intact).</para>
</listitem>
<listitem>
@ -1730,6 +1731,69 @@ docs:Documentation Bug:freebsd-doc:</programlisting>
&man.scp.1;.</para>
</sect1>
<sect1 id="coverity">
<title>&coverity.prevent; Availability for &os; Committers</title>
<para>In January 2006, the &os;&nbsp;Foundation obtained a license for
&coverity.prevent; from &coverity&nbsp;Ltd. With this donation, all
&os; developers can obtain access to <application>Coverity
Prevent</application> analysis results of all &os; Project
software.</para>
<para>&os; developers who are interested in obtaining access to the
analysis results of the automated <application>Coverity
Prevent</application> runs, can find out more by logging
into <hostid>freefall</hostid> and reading the relevant bits of the
files:</para>
<variablelist>
<varlistentry>
<term><filename>/usr/local/coverity/coverity_license.txt</filename></term>
<listitem>
<para>The license terms to which the &os; developers will have
to agree in order to use &coverity.prevent; analysis
results.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>/usr/local/coverity/coverity_announcement.txt</filename></term>
<listitem>
<para>The announcement posted to the developers' mailing list of the
&os; Project. It contains useful information about the &os;
Foundation and &coverity;&nbsp;Ltd., as well as signup information
for registering with the &coverity.prevent; installation of the
&os; Cluster.</para>
<para>After reading and understanding the license terms
of <filename>coverity_license.txt</filename>, all &os; developers
who are interested in using the analysis results of
&coverity.prevent; should read this file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>/usr/local/coverity/coverity_readme.txt</filename></term>
<listitem>
<para>A short guide about fixes which are committed to the &os;
source tree after being detected by &coverity.prevent; and
analyzed by an &os; developer.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The &os; Wiki includes a mini-guide for developers who are
interested in working with the &coverity.prevent; analysis reports:
<ulink url="http://wiki.freebsd.org/CoverityPrevent"></ulink>. Please
note that this mini-guide is only readable by &os; developers, so if you
cannot access this page, you will have to ask someone to add you to the
appropriate Wiki access list.</para>
<para>Finally, all &os; developers who are going to use &coverity.prevent;
are always encouraged to ask for more details and usage information, by
posting any questions to the mailing list of the &os; developers.</para>
</sect1>
<sect1 id="rules">
<title>The FreeBSD Committers' Big List of Rules</title>

View file

@ -95,6 +95,13 @@
countries.</para>">
<!ENTITY wordperfect "<trademark class='registered'>WordPerfect</trademark>">
<!-- http://www.coverity.com/html/press_story45_07_25_07.html -->
<!ENTITY tm-attrib.coverity "<para>Coverity is a registered trademark;
Coverity Extend, Coverity Prevent and Coverity Prevent SQS are trademarks of
Coverity, Inc.</para>">
<!ENTITY coverity "<trademark class='registered'>Coverity</trademark>">
<!ENTITY coverity.prevent "<trademark class='registered'>Coverity Prevent</trademark>">
<!-- http://www.creative.com/legal.asp -->
<!ENTITY tm-attrib.creative "<para>Sound Blaster is a trademark of
Creative Technology Ltd. in the United States and/or other