doc/manual/building.html - Issue 139673002: Updating Findbugs from 2.0.1 to 2.0.3

Side by Side Diff: doc/manual/building.html

Issue 139673002: Updating Findbugs from 2.0.1 to 2.0.3 (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: bulach's nits Created 6 years, 11 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 unified diff | Download patch

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

OLD	NEW
1 <html><head>	1 <html><head>

2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">	2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">

3 <title>Chapter 3. Building FindBugs™ from Source</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" hre f="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" t itle="FindBugs™ Manual"><link rel="prev" href="installing.html" title="Cha pter 2. Installing FindBugs™"><link rel="next" href="running.htm l" title="Chapter 4. Running FindBugs™"></head><body bgcolor="wh ite" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="nav header"><table width="100%" summary="Navigation header"><tr><th colspan="3" alig n="center">Chapter 3. Building <span class="application">FindBugs</spa n>™ 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">Ne xt</a></td></tr></table><hr></div><div class="chapter" title="Chapter 3.&nb sp;Building FindBugs™ from Source"><div class="titlepage"><div><div><h2 cl ass="title"><a name="building"></a>Chapter 3. Building <span class="ap plication">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="buildin g.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="file name">local.properties</code></a></span></dt><dt><span class="sect1"><a href="bu ilding.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></d l></div><p>	3 <title>Chapter 3. Building FindBugs™ from Source</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" hre f="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" t itle="FindBugs™ Manual"><link rel="prev" href="installing.html" title="Cha pter 2. Installing FindBugs™"><link rel="next" href="running.htm l" title="Chapter 4. Running FindBugs™"></head><body bgcolor="wh ite" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="nav header"><table width="100%" summary="Navigation header"><tr><th colspan="3" alig n="center">Chapter 3. Building <span class="application">FindBugs</spa n>™ 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">Ne xt</a></td></tr></table><hr></div><div class="chapter" title="Chapter 3.&nb sp;Building FindBugs™ from Source"><div class="titlepage"><div><div><h2 cl ass="title"><a name="building"></a>Chapter 3. Building <span class="ap plication">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="buildin g.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="file name">local.properties</code></a></span></dt><dt><span class="sect1"><a href="bu ilding.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></d l></div><p>

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

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

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

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

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

9 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="li stitem"><p>	9 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="li stitem"><p>

10 The <a class="ulink" href="http://prdownloads.sourceforge.net/findbugs/fin dbugs-2.0.1-source.zip?download" target="_top"><span class="application">FindBug s</span> source distribution</a>	10 The <a class="ulink" href="http://prdownloads.sourceforge.net/findbugs/fin dbugs-2.0.3-source.zip?download" target="_top"><span class="application">FindBug s</span> source distribution</a>

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

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

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

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

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

16 </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>	16 </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>

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

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

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

20 downloaded from the <a class="ulink" href="http://ant.apache.org/" targe t="_top"><span class="application">Ant</span> website</a>.	20 downloaded from the <a class="ulink" href="http://ant.apache.org/" targe t="_top"><span class="application">Ant</span> website</a>.

21 Make sure that when you run <span class="application">Ant</span> your <e m class="replaceable"><code>JAVA_HOME</code></em>	21 Make sure that when you run <span class="application">Ant</span> your <e m class="replaceable"><code>JAVA_HOME</code></em>

22 environment variable points to the directory in which you installed	22 environment variable points to the directory in which you installed

23 JDK 1.5 (or later).	23 JDK 1.5 (or later).

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

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

26 you will also need the following software:	26 you will also need the following software:

27 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="li stitem"><p>	27 </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="li stitem"><p>

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

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

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

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

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

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

34 </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>	34 </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>

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

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

37	37

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

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

40 </pre><p>	40 </pre><p>

41	41

42 </p></div><div class="sect1" title="3. Modifying local.properties"><div cla ss="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>	42 </p></div><div class="sect1" title="3. Modifying local.properties"><div cla ss="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>

43 If you intend to build the FindBugs documentation,	43 If you intend to build the FindBugs documentation,

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

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

46 <code class="filename">build.xml</code> file to build <span class="application"> FindBugs</span>.	46 <code class="filename">build.xml</code> file to build <span class="application"> FindBugs</span>.

47 If you do not want to build the FindBugs documentation, then you	47 If you do not want to build the FindBugs documentation, then you

48 can ignore this file.	48 can ignore this file.

49 </p><p>	49 </p><p>

(...skipping 64 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
114 Total time: 17 seconds	114 Total time: 17 seconds

115 </code>	115 </code>

116 </pre><p>	116 </pre><p>

117 </p></div><div class="sect1" title="5. Running FindBugs™ from a sourc e directory"><div class="titlepage"><div><div><h2 class="title" style="clear: bo th"><a name="d0e427"></a>5. Running <span class="application">FindBugs</spa n>™ from a source directory</h2></div></div></div><p>	117 </p></div><div class="sect1" title="5. Running FindBugs™ from a sourc e directory"><div class="titlepage"><div><div><h2 class="title" style="clear: bo th"><a name="d0e427"></a>5. Running <span class="application">FindBugs</spa n>™ from a source directory</h2></div></div></div><p>

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

119 building the <span class="command"><strong>build</strong></span> target, the wor king directory	119 building the <span class="command"><strong>build</strong></span> target, the wor king directory

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

121 running <span class="application">FindBugs</span> in <a class="xref" href="runni ng.html" title="Chapter 4. Running FindBugs™">Chapter 4, <i >Running <span class="application">FindBugs</span>™</i></a>	121 running <span class="application">FindBugs</span> in <a class="xref" href="runni ng.html" title="Chapter 4. Running FindBugs™">Chapter 4, <i >Running <span class="application">FindBugs</span>™</i></a>

122 applies to source distributions, too.	122 applies to source distributions, too.

123 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigati on footer"><tr><td width="40%" align="left"><a accesskey="p" href="installing.ht ml">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="running.html">Next</a></td></tr><tr> <td width="40%" align="left" valign="top">Chapter 2. Installing <span class="application">FindBugs</span>™ </td><td width="20%" align="cent er"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right " valign="top"> Chapter 4. Running <span class="application">Find Bugs</span>™</td></tr></table></div></body></html>	123 </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigati on footer"><tr><td width="40%" align="left"><a accesskey="p" href="installing.ht ml">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="running.html">Next</a></td></tr><tr> <td width="40%" align="left" valign="top">Chapter 2. Installing <span class="application">FindBugs</span>™ </td><td width="20%" align="cent er"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right " valign="top"> Chapter 4. Running <span class="application">Find Bugs</span>™</td></tr></table></div></body></html>

OLD	NEW