Zadanie Ant porównywania

Przeznaczenie

To zadanie przeprowadza pełne porównanie profilu interfejsu API w odniesieniu do wersji bazowej.

Opis

Opis

Nazwa zadania Ant to apitooling.compare. Aby możliwe było jego użycie, plik JAR apitooling-ant.jar musi znajdować się w ścieżce klas narzędzia Ant.

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

Parametry

Atrybut Opis Wymagany
baseline Ten atrybut określa położenie wersji bazowej odniesienia.

Może to być plik .zip, .jar, .tgz lub .tar.gz albo katalog odpowiadający folderowi instalacyjnemu platformy Eclipse. Jest to katalog, w którym znajduje się plik wykonywalny platformy Eclipse.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
profile Ten atrybut określa położenie bieżącego produktu lub profilu, który ma zostać porównany z wersją bazową odniesienia.

Może to być plik .zip, .jar, .tgz lub .tar.gz albo katalog odpowiadający folderowi instalacyjnemu platformy Eclipse. Jest to katalog, w którym znajduje się plik wykonywalny platformy Eclipse.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
report Ustawia położenie wyjściowe, w którym będzie generowany raport.

Po zakończeniu zadania raport o nazwie compare.xml będzie dostępny w danym katalogu.

Położenie jest określane przy użyciu pełnej ścieżki.
Tak
excludelist Ustawia położenie listy wykluczeń.

Położenie listy wykluczeń określa plik tekstowy zawierający pakunki do wykluczenia z analizy. Domyślnie analizowane są wszystkie pakunki w profilu. Atrybutów listy włączeń i wykluczeń można używać do selektywnego włączania i wykluczania pakunków. Lista włączeń określa zbiór pakunków, które mają być analizowane (jej pominięcie oznacza włączenie wszystkich pakunków). Po niej jest stosowana lista wykluczeń. Każdy wiersz pliku określa jeden z następujących elementów:
  • konkretna nazwa pakunku,
  • wyrażenie regularne porównywane z nazwami pakunków (wiersze zaczynające się od łańcucha „R:”),
  • komentarz (wiersze zaczynające się od znaku „#”).

Położenie jest określane przy użyciu pełnej ścieżki.
Przykładowa lista wykluczeń:
 # PAKUNKI DOC
 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
 # PAKUNKI SPOZA ŚRODOWISKA ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Wykluczenie wszystkich pakunków środowiska PDE
 R:org\.eclipse\.pde\..*
 ...
Lista wykluczeń może zawierać wyrażenia regularne w wierszach rozpoczynających się łańcuchem "R:".
Nie
includelist Ustawia położenie listy włączeń.

Położenie listy włączeń określa plik tekstowy zawierający pakunki do uwzględnienia w analizie. Domyślnie analizowane są wszystkie pakunki w profilu. Atrybutów listy włączeń i wykluczeń można używać do selektywnego włączania i wykluczania pakunków. Lista włączeń określa zbiór pakunków, które mają być analizowane (jej pominięcie oznacza włączenie wszystkich pakunków). Po niej jest stosowana lista wykluczeń. Każdy wiersz pliku określa jeden z następujących elementów:
  • konkretna nazwa pakunku,
  • wyrażenie regularne porównywane z nazwami pakunków (wiersze zaczynające się od łańcucha „R:”),
  • komentarz (wiersze zaczynające się od znaku „#”).

Położenie jest określane przy użyciu pełnej ścieżki.
Przykładowa lista włączeń:
 # PAKUNKI DOC
 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
 # PAKUNKI SPOZA ŚRODOWISKA ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Wykluczenie wszystkich pakunków środowiska PDE
 R:org\.eclipse\.pde\..*
 ...
Nie
debug Ustawia wartość debugowania.

Możliwe wartości to: true, false.
Wartość domyślna to false.
Nie
components Ustawia położenie listy komponentów.

Lista komponentów zawiera nazwy wszystkich komponentów, które należy porównać. W przypadku jej pominięcia porównywane są wszystkie komponenty z danej wersji bazowej.
Położenie jest określane przy użyciu pełnej ścieżki.
Format pliku listy komponentów wygląda następująco:
 # PAKUNKI DOC
 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
 # Włączenie wszystkich pakunków środowiska PDE
 R:org\.eclipse\.pde\..*
 ...
Lista komponentów może zawierać wyrażenia regularne w wierszach rozpoczynających się łańcuchem "R:".
Nie
visibility Ustawia wartość widoczności.

Możliwe wartości: API, ALL
Wartość domyślna to API.
Nie

Przykłady

	<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:\lista_wykluczeń_zewnętrznych.txt"
		debug="true"
	/>

Spowoduje to uruchomienie zadania tworzącego pliki compare.xml w folderze D:\reports\xml. Używa ono listy wykluczeń w celu zmniejszenia liczby problemów do zgłoszenia.

Ponieważ włączone jest debugowanie, część danych śledzenia debugowania będzie wyświetlana w konsoli narzędzia Ant.

Informacje pokrewne

Zadanie Ant blokowania interfejsu API
Zadanie Ant generowania pliku
Zadanie Ant użycia interfejsu API
Zadanie Ant konwersji raportu analizy
Zadanie Ant konwersji raportu blokowania interfejsu API
Zadanie Ant konwersji raportu użycia interfejsu API
Zadanie Ant konwersji raportu deaktualizowania interfejsu API