Author: ymartel Date: 2010-10-01 11:33:48 +0200 (Fri, 01 Oct 2010) New Revision: 1833 Url: http://nuiton.org/repositories/revision/maven-license-plugin/1833 Log: [third party] update site documentation about include/exclude, add french version Modified: trunk/src/site/apt/usage.apt trunk/src/site/fr/apt/usage.apt Modified: trunk/src/site/apt/usage.apt =================================================================== --- trunk/src/site/apt/usage.apt 2010-09-29 13:49:21 UTC (rev 1832) +++ trunk/src/site/apt/usage.apt 2010-10-01 09:33:48 UTC (rev 1833) @@ -262,7 +262,7 @@ ** exclude groupIds - While using configuration's property <<excludeGroupIds>> on third-party goals, + While using configuration's property <<excludeGroups>> on third-party goals, it will remove all the dependencies came from the given groupIds fom the THIRD-PARTY file. @@ -306,7 +306,7 @@ ** exclude artifactIds - While using configuration's property <<excludeArtifactIds>> on third-party goals, + While using configuration's property <<excludeArtifacts>> on third-party goals, it will remove all the dependencies came from the given artifactsIds fom the THIRD-PARTY file. @@ -351,7 +351,7 @@ ** include groupIds - While using configuration's property <<includeGroupIds>> on third-party goals, + While using configuration's property <<includeGroups>> on third-party goals, it will include only the dependencies came from the given groupIds fom the THIRD-PARTY file. @@ -396,8 +396,8 @@ ** include artifactIds - While using configuration's property <<excludeArtifactIds>> on third-party goals, - it will remove include onlu the dependencies came from the given artifactIds fom the + While using configuration's property <<excludeArtifacts>> on third-party goals, + it will include only the dependencies came from the given artifactIds fom the THIRD-PARTY file. *** Example Modified: trunk/src/site/fr/apt/usage.apt =================================================================== --- trunk/src/site/fr/apt/usage.apt 2010-09-29 13:49:21 UTC (rev 1832) +++ trunk/src/site/fr/apt/usage.apt 2010-10-01 09:33:48 UTC (rev 1833) @@ -247,6 +247,206 @@ (The Apache Software License, Version 2.0) JHLabs Image Processing Filters (com.jhlabs:filters:2.0.235 - http://www.jhlabs.com/ip/index.html) ------------------------------------------------------------------------------- +* Filtrer les dépendances + + <Depuis la version 2.3>, il est possible d'utiliser des filtres sur le THIRD-PARY, + en n'incluant que certaines dépendances, ou en excluant certaines. + + * Inclure des ArtifactIds ou des GroupIds + + Les propriétés includedArtifacts et includedGroups permettent de ne mentionner + que certaines dépendances, renseignées par leur ArtifactId ou le GroupId, + dans le fichier THIRD-PARTY. + + * Exclude ArtifactIds or GroupIds + + Les propriétés excludedArtifacts et excludesGroups permettent d'exclure certaines + dépendances du fichier de THIRD-PARTY. + + * Inclusion - Exclusion : Priorité. + + Le filtre d'exclusion est prioritaire sur le filtre d'inclusion. Aussi, si un + artifact est renseigné en includedArtifacts mais que son groupe est renseigné + dans le excludedArtifacts, l'artifact ne sera pas présent dans le fichier + THIRD-PARTY. + +** excludedgroups + + En utilisant la propriété <<excludeGroups>> avec les goals third-party, cela + supprime du fichier THIRD-PARTY toutes les dépendances provenant des groupsIds + donnés. + +*** Exemple + + Soit un pom avec les dépendances suivantes : + +------------------------------------------------------------------------------- + + <dependencies> + + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>1.1.1</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>filters</artifactId> + <version>2.0.235</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>javaproj</artifactId> + <version>1.0</version> + </dependency< + + </dependencies> +------------------------------------------------------------------------------- + + En executant <mvn add-third-party -Dlicense.excludedGroups=com\.jhla.*>, + on obtient le fichier <<THIRD-PARTY>> suivant : + +------------------------------------------------------------------------------- +List of 2 third-party dependencies. + + (The Apache Software License, Version 2.0) Commons Logging (commons-logging:commons-logging:1.1.1 - http://commons.apache.org/logging) +------------------------------------------------------------------------------- + +** excludedartifacts + + En utilisant la propriété <<excludeArtifacts>> sur les goals third-party, cela + supprime du fichier THIRD PARTY toutes les dépendances correspondant artifactsIds renseignés. + +*** Exemple + + Soit un pom avec les dependances suivantes : + +------------------------------------------------------------------------------- + + <dependencies> + + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>1.1.1</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>filters</artifactId> + <version>2.0.235</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>javaproj</artifactId> + <version>1.0</version> + </dependency< + + </dependencies> +------------------------------------------------------------------------------- + + En executant <mvn add-third-party -Dlicense.excludedArtifacts=javaproj>, + on obtient le fichier <<THIRD-PARTY>> suivant : + +------------------------------------------------------------------------------- +List of 2 third-party dependencies. + + (Apache License, Version 2.0) JHLabs Image Processing Filters (com.jhlabs:filters:2.0.235 - http://www.jhlabs.com/ip/index.html) + (The Apache Software License, Version 2.0) Commons Logging (commons-logging:commons-logging:1.1.1 - http://commons.apache.org/logging) +------------------------------------------------------------------------------- + +** includedGroups + + L'utilisation de la propriété <<includeGroupIds>> avec les goals third-party + permet de renseigner le fichier THIRD-PARTY uniquement avec les dépendances + provenant des groupsIds donnés. + +*** Exemple + + Soit un pom avec les dependances suivantes : + +------------------------------------------------------------------------------- + + <dependencies> + + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>1.1.1</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>filters</artifactId> + <version>2.0.235</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>javaproj</artifactId> + <version>1.0</version> + </dependency< + + </dependencies> +------------------------------------------------------------------------------- + + En executant <mvn add-third-party -Dlicense.includedGroups=com\.jhlabs>, + on obtient le fichier <<THIRD-PARTY>> suivant : + +------------------------------------------------------------------------------- +List of 2 third-party dependencies. + + (Apache License, Version 2.0) JHLabs Image Processing Filters (com.jhlabs:filters:2.0.235 - http://www.jhlabs.com/ip/index.html) + (The Apache Software License, Version 2.0) JHlabs Java Projection Library (com.jhlabs:javaproj:1.0 - http://www.jhlabs.com/java/maps/proj/index.html) +------------------------------------------------------------------------------- + +** includedArtifacts + + L'utilisation de la propriété <<excludeArtifactIds>> sur les goals third-party + permet de n'inclure dans le fichier THIRD-PARTY que les artifacts renseignés. + +*** Example + + Soit un pom avec les dependances suivantes : + +------------------------------------------------------------------------------- + + <dependencies> + + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <version>1.1.1</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>filters</artifactId> + <version>2.0.235</version> + </dependency> + + <dependency> + <groupId>com.jhlabs</groupId> + <artifactId>javaproj</artifactId> + <version>1.0</version> + </dependency< + + </dependencies> +------------------------------------------------------------------------------- + + En executant <mvn add-third-party -Dlicense.includedArtifacts=filters>, + on obtient le fichier <<THIRD-PARTY>> suivant : + +------------------------------------------------------------------------------- +List of 2 third-party dependencies. + + (Apache License, Version 2.0) JHLabs Image Processing Filters (com.jhlabs:filters:2.0.235 - http://www.jhlabs.com/ip/index.html) +------------------------------------------------------------------------------- + + Obtenir des informations * license-list goal