doc/manual/building.html - Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1.

Unified Diff: doc/manual/building.html

Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1. (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: rebase again Created 5 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: doc/manual/building.html

diff --git a/doc/manual/building.html b/doc/manual/building.html

index 9c60d482b7c3ebd143314b1ced9d4a69f9a426b9..3f78e32fc7fdb09409951a223c2f705adb994232 100644

--- a/doc/manual/building.html

+++ b/doc/manual/building.html

@@ -1,19 +1,19 @@

- <title>Chapter 3. Building FindBugs™ from Source</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="installing.html" title="Chapter 2. Installing FindBugs™"><link rel="next" href="running.html" title="Chapter 4. Running FindBugs™"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Building <span class="application">FindBugs</span>™ from Source</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="installing.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="running.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 3. Building FindBugs™ from Source"><div class="titlepage"><div><div><h2 class="title"><a name="building"></a>Chapter 3. Building <span class="application">FindBugs</span>™ from Source</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="building.html#d0e173">1. Prerequisites</a></span></dt><dt><span class="sect1"><a href="building.html#d0e262">2. Extracting the Source Distribution</a></span></dt><dt><span class="sect1"><a href="building.html#d0e275">3. Modifying <code class="filename">local.properties</code></a></span></dt><dt><span class="sect1"><a href="building.html#d0e333">4. Running <span class="application">Ant</span></a></span></dt><dt><span class="sect1"><a href="building.html#d0e427">5. Running <span class="application">FindBugs</span>™ from a source directory</a></span></dt></dl></div><p>

+ <title>Chapter 3. Building FindBugs™ from Source</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="installing.html" title="Chapter 2. Installing FindBugs™"><link rel="next" href="running.html" title="Chapter 4. Running FindBugs™"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Building <span class="application">FindBugs</span>™ from Source</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="installing.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="running.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="building"></a>Chapter 3. Building <span class="application">FindBugs</span>™ from Source</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="building.html#d0e173">1. Prerequisites</a></span></dt><dt><span class="sect1"><a href="building.html#d0e262">2. Extracting the Source Distribution</a></span></dt><dt><span class="sect1"><a href="building.html#d0e275">3. Modifying <code class="filename">local.properties</code></a></span></dt><dt><span class="sect1"><a href="building.html#d0e333">4. Running <span class="application">Ant</span></a></span></dt><dt><span class="sect1"><a href="building.html#d0e427">5. Running <span class="application">FindBugs</span>™ from a source directory</a></span></dt></dl></div><p>

This chapter describes how to build <span class="application">FindBugs</span> from source code. Unless you are

interesting in modifying <span class="application">FindBugs</span>, you will probably want to skip to the

<a class="link" href="running.html" title="Chapter 4. Running FindBugs™">next chapter</a>.

-</p><div class="sect1" title="1. Prerequisites"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e173"></a>1. Prerequisites</h2></div></div></div><p>

+</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e173"></a>1. Prerequisites</h2></div></div></div><p>

To compile <span class="application">FindBugs</span> from source, you will need the following:

-</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>

- The <a class="ulink" href="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.0-source.zip?download" target="_top"><span class="application">FindBugs</span> source distribution</a>

+</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>

+ The <a class="ulink" href="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.1-source.zip?download" target="_top"><span class="application">FindBugs</span> source distribution</a>

</p></li><li class="listitem"><p>

<a class="ulink" href="http://java.sun.com/j2se/" target="_top">JDK 1.5.0 or later</a>

</p></li><li class="listitem"><p>

<a class="ulink" href="http://ant.apache.org/" target="_top">Apache <span class="application">Ant</span></a>, version 1.6.3 or later

</p></li></ul></div><p>

-</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="warning.png"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>

+</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="warning.png"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>

The version of <span class="application">Ant</span> included as <code class="filename">/usr/bin/ant</code> on

Redhat Linux systems will <span class="emphasis"><em>not</em></span> work for compiling

<span class="application">FindBugs</span>. We recommend you install a binary distribution of <span class="application">Ant</span>

@@ -24,22 +24,22 @@ To compile <span class="application">FindBugs</span> from source, you will need

</p></td></tr></table></div><p>

If you want to be able to generate formatted versions of the <span class="application">FindBugs</span> documentation,

you will also need the following software:

-</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>

+</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>

The <a class="ulink" href="http://docbook.sourceforge.net/projects/xsl/index.html" target="_top">DocBook XSL Stylesheets</a>.

These are required to convert the <span class="application">FindBugs</span> manual into HTML format.

</p></li><li class="listitem"><p>

The <a class="ulink" href="http://saxon.sourceforge.net/" target="_top"><span class="application">Saxon</span> XSLT Processor</a>.

(Also required for converting the <span class="application">FindBugs</span> manual to HTML.)

</p></li></ul></div><p>

-</p></div><div class="sect1" title="2. Extracting the Source Distribution"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e262"></a>2. Extracting the Source Distribution</h2></div></div></div><p>

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e262"></a>2. Extracting the Source Distribution</h2></div></div></div><p>

After you download the source distribution, you'll need to extract it into

a working directory. A typical command to do this is:

</p><pre class="screen">

-<code class="prompt">$ </code><span class="command"><strong>unzip findbugs-3.0.0-source.zip</strong></span>

+<code class="prompt">$ </code><span class="command"><strong>unzip findbugs-3.0.1-source.zip</strong></span>

</pre><p>

-</p></div><div class="sect1" title="3. Modifying local.properties"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e275"></a>3. Modifying <code class="filename">local.properties</code></h2></div></div></div><p>

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e275"></a>3. Modifying <code class="filename">local.properties</code></h2></div></div></div><p>

If you intend to build the FindBugs documentation,

you will need to modify the <code class="filename">local.properties</code> file

used by the <a class="ulink" href="http://ant.apache.org/" target="_top"><span class="application">Ant</span></a>

@@ -79,7 +79,7 @@ The <code class="varname">saxon.home</code> property is the full path to the

directory where you installed the <a class="ulink" href="http://saxon.sourceforge.net/" target="_top"><span class="application">Saxon</span> XSLT Processor</a>.

You only need to specify this property if you will be

generating the <span class="application">FindBugs</span> documentation.

-</p></div><div class="sect1" title="4. Running Ant"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e333"></a>4. Running <span class="application">Ant</span></h2></div></div></div><p>

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e333"></a>4. Running <span class="application">Ant</span></h2></div></div></div><p>

Once you have extracted the source distribution,

made sure that <span class="application">Ant</span> is installed,

modified <code class="filename">build.properties</code> (optional),

@@ -90,7 +90,7 @@ of running the command

<code class="prompt">$ </code><span class="command"><strong>ant <em class="replaceable"><code>target</code></em></strong></span>

</pre><p>

where <em class="replaceable"><code>target</code></em> is one of the following:

-</p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>build</strong></span></span></dt><dd><p>

+</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>build</strong></span></span></dt><dd><p>

This target compiles the code for <span class="application">FindBugs</span>. It is the default target.

</p></dd><dt><span class="term"><span class="command"><strong>docs</strong></span></span></dt><dd><p>

This target formats the documentation. (It also compiles some of

@@ -114,7 +114,7 @@ BUILD SUCCESSFUL

Total time: 17 seconds

</code>

</pre><p>

-</p></div><div class="sect1" title="5. Running FindBugs™ from a source directory"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e427"></a>5. Running <span class="application">FindBugs</span>™ from a source directory</h2></div></div></div><p>

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e427"></a>5. Running <span class="application">FindBugs</span>™ from a source directory</h2></div></div></div><p>

The <span class="application">Ant</span> build script for <span class="application">FindBugs</span> is written such that after

building the <span class="command"><strong>build</strong></span> target, the working directory

is set up just like a binary distribution. So, the information about

« no previous file with comments | « doc/manual/anttask.html ('k') | doc/manual/datamining.html » ('j') | no next file with comments »