งาน Ant ปัญหา API Use Scan

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

งานนี้จะแก้ปัญหา API Use Scans ในโปรไฟล์ที่สัมพันธ์กับข้อมูลพื้นฐาน ซึ่งจะรายงานการอ้างอิงถึงชนิด โปรไฟล์ และฟิลด์ที่ตอนนี้หายไปจากโปรไฟล์

การใช้งาน

คำอธิบาย

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

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

พารามิเตอร์

แอ็ตทริบิวต์ คำอธิบาย จำเป็นต้องมี
profile แอ็ตทริบิวต์นี้จะระบุตำแหน่งของผลิตภัณฑ์หรือโปรไฟล์ปัจจุบันที่คุณต้องการแก้ไขปัญหากับ API Use Scans

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

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

เมื่องานเสร็จสิ้น รายงานจะพร้อมใช้งานในไดเร็กทอรีนี้ โฟลเดอร์ย่อยถูกสร้างขึ้น สำหรับคอมโพเนนต์แต่ละตัวที่มีปัญหาที่ต้องรายงาน แต่ละโฟลเดอร์ย่อยมีไฟล์ที่เรียกว่า "report.xml".

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

ซึ่งสามารถเป็นไฟล์ .zip หรือไดเร็กทอรีที่สอดคล้องกับรายงาน API Use Scan นี่คือไดเร็กทอรีที่คุณสามารถหาโฟลเดอร์ XML ใน Use Scan
ใช่
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
 R:javax\..*
 ...
ไม่ใช่
includelist ตั้งตำแหน่งรายการที่รวม

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

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

การกำหนดค่าตามความชอบถูกใช้เพื่อกำหนดระดับความรุนแรงของปัญหา ระดับความรุนแรงของปัญหามีค่าอยู่สามค่า: ละเว้น คำเตือน หรือข้อผิดพลาด ชุดของปัญหาที่ตรวจพบถูกนิยามไว้โดยคีย์การกำหนดค่าตาความชอบสำหรับปัญหาที่สอดคล้งกันในเครื่องมือ API
ตำแหน่งที่ระบุโดยใช้พาธสัมบูรณ์ หากตำแหน่งที่กำหนดไว้ไม่มีอยู่ การกำหนดค่าตามความชอบจะไม่ถูกตั้งค่าไว้
บรรทัดที่ขึ้นต้นด้วย '#' จะถูกละเว้น รูปแบบของไฟล์การกำหนดค่าตามความชอบจะดูคล้ายกับที่แสดงต่อไปนี้:
 #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
คีย์สามารถพบได้ใน org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes
ไม่ใช่
debug ตั้งค่าดีบัก

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

ตัวอย่าง

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

รันภารกิจการสร้างไฟล์ report.xml ภายในโฟลเดอร์ D:\reports\xml ชนิด เมธอด และฟิลด์ จาก use scans จะถูกแก้ไขปัญหาในโปรไฟล์ที่ D:\eclipse\3.7\eclipse และส่วนที่หายไปจะถูกรายงาน ซึ่งจะใช้รายการที่แยกออกจากไฟล์ D:\exclude_list_external.txt เพื่อลดจำนวนของบันเดิลที่ปัญหาถูกรายงาน

ระดับความรุนแรงของปัญหาจะถูกสร้างขึ้นตามที่ระบุไว้โดย D:\tests_api\org.eclipse.pde.api.tools.prefs

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

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

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