Ant-taak API-migratiegebruik

Doel

Hiermee wordt geprobeerd een API-gebruiksscan opnieuw om te zetten voor een mogelijke productrelease, en worden eventuele niet-omgezette verwijzingen gerapporteerd.

Gebruik

Description

De naam van de ant-taak is apitooling.apimigration. Om deze te kunnen gebruiken, moet het jar-bestand apitooling-ant.jar in het Ant-klassenpad staan.

 <apitooling.apimigration
	candidate="..."
	usescan="..."
	scopepattern="..."
	referencepattern="..."
	excludelist="..."
	includelist="..."
	report="..."
			debug="..."
/>

Parameters

Attribute Beschrijving Required
candidate Dit kenmerk geeft het product aan dat u wilt gebruiken als migratiekandidaat.

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.

Ja
usescan Dit kenmerk geeft de product-gebruiksscan aan die u wilt vergelijken met de migratiekandidaat.

De usescan wordt opgegeven met een absoluut pad naar de hoofddirectory van de gebruiksscan.
Ja
scopepattern Dit kenmerk geeft het expressiepatroon aan voor het opbouwen van het bereik aan elementen waarin moet worden gezocht naar verwijzingen vanuit de productlocatie.

Het patroon moet een correct geformuleerde expressie zijn, zie hier.
Nee
referencepattern Hiermee stelt u het expressiepatroon in voor het opbouwen van het bereik aan elementen waarin moet worden gezocht naar verwijzingen vanuit de productlocatie.

Het patroon moet een correct geformuleerde expressie zijn, zie hier.
Nee
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:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
Nee
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:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
Nee
rapport Het instellen van de uitvoerlocatie waar de rapporten worden gegenereerd.

Als de taak is voltooid, zijn de rapporten in deze directory beschikbaar in een hiƫrarchische structuur. Er wordt een submap gemaakt voor alle componenten waarnaar een andere bundel verwijst. Elke submap bevat een bestand met de naam "[bundelnaam].xml". In deze map bevindt zich een submap (genaamd "[verwijsbundelnaam].xml") voor elke bundel die verwijst naar de bundel van de map. In de map van de verwijzende bundel bevindt zich een van drie submappen (API, PRIVATE en OTHER), die type-, methode- of veldverwijzingen bevatten.

Er worden twee andere speciale bestanden in de rapportdirectory geschreven , namelijk "not_searched.xml" en "no_apidescription.xml". Deze bevatten respectievelijk informatie over bundels in de basislijn waarin niet naar gebruiksinformatie is gezocht, en bundels die geen .api_description-bestanden bevatten.

De locatie wordt opgegeven als absoluut pad.

Bijvoorbeeld:
  root
   |
   +-- "not_searched.xml"
   +-- "no_apidescription.xml"
   +-- bundle name with usage
     |
     +--referencing bundle name
      |
      +-- [API or PRIVATE or OTHER]
       |
       +--[type_ or method_ or field_]references.xml
Ja
debug Instellen van de foutopsporingswaarde.

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

Voorbeelden

 <apitooling.apimigration
  candidate="/eclipse/sdk3.5"
  usescan="/eclipse/scans/sdk3.4"

  scopepattern=".*"
  referencepattern="org\.eclipse.*"
  excludelist="D:\exclude_list_external.txt"
  report="/eclipse/apimigration/xml"
  debug="true"

 />

Hiermee wordt de taak gestart voor het maken van *.xml-bestanden in de map /eclipse/apimigration/xml. The task will re-resolve all references in the usescan location - defined by the regular expression .* - against the candidate product whose identifier begins with org.eclipse (defined by the org\.eclipse.* regular expression). It will use the exclude list file located in D:\exclude_list_external.txt to reduce the number of problems to report.

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

Verwante onderwerpen

Ant-taak API blokkeren
Ant-taak Bestanden genereren
Ant-taak Analyserapport converteren
Ant-taak API-blokkeringsrapport converteren
Ant-taak API-depreciatie
Ant-taak API-depreciatie - Rapportconversie
Ant-taak API-gebruiksrapport converteren
Ant-taak API-gebruiksmigratierapport converteren