Vertailun Ant-tehtävä

Käyttötarkoitus

Tämä tehtävä ajaa täydellisen ohjelmointirajapintaprofiilin vertailun suhteessa perustasoon.

Käyttö

Kuvaus

Ant-tehtävän nimi on apitooling.compare. Jar-tiedoston apitooling-ant.jar käyttö edellyttää, että tiedosto on Ant-tehtävän luokkapolussa.

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

Parametrit

Määrite Kuvaus Pakollinen
baseline Tämä määrite ilmaisee viiteperustason sijainnin.

Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa.

Sijainti määritetään absoluuttisen polun avulla.
Kyllä
profile Tämä määrite ilmaisee sen nykyisen tuotteen tai profiilin sijainnin, jota on tarkoitus verrata viiteperustasoon.

Sijainti voi olla .zip-, .jar-, .tgz- tai .tar.gz-tiedosto tai Eclipse-järjestelmän asennuskansiota vastaava hakemisto. Eclipse-järjestelmän ohjelmatiedosto on tässä hakemistossa.

Sijainti määritetään absoluuttisen polun avulla.
Kyllä
report Määrittää tulostussijainnin, johon raportti luodaan.

Kun tehtävä on valmis, "compare.xml"-niminen raportti on käytettävissä tässä hakemistossa.

Sijainti määritetään absoluuttisen polun avulla.
Kyllä
excludelist Määrittää pois suljettavien luettelon sijainnin.

Pois suljettavien luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysistä pois suljettavista resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
  • määritetyn resurssijoukon nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

Sijainti määritetään absoluuttisen polun avulla.
Seuraavassa on esimerkki pois sulkevasta luettelosta:
 # 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\..*
 ...
Pois sulkeva luettelo voi sisältää säännöllisiä lausekkeita, jos rivi alkaa merkkijonolla "R:".
Ei
includelist Määrittää sisällyttävän luettelon sijainnin.

Sisällyttävän luettelon sijainti määrittää tekstitiedoston, joka sisältää luettelon analyysiin sisällytettävistä resurssijoukoista. Oletusarvon mukaan kaikki profiilin resurssijoukot analysoidaan. Resurssijoukkoja voidaan valikoivasti sisällyttää ja sulkea pois sisällyttävillä ja pois sulkevilla luettelomääritteillä. Sisällyttävä luettelo määrittää analysoitavat resurssijoukot (jos mitään ehtoa ei ole määritetty, kaikki resurssijoukot otetaan mukaan), ja pois sulkeva luettelo otetaan käyttöön. Tiedoston jokainen rivi määrittää yhden seuraavista:
  • määritetyn resurssijoukon nimen
  • säännöllisen lausekkeen, jota verrataan resurssijoukkojen nimiin (rivit alkavat merkkijonolla "R:")
  • kommentin (rivit alkavat merkillä "#")

Sijainti määritetään absoluuttisen polun avulla.
Seuraavassa on esimerkki sisällyttävästä luettelosta:
 # 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\..*
 ...
Ei
debug Määrittää vianmääritysarvon.

Mahdolliset arvot ovat seuraavat: true, false
Oletusarvo on false.
Ei
components Määrittää komponenttien luettelon sijainnin.

Komponenttien luettelo sisältää kaikki verrattavien komponenttien nimet. Jos tämä jätetään pois, kaikki annetun perustason komponentit verrataan.
Sijainti määritetään absoluuttisen polun avulla.
Komponenttienluettelon tiedosto on seuraavan muotoinen:
 # 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\..*
 ...
Komponenttien luettelo voi sisältää säännöllisiä lausekkeita, jos rivi alkaa merkkijonolla "R:".
Ei
visibility Määrittää näkyvyysarvon.

Mahdolliset arvot ovat seuraavat: API, ALL
Oletusarvo on API.
Ei

Esimerkkejä

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

Järjestelmä ajaa tehtävän, joka luo compare.xml-tiedostot kansioon D:\reports\xml. Tehtävä pienentää raportoitavien ongelmien määrää käyttämällä pois suljettavien luetteloa.

Vianmääritys on käytössä, joten vianmäärityksen jäljitystietoja tulee näkyviin Ant-konsoliin.

Aiheeseen liittyviä ohjeita

Ohjelmointirajapinnan jäädytyksen Ant-tehtävä
Tiedostojen luonnin Ant-tehtävä
Ohjelmointirajapinnan käytön Ant-tehtävä
Analyysiraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan jäädytysraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan käyttöraportin muunnon Ant-tehtävä
Ohjelmointirajapinnan vanhentumisraportin muunnon Ant-tehtävä