Неполадки осмотра использования API - Задача Ant

Назначение

Эта задача позволяет преобразовать осмотры использования API в профайле относительно контрольной версии. Она сообщает о ссылках на типы, методы и поля, которые отсутствуют в профайле в данный момент.

Формат

Описание

Именем задачи Ant: apitooling.apiusescanproblems. Для использования JAR-файла apitooling-ant.jar он должен находиться в classpath Ant.

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

Параметры

Атрибут Описание Обязательный
profile Этот атрибут задает расположение текущего продукта или профайла, для которого требуется выполнить обработку осмотров использования API.

Это может быть файл .zip, .jar, .tgz, .tar.gz или каталог, который соответствует каталогу установки Eclipse. Это каталог, в котором находятся исполняемые файлы Eclipse.

Расположение задается с помощью абсолютного пути.
Да
report Установите расположение вывода, в котором будут генерироваться отчеты.

После выполнения задачи отчеты становятся доступными в этом каталоге. Подпапка создается для каждого компонента, который имеет неполадки. Каждая подпапка содержит файл с именем "report.xml".

Расположение задается с помощью абсолютного пути.
Да
apiusescans Указывает список разделенных запятыми значений расположений осмотров использования API, для которых требуется выполнить проверку относительно профайла.

Это может быть файл .zip или каталог, соответствующий отчету об осмотре использования API. Это каталог, в котором находится папка 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
 R:javax\..*
 ...
Нет
includelist Задайте расположение списка включения.

Расположение списка включения указывает текстовый файл, в котором перечислены комплекты, подлежащие включению в анализ. По умолчанию анализируются все комплекты профайла. Атрибуты списка включения и списка исключения можно использовать для выборочного включения и исключения комплектов. Список включения задает набор комплектов для анализа (если не указан, включаются все комплекты), затем применяется список исключения. Каждая строка файла задает один из следующих элементов:
  • имя определенного комплекта
  • регулярное выражение для поиска совпадений с именами комплектов (строки с "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\..*
 ...
Нет
параметры Установите параметры для задачи.

Параметры используются для настройки серьезности неполадки. Серьезность неполадки может принимать одно из трех значений: Ignore, Warning или Error. Набор обнаруженных неполадок определяется соответствующими ключами атрибутов неполадок в инструментах 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. Типы, методы и поля из осмотров использования будут обработаны в профайле по адресу D:\eclipse\3.7\eclipse, а информация об отсутствующих будет указана в отчете. Будет использоваться список исключения из файла D:\exclude_list_external.txt для уменьшения числа комплектов, для которых в отчете будут показаны неполадки.

Серьезность неполадки будет генерироваться, как указано в D:\tests_api\org.eclipse.pde.api.tools.prefs.

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

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

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