Tâche Ant de comparaison

Objectif

Cette tâche exécute une comparaison complète d'un profil d'API relatif à une ligne de base.

Syntaxe

Description

Le nom de la tâche Ant est le suivant : apitooling.compare. Pour qu'il puisse être utilisé, le fichier jar apitooling-ant.jar doit figurer dans le chemin d'accès aux classes Ant.

<apitooling.compare
	baseline="..."
	profile="..."
	report="..."
	excludelist="..."
	includelist="..."
	components="..."
	visibility="..."
	debug="..."
/>

Paramètres

Attribut Description Obligatoire
baseline Cet attribut définit l'emplacement de la ligne de base de référence.

Il peut s'agir d'un fichier .zip, .jar, .tgz, .tar.gz ou d'un répertoire qui correspond au dossier d'installation Eclipse. Il s'agit du répertoire dans lequel se trouve l'exécutable Eclipse.

L'emplacement est défini en utilisant un chemin absolu.
Oui
profile Cet attribut définit l'emplacement du produit ou du profil en cours à comparer à la ligne de base de référence.

Il peut s'agir d'un fichier .zip, .jar, .tgz, .tar.gz ou d'un répertoire qui correspond au dossier d'installation Eclipse. Il s'agit du répertoire dans lequel se trouve l'exécutable Eclipse.

L'emplacement est défini en utilisant un chemin absolu.
Oui
report Définit l'emplacement dans lequel le rapport est généré.

Une fois la tâche exécutée, le rapport "compare.xml" est disponible dans ce répertoire.

L'emplacement est spécifié en utilisant un chemin absolu.
Oui
excludelist Définit l'emplacement de la liste d'exclusion.

L'emplacement de la liste d'exclusion indique les regroupements de fichier texte devant être exclus de l'analyse. Par défaut, tous les regroupements dans le profil sont analysés. Les attributs de liste d'inclusion et d'exclusion peuvent être utilisés pour inclure et exclure des regroupements de manière sélective. La liste d'inclusion est tirée de l'ensemble de regroupements devant être analysés (en cas d'omission, tous les regroupements sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
  • un nom de regroupement spécifique
  • une expression régulière devant correspondre aux noms de regroupements (lignes associées à "R:")
  • un commentaire (lignes associées à '#')

L'emplacement est défini en utilisant un chemin absolu.
L'exemple ci-dessous illustre la liste d'exclusion :
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
La liste d'exclusion peut contenir des expressions régulières si la ligne commence par "R:".
Non
includelist Définit l'emplacement de la liste d'inclusion.

L'emplacement de la liste d'inclusion indique un fichier texte répertoriant les regroupements à inclure dans l'analyse. Par défaut, tous les regroupements dans le profil sont analysés. Les attributs de liste d'inclusion et d'exclusion peuvent être utilisés pour inclure et exclure des regroupements de manière sélective. La liste d'inclusion est tirée de l'ensemble de regroupements devant être analysés (en cas d'omission, tous les regroupements sont inclus), et la liste d'exclusion est appliquée. Chaque ligne du fichier indique l'un des éléments suivants :
  • un nom de regroupement spécifique
  • une expression régulière devant correspondre aux noms de regroupements (lignes associées à "R:")
  • un commentaire (lignes associées à '#')

L'emplacement est défini en utilisant un chemin absolu.
L'exemple ci-dessous illustre la liste d'inclusion :
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
Non
debug Définit la valeur de débogage.

Les valeurs possibles sont true et false
La valeur par défaut est false.
Non
components Définit l'emplacement de la liste des composants.

La liste des composants contient tous les noms de composants qui doivent être comparés. En cas d'omission, tous les composants de la ligne de base donnée sont comparés.
L'emplacement est défini en utilisant un chemin absolu.
Le format du fichier de la liste des composants se présente comme suit :
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 org.eclipse.platform.doc.isv
 org.eclipse.platform.doc.user
 # Include all pde bundles
 R:org\.eclipse\.pde\..*
 ...
La liste des composants peut contenir des expressions régulières si la ligne commence par "R:".
Non
visibility Définit la valeur de visibilité.

Les valeurs possibles sont : API, ALL
La valeur par défaut est API.
Non

Exemples

	<apitooling.compare
		baseline="D:\eclipse\3.4.1\eclipse"
		profile="D:\eclipse-SDK-I20081118-0800-linux-gtk.tar.gz"
		report="D:\reports\xml"
		excludelist="D:\exclude_list_external.txt"
		debug="true"
	/>

Cet exemple permet d'exécuter la tâche en créant des fichiers compare.xml dans le dossier D:\reports\xml. Il utilise la liste d'exclusion afin de réduire le nombre d'incidents à signaler.

Etant donné que le débogage est activé, un traçage de débogage apparaît dans la console Ant.

Référence connexe

Tâche Ant de gel d'API
Tâche Ant de génération de fichier
Tâche Ant d'utilisation d'API
Tâche Ant de conversion de rapport d'analyse
Tâche Ant de conversion de rapport de gel d'API
Tâche Ant de conversion de rapport d'utilisation d'API
Tâche Ant de conversion de rapport de dépréciation d'API