Εργασία 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
 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
 # ΔΕΣΜΕΣ ΕΚΤΟΣ ECLIPSE
 com.ibm.icu
 com.jcraft.jsch
 javax.servlet
 javax.servlet.jsp
 # Exclude all pde bundles
 R:org\.eclipse\.pde\..*
 ...
Η λίστα εξαιρέσεων μπορεί να περιέχει κανονικές εκφράσεις εφόσον η γραμμή αρχίζει με "R:".
Όχι
includelist Ορίζει τη θέση της λίστας συμπεριλήψεων.

Η θέση της λίστας συμπεριλήψεων καθορίζει ένα αρχείο κειμένου στο οποίο εμφανίζονται οι δέσμες που θα συμπεριληφθούν στην ανάλυση. Από προεπιλογή, αναλύονται όλες οι δέσμες του προφίλ. Τα γνωρίσματα λίστας συμπεριλήψεων και εξαιρέσεων μπορούν να χρησιμοποιηθούν για την επιλεκτική συμπερίληψη ή εξαίρεση δεσμών. Η λίστα συμπεριλήψεων παρέχει το αρχικό σύνολο με τις δέσμες που θα αναλυθούν (αν παραλειφθεί, συμπεριλαμβάνονται όλες οι δέσμες). Στη συνέχεια εφαρμόζεται η λίστα εξαιρέσεων. Κάθε γραμμή του αρχείου καθορίζει ένα από τα εξής:
  • ένα όνομα δέσμης
  • μια κανονική έκφραση για την αναζήτηση ονομάτων δεσμών (γραμμές που αρχίζουν με "R:")
  • ένα σχόλιο (γραμμές που αρχίζουν με '#')

Η θέση καθορίζεται με τη χρήση μιας απόλυτης διαδρομής.
Ακολουθεί ένα παράδειγμα λίστας συμπεριλήψεων:
 # ΔΕΣΜΕΣ 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
 # ΔΕΣΜΕΣ ΕΚΤΟΣ ECLIPSE
 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
 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
 # Συμπερίληψη όλων των δεσμών pde
 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