Ant-oppgave for sammenlikning

Formål

Denne oppgaven kjører en komplett sammenlikning av en API-profil relativt til en basis.

Bruk

Beskrivelse

Navnet på Ant-oppgaven er: apitooling.compare. Når den skal brukes, må jar-filen apitooling-ant.jar være i Ant-klassebanen.

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

Parametere

Attributt Beskrivelse Obligatorisk
baseline Dette attributtet oppgir plasseringen av referansebasisen.

Det kan være en *.zip-, *.jar-, *.tgz- eller *.tar.gz-fil eller en katalog som tilsvarer installeringsmappen til Eclipse. Dette er katalogen hvor du finner den utførbare filen til Eclipse.

Plasseringen oppgis med en absolutt bane.
Ja
profile Dette attributtet oppgir plasseringen av det gjeldende produktet eller profilen som du vil sammenlikne med referansebasisen.

Det kan være en *.zip-, *.jar-, *.tgz- eller *.tar.gz-fil eller en katalog som tilsvarer installeringsmappen til Eclipse. Dette er katalogen hvor du finner den utførbare filen til Eclipse.

Plasseringen oppgis med en absolutt bane.
Ja
report Angi utdataplasseringen hvor rapporten skal genereres.

Når du har fullført denne oppgaven, er rapporten "compare.xml" tilgjengelige i denne katalogen.

Plasseringen oppgis med en absolutt bane.
Ja
excludelist Velg plasseringen til ekskluderingslisten.

Ekskluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal ekskluderes fra analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Inkluderingslisten initialiserer settet med bunter som skal analyseres (hvis den er utelatt, blir alle bunter inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et regulært uttrykk som skal sammenliknes med buntnavn (linjer som begynner med "R:")
  • en kommentar (linjer som begynner med '#')

Plasseringen oppgis med en absolutt bane.
Nedenfor finner du et eksempel på en ekskluderingsliste:
 # 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\..*
 ...
Ekskluderingslisten kan inneholde regulære uttrykk hvis linjen begynner med "R:".
Nei
includelist Angi plasseringen til ekskluderingslisten.

Inkluderingslisteplasseringen oppgir en tekstfil med en liste over bunter som skal inkluderes i analysen. Som standard blir alle bunter i profilen analysert. Attributtene for inkluderings- og ekskluderingsliste kan brukes til å velge bunter som skal inkluderes og ekskluderes. Inkluderingslisten initialiserer settet med bunter som skal analyseres (hvis den er utelatt, blir alle bunter inkludert), og deretter blir ekskluderingslisten brukt. Hver linje i filen oppgir ett av følgende:
  • et bestemt buntnavn
  • et regulært uttrykk som skal sammenliknes med buntnavn (linjer som begynner med "R:")
  • en kommentar (linjer som begynner med '#')

Plasseringen oppgis med en absolutt bane.
Nedenfor finner du et eksempel på en inkluderingsliste:
 # 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\..*
 ...
Nei
debug Angi feilsøkingsverdien.

Mulige verdier er true og false
Standardverdien er false.
Nei
components Velg plasseringen til komponentlisten.

Komponentlisten inneholder alle komponentnavn som må sammenliknes. Hvis attributtet ikke er oppgitt, blir alle komponenter fra oppgitt basis sammenliknet.
Plasseringen oppgis med en absolutt bane.
Formatet på komponentlistefilen er slik:
 # 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\..*
 ...
Komponentlisten kan inneholde regulære uttrykk hvis linjen begynner med "R:".
Nei
visibility Angi synlighetsverdien.

Mulige verdier er API og ALL
Standardverdien er API.
Nei

Eksempler

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

Dette kjører oppgaven som oppretter compare.xml-filer i mappen D:\reports\xml. Den bruker ekskluderingslisten til å redusere antall problemer som rapporteres.

På grunn av at feilsøking er aktivert, vises noe feilsøkingssporing i Ant-konsollen.

Beslektet referanse

Ant-oppgave for API-frys
Ant-oppgave for filgenerering
Ant-oppgave for API-bruk
Ant-oppgave for konvertering av analyserapport
Ant-oppgave for konvertering av rapport for API-frys
Ant-oppgave for konvertering av rapport for API-bruk
Ant-oppgave for konvertering av rapport for API-foreldelse