Задача Ant сравнения

Назначение

Эта задача выполняет полное сравнение профайла API относительно контрольной версии.

Формат

Описание

Имя задачи Ant: apitooling.compare. Для использования JAR-файла apitooling-ant.jar он должен находиться в classpath 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.
Нет
компоненты Задайте расположение списка компонентов.

Список компонентов содержит имена всех компонентов, которые требуется сравнить. При его отсутствии будут сравниваться все компоненты данной контрольной версии.
Расположение задается с помощью абсолютного пути.
Формат файла списка компонентов:
 # 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"
	/>

Будет запущена задача создания файлов compare.xml в папке D:\reports\xml. Будет использоваться список исключения, чтобы уменьшить количество неполадок в отчете.

После включения отладки некоторая информация трассировки будет показана на консоли Ant.

Связанные ссылки

Задача Ant фиксации состояния API
Задача Ant генерации файла
Задача Ant использования API
Задача Ant преобразования отчета об анализе
Задача Ant преобразования отчета о фиксации состояния API
Задача Ant преобразования отчета об использовании API
Задача Ant преобразования отчета об устаревшем API