ภารกิจ Ant การโอนย้ายการใช้ API

วัตถุประสงค์

ภารกิจนี้กำหนด API ใช้ scan และพยายามแก้ปัญหาภายใน ที่กำหนดรีลีสผลิตภัณฑ์และรายงานการอ้างถึงที่ยังไม่ได้แก้ปัญหาใดๆ

Usage

รายละเอียด

ชื่อของภารกิจ Ant คือ: apitooling.apimigration เมื่อต้องการใช้ ไฟล์ jar apitooling-ant.jar จะต้องอยู่บน Ant classpath

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

พารามิเตอร์

แอ็ตทริบิวต์ คำอธิบาย ต้องการ
candidate แอ็ตทริบิวต์นี้ระบุผลิตภัณฑ์ที่คุณต้องการให้ใช้สมาชิกการโอนย้ายระบบ

ซึ่งสามารถเป็นไฟล์ .zip, .jar, .tgz, .tar.gz หรือไดเร็กทอรีที่สอดคล้องกับโฟลเดอร์การติดตั้ง Eclipse นี่คือไดเร็กทอรี ที่คุณสามารถค้นหาโปรแกรมเรียกทำงาน Eclipse

Yes
usescan แอ็ตทริบิวต์นี้ระบุผลิตภัณฑ์ที่ใช้สแกนที่คุณต้องการให้เปรียบเทียบสมาชิกการโอนย้ายระบบ

usescan ถูกระบุไว้โดยใช้พาธสัมบูรณ์กับ root ของการใช้สแกน
Yes
scopepattern แอ็ตทริบิวต์นี้ระบุรูปแบบนิพจน์ปกติที่ใช้เพื่อสร้างขอบเขตของอิลิเมนต์เพื่อค้นหา การอ้างถึงจากในตำแหน่งผลิตภัณฑ์

รูปแบบต้องอยู่ในนิพจน์ปกติที่จัดรูปแบบแล้วตามที่กำหนดไว้ ที่นี่
No
referencepattern ตั้งค่ารูปแบบนิพจน์ปกติที่ใช้เพื่อ build ขอบเขตของอิลิเมนต์เพื่อค้นหา การอ้างอิงในตำแหน่งผลิตภัณฑ์

รูปแบบต้องอยู่ในนิพจน์ปกติที่จัดรูปแบบแล้วตามที่กำหนดไว้ ที่นี่
No
excludelist ตั้งค่าการแยกตำแหน่งรายการ

การแยกตำแหน่งรายการจะระบุไฟล์ข้อความที่แสดงรายการบันเดิลที่จะถูกแยกออกจากการวิเคราะห์ โดยดีฟอลต์บันเดิลทั้งหมดในโปรไฟล์จะถูกวิเคราะห์ แอ็ตทริบิวต์รายการที่ถูกรวมและถูกแยกสามารถถูกใช้เพื่อเลือกบันเดิลที่จะรวมหรือแยก รายการที่รวมจะ seed ชุดของบันเดิลที่จะถูกวิเคราะห์ (เมื่อปล่อยไว้บันเดิลทั้งหมดจะถูกรวม) และจากนั้นรายการที่แยกออกจะถูกนำมาใช้ แต่ละบรรทัดของไฟล์จะระบุสิ่งต่อไปนี้:
  • ชื่อบันเดิลที่ระบุ
  • นิพจน์ทั่วไปเพื่อเปรียบเทียบกับชื่อบันเดิล (บรรทัดที่มี "R:")
  • หมายเหตุ (บรรทัดที่มี '#')

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์+
ต่อไปนี้เป็นตัวอย่างของรายการที่ถูกแยกออก:
# EXCLUDED BUNDLES
R:org\.eclipse\..*\.doc\..*
...
No
includelist ตั้งตำแหน่งรานการที่รวม

ตำแหน่งของรายการที่รวมจะระบุไฟล์ข้อความที่แสดงรายการบันเดิลที่จะถูกรวมในการวิเคราะห์ โดยดีฟอลต์บันเดิลทั้งหมดในโปรไฟล์จะถูกวิเคราะห์ แอ็ตทริบิวต์รายการที่ถูกรวมและถูกแยกสามารถถูกใช้เพื่อเลือกบันเดิลที่จะรวมหรือแยก รายการที่รวมจะ seed ชุดของบันเดิลที่จะถูกวิเคราะห์ (เมื่อปล่อยไว้บันเดิลทั้งหมดจะถูกรวม) และจากนั้นรายการที่แยกออกจะถูกนำมาใช้ แต่ละบรรทัดของไฟล์จะระบุสิ่งต่อไปนี้:
  • ชื่อบันเดิลที่ระบุ
  • นิพจน์ทั่วไปเพื่อเปรียบเทียบกับชื่อบันเดิล (บรรทัดที่มี "R:")
  • หมายเหตุ (บรรทัดที่มี '#')

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์+
ต่อไปนี้เป็นตัวอย่างของรายการที่ถูกรวม:
# INCLUDED BUNDLES
R:org\.eclipse\..*
...
No
report ตั้งค่าตำแหน่งเอาต์พุตที่รายงานถูกสร้างขึ้น

เมื่อภารกิจเสร็จสิ้นแล้ว รายงานจะพร้อมใช้งานในไดเร็กทอรีนี้โดยใช้โครงสร้างเชิงลำดับชั้น โฟลเดอร์ย่อยถูกสร้างขึ้น สำหรับคอมโพเนนต์ที่มีบันเดิลอื่นๆ ที่อ้างถึง แต่ละโฟลเดอร์ย่อยมีไฟล์ที่เรียกว่า "[bundlename].xml" ภายในโฟลเดอร์นี้ มีโฟลเดอร์ย่อยอื่น (ที่ชือ "[referencing bundle name].xml") สำหรับแต่ละบันเดิลที่อ้างถึงบันเดิลที่มีโฟลเดอร์ ภายในการอ้างถึงโฟลเดอร์บันเดิลมีหนึ่งในสามโฟลเดอร์ย่อย (API, PRIVATE หรือ OTHER) ซึ่งมีชนิด เมธอด หรือการอ้างถึงฟิลด์ที่มีชนิดนั้น

ไฟล์พิเศษอื่นๆ สองไฟล์ถูกเขียนลงในไดเร็กทอรี report ซึ่งมี "not_searched.xml" และ "no_apidescription.xml" และมีข้อมูล เกี่ยวกับบันเดิลจากข้อมูลพื้นฐานที่ไม่ได้ค้นหาข้อมูลการใช้งานและไม่มีไฟล์ .api_description อยู่ในนั้นตามลำดับ

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์+

ตัวอย่างเช่น:
  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
Yes
ดีบัก ตั้งค่าดีบัก

ค่าที่เป็นไปได้ คือ: true, false
ค่าดีฟอลต์คือ false
No

ตัวอย่าง

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

 />

รันภารกิจที่สร้างไฟล์ *.xml ภายในโฟลเดอร์ /eclipse/apimigration/xml งานจะแก้ไขปัญหาการอ้างอิงทั้งหมดใหม่ในตำแหน่ง usescan - กำหนดโดยนิพจน์ทั่วไป .* - เทียบกับผลิตภัณฑ์ที่เป็นตัวเลือกที่ตัวบ่งชี้เริ่มต้นด้วย org.eclipse (กำหนดโดยนิพจน์ทั่วไป org\.eclipse.*) ซึ่งจะใช้ไฟล์รายการแยกออกที่อยู่ใน D:\exclude_list_external.txt เพื่อลดจำนวนปัญหาที่จะรายงาน

หากเปิดใช้งานการดีบัก การติดตามการดีบักบางส่วนจะแสดงอยู่ในคอนโซล Ant

การอ้างถึงที่เกี่ยวข้อง

ภารกิจ Ant สำหรับ API Freeze
ภารกิจ Ant สำหรับการสร้างไฟล์
ภารกิจ Ant สำหรับการแปลงรายงานการวิเคราะห์
ภารกิจ Ant สำหรับการแปลงรายงาน API Freeze
ภารกิจ Ant สำหรับการไม่ยอมรับ API
ภารกิจ Ant สำหรับการแปลงรายงานการไม่ยอมรับ API
ภารกิจ Ant สำหรับการแปลงรายงานการใช้ API
ภารกิจ Ant สำหรับการแปลรายงานการโอนย้ายระบบที่ใช้ API