Ant-uppgiften Compare

Ändamål

Uppgiften kör en fullständig jämförelse av en API-profil mot en basnivå.

Användning

Beskrivning

Ant-uppgiftens namn: apitooling.compare. Om den ska kunna användas måste JAR-filen apitooling-ant.jar finnas i Ant-klassökvägen.

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

Parametrar

Attribut Beskrivning Obligatoriskt
baseline Attributet anger platsen för refererad basnivå.

Det kan vara en .zip-, .jar-, .tgz-, .tar.gz-fil eller en katalog som motsvarar installationskatalogen för Eclipse. Det är den katalog där alla körbara Eclipse-filer finns.

Platsen anges med en absolut sökväg.
Ja
profile Attributet anger platsen för aktuell produktprofil som ska jämföras med referensbasnivån.

Det kan vara en .zip-, .jar-, .tgz-, .tar.gz-fil eller en katalog som motsvarar installationskatalogen för Eclipse. Det är den katalog där alla körbara Eclipse-filer finns.

Platsen anges med en absolut sökväg.
Ja
report Utdataplats där rapporten skapas.

När uppgiften är klar blir rapporten "compare.xml" tillgänglig i den här katalogen.

Platsen anges med en absolut sökväg.
Ja
excludelist Platsen för exkluderingslistan

I exkluderingslistan anges en textfil där de samlingspaket som ska uteslutas från analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Inkluderingslistan anger vilka paket som ska analyseras (om den utelämnas tas alla paket med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett reguljärt uttryck som matchas mot paketnamnen (rader som börjar med "R:")
  • en kommentar (rader börjar med #)

Platsen anges med en absolut sökväg.
Följande är ett exempel på en exkluderingslista:
 # 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\..*
 ...
Exkluderingslistan kan innehålla reguljära uttryck om raden inleds med "R:".
Nej
includelist Platsen för inkluderingsslistan.

I inkluderingslistan anges en textfil där de samlingspaket som ska tas med i analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Inkluderingslistan anger vilka paket som ska analyseras (om den utelämnas tas alla paket med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett reguljärt uttryck som matchas mot paketnamnen (rader som börjar med "R:")
  • en kommentar (rader börjar med #)

Platsen anges med en absolut sökväg.
Följande är ett exempel på en inkluderingslista:
 # 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\..*
 ...
Nej
debug Felsökningsvärdet

Giltiga värden är true och false.
Standardvärdet är false.
Nej
components Platsen för komponentlistan.

Komponentlisttan innehåller namnen på alla komponenter som ska jämföras. Om den utelämnas jämförs alla komponenter från den angivna basnivån.
Platsen anges med en absolut sökväg.
Formatet för komponentlistefilen ser ut så här:
 # 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\..*
 ...
Komponentlistan kan innehålla reguljära uttryck om raden inleds med "R:".
Nej
visibility Synlighetsvärdet.

Giltiga värden är API och ALL
Standard är API.
Nej

Exempel

	<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"
	/>

Uppgiften som skapar compare.xml-filer i mappen D:\reports\xml körs. Uteslutningslistan används för att minska antalet problem att rapportera.

Eftersom debug är aktiverat visas vissa felsökningsmeddelanden i Ant-konsolen.

Närliggande referenser

Ant-uppgiften API Freeze
Ant-uppgiften File Generation
Ant-uppgiften API Use
Ant-uppgiften Analysis Report Conversion
Ant-uppgiften API Freeze Report Conversion
Ant-uppgiften API Use Report Conversion
Ant-uppgiften API Deprecation Report Conversion