This is an automated email from the ASF dual-hosted git repository. pottlinger pushed a commit to branch fix/RAT-450 in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
commit fefc482a58077059bd1ca2d7efc05b031e3a7141 Author: P. Ottlinger <[email protected]> AuthorDate: Sun Nov 10 00:45:45 2024 +0100 RAT-450: Harmonize log messages to ease migration for RAT consumers of v0.17 --- .../java/org/apache/rat/mp/AbstractRatMojo.java | 36 +++++++++++----------- .../main/java/org/apache/rat/mp/RatCheckMojo.java | 8 ++--- src/changes/changes.xml | 3 ++ 3 files changed, 25 insertions(+), 22 deletions(-) diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java b/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java index eb88c25a..158b9a59 100644 --- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java +++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/AbstractRatMojo.java @@ -78,7 +78,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * Specifies the licenses to accept. By default, these are added to the default * licenses, unless you set <addDefaultLicenseMatchers> to false. Arguments should be * file name of <Configs> file structure. - * @deprecated use <config>. + * @deprecated Use <config>. * @since 0.8 */ @Parameter @@ -87,7 +87,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { /** * Specifies the additional licenses file. - * @deprecated Use <config>. + * @deprecated Use <config>. */ @Parameter @Deprecated @@ -105,21 +105,21 @@ public abstract class AbstractRatMojo extends BaseRatMojo { /** * Whether to add the default list of license matchers. - * @deprecated use <config> + * @deprecated Use <config>. */ @Deprecated @Parameter(property = "rat.addDefaultLicenseMatchers") private boolean addDefaultLicenseMatchers; /** The list of approved licenses - * @deprecated use <config> + * @deprecated Use <config>. */ @Deprecated @Parameter(required = false) private String[] approvedLicenses; /** The file of approved licenses - * @deprecated use <config> + * @deprecated Use <config>. */ @Deprecated @Parameter(property = "rat.approvedFile") @@ -129,21 +129,21 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * Specifies the license families to accept. * * @since 0.8 - * @deprecated use LicenseFamily section of configuration file. + * @deprecated Use LicenseFamily section of configuration file. */ @Deprecated @Parameter private SimpleLicenseFamily[] licenseFamilies; /** The list of license definitions. - * @deprecated Deprecated for removal since 0.17: Use <Config> instead. See Config file documentation. + * @deprecated Deprecated for removal since 0.17: Use <Config> instead. See configuration file documentation. */ @Deprecated @Parameter private Object[] licenses; /** The list of family definitions. - * @deprecated use <Configs> + * @deprecated Use <Configs>. */ @Deprecated @Parameter @@ -151,14 +151,14 @@ public abstract class AbstractRatMojo extends BaseRatMojo { /** * Specifies the include files character set. - * if ${project.build.sourceEncoding} is not set defaults to UTF-8 + * If ${project.build.sourceEncoding} is not set defaults to UTF-8. */ @Parameter(property = "rat.includesFileCharset", defaultValue = "${project.build.sourceEncoding}") private String includesFileCharset; /** * Specifies the include files character set. - * if ${project.build.sourceEncoding} is not set defaults to UTF-8 + * If ${project.build.sourceEncoding} is not set defaults to UTF-8. */ @Parameter(property = "rat.excludesFileCharset", defaultValue = "${project.build.sourceEncoding}") private String excludesFileCharset; @@ -176,8 +176,8 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * <li>configuration files for IDEA, see * <a href="#useIdeaDefaultExcludes">useIdeaDefaultExcludes</a></li> * </ul> - * @deprecated when set to true specifies that the STANDARD_PATTERNS are excluded, as are - * the STANDARD_SCMS patterns. Use the various InputExclude and InputInclude elements to + * @deprecated When set to true specifies that the STANDARD_PATTERNS are excluded, as are + * the STANDARD_SCMS patterns. Use the various InputExclude and InputInclude elements to * explicitly specify what to include or exclude. */ @Parameter(property = "rat.useDefaultExcludes", defaultValue = "true") @@ -189,7 +189,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * Maven specific default excludes are given by the constant * MAVEN_DEFAULT_EXCLUDES: The <code>target</code> directory, the * <code>cobertura.ser</code> file, and so on. - * @deprecated when set to true specifies that the MAVEN patterns are excluded + * @deprecated When set to true specifies that the MAVEN patterns are excluded. * Use "inputIncludeStd MAVEN" to override. */ @Parameter(property = "rat.useMavenDefaultExcludes", defaultValue = "true") @@ -201,7 +201,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * their contents as excludes. At the moment this works for the following SCMs: * * @see org.apache.rat.config.exclusion.StandardCollection - * @deprecated when set to true specifies that the STANDARD_SCMS exclusion file + * @deprecated When set to true specifies that the STANDARD_SCMS exclusion file * processors are used to exclude files and directories (e.g. ".gitignore" or ".hgignore"). * Use "inputIncludeStd STANDARD_SCMS" to override. */ @@ -214,7 +214,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * Eclipse specific default excludes are given by the constant * ECLIPSE_DEFAULT_EXCLUDES: The <code>.classpath</code> and * <code>.project</code> files, the <code>.settings</code> directory, and so on. - * @deprecated when set to true specifies that the ECLIPSE patterns are excluded + * @deprecated When set to true specifies that the ECLIPSE patterns are excluded. * Use "inputIncludeStd ECLIPSE" to override. */ @Parameter(property = "rat.useEclipseDefaultExcludes", defaultValue = "true") @@ -226,7 +226,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { * IDEA specific default excludes are given by the constant * IDEA_DEFAULT_EXCLUDES: The <code>*.iml</code>, <code>*.ipr</code> and * <code>*.iws</code> files and the <code>.idea</code> directory. - * @deprecated when set to true specifies that the IDEA patterns are excluded + * @deprecated When set to true specifies that the IDEA patterns are excluded. * Use "inputIncludeStd IDEA" to override. */ @Deprecated @@ -257,7 +257,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { protected MavenProject project; /** - * @return Returns the Maven project. + * @return the Maven project. */ protected MavenProject getProject() { return project; @@ -296,7 +296,7 @@ public abstract class AbstractRatMojo extends BaseRatMojo { @Deprecated // remove this for version 1.0 private void reportDeprecatedProcessing() { if (getDeprecatedConfigs().findAny().isPresent()) { - DefaultLog.getInstance().warn("Configuration uses deprecated configuration. Please upgrade to v0.17 configuration options"); + DefaultLog.getInstance().warn("Configuration uses deprecated configuration. You need to upgrade to v0.17 configuration options."); } } diff --git a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java index f3acfeae..05bdb3d9 100644 --- a/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java +++ b/apache-rat-plugin/src/main/java/org/apache/rat/mp/RatCheckMojo.java @@ -58,7 +58,7 @@ public class RatCheckMojo extends AbstractRatMojo { /** * Where to store the report. - * @deprecated use 'out' property. + * @deprecated Use 'out' property instead. */ @Deprecated @Parameter @@ -74,7 +74,7 @@ public class RatCheckMojo extends AbstractRatMojo { * or "xml" for the raw XML report. Alternatively you can give the path of an * XSL transformation that will be applied on the raw XML to produce the report * written to the output file. - * @deprecated use setStyleSheet or xml + * @deprecated Use setStyleSheet or xml instead. */ @Deprecated @Parameter(property = "rat.outputStyle") @@ -90,7 +90,7 @@ public class RatCheckMojo extends AbstractRatMojo { /** * Maximum number of files with unapproved licenses. - * @deprecated use <counterMax>Unapproved:value</counterMax> + * @deprecated Use <counterMax>Unapproved:value</counterMax>. */ @Deprecated @Parameter(property = "rat.numUnapprovedLicenses", defaultValue = "0") @@ -99,7 +99,7 @@ public class RatCheckMojo extends AbstractRatMojo { /** * Whether to add license headers; possible values are {@code forced}, * {@code true}, and {@code false} (default). - * @deprecated use <editLicense> and <editOverwrite> + * @deprecated Use <editLicense> and <editOverwrite>. */ @Deprecated @Parameter(property = "rat.addLicenseHeaders") diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 241c49ba..f32416db 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -72,6 +72,9 @@ The <action> type attribute can be one of: </release> --> <release version="0.17-SNAPSHOT" date="xxxx-yy-zz" description="Current SNAPSHOT - release to be done"> + <action issue="RAT-450" type="fix" dev="pottlinger"> + Harmonize log output messages that are automatically generated for Maven command line options to ease migration to v0.17. + </action> <action issue="RAT-399" type="add" dev="claudenw"> Moved the ignore code into apache-rat-core and provide more statistics in RAT report. Furthermore the CLI allows configuration of counter minimum and maximum values, e.g. maximum number of allowed unapproved licenses. </action>
