比较 Ant 任务

用途

此任务将 API 概要文件相对于基线进行完整比较。

用法

描述

Ant 任务的名称为 apitooling.compare。要使用 JAR 文件 apitooling-ant.jar,此文件必须在 Ant 类路径上。

<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 设置排除列表位置。

排除列表位置指定将不对其进行分析的文本文件列表捆绑软件。缺省情况下,将对概要文件中的所有捆绑软件进行分析。可以使用包括和排除列表属性来有选择地包括和排除捆绑软件。包括列表确定要分析的捆绑软件集(如果省略了,那么将包括所有捆绑软件),然后应用排除列表。此文件的每一行指定下列其中一项:
  • 特定捆绑软件名称
  • 要与捆绑软件名称进行匹配的正则表达式(带有“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 设置包括列表位置。

包括列表位置指定要对其进行分析的文本文件列表捆绑软件。缺省情况下,将对概要文件中的所有捆绑软件进行分析。可以使用包括和排除列表属性来有选择地包括和排除捆绑软件。包括列表确定要分析的捆绑软件集(如果省略了,那么将包括所有捆绑软件),然后应用排除列表。此文件的每一行指定下列其中一项:
  • 特定捆绑软件名称
  • 要与捆绑软件名称进行匹配的正则表达式(带有“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。
否
components 设置组件的列表位置。

组件列表包含必须比较的所有组件的名称。如果省略了此属性,那么将对所给定基线的所有组件进行比较。
使用绝对路径来指定此位置。
组件的列表文件的格式如下所示:
 # 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:”开头,那么组件的列表可以包含正则表达式。
否
visibility 设置可视性值。

此属性的值可以为 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"
	/>

这将运行在 D:\reports\xml 文件夹中创建 compare.xml 文件的任务。它将使用排除列表来减少要报告的问题数。

因为已启用调试,所以某些调试跟踪将显示在 Ant 控制台中。

相关参考

API 冻结 Ant 任务
文件生成 Ant 任务
API 使用 Ant 任务
分析报告转换 Ant 任务
API 冻结报告转换 Ant 任务
API 使用报告转换 Ant 任务
API 不推荐报告转换 Ant 任务