Author: jcouteau Date: 2010-11-17 11:34:03 +0100 (Wed, 17 Nov 2010) New Revision: 1878 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1878 Log: Remove old useless doc Removed: trunk/src/site/apt/descriptor.apt trunk/src/site/fr/apt/descriptor.apt Modified: trunk/src/site/apt/usage.apt trunk/src/site/site_en.xml trunk/src/site/site_fr.xml Deleted: trunk/src/site/apt/descriptor.apt =================================================================== --- trunk/src/site/apt/descriptor.apt 2010-11-17 10:11:55 UTC (rev 1877) +++ trunk/src/site/apt/descriptor.apt 2010-11-17 10:34:03 UTC (rev 1878) @@ -1,95 +0,0 @@ -~~~ -~~ #%L -~~ Maven License Plugin -~~ -~~ $Id$ -~~ $HeadURL$ -~~ %% -~~ Copyright (C) 2008 - 2010 CodeLutin, Tony Chemit -~~ %% -~~ This program is free software: you can redistribute it and/or modify -~~ it under the terms of the GNU Lesser General Public License as -~~ published by the Free Software Foundation, either version 3 of the -~~ License, or (at your option) any later version. -~~ -~~ This program is distributed in the hope that it will be useful, -~~ but WITHOUT ANY WARRANTY; without even the implied warranty of -~~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -~~ GNU General Lesser Public License for more details. -~~ -~~ You should have received a copy of the GNU General Lesser Public -~~ License along with this program. If not, see -~~ <http://www.gnu.org/licenses/lgpl-3.0.html>. -~~ #L% -~~~ ----- -License project descriptor ----- - -Warning - - <Since version 2.4>, <<the descriptor file is no more mandatory. It will be removed - from version 3.>> - -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-file-header-mojo.html}update-file-header}} and - {{{./update-project-license-mojo.html}update-project-license}}. - -xsd - - This file is ruled by a {{{./licenseProjectDescriptor-1.0.0.xsd}xsd file}}. - -Example - - The next example applies a lgpl 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/licenseProjectDescriptor-1.0.0.xsd"> - <mainLicense>gpl_v3</mainLicense> - <headers> - <header> - <licenseName>lgpl_v3</licenseName> - <commentStyle>java</commentStyle> - <fileSets> - <fileSet> - <basedir>all/src</basedir> - <includes> - <include>**/*.java</include> - </includes> - </fileSet> - </fileSets> - </header> - </headers> - </project> -------------------------------------------------------------------------------- - -How to create your own project.xml file - - The project.xml file should be located in the src/license directory. - - The xml file is included in project tags. Then you describe the main license - using one of the codes present in maven-license-plugin (use - mvn license:license-list -Ddetail to get the list of the codes and - corresponding licenses). - - You can then declare headers. A header is the association of a license and a - comment-style. If no license is present, the mainLicense will be taken. You - can set here the base dir and the files to include and/or exclude pattern. - - Note that your are not limited in the number of headers. You can create a - header for one file in case of copied code from other projects, but in this - case you might prefer using the %%IgnoreLicense tag in the file itself. The - previous example should help you create your project.xml file. Modified: trunk/src/site/apt/usage.apt =================================================================== --- trunk/src/site/apt/usage.apt 2010-11-17 10:11:55 UTC (rev 1877) +++ trunk/src/site/apt/usage.apt 2010-11-17 10:34:03 UTC (rev 1878) @@ -83,7 +83,7 @@ * How to consolidate the THIRD-PARTY file - It is possiblie to improve the THIRD-PARTY file : + It is possible to improve the THIRD-PARTY file : - Fill back missing license for dependencies. @@ -91,8 +91,8 @@ ** Add missing licenses. - while using configuration's property <<useMissingfile>> on third-party goals, - it will create (or read for aggregate) a file located from property <<missingFfile>> + While using configuration's property <<useMissingfile>> on third-party goals, + it will create (or read for aggregate) a file located from property <<missingFile>> (by default <<src/license/THIRD-PARTY.properties>>). In this file, we find dependencies with no license, you just have to fill @@ -124,7 +124,7 @@ </dependencies> ------------------------------------------------------------------------------- - Here is a <<THIRD-PARTY>> file with unamed licenses launched by + Here is a <<THIRD-PARTY>> file with unnamed licenses launched by -------------------------------------------------------------------------------- mvn license:add-third-party -DuseMissingFile @@ -176,7 +176,7 @@ ** Merge licenses. - to merge licenses added in <<THIRd-PARTY>> file, you have to add a <<licenseMerges>> + To merge licenses added in <<THIRd-PARTY>> file, you have to add a <<licenseMerges>> to the plugin this configuration : Each entry of <<licenseMerges>> describe a merge, the first license is the one to keep. Deleted: trunk/src/site/fr/apt/descriptor.apt =================================================================== --- trunk/src/site/fr/apt/descriptor.apt 2010-11-17 10:11:55 UTC (rev 1877) +++ trunk/src/site/fr/apt/descriptor.apt 2010-11-17 10:34:03 UTC (rev 1878) @@ -1,97 +0,0 @@ -~~~ -~~ #%L -~~ Maven License Plugin -~~ -~~ $Id$ -~~ $HeadURL$ -~~ %% -~~ Copyright (C) 2008 - 2010 CodeLutin, Tony Chemit -~~ %% -~~ This program is free software: you can redistribute it and/or modify -~~ it under the terms of the GNU Lesser General Public License as -~~ published by the Free Software Foundation, either version 3 of the -~~ License, or (at your option) any later version. -~~ -~~ This program is distributed in the hope that it will be useful, -~~ but WITHOUT ANY WARRANTY; without even the implied warranty of -~~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -~~ GNU General Lesser Public License for more details. -~~ -~~ You should have received a copy of the GNU General Lesser Public -~~ License along with this program. If not, see -~~ <http://www.gnu.org/licenses/lgpl-3.0.html>. -~~ #L% -~~~ ----- -License project descriptor ----- - -Attention - - <Depuis la version 2.4>, <<le fichier de description n'est plus obligatoire. Il - sera supprimé avec la version 3.>> - -Abstract - - Ce document décrit le fichier de description de license introduit dans la - version 2.1. - - Le but du fichier de description de license est d'énumérer tous les fichiers à - inclure dans le process de license par license et par type. - - Ce nouveau format est utilisé dans les goals - {{{./update-file-header-mojo.html}update-file-header}} et - {{{./update-project-license-mojo.html}update-project-license}}. - -xsd - - Ce fichier est géré par un {{{../licenseProjectDescriptor-1.0.0.xsd}fichier xsd}}. - -Exemple - - L'exemple suivant applique la license lgpl v3 à tous les fichier java présents - dans <<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/licenseProjectDescriptor-1.0.0.xsd"> - <mainLicense>gpl_v3</mainLicense> - <headers> - <header> - <licenseName>lgpl_v3</licenseName> - <commentStyle>java</commentStyle> - <fileSets> - <fileSet> - <basedir>all/src</basedir> - <includes> - <include>**/*.java</include> - </includes> - </fileSet> - </fileSets> - </header> - </headers> - </project> -------------------------------------------------------------------------------- - -Comment créer son propre fichier project.xml - - Le fichier <<project.xml>> doit être situé dans le dossier <<src/license>>. - - Le fichier xml est inclus entre des balises project. Vous décrivez ensuite la - license principale du projet en utilisant les codes du plugin (utilisez - mvn license:license-list -Ddetail pour connaitre la liste des codes et des - licenses correspondantes). - - Vous pouvez ensuite déclarer des headers. Un header est l'association d'une - license et d'un stye de commentaire. S'il n'y a pas de license, la license - principale du projet est utilisée. Vous pouvez déclarer le répertoire de base - et le pattern de sélection/inclusion de fichiers. - - Notez que vous n'êtes pas limités dans le nombre de headers. Vous pouvez - créer un header pour un fichier dans le cas de code copié depuis un autre - projet par exemple, ou vous pouvez utiliser le tag <<% %Ignore-License>> dans - le fichier lui-même. L'exemple précédent devrait vous permettre de créer votre - propre fichier project.xml. Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2010-11-17 10:11:55 UTC (rev 1877) +++ trunk/src/site/site_en.xml 2010-11-17 10:34:03 UTC (rev 1878) @@ -57,7 +57,6 @@ <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="Add your license" href="addLicense.html"/> <item name="Usage" href="usage.html"> <item name="License" href="usage.html#License"> Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2010-11-17 10:11:55 UTC (rev 1877) +++ trunk/src/site/site_fr.xml 2010-11-17 10:34:03 UTC (rev 1878) @@ -56,7 +56,6 @@ <menu name="Utilisateur"> <item name="Introduction" href="index.html"/> <item name="Modèle de header de fichier" href="header.html"/> - <item name="Descripteur de license du projet" href="descriptor.html"/> <item name="Ajouter une license" href="addLicense.html"/> <item name="Utilisation" href="usage.html"> <item name="License" href="usage.html#License">