Author: tchemit Date: 2010-04-09 23:25:47 +0200 (Fri, 09 Apr 2010) New Revision: 1728 Log: - change section delimiter -- to %% to avoid error in xml comment - add addSvnKeyWords flag in update-license goal to add svn:keywords on new header - update doc Added: trunk/src/site/rst/descriptor.rst Modified: trunk/src/it/update-license/src/main/java/org/nuiton/license/plugin/test/MyBean2.java trunk/src/main/java/org/nuiton/license/plugin/UpdateLicenseMojo.java trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java trunk/src/main/resources/license/defaultHeader.vm trunk/src/site/rst/index.rst trunk/src/site/site_en.xml trunk/src/test/resources/org/nuiton/license/plugin/updateLicenseMojoTest/updateLicense/src/MyBean.java Modified: trunk/src/it/update-license/src/main/java/org/nuiton/license/plugin/test/MyBean2.java =================================================================== --- trunk/src/it/update-license/src/main/java/org/nuiton/license/plugin/test/MyBean2.java 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/it/update-license/src/main/java/org/nuiton/license/plugin/test/MyBean2.java 2010-04-09 21:25:47 UTC (rev 1728) @@ -1,9 +1,9 @@ /* * #%L * License Test :: do NOT update! - * -- + * %% * Copyright (C) 2010 Tony - * -- + * %% * Fake to be removed! * #L% */ Modified: trunk/src/main/java/org/nuiton/license/plugin/UpdateLicenseMojo.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/UpdateLicenseMojo.java 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/main/java/org/nuiton/license/plugin/UpdateLicenseMojo.java 2010-04-09 21:25:47 UTC (rev 1728) @@ -99,6 +99,14 @@ protected String inceptionYear; /** + * A flag to add svn:keywors on new header. + * + * @parameter expression="${license.addSvnKeyWords}" default-value="false" + * @since 2.1 + */ + protected boolean addSvnKeyWords; + + /** * A flag to update copyright application time (change copyright last year * if required) according to the last commit made on the processed file. * @@ -117,7 +125,6 @@ */ protected String ignoreTag; - /** * To specify an external extra licenses repository resolver (says the base * url of the repository where the {@code license.properties} is present). @@ -583,8 +590,23 @@ String copyrightHolder, String encoding) throws IOException { FileHeader result = new FileHeader(); - result.setDescription(projectName); + StringBuilder buffer = new StringBuilder(); + buffer.append(projectName); + if (addSvnKeyWords) { + // add svn keyworks + buffer.append(FileHeaderTransformer.LINE_SEPARATOR).append("$Author$"); + buffer.append(FileHeaderTransformer.LINE_SEPARATOR).append("$LastChangedDate$"); + buffer.append(FileHeaderTransformer.LINE_SEPARATOR).append("$LastChangedRevision$"); + buffer.append(FileHeaderTransformer.LINE_SEPARATOR).append("$Id$"); + buffer.append(FileHeaderTransformer.LINE_SEPARATOR).append("$HeadURL$"); + + } + result.setDescription(buffer.toString()); + if (getLog().isDebugEnabled()) { + getLog().debug("header description : " + result.getDescription()); + } + String licenseContent = license.getHeaderContent(encoding); result.setLicense(licenseContent); Modified: trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java =================================================================== --- trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/main/java/org/nuiton/license/plugin/header/transformer/FileHeaderTransformer.java 2010-04-09 21:25:47 UTC (rev 1728) @@ -48,7 +48,7 @@ String ROLE_NAME = FileHeaderTransformer.class.getName(); /** default section delimiter */ - String DEFAULT_SECTION_DELIMITER = "--"; + String DEFAULT_SECTION_DELIMITER = "%%"; /** default process start tag */ String DEFAULT_PROCESS_START_TAG = "#%L"; Modified: trunk/src/main/resources/license/defaultHeader.vm =================================================================== --- trunk/src/main/resources/license/defaultHeader.vm 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/main/resources/license/defaultHeader.vm 2010-04-09 21:25:47 UTC (rev 1728) @@ -1,4 +1,10 @@ $projectName + +#$Author#$ +#$LastChangedDate#$ +#$LastChangedRevision#$ +#$Id#$ +#$HeadURL#$ -- Copyright (C) $inceptionYear $organizationName -- Added: trunk/src/site/rst/descriptor.rst =================================================================== --- trunk/src/site/rst/descriptor.rst (rev 0) +++ trunk/src/site/rst/descriptor.rst 2010-04-09 21:25:47 UTC (rev 1728) @@ -0,0 +1,62 @@ +License project descriptor +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +:Author: Tony Chemit <chemit@codelutin.com> + +.. contents:: + :depth: 2 + +.. sectnum:: + :start: 1 + :depth: 2 + +Abstract +======== + +This document describes the license project descriptor file introduced in version 2.1. + +The license file descriptor file aims to enumerate all files to include in +license process per type and license. + +This new format is used in goal `update-license`_. + +TODO-TC-20100409 Do this documentation + +xsd +=== + +This file is ruled by a `xsd file`_. + +Example +------- + +The next example applies a gpl v3 license on all java files in **src/main/java**. + +:: + + <?xml version='1.0' encoding='UTF-8'?> + <project xmlns="http://maven-site.nuiton.org/maven-license-plugin/1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven-site.nuiton.org/maven-license-plugin/1.0.0 http://maven-site.nuiton.org/maven-license-plugin/licenseProject-1.0.0.xsd"> + <mainLicense>gpl_v3</mainLicense> + <licenseSets> + <licenseSet> + <fileSets> + <fileSet> + <headerType>java</headerType> + <basedir>src/main/java</basedir> + <includes> + <include>**/*.java</include> + </includes> + </fileSet> + </fileSets> + </licenseSet> + </licenseSets> + </project> + +.. _update-license: update-license-mojo.html + +.. _comment-style-list: comment-style-list-mojo.html + +.. _xsd file: licenseProject-1.0.0.xsd \ No newline at end of file Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/site/rst/index.rst 2010-04-09 21:25:47 UTC (rev 1728) @@ -74,8 +74,10 @@ * `license license-list`_ display list of available license. - * `license update-header`_ add or update license header on some files. + * `license update-license`_ add or update license header on some files (new versions). + * `license update-header`_ add or update license header on some files (deprecated). + Usage ~~~~~ Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/site/site_en.xml 2010-04-09 21:25:47 UTC (rev 1728) @@ -47,6 +47,7 @@ <menu name="User"> <item name="Introduction" href="index.html"/> <item name="File header model" href="header.html"/> + <item name="License project descriptor" href="descriptor.html"/> <item name="Usage" href="usage.html"/> <item name="Goals" href="plugin-info.html"> <item name="add-license" href="add-license-mojo.html"/> Modified: trunk/src/test/resources/org/nuiton/license/plugin/updateLicenseMojoTest/updateLicense/src/MyBean.java =================================================================== --- trunk/src/test/resources/org/nuiton/license/plugin/updateLicenseMojoTest/updateLicense/src/MyBean.java 2010-04-09 19:58:48 UTC (rev 1727) +++ trunk/src/test/resources/org/nuiton/license/plugin/updateLicenseMojoTest/updateLicense/src/MyBean.java 2010-04-09 21:25:47 UTC (rev 1728) @@ -1,9 +1,9 @@ /* * #%L * License Test :: do NOT update! - * -- + * %% * Copyright (C) 2000 Codelutin do NOT update! - * -- + * %% * Fake to be removed! * #L% */