Debugger : The Set File, Set Output And Cancel Output Commands : SET OUTPUT Command : Recording Comments in a Log File

Recording Comments in a Log File

Whenever the executing prototype pauses and enters the debug mode, you may enter not only Debugger commands, but also comments. Comments have absolutely no influence on the execution. However, they are recorded into the log file as part of the debugging session transcript. This option supports a better understanding of the saved transcript contents in a post-run analysis. You can use comments to:

Comments are extremely helpful when the transcript is not analyzed immediately after the run or by persons other than those performing the run.

A comment is a free text string starting with a hyphen. You enter it when the Debugger prompt is displayed:

Pdb > - free_text

 

 

Comments are recorded in the log file literally, including the hyphen.

To illustrate the use of comments, suppose that in the above example of the debugging session, you entered the following comments between the commands SHOW DATA and SET DATA:

Pdb > - ***** The difference between the bounds
Pdb > - ***** shouldn’t exceed 60.0

Then the corresponding portion of the log file appears as:

SHOW DATA *bound
- Current values of data_items:
- system: LOWER_BOUND = 20.5
- system:UPPER_BOUND = 84.7
- ***** The difference between the bounds
- ***** shouldn’t exceed 60.0
SET DATA lower_bound := 25.0