Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 90550

Summary:	(Plat) filter documentation incorrect for standalone profiling
Product:	z_Archived	Reporter:	Kim Coleman <kcoleman>
Component:	Hyades	Assignee:	Nellie Chau <nelliec>
Status:	CLOSED FIXED	QA Contact:
Severity:	normal
Priority:	P3	Keywords:	Documentation
Version:	unspecified
Target Milestone:	---
Hardware:	PC
OS:	Windows XP
Whiteboard:	closed460

Description Kim Coleman

2005-04-06 18:52:51 EDT

In the help topic "Profiling an application in stand-alone mode", there is a 
section on filters which I believe is incorrect/incomplete. It indicates that 
the contents of a filter file should be "pattern mode", where pattern is:

"A string with no imbedded blanks. The string may contain a single asterisk (*) 
either at the beginning of the string or at the end of the string. The * 
matches zero or more characters, thus making the pattern a generic prefix or 
suffix pattern. A sole * can also be specified to represent all strings."

This would lead one to believe this is a valid filter file:

my.package* INCLUDE
* EXCLUDE

But in fact, this is not the case. Instead, this should look like:

my.package*  *  INCLUDE
*  *  EXCLUDE

Note that there are 3 fields on each line, not 2. The real syntax more like:

class_pattern method_pattern mode

I got this info from Samson and it did indeed seem to fix my problem. If you 
can confirm it with someone more in the know than I am, we should fix the help 
so it doesn't lead the next person down the same garden path.

Comment 1 Nellie Chau

2005-04-08 10:45:27 EDT

Can you assign this one to me?  and prefix the summary with (Plat), and add the
Keyword Documentation?

Thanx.

Comment 2 Kim Coleman

2005-04-08 14:24:14 EDT

Reassigning and making other changes as per Nellie's request.

Comment 3 Nellie Chau

2005-04-11 12:44:24 EDT

Fixed in TPTP 3.3. & 4.0:

Text updated as follows:
The filter file should specify three fields, package/class, method, and mode in
the following format:
   package/class method mode

where:

    package/class
        This field is used to specify a pattern for a package or a class name.
The pattern should be specified as a string with no imbedded blanks. The string
may contain a single asterisk (*) either at the beginning of the string or
trailing the string, e.g. *.mypackage or org.mycompany.*. The * matches zero or
more characters, thus making the pattern a generic prefix or suffix pattern. A
sole * can also be specified to represent all strings.
    method
        This field is used to specify a pattern for the method name. The pattern
should be specified as a string with no imbedded blanks and with the same
specification rules as the class field.
    mode
        This field specifies whether the package or class that matches the
pattern is to be included or excluded from profiling. The value for mode is
either INCLUDE or EXCLUDE.

Filter patterns are processed in the order that they are specified until the
first pattern match succeeds. If the class name does not match any of the
specified filter patterns, the default is to INCLUDE the class.

Comment 4 Paul Slauenwhite

2009-06-30 12:32:58 EDT

As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant enhancements/defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this enhancement/defect is verified/closed by the Project Lead since this enhancement/defect has been resolved and unverified for more than 1 year and considered to be fixed. If this enhancement/defect is still unresolved and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.