Ant-uppgiften API Use Migration

Ändamål

Uppgiften tar en angiven API-användningssökning och försöker lösa den inom en angiven kandidatproduktutgåva och rapportrar olösta referenser.

Användning

Beskrivning

Ant-uppgiftens namn: apitooling.apimigration. Om den ska kunna användas måste JAR-filen apitooling-ant.jar finnas i Ant-klassökvägen.

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

Parametrar

Attribut Beskrivning Obligatoriskt
candidate Attributet anger den produkt som du vill använda som migreringskandidat.

Det kan vara en .zip-, .jar-, .tgz-, .tar.gz-fil eller en katalog som motsvarar installationskatalogen för Eclipse. Det är den katalog där alla körbara Eclipse-filer finns.

Ja
usescan Attributet anger den produktanvändningssökning som du vill jämföra med migreringskandidaten.

Du anser användningssökningen med en absolut sökväg till roten av användningssökningen.
Ja
scopepattern Attributet anger mönstret för det reguljära uttrycket som används till att konstruera elementområdet för sökning efterreferenser från produktplatsen.

Mönstret måste vara ett giltigt reguljärt uttryck, vilket definieras här.
Nej
referencepattern Ange det mönster för reguljära uttryck som ska användas som elementområde för sökningen efter referenser till från produktplatsen.

Mönstret måste vara ett giltigt reguljärt uttryck, vilket definieras här.
Nej
excludelist Platsen för exkluderingslistan

I exkluderingslistan anges en textfil där de samlingspaket som ska uteslutas från analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Inkluderingslistan anger vilka paket som ska analyseras (om den utelämnas tas alla paket med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett reguljärt uttryck som matchas mot paketnamnen (rader som börjar med "R:")
  • en kommentar (rader börjar med #)

Platsen anges med en absolut sökväg.
Följande är ett exempel på en exkluderingslista:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
Nej
includelist Platsen för inkluderingsslistan.

I inkluderingslistan anges en textfil där de samlingspaket som ska tas med i analysen listas. Som standard analyseras alla paket i profilen. Med inkluderings- och exkluderingslistattributen kan du välja vilka paket som ska tas med repektive uteslutas. Inkluderingslistan anger vilka paket som ska analyseras (om den utelämnas tas alla paket med), och sedan tillämpas exkluderingslistan. Varje rad i filen anger antingen:
  • ett specifikt samlingspaketnamn
  • ett reguljärt uttryck som matchas mot paketnamnen (rader som börjar med "R:")
  • en kommentar (rader börjar med #)

Platsen anges med en absolut sökväg.
Följande är ett exempel på en inkluderingslista:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
Nej
report Utdataplats där rapporteran skapas.

När uppgiften har slutförts finns rapporterna i katalogen i en hierarki. En undermapp skapas för varje komponent som refereras av ett annat samlingspaket. Varje undermapp innehåller filen "[samlingspaketnamn].xml". I mappen finns en annan undermapp (med namnet "[namn på refererande samlingspaket].xml") för varje samlingspaket som refererar till samlingspaket i den innehållande mappen. I mappen för referenssamlingspaketet finns en av tre undermappar (API, PRIVATE eller OTHER) som innehåller typ, metod eller fältreferenser av den typen.

Två andra specialfiler skapas i rapportkatalogen, "not_searched.xml" och "no_apidescription.xml" och som innehåller information om samlingspaket från basnivån som inte används för sökning och de som inte har några .api_description-filer.

Platsen anges med en absolut sökväg.

Exempel:
  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 Felsökningsvärdet

Giltiga värden är: true, false
Standardvärdet är false.
Nej

Exempel

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

 />

Uppgiften som skapar *.xml-filer i mappen /eclipse/apimigration/xml körs. Uppgiften tolkar alla referenser i usescan-platsen - som definierats av reguljära uttryck .* - mot kandidatprodukten vars identifierare börjar med org.eclipse (som definierats av det reguljära uttrycket org\.eclipse.*). Exkluderingslistan D:\exclude_list_external.txt används för att minska antalet problem som ska rapporteras.

Om debug är aktiverat visas vissa felsökningsmeddelanden i Ant-konsolen.

Närliggande referenser

Ant-uppgiften API Freeze
Ant-uppgiften File Generation
Ant-uppgiften Analysis Report Conversion
Ant-uppgiften API Freeze Report Conversion
Ant-uppgiften API Deprecation
Ant-uppgiften API Deprecation Report Conversion
Ant-uppgiften API Use Report Conversion
Ant-uppgiften API Use Migration Report Conversion