Skip to content

Commit 5388aa6

Browse files
Bananeweizenlkoe
authored andcommitted
#70: upgrade to checkstyle core 8.10
* upgrade core library * create release notes * upgrade version numbers * moved alert message of Lars out of each version, now on top of release notes * typo fixes in metadata * packaged and updated documentation There haven't been any changes in checkstyle/xdocs mentioning a newly introduced config element since 8.6, so it seems safe to assume there are no metadata changes.
1 parent 56e4e9e commit 5388aa6

File tree

48 files changed

+199
-185
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+199
-185
lines changed

docs/partials/builtin-config.html

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@ <h1>Provide a custom built-in configuration</h1>
1414
<p>
1515
<b>Example:</b>
1616
</p>
17-
<pre><code>
18-
&lt;extension
17+
<pre><code>&lt;extension
1918
id="checkstyle.CheckConfiguration"
2019
point="net.sf.eclipsecs.core.configurations"&gt;
2120
&lt;check-configuration
@@ -24,13 +23,11 @@ <h1>Provide a custom built-in configuration</h1>
2423
description="Sample Built-in configuration"&gt;
2524
&lt;property name="maxLineLength" value="50"/&gt;
2625
&lt;/check-configuration&gt;
27-
&lt;/extension&gt;
28-
</code></pre>
26+
&lt;/extension&gt;</code></pre>
2927
<p>
3028
<b>Example 2 - custom built-in config to become the default configuration (highest default-weight wins):</b>
3129
</p>
32-
<pre><code>
33-
&lt;extension
30+
<pre><code>&lt;extension
3431
id="checkstyle.CheckConfiguration"
3532
point="net.sf.eclipsecs.core.configurations"&gt;
3633
&lt;check-configuration
@@ -40,6 +37,5 @@ <h1>Provide a custom built-in configuration</h1>
4037
default-weight="10"&gt;
4138
&lt;property name="maxLineLength" value="50"/&gt;
4239
&lt;/check-configuration&gt;
43-
&lt;/extension&gt;
44-
</code></pre>
40+
&lt;/extension&gt;</code></pre>
4541
</div>

docs/partials/custom-checks.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ <h1>Providing custom Checkstyle checks</h1>
5252
good idea to include this document type declaration to your metadata file: </p>
5353
<pre><code>&lt;!DOCTYPE checkstyle-metadata
5454
PUBLIC &quot;-//eclipse-cs//DTD Check Metadata 1.1//EN&quot;
55-
&quot;http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd&quot;&gt;
56-
</code></pre>
55+
&quot;http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd&quot;&gt;</code></pre>
5756
<p>This way you can validate your metadata file against the dtd using your preferred XML editor.</p>
5857
<p> The dtd file itself contains an abundance of documentation on the tags and their attributes, further
5958
further practical reference you may want to peek into the <code>net.sf.eclipsecs.checkstyle</code>

docs/partials/custom-filters.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,15 @@ <h1>Custom plugin filters</h1>
1515
</p>
1616
<p>Example:</p>
1717
<p>Using the <code>net.sf.eclipsecs.core.filters</code> extension point in your <code>plugin.xml</code></p>
18-
<pre><code>
19-
&lt;extension
18+
<pre><code>&lt;extension
2019
id="checkstyle.CheckstyleFilters"
2120
point="net.sf.eclipsecs.core.filters"&gt;
2221
&lt;filter
2322
name="Sample Filter"
2423
internal-name="SampleFilter"
2524
description="Sample Filter"
2625
class="net.sf.eclipsecs.sample.filter.SampleFilter"/&gt;
27-
&lt;/extension&gt;
28-
</code></pre>
26+
&lt;/extension&gt;</code></pre>
2927
<p>The filter implementation class must implement the
3028
<code>net.sf.eclipsecs.core.projectconfig.filters.IFilter</code> interface.<br/> To make life a bit easier
3129
for you there is the <code>net.sf.eclipsecs.core.projectconfig.filters.AbstractFilter</code> class which

docs/partials/extensions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h1>Extending the Eclipse Checkstyle Plugin</h1>
1818
not as complicated as it sounds.</p>
1919
<p> The easiest way is to check out the sample eclipse-cs extension plugin from the Git repository, this sample
2020
plugin provides an example for each documented extension hook.</p>
21-
<p>The repository location is: <code>git://git.code.sf.net/p/eclipse-cs/git</code><br/>The project to check out is:
21+
<p>The repository location is: <code>https://github.com/checkstyle/eclipse-cs.git</code><br/>The project to check out is:
2222
<code>net.sf.eclipsecs.sample</code></p>
2323
<p>After you got the project in your workspace you can just disconnect it from the Git and rename the project and
2424
the plugins symbolic bundle name in <code>META-INF/MANIFEST.MF</code> to your liking.</p>

docs/partials/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h1>Eclipse Checkstyle Plugin</h1>
3636
<br />
3737
<small>
3838
<sup>2 </sup>
39-
Latest release 8.8.0, based on Checkstyle 8.8, see
39+
Latest release 8.10.0, based on Checkstyle 8.10, see
4040
<a href="#!/releasenotes">release notes</a>
4141
</small>
4242
</div>

docs/partials/install.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ <h1>Installation</h1>
1010
<p>
1111
<a class="btn btn-primary btn-outline-inverse btn-lg" target="_blank"
1212
href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=150"
13-
title="Drag and drop this link into a running Eclipse Indigo/Kepler/Luna workspace to install Checkstyle Plugin"
13+
title="Drag and drop this link into a running Eclipse Indigo/Juno/Kepler/Luna/Mars/Neon/Oxygen workspace to install Checkstyle Plugin"
1414
><i class="fa fa-plug"> </i> Install </a>
1515
</p>
1616
<ol>
17-
<li>Drag&amp;Drop the link above to a running Eclipse Indigo/Juno/Kepler/Luna/Mars instance. This will trigger the
17+
<li>Drag&amp;Drop the link above to a running Eclipse Indigo/Juno/Kepler/Luna/Mars/Neon/Oxygen instance. This will trigger the
1818
Eclipse Marketplace client with the Eclipse Checkstyle Plugin being pre-selected for
1919
installation.</li>
2020
<li>Confirm the selection of features to install</li>

docs/partials/releasenotes.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
<div class="container" data-ng-controller="ReleaseNotesCtrl">
22
<!-- <div data-google-ad=""/> -->
33

4+
<div class="alert alert-info">
5+
The slow rate of recent updates is owed to a shift in personal interest and how I spend my spare
6+
time.
7+
<p>
8+
If you want to help keep this project afloat and steadily updated please send me a message or
9+
<a href="https://sourceforge.net/p/eclipse-cs/discussion/274376/thread/3b44a5eb/">post to the
10+
forums
11+
</a>
12+
.
13+
</p>
14+
<p>
15+
Additionally activity has started to migrate the project to Github (
16+
<a href="https://github.com/checkstyle/eclipse-cs">eclipse-cs Github page</a>
17+
), hoping this will make it easier for contributions.
18+
Code and issue tracking have already been moved, other facilities will
19+
follow over the course of the next weeks.
20+
</p>
21+
-- Lars
22+
</div>
23+
424
<h1>Release notes <button class="btn btn-primary btn-sm" data-ng-click="expandAll()"><i class="fa fa-plus-square-o"
525
> </i> Expand all</button></h1>
626
<accordion data-close-others="false">
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<div>
2+
<p>Updates the Checkstyle core to version 8.10.</p>
3+
<p>
4+
Please note that this version requires
5+
<strong>Java 8 as the minimum runtime environment</strong>
6+
. This requires
7+
you to run Eclipse on a Java 8 JVM in order to use this plugin version.
8+
</p>
9+
<p>This restriction does not affect the ability to analyze Java 5 or lower level source code.</p>
10+
<p>
11+
Please read the
12+
<a target="_blank" href="http://checkstyle.sourceforge.net/releasenotes.html">Checkstyle
13+
release notes
14+
</a>
15+
for details on recent and potentially breaking changes in Checkstyle.
16+
Checkstyle configuration files potentially
17+
need to be adapted to this version.
18+
</p>
19+
<h3>Features</h3>
20+
<ul>
21+
<li><a href="https://github.com/checkstyle/eclipse-cs/issues/70">#70 Upgrade to Checkstyle 8.10</a></li>
22+
</ul>
23+
<h3>Bugfixes</h3>
24+
<ul>
25+
<li><a href="https://github.com/checkstyle/eclipse-cs/issues/48">#48 Package name check has wrong default in Sun configuration</a></li>
26+
</ul>
27+
</div>

docs/partials/releases/8.5.0/release_notes.html

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,6 @@
1414
</a>
1515
for details on recent changes in Checkstyle.
1616
</p>
17-
<div class="alert alert-info">
18-
The slow rate of recent updates is owed to a shift in personal interest and how I spend my spare
19-
time.
20-
<br />
21-
<br />
22-
If you want to help keep this project afloat and steadily updated please send me a message or post to the
23-
forums
24-
(https://sourceforge.net/p/eclipse-cs/discussion/274376/thread/3b44a5eb/).
25-
<br />
26-
<br />
27-
-- Lars
28-
</div>
2917
<h3>Bugfixes</h3>
3018
<ul>
3119
<li>

docs/partials/releases/8.7.0/release_notes.html

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,4 @@
1616
Checkstyle configuration files potentially
1717
need to be adapted to this version.
1818
</p>
19-
<div class="alert alert-info">
20-
The slow rate of recent updates is owed to a shift in personal interest and how I spend my spare
21-
time.
22-
<p>
23-
If you want to help keep this project afloat and steadily updated please send me a message or
24-
<a href="https://sourceforge.net/p/eclipse-cs/discussion/274376/thread/3b44a5eb/">post to the
25-
forums
26-
</a>
27-
.
28-
</p>
29-
<p>
30-
Additionally activity has started to migrate the project to Github (
31-
<a href="https://github.com/checkstyle/eclipse-cs">eclipse-cs Github page</a>
32-
), hoping this will make it easier for contributions.
33-
Code and issue tracking have already been moved, other facilities will
34-
follow over the course of the next weeks.
35-
</p>
36-
-- Lars
37-
</div>
3819
</div>

0 commit comments

Comments
 (0)