Tarefa ant de comparação

Finalidade

Esta tarefa executa uma comparação completa de um perfil da API relativo a uma linha de base.

Utilização

Descrição

O nome da tarefa Ant é: apitooling.compare. Para ser utilizada, o ficheiro jar apitooling-ant.jar tem de estar no caminho de classe de ant.

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

Parâmetros

Atributo Descrição Necessário
baseline Este atributo especifica a localização da linha de base de referência.

Pode ser um ficheiro .zip, .jar, .tgz ou .tar.gz, ou um directório que corresponda a um pasta de instalação do Eclipse. Este directório é onde se encontra o executável do Eclipse.

A localização é especificada utilizando um caminho absoluto.
Sim
profile Este atributo especifica a localização do produto actual ou o perfil que pretende comparar com a linha de base de referência.

Pode ser um ficheiro .zip, .jar, .tgz ou .tar.gz, ou um directório que corresponda a um pasta de instalação do Eclipse. Este directório é onde se encontra o executável do Eclipse.

A localização é especificada utilizando um caminho absoluto.
Sim
report Defina a localização de saída onde o relatório será gerado.

Assim que a tarefa for concluída, o relatório designado "compare.xml" fica disponível neste directório.

A localização é especificada utilizando um caminho absoluto.
Sim
excludelist Define a localização da lista de exclusão.

A localização da lista de exclusões especifica um ficheiro de texto que lista os lotes a excluir da análise. Por predefinição, todos os lotes no perfil serão analisados. Os atributos da lista de exclusões e inclusões podem ser utilizados, de forma selectiva, para incluir e excluir lotes. A lista de inclusões dissemina o conjunto de lotes a analisar (quando omitidos, todos os lotes são incluídos), e a lista de exclusões é então aplicada. Cada linha do ficheiro especifica:
  • um nome de lote específico
  • uma expressão regular para corresponder relativamente a nomes de lotes (linhas que começam por "R:")
  • um comentário (linhas que começam por '#')

A localização é especificada utilizando um caminho absoluto.
A seguir encontra-se um exemplo de uma lista de exclusões:
 # 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\..*
 ...
A lista de exclusões pode conter expressões regulares se a linha começar por "R:".
Não
includelist Defina a localização da lista de inclusões.

A localização da lista de inclusões especifica um ficheiro de texto que lista os lotes a incluir da análise. Por predefinição, todos os lotes no perfil serão analisados. Os atributos da lista de exclusões e inclusões podem ser utilizados, de forma selectiva, para incluir e excluir lotes. A lista de inclusões dissemina o conjunto de lotes a analisar (quando omitidos, todos os lotes são incluídos), e a lista de exclusões é então aplicada. Cada linha do ficheiro especifica:
  • um nome de lote específico
  • uma expressão regular para corresponder relativamente a nomes de lotes (linhas que começam por "R:")
  • um comentário (linhas que começam por '#')

A localização é especificada utilizando um caminho absoluto.
A seguir encontra-se um exemplo de uma lista de inclusões:
 # 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\..*
 ...
Não
debug Define o valor de depuração.

Os valores possíveis são: true, false
A predefinição é false.
Não
components Defina a localização da lista de componentes.

A lista de componentes contém todos os nomes dos componentes que é necessário comparar. Se omitida, todos os componentes da linha de base fornecida serão comparados.
A localização é especificada utilizando um caminho absoluto.
O formato do ficheiro da lista de componentes assemelha-se ao seguinte:
 # 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\..*
 ...
A lista de componentes pode conter expressões regulares se a linha começar por "R:".
Não
visibility Defina o valor de visibility.

Os valores possíveis são: API, ALL
A predefinição é API.
Não

Exemplos

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

Isto irá executar a tarefa criando ficheiros compare.xml dentro da pasta D:\reports\xml. Irá utilizar a lista de exclusão para reduzir o número de problemas para o relatório.

Uma vez que a depuração está activada, aparecerá alguma indicação de rastreio na consola ant.

Referência relacionada

Tarefa ant de congelamento da API
Tarefa ant de geração de ficheiros
Tarefa ant de utilização da API
Tarefa ant de conversão de relatórios de análise
Tarefa ant de conversão de relatórios de congelamento da API
Tarefa ant de conversão de relatórios de utilização da API
Tarefa ant de conversão de relatórios de desactualização da API