Author: hboutemy
Date: Sun Jan 18 17:30:52 2015
New Revision: 1652807
URL: http://svn.apache.org/r1652807
Log:
[MCHECKSTYLE-257] display predefined rulesets content
Added:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
(with props)
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
(with props)
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm
(with props)
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm
(with props)
Modified:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
Added: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt?rev=1652807&view=auto
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
(added)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
Sun Jan 18 17:30:52 2015
@@ -0,0 +1,40 @@
+ ------
+ Predefined Rulesets
+ ------
+ Hervé Boutemy
+ ------
+ 2015-01-18
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+Predefined Rulesets
+
+ Maven Checkstyle plugin contains predefined rulesets:
+
+ * {{{./sun_checks.html}<<<config/sun_checks.xml>>>}},
+
+ * {{{./maven_checks.html}<<<config/maven_checks.xml>>>}},
+
+ * {{{./turbine_checks.html}<<<config/turbine_checks.xml>>>}}.
+
+ []
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/index.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm?rev=1652807&view=auto
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
(added)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
Sun Jan 18 17:30:52 2015
@@ -0,0 +1,35 @@
+ ------
+ config/maven_checks.xml Predefined Ruleset
+ ------
+ Hervé Boutemy
+ ------
+ 2015-01-18
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+<<<config/maven_checks.xml>>> Predefined Ruleset
+
+ Maven Checkstyle plugin contains <<<config/maven_checks.xml>>> predefined
ruleset for
+ {{{/developers/conventions/code.html}Maven coding conventions}}:
+
+%{snippet|file=${project.basedir}/src/main/resources/config/maven_checks.xml}
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/maven_checks.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm?rev=1652807&view=auto
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm
(added)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm
Sun Jan 18 17:30:52 2015
@@ -0,0 +1,35 @@
+ ------
+ config/sun_checks.xml Predefined Ruleset
+ ------
+ Hervé Boutemy
+ ------
+ 2015-01-18
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+<<<config/sun_checks.xml>>> Predefined Ruleset
+
+ Maven Checkstyle plugin contains <<<config/sun_checks.xml>>> predefined
ruleset derived from the configuration
+ included in Checkstyle sources:
+
+%{snippet|file=${project.basedir}/src/main/resources/config/sun_checks.xml}
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/sun_checks.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm?rev=1652807&view=auto
==============================================================================
---
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm
(added)
+++
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm
Sun Jan 18 17:30:52 2015
@@ -0,0 +1,34 @@
+ ------
+ config/turbine_checks.xml Predefined Ruleset
+ ------
+ Hervé Boutemy
+ ------
+ 2015-01-18
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+<<<config/turbine_checks.xml>>> Predefined Ruleset
+
+ Maven Checkstyle plugin contains <<<config/turbine_checks.xml>>> predefined
ruleset for Turbine coding conventions:
+
+%{snippet|file=${project.basedir}/src/main/resources/config/turbine_checks.xml}
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/config/turbine_checks.apt.vm
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm?rev=1652807&r1=1652806&r2=1652807&view=diff
==============================================================================
--- maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm
(original)
+++ maven/plugins/trunk/maven-checkstyle-plugin/src/site/apt/index.apt.vm Sun
Jan 18 17:30:52 2015
@@ -34,7 +34,9 @@ ${project.name}
This version of the plugin uses Checkstyle ${checkstyleVersion} and requires
Java ${javaVersion}.
The plugin can be configured in the project's POM. Predefined rulesets are
included with the plugin, these are:
- <<<sun_checks.xml>>>, <<<turbine_checks.xml>>> and <<<maven_checks.xml>>>.
You can also use a custom ruleset by
+ {{{./config/sun_checks.xml}<<<sun_checks.xml>>>}},
+ {{{./config/turbine_checks.xml}<<<turbine_checks.xml>>>}} and
+ {{{./config/maven_checks.xml}<<<maven_checks.xml>>>}}. You can also use a
custom ruleset by
specifying it in the plugin configuration.
* Goals Overview
