เปรียบเทียบงาน Ant

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

งานนี้จะรันการเปรียบเทียบที่สมบูรณ์ของโปรไฟล์ API ที่สัมพัน์กับข้อมูลพื้นฐาน

การใช้งาน

รายละเอียด

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

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

พารามิเตอร์

แอ็ตทริบิวต์ คำอธิบาย จำเป็นต้องมี
baseline แอ็ตทริบิวต์นี้ระบุตำแหน่งของการอ้างอิงพื้นฐาน

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

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

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

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

เมื่องานเสร็จสิ้น รายงานชื่อ "compare.xml" จะพร้อมใช้งานในไดเร็กทอรีนี้

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

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

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
ต่อไปนี้เป็นตัวอย่างของรายการที่ถูกแยกออก:
 # 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\..*
 ...
รายการที่แยกออกสามารถมีนิพจน์ทั่วไป ถ้าบรรทัดเริ่มต้นด้วย "R:".
ไม่ใช่
includelist ตั้งตำแหน่งรายการที่รวม

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

ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
ต่อไปนี้เป็นตัวอย่างของรายการที่ถูกรวม:
 # 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\..*
 ...
ไม่ใช่
debug ตั้งค่าดีบัก

ค่าที่เป็นไปได้คือ: true, false
ค่าดีฟอลต์คือ false
ไม่ใช่
คอมโพเนนต์ ตั้งตำแหน่งรายการของคอมโพเนนต์

รายการของคอมโพเนนต์ประกอบด้วยชื่อของคอมโพเนนต์ทั้งหมดที่ต้องถูกเปรียบเทียบ ถ้าปล่อยไว้ คอมโพเนนต์ทั้งหมดจากข้อมูลพื้นฐานที่กำหนดจะถูกเปรียบเทียบ
ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์
รูปแบบของไฟล์รายการขแงคอมโพเนนต์จะเหมือนดังต่อไปนี้:
 # 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\..*
 ...
รายการของคอมโพเนนต์สามารถประกอบด้วยนิพจน์ทั่วไป ถ้าบรรทัดเริ่มต้นด้วย "R:"
ไม่ใช่
ความสามารถแสดง ตั้งค่าความสามารถแสดง

ค่าที่เป็นไปได้คือ: API, ALL
ค่าดีฟอลต์ คือ API
ไม่ใช่

ตัวอย่าง

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

ซึ่งจะรันงานการสร้างไฟล์ compare.xml ภายในโฟลเดอร์ D:\reports\xml ซึ่งจะใช้รายการที่แยกออกเพื่อลดจำนวนของปัญหาที่ต้องรายงาน

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

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

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