Hi Dennis,
FYI, I am working on the version 2.0 of this plugin which will starts from
scratch fro the third-party + download licenses part.
So don't waste too much time on it, except if you want to do a release of the
1.6 ;) (We can talk of this on IRC I am here.)
Have a nice sunday,
tony.
On Sun, 15 Sep 2013 05:12:59 -0500 (CDT)
denn...@codehaus.org wrote:
> [18717] trunk/mojo/license-maven-plugin/src: Fix typos and broken links.
> Revision 18717 Author dennisl Date 2013-09-15 05:12:58 -0500 (Sun, 15 Sep
> 2013)
> Log MessageFix typos and broken links.
> Modified Paths
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/api/ThirdPartyHelper.java
> trunk/mojo/license-maven-plugin/src/site/apt/examples/example-comment-style-list.apt.vm
> trunk/mojo/license-maven-plugin/src/site/apt/examples/update-file-header-config.apt.vm
> trunk/mojo/license-maven-plugin/src/site/apt/header.apt
> trunk/mojo/license-maven-plugin/src/site/apt/usage.apt.vm
> trunk/mojo/license-maven-plugin/src/site/fml/faq.fml
> Diff
> Modified:
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java
> (18716 => 18717)
> ---
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java
> 2013-09-15 09:10:52 UTC (rev 18716)
> +++
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java
> 2013-09-15 10:12:58 UTC (rev 18717)
> @@ -59,7 +59,7 @@
> import java.util.TreeMap;
>
> /**
> - * Abstract mojo for file-header operations (chekc, update, report,...).
> + * Abstract mojo for file-header operations (check, update, report,...).
> * <p/>
> *
> * @author tchemit <che...@codelutin.com>
> @@ -220,9 +220,9 @@
> /**
> * A flag to add the license header in java files after the package
> statement.
> * <p/>
> - * This is a pratice used by many people (apache, codehaus, ...).
> + * This is a practice used by many people (apache, codehaus, ...).
> * <p/>
> - * <b>Note:</b> By default this property is then to {@code true} since
> it is a good pratice.
> + * <b>Note:</b> By default this property is then to {@code true} since
> it is a good practice.
> *
> * @since 1.2
> */
> @@ -249,7 +249,7 @@
> /**
> * Specific files to includes, separated by a comma. By default, it is
> "** /*".
> * <p/>
> - * <b>Note:</b> This parameter is not useable if you are still using a
> project file descriptor.
> + * <b>Note:</b> This parameter is not usable if you are still using a
> project file descriptor.
> *
> * @since 1.0
> */
> @@ -274,10 +274,10 @@
> /**
> * To associate extra extension files to an existing comment style.
> * <p/>
> - * Keys of the map are the extension of extra files to treate, and the
> value
> + * Keys of the map are the extension of extra files to treat, and the
> value
> * is the comment style you want to associate.
> * <p/>
> - * For example, to treate file with extensions {@code java2} and {@code
> jdata}
> + * For example, to treat file with extensions {@code java2} and {@code
> jdata}
> * as {@code java} files (says using the {@code java} comment style,
> declare this
> * in your plugin configuration :
> * <pre>
> @@ -296,7 +296,7 @@
> protected Map<String, String> extraExtensions;
>
> /**
> - * Template used to build the description scetion of the license header.
> + * Template used to build the description section of the license header.
> * <p/>
> * (This template use freemarker).
> *
> @@ -360,7 +360,7 @@
> private long timestamp;
>
> /**
> - * The dictionnary of extension indexed by their associated comment
> style.
> + * The dictionary of extension indexed by their associated comment style.
> *
> * @since 1.0
> */
> @@ -379,12 +379,12 @@
> private Set<File> processedFiles;
>
> /**
> - * Dictionnary of treated files indexed by their state.
> + * Dictionary of treated files indexed by their state.
> */
> private EnumMap<FileState, Set<File>> result;
>
> /**
> - * Dictonnary of files to treate indexed by their CommentStyle.
> + * Dictionary of files to treat indexed by their CommentStyle.
> */
> private Map<String, List<File>> filesToTreateByCommentStyle;
>
> @@ -574,7 +574,7 @@
> }
> }
>
> - // get all files to treate indexed by their comment style
> + // get all files to treat indexed by their comment style
> filesToTreateByCommentStyle = obtainFilesToProcessByCommentStyle();
>
> // build the description template
> @@ -724,7 +724,7 @@
> }
> }
>
> - // Obtain all files to treate
> + // Obtain all files to treat
> Map<File, String[]> allFiles = new HashMap<File, String[]>();
> getFilesToTreateForRoots( includes, excludes, rootsList, allFiles );
>
> @@ -743,7 +743,7 @@
> if ( StringUtils.isEmpty( commentStyle ) )
> {
>
> - // unknown extension, do not treate this file
> + // unknown extension, do not treat this file
> continue;
> }
> //
> @@ -1264,7 +1264,7 @@
> *
> * @param includes includes
> * @param excludes excludes
> - * @param roots root directories to treate
> + * @param roots root directories to treat
> * @param files cache of file detected indexed by their root directory
> */
> protected void getFilesToTreateForRoots( String[] includes, String[]
> excludes, List<String> roots,
> Modified:
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/api/ThirdPartyHelper.java
> (18716 => 18717)
> ---
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/api/ThirdPartyHelper.java
> 2013-09-15 09:10:52 UTC (rev 18716)
> +++
> trunk/mojo/license-maven-plugin/src/main/java/org/codehaus/mojo/license/api/ThirdPartyHelper.java
> 2013-09-15 10:12:58 UTC (rev 18717)
> @@ -50,7 +50,7 @@
> * Load all dependencies given the configuration as {@link MavenProject}.
> *
> * @param configuration the configuration of the project and
> include/exclude to do on his dependencies
> - * @return the dictionnary of loaded dependencies as {@link
> MavenProject} indexed by their gav.
> + * @return the dictionary of loaded dependencies as {@link MavenProject}
> indexed by their gav.
> */
> SortedMap<String, MavenProject> loadDependencies(
> MavenProjectDependenciesConfigurator configuration );
>
> @@ -75,7 +75,7 @@
>
> /**
> * Load unsafe mapping for all dependencies with no license in their
> pom, we will load the missing file
> - * if it exists and alos add all dependencies from licenseMap with no
> license known.
> + * if it exists and also add all dependencies from licenseMap with no
> license known.
> *
> * @param licenseMap the license map of all dependencies.
> * @param missingFile location of an optional missing fille (says where
> you fix missing license).
> Modified:
> trunk/mojo/license-maven-plugin/src/site/apt/examples/example-comment-style-list.apt.vm
> (18716 => 18717)
> ---
> trunk/mojo/license-maven-plugin/src/site/apt/examples/example-comment-style-list.apt.vm
> 2013-09-15 09:10:52 UTC (rev 18716)
> +++
> trunk/mojo/license-maven-plugin/src/site/apt/examples/example-comment-style-list.apt.vm
> 2013-09-15 10:12:58 UTC (rev 18717)
> @@ -39,7 +39,7 @@
> mvn license:comment-style-list
>
> -------------------------------------------------------------------------------
>
> - To display the example, use the <<detail>> parameter :
> + To display example comments, use the <<detail>> parameter :
>
>
> -------------------------------------------------------------------------------
> mvn license:comment-style-list -Ddetail
> Modified:
> trunk/mojo/license-maven-plugin/src/site/apt/examples/update-file-header-config.apt.vm
> (18716 => 18717)
> ---
> trunk/mojo/license-maven-plugin/src/site/apt/examples/update-file-header-config.apt.vm
> 2013-09-15 09:10:52 UTC (rev 18716)
> +++
> trunk/mojo/license-maven-plugin/src/site/apt/examples/update-file-header-config.apt.vm
> 2013-09-15 10:12:58 UTC (rev 18717)
> @@ -29,13 +29,13 @@
> * roots : it is a list of the main directories from which we apply the
> license on files. The default roots is <src, target/generated-sources,
> target/processed-source>,
>
> - * includes : List of files to include, gived by a regexp (for example:
> <*Dao.java>).
> + * includes : List of files to include, given by a regexp (for example:
> <*Dao.java>).
> The default include is **/*,
>
> - * excludes: List of files to exclude, gived by a regexp (for example:
> <*Test.java>).
> - there is no default excludes files.
> + * excludes: List of files to exclude, given by a regexp (for example:
> <*Test.java>).
> + No files are excludes by default.
>
> - * extraExtensions: Dictionnary of extensions to map to existing comment
> style.
> + * extraExtensions: Dictionary of extensions to map to existing comment
> style.
>
> * customize description section: Define a template to change the
> description section of a file header.
>
> @@ -235,7 +235,7 @@
>
> In the template you can use these variables:
>
> - * {{{../update-file-header-mojo.html#project}project}}
> + * project (current Maven project)
>
> * {{{../update-file-header-mojo.html#addSvnKeyWords}addSvnKeyWords}}
>
> @@ -262,7 +262,7 @@
> </plugins>
>
> -------------------------------------------------------------------------------
>
> - With this freemarker template located in
> <${basedir}/src/license/myDescriptionTemplate.ftl>:
> + With this freemarker template located in
> <$\{basedir\}/src/license/myDescriptionTemplate.ftl>:
>
>
> -------------------------------------------------------------------------------
> <#-- To render the description of a license file header.
> Modified: trunk/mojo/license-maven-plugin/src/site/apt/header.apt (18716 =>
> 18717)
> --- trunk/mojo/license-maven-plugin/src/site/apt/header.apt 2013-09-15
> 09:10:52 UTC (rev 18716)
> +++ trunk/mojo/license-maven-plugin/src/site/apt/header.apt 2013-09-15
> 10:12:58 UTC (rev 18717)
> @@ -63,7 +63,7 @@
>
> * Configuration
>
> - You can configure those things :
> + You can configure these things:
>
> * start process tag (using the
> {{{./update-file-header-mojo.html#processStartTag}processStartTag}} parameter)
>
> @@ -71,12 +71,14 @@
>
> * end process tag (using the
> {{{./update-file-header-mojo.html#processEndTag}processEndTag}} parameter)
>
> + []
> +
> <<Note:>>
>
> * The plugin won't be able to migrate from a header configuration to
> another one, so prepare this
> configuration before the first execution of the goal (and never change
> it :().
>
> - * As the configuration has a special meaning for the goal to treat a file
> and should not be eable to be found more
> + * As the configuration has a special meaning for the goal to treat a file
> and should not be able to be found more
> than once in a file, we can use special space separator, the goal will
> remove then. In that way the exact
> configuration won't be found twice in your pom.xml.
>
> @@ -97,7 +99,7 @@
> Copyright (C) firstYear[ - lastYear] holder
>
> --------------------------------------------------------------------------------
>
> - If *firstYear* and *lastYear* are the same then lastYear is omitted.
> + If <firstYear> and <lastYear> are the same then <lastYear> is omitted.
>
> * Comment box
>
> @@ -106,7 +108,7 @@
>
> Available comment styles
>
> - Here is the available comment styles.
> + Here are the available comment styles.
>
> Using the goal {{{./comment-style-list-mojo.html}comment-style-list}}
> you can find all of them.
> @@ -212,5 +214,5 @@
> %%Ignore-License
>
> --------------------------------------------------------------------------------
>
> - Note : Don't use start (1) and end (7 in exemple) balise
> + Note : Don't use start (1) and end (7 in example) balise
> You can change it with <<ignoreTag>> property.
> Modified: trunk/mojo/license-maven-plugin/src/site/apt/usage.apt.vm (18716
> => 18717)
> --- trunk/mojo/license-maven-plugin/src/site/apt/usage.apt.vm 2013-09-15
> 09:10:52 UTC (rev 18716)
> +++ trunk/mojo/license-maven-plugin/src/site/apt/usage.apt.vm 2013-09-15
> 10:12:58 UTC (rev 18717)
> @@ -74,7 +74,7 @@
> mvn license:comment-style-list -Ddetail
>
> -------------------------------------------------------------------------------
>
> - For more information, see the
> {{{./examples/example-license-list.html}examples}} and
> + For more information, see the
> {{{./examples/example-comment-style-list.html}examples}} and
> for full detail see {{{./comment-style-list-mojo.html}detail page}}.
>
> ** help goal
> @@ -105,24 +105,22 @@
> It can also generate a bundle License file to avoid name collision in a
> final
> application.
>
> - for full detail see {{{./update-project-license-mojo.html}detail page}}.
> + For full detail see {{{./update-project-license-mojo.html}detail page}}.
>
> ** update-file-header goal
>
> This goal adds or updates the license header based on the configuration.
>
> For more information, see the
> {{{./examples/update-file-header-config.html}examples}} and
> - for full detail see {{{./update-file-header-mojo.html}detail page}}.
> + for full detail on the configuration see
> {{{./update-file-header-mojo.html}detail page}}.
>
> - for full detail on the configuration see
> {{{./update-file-header-config.html}detail page}}.
> -
> ** check-file-header goal
>
> This goal checks the license header based on the configuration on project
> sources files.
>
> For full detail see {{{./check-file-header-mojo.html}detail page}}.
>
> - This goal has same behaviour that the update-file-header with <dryRun>
> option.
> + This goal has same behaviour as the update-file-header with <dryRun>
> option.
>
>
> * Getting Dependency License Information
> @@ -131,10 +129,10 @@
>
> This goal builds the THIRD-PARTY.txt file and adds it in the build.
>
> - We also are able to consolidate the generated file by filling another
> + We are also able to consolidate the generated file by filling another
> file (the <<missing file>>) for dependencies without license.
>
> - <Note:> This mojo has not effect on a <<pom>> project.
> + <Note:> This mojo has no effect on a <<pom>> project.
>
> For more information, see the
> {{{./examples/example-thirdparty.html}examples}} and for
> full details see {{{./add-third-party-mojo.html}the add third party mojo
> page}}.
> @@ -144,7 +142,7 @@
> This goal builds the THIRD-PARTY.txt file on a multi-module project from
> the dependencies of all its modules.
>
> - <Note:> This mojo has only effect on a <<pom>> project.
> + <Note:> This mojo only has effect on a <<pom>> project.
>
> For more information, see the
> {{{./examples/example-thirdparty.html}examples}} and for
> full detail see {{{./aggregate-add-third-party-mojo.html}the aggregate add
> third party mojo
> @@ -156,8 +154,7 @@
> licenses. Example configuration is listed below, and more information is
> available in the
> {{{./examples/example-download-licenses.html}examples page}}.
>
> - By default the plugin attaches to the <<<generate-resources>>> phase of
> the build lifecycle. An
> - example configuration is supplied below.
> + By default the plugin attaches to the <<<generate-resources>>> phase of
> the build lifecycle.
>
> -------------------
> <project>
> Modified: trunk/mojo/license-maven-plugin/src/site/fml/faq.fml (18716 =>
> 18717)
> --- trunk/mojo/license-maven-plugin/src/site/fml/faq.fml 2013-09-15
> 09:10:52 UTC (rev 18716)
> +++ trunk/mojo/license-maven-plugin/src/site/fml/faq.fml 2013-09-15
> 10:12:58 UTC (rev 18717)
> @@ -30,9 +30,9 @@
> <p>
> The Codehaus plugin and the <a href="">Google Code</a> plugin were
> developed separately but with similar goals.
> The two plugins have several overlapping features including
> verifying and updating license information in
> - source files. The Codehaus plugin also provides the ability to
> download the licenses of thirdparty dependencies
> + source files. The Codehaus plugin also provides the ability to
> download the licenses of third party dependencies
> and create and XML report listing each project dependency and its
> license. If you are not sure which one to use
> - you should try both to see which one better fits your needs.
> + you should try both to see which one best fits your needs.
> </p>
> </answer>
> </faq>
> @@ -42,7 +42,7 @@
> <p>
> The <a
> href="http://maven-site.nuiton.org/maven-license-plugin/";>Code Lutin
> maven-license-plugin</a> is an older version of the Codehaus
> license-maven-plugin. The source code
> of the Code Lutin plugin was donated to Codehaus and merged with
> some existing license plugin code.
> - His original creator joined then the Codehaus team to continue the
> project developement.
> + The original creator joined then the Codehaus team to continue the
> project development.
> </p>
> </answer>
> </faq>
> @@ -54,7 +54,7 @@
> You should use the <i>mysql</i> header style instead, with
> with configuration:
> <pre>
> <extraExtensions>
> - <sql>mysql</sql>
> + <sql>mysql</sql>
> </extraExtensions>
> </pre>
> <a href="http://jira.codehaus.org/browse/MLICENSE-56";>Bug
> detail.</a>
>
> To unsubscribe from this list please visit:
>
> http://xircles.codehaus.org/manage_email
--
Tony Chemit
--------------------
tél: +33 (0) 2 40 50 29 28
email: che...@codelutin.com
http://www.codelutin.com
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
