next up previous contents
Next: Graphical Output Up: Summary Report Previous: Inquiry

Response

From tpearse@boi.hp.com Fri Oct 11 15:02:51 1996
Date: Thu, 10 Oct 1996 10:59:14 -0600
From: Troy Pearse 
To: suthe922@cs.uidaho.edu, tpearse@boi.hp.com
Cc: cary8741@cs.uidaho.edu, evans911@cs.uidaho.edu, gatkins@cs.uidaho.edu,
    jone9333@cs.uidaho.edu, oman@cs.uidaho.edu, tpearse@hpdmd48.boi.hp.com
Subject: Re:  Textual Summary Report Format (CS481 Team B)

Noah,

I've been out of town for a week or so and haven't had a chance to
review your output.  At first glance I think it looks good.  The only
thing that struck me right away was that some of your indenting is not
obvious.  In general, you should only indent a sub-title if it is a
"part" of the previous line's information.  With that in mind, you might
think about "numbering" the sections and subsections of your report,
such as 1, 1.1, 1.1.2, etc. and see how that looks.

Below are a few comments.  

Looks good,


Troy Pearse
Hewlett-Packard

> 
> ===========================================================================
> 	Summary Report for ../test/Text.h :
> 
> 	Analysis options specified:
> 
> 	C : Display Comprehensive Conditional Logic Listing
> 	D : Display Conditional Directive Summary
> 	E : Display Conditional Expression Summary
> 	L : Display Total Lines of Code
> 	T : Display Total Lines of Conditional Compilation Logic
> 	V : Display V(g) and V'(g) for Conditional Logic
> 
> 	Code Analysis Summary:
> 
> 		Total Lines of Code:		310
> 		Total Lines of CC Logic:	44
> 		Total V(g) for CCDs:		22
>         	Total V'(g) for CCDs:		22

- Why is the above line indented? 
- Can you line up the numbers better, left justified?  
  (not too important, though)

>         	
>        		Directive Use Summary:

- Indentation here (above) is not obvious to me at first glance.

- Some headings might help, such as number of occurances, and type of
  conditional

- Where is the count of #endif?
- Please always list all types of conditional logic, with number of occurances
  as "0" for those which are not used in the file.

           
>         
>         		2	#else
>         		21	#endif
>         		19	#if
>         		2	#ifndef
>         
>         	Expression Use Summary:
>         
>         		17	NeedFunctionPrototypes
>         		2	NeedWidePrototypes
>         		1	_XawText_h
>         		1	_XtStringDefs_h_
>         
>         	Complete Conditional Logic Listing:

- Make sure your line numbers and aligment can handle files that are
  up to 99,000 lines long.

- Are these the source lines from the file, or created by you?
- What does a line with a continuation look like?
  ie:  #if (FEATURE == ON) && \
           (DEBUG == OFF)


> 
>         	Line#	CCD		Expression
>         	----------------------------------------------
>         	51	#ifndef		_XawText_h
>         	143	#ifndef		_XtStringDefs_h_
>         	148	#endif		
>         	175	#if		NeedFunctionPrototypes
>         	177	#endif		
>         	181	#if		NeedFunctionPrototypes
>         	183	#endif		
>         	187	#if		NeedFunctionPrototypes
>         	189	#endif		
>         	193	#if		NeedFunctionPrototypes
>         	195	#endif		
>         	199	#if		NeedFunctionPrototypes
>         	202	#endif		
>         	206	#if		NeedFunctionPrototypes
>         	210	#endif		
>         	214	#if		NeedFunctionPrototypes
>         	218	#endif		
>         	222	#if		NeedFunctionPrototypes
>         	227	#endif		
>         	231	#if		NeedFunctionPrototypes
>         	233	#endif		
>         	237	#if		NeedFunctionPrototypes
>         	240	#endif		
>         	244	#if		NeedFunctionPrototypes
>         	246	#endif		
>         	250	#if		NeedFunctionPrototypes
>         	252	#endif		
>         	256	#if		NeedFunctionPrototypes
>         	260	#endif		
>         	264	#if		NeedFunctionPrototypes
>         	268	#endif		
>         	272	#if		NeedFunctionPrototypes
> 		274	#endif		

- Why is this line negatively-indented?

>         	278	#if		NeedFunctionPrototypes
>         	280	#if		NeedWidePrototypes
>         	282	#else		
>         	284	#endif		
>         	286	#endif		
>         	290	#if		NeedFunctionPrototypes
>         	292	#if		NeedWidePrototypes
>         	294	#else		
>         	296	#endif		
>         	297	#endif		
>         	309	#endif		

Can I get some "indentation" here to show nested conditional's?

>         
>         *** End of Analysis Summary ***	
> ===========================================================================
> 
> By default, however, the expression summary data and the complete
> conditional logic listing will not be displayed.  The complete list,
> we feel, is simply too much info to be provided by default.  When Gerry
> saw our format, he suggested that the expression use summary also not
> be printed by default.  The expression summary could get several pages
> long if there were a lot of unique expressions in a file.

- I'd rather have the long listing as default, with possibly an option to
  turn the long listing off.

> 
> The default summary report for the same input file would look like the
> following:
> 
> ===========================================================================
> 	Summary Report for ../test/Text.h :
> 
> 	Analysis options specified:
> 
> 	D : Display Conditional Directive Summary
> 	L : Display Total Lines of Code
> 	T : Display Total Lines of Conditional Compilation Logic
> 	V : Display V(g) and V'(g) for Conditional Logic
> 
> 	Code Analysis Summary:
> 
> 		Total Lines of Code:		310
> 		Total Lines of CC Logic:	44
> 		Total V(g) for CCDs:		22
> 		Total V'(g) for CCDs:		22
> 
> 		Directive Use Summary:
> 
> 			2	#else
> 			21	#endif
> 			19	#if
> 			2	#ifndef
> 
> 	*** End of Analysis Summary ***
> ===========================================================================
> 
> The Analysis Options section of the summary displays the command line
> options selected when the program was run.  These may have been explicitly
> specified or selected by default.  Notice that in the second example, the 
> C and E options are no longer specified.  This information could remain or
> not in our opinion.  If you would like to be able to look at a result summary

- Go ahead and leave it in.

> and immediately be able to tell what options you specified when you ran
> the analysis, then this data would be useful.  This could be useful if 
> different people are viewing results than those that actually generated
> them, as an example.  Let us know whether you'd like to see this information
> in the future.
> 
> Gerry has reviewed this report format and feels that it is both easy
> to understand and contains the relevant data that is required.  He supports
> the above displayed default data format, also.
> 
> Please let us know whether this summary report format meets with your 
> approval or whether there are additions / changes you would like to
> see.
> 
> Sincerely,
> 
> Noah Sutherland
> Team Leader
> CS481 Team B
> University of Idaho