Ant-opgave: Sammenlign

Formål

Denne opgave udfører en fuldstændig sammenligning af en API-profil i forhold til en grundlinje.

Brug

Beskrivelse

Navnet på Ant-opgaven er: apitooling.compare. For at kunne bruges skal JAR-filen apitooling-ant.jar findes i Ant-classpath.

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

Parametre

Attribut Beskrivelse Påkrævet
baseline Denne attribut angiver placeringen af referencegrundlinjen.

Det kan være en .zip-, .jar-, .tgz-, .tar.gz-fil eller et bibliotek, der svarer til Eclipse-installationsfolderen. Det er i dette bibliotek, at du kan finde den eksekvérbare Eclipse-fil.

Placeringen angives ved hjælp af en absolut sti.
Ja
profile Denne attribut angiver placeringen af det aktuelle produkt eller den aktuelle profil, som du vil sammenligne med referencegrundlinjen.

Det kan være en .zip-, .jar-, .tgz-, .tar.gz-fil eller et bibliotek, der svarer til Eclipse-installationsfolderen. Det er i dette bibliotek, at du kan finde den eksekvérbare Eclipse-fil.

Placeringen angives ved hjælp af en absolut sti.
Ja
report Angiv den outputplacering, hvor rapporten bliver genereret.

Når opgaven er udført, er rapporten "compare.xml" tilgængelig i dette bibliotek.

Placeringen angives ved hjælp af en absolut sti.
Ja
excludelist Angiv placeringen af exclude-listen.

Placeringen af exclude-listen angiver en tekstfil med de bundter, der skal udelades fra analysen. Som standard analyseres alle bundterne i profilen. Attributter for include- og exclude-lister kan bruges til selektivt at medtage og udelade bundter. Include-listen tilfører det bundtsæt, der skal analyseres (når den ikke angives, medtages alle bundter), og exclude-listen anvendes derefter. Linjerne i filen angiver et af følgende:
  • et specifikt bundtnavn
  • et regulært udtryk, som skal matches med bundtnavne (linjer, der starter med "R:")
  • en kommentar (linjer, der starter med '#')

Placeringen angives ved hjælp af en absolut sti.
Her er et eksempel på en exclude-liste:
 # DOC-BUNDTER
 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
 # IKKE-ECLIPSE-BUNDTER
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Udelad ALLE pde-bundter
 R:org\.eclipse\.pde\..*
 ...
Exclude-listen kan indeholde regulære udtryk, hvis linjen starter med "R:".
Nej
includelist Angiv placeringen af include-listen.

Placeringen af include-listen angiver en tekstfil med de bundter, der skal medtages i analysen. Som standard analyseres alle bundterne i profilen. Attributter for include- og exclude-lister kan bruges til selektivt at medtage og udelade bundter. Include-listen tilfører det bundtsæt, der skal analyseres (når den ikke angives, medtages alle bundter), og exclude-listen anvendes derefter. Linjerne i filen angiver et af følgende:
  • et specifikt bundtnavn
  • et regulært udtryk, som skal matches med bundtnavne (linjer, der starter med "R:")
  • en kommentar (linjer, der starter med '#')

Placeringen angives ved hjælp af en absolut sti.
Her er et eksempel på en include-liste:
 # DOC-BUNDTER
 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
 # IKKE-ECLIPSE-BUNDTER
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Udelad alle pde-bundter
 R:org\.eclipse\.pde\..*
 ...
Nej
debug Angiv fejlfindingsværdien.

Mulige værdier er: true, false
Standardværdien er false.
Nej
components Angiv placeringen af komponentlisten.

Komponentlisten indeholder alle de komponentnavne, der skal sammenlignes. Hvis den udelades, bliver alle komponenter i den angivne grundlinje sammenlignet.
Placeringen angives ved hjælp af en absolut sti.
Formatet af filen med komponentlisten ser sådan ud:
 # DOC-BUNDTER
 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
 # Inkludér alle pde-bundter
 R:org\.eclipse\.pde\..*
 ...
Komponentlisten kan indeholde regulære udtryk, hvis linjen starter med "R:".
Nej
visibility Angiv synlighedsværdien.

Mulige værdier er: API, ALL
Standardværdien er API.
Nej

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

Herved køres den opgave, som opretter compare.xml-filer, i folderen D:\reports\xml . Opgaven bruger exclude-listen til at reducere antallet af problemer, der skal rapporteres.

Da fejlfinding er aktiveret, bliver der vist fejlfindingssporing i Ant-konsollen.

Relaterede referencer

Ant-opgave: API-frys
Ant-opgave: Generering af fil
Ant-opgave: API-brug
Ant-opgave: Konvertering af analyserapport
Ant-opgave: Konvertering af API-frysrapport
Ant-opgave: Konvertering af API-brugsrapport
Ant-opgave: Konvertering af API-forældelsesrapport