Ant-taak voor problemen met API-gebruiksscans

Doel

This task resolves the API Use Scans in a profile relative to a baseline. It reports the references to the types, methods and fields which are now missing from the profile.

Gebruik

Description

The name of the Ant task is: apitooling.apiusescanproblems. To be used, the jar file apitooling-ant.jar has to be on the Ant classpath.

<apitooling.apiusescanproblems
	profile="..."
	report="..."
	apiusescans="..."
	excludelist="..."
	includelist="..."
	preferences="..."
			debug="..."
/>

Parameters

Kenmerk Beschrijving Verplicht
profile This attribute specifies the location of the current product or profile that you want to resolved the API Use Scans against.

Dit kan een bestand met de extensie zip, jar, tgz of tar.gz zijn, maar ook een directory die correspondeert met de Eclipse-installatiemap. Dit is de directory waarin het uitvoerbare Eclipse-bestand is opgeslagen.

De locatie wordt opgegeven als absoluut pad.
Yes
report Het instellen van de uitvoerlocatie waar de rapporten worden gegenereerd.

Once the task is completed, reports are available in this directory. Er wordt een submap gemaakt voor alle componenten waarvoor problemen moeten worden gerapporteerd. Elke submap bevat een bestand met de naam "report.xml".

De locatie wordt opgegeven als absoluut pad.
Yes
apiusescans This attribute specifies the comma-separated list of the locations of the API Use Scans that you want to check against the profile.

It can be a .zip file or a directory that corresponds to the API Use Scan report. This is the directory is which you can find the XML folder in the Use Scan.
Yes
excludelist Instelling van de locatie van de uitsluitingslijst.

The exclude list location specifies a text file listing bundles to be excluded from the analysis. By default all bundles in the profile are analyzed. The include and exclude list attributes can be used to selectively include and exclude bundles. The include list seeds the set of bundles to be analyzed (when omitted, all bundles are included), and the exclude list is then applied. Each line of the file specifies one of:
  • a specific bundle name
  • a regular expression to match against bundle names (lines being with "R:")
  • a comment (lines being with '#')

De locatie wordt opgegeven als absoluut pad.
Following is an example exclude list:
 # 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
 R:javax\..*
 ...
No
includelist Set the include list location.

The include list location specifies a text file listing bundles to be included in the analysis. By default all bundles in the profile are analyzed. The include and exclude list attributes can be used to selectively include and exclude bundles. The include list seeds the set of bundles to be analyzed (when omitted, all bundles are included), and the exclude list is then applied. Each line of the file specifies one of:
  • a specific bundle name
  • a regular expression to match against bundle names (lines being with "R:")
  • a comment (lines being with '#')

De locatie wordt opgegeven als absoluut pad.
Following is an example include list:
 # DOC BUNDLES
 org.eclipse.jdt.doc.isv
 org.eclipse.jdt.doc.user
 org.eclipse.pde.doc.user
 R:org.eclipse.platform.doc.*
 # NON-ECLIPSE BUNDLES
 com.ibm.icu
 com.jcraft.jsch
 R:javax\..*
 ...
No
preferences Instellen van de eigenschappen van de taak.

De voorkeuren worden gebruikt om de probleemseverity te configureren. Er zijn drie mogelijke waarden voor de probleemseverity: Ignore, Warning en Error. De aangetroffen probleemset wordt gedefinieerd met corresponderende probleemvoorkeurensleutels in API-tools.
De locatie wordt opgegeven als absoluut pad. Als de gegeven locatie niet bestaat, kunnen er geen voorkeuren worden ingesteld.
Regels die beginnen met het teken '#' worden genegeerd. De indeling van het voorkeurenbestand ziet er als volgt uit:
 #Thu Nov 20 17:35:06 EST 2008
 API_USE_SCAN_TYPE_SEVERITY=Error
 API_USE_SCAN_METHOD_SEVERITY=Error
 API_USE_SCAN_FIELD_SEVERITY=Error
De sleutels zijn te vinden in org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes.
No
debug Instellen van de foutopsporingswaarde.

De mogelijke waarden zijn true en false.
De standaardwaarde is false.
No

Examples

	<apitooling.apiusescanproblems
		profile="D:\eclipse\3.7\eclipse"
		report="D:\reports\xml"
		apiusescans="D:\APIUseScan\ProductOne,D:\APIUseScan\ProductTwo"
		excludelist="D:\exclude_list_external.txt"
		preferences="D:\tests_api\org.eclipse.pde.api.tools.prefs"
		debug="true"
	/>

Hiermee wordt de taak gestart voor het maken van report.xml-bestanden in de map D:\reports\xml. The types, methods and fields from the use scans will be resolved in the profile at D:\eclipse\3.7\eclipse and the missing ones will be reported. It will use the exclude list from the file D:\exclude_list_external.txt to reduce the number of bundles for which problems to report.

De probleemseverity wordt gegenereerd aan de hand van D:\tests_api\org.eclipse.pde.api.tools.prefs.

Omdat de foutopsporing is ingeschakeld, zijn er enige foutopsporingsgegevens te zien in de ant-console.

Verwante onderwerpen

API Analysis Ant Task
Ant-taak API blokkeren
Ant-taak Bestanden genereren
API Use Ant Task
Ant-taak Analyserapport converteren
Ant-taak API-blokkeringsrapport converteren
Ant-taak API-gebruiksrapport converteren
Ant-taak API-depreciëring
Ant-taak API-depreciëringsrapport converteren