GUI Reference: Warning Report

• Navigating to
• Page Properties
• Contents and Usage
• Annotations
• Interaction and Navigation
• Navigating from
• Related Tasks

Important Note: the CodeSonar Web GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

Navigating to

The Warning Report page for a specific warning can be reached in any of the following ways.

Page Properties

Contents and Usage

The following annotated screenshot shows the various parts of a Warning Report page.

Standard Header

See CodeSonar GUI Reference: Standard Header. The highlight legend is available.

Breadcrumbs

Home > [Other_ProjectTree_Ancestors >] Project_Name > Analysis_Name > Warning Warning_ID

Page Heading and Links

Warning Properties and Details

In its unexpanded form, this part of the page consists of two lines.

• The first line summarizes the current values of the warning's user-controlled properties: Owner, Priority, State, Finding, and Notes. To modify any of these values, click edit properties and use the Change Warning form as described below.
• The second line contains a warning details... link. Click the link to show a table of basic information about the warning.

  Categories	The warning class categories. Use warning category filtering to show only the categories you are interested in.
  Warning ID
  Procedure
  Explore Callers	Links to various mechanisms for examining the sequence of calls leading to the warning. graphical (lite) Navigates to the Explore Callers page for the warning. tabular Navigates to the Search Callers page for the warning.
  Similar Warnings	If the analysis contains other warning instances in the the same warning group, their Warning IDs will be listed here. The list is not sensitive to the Visible Warnings setting.
  Last Modified	Click show details to see additional information about the analysis and warning: Analysis (Warning Analysis . Analysis) Analysis Description (Warning Analysis . Analysis Description) Started (Warning Analysis . Started) Click show details to show the analysis Username, Machine, and Address. Finished (Warning Analysis . Finished) Click show logs for links to the analysis Build Log, CodeSonar Parse Log, and CodeSonar Analysis Log. Analysis State (Warning Analysis . Analysis State) Detected First Detected

Menu Bar

The menu bar provides two menus: Show Events and Options.

Show Events Menu

Select an item from this menu to expand the specified set of annotations (and hide all others). All events. Expand all data annotations and all control flow annotations. Only primary events. Expand the data annotations that CodeSonar has determined are especially important. If you have selected Show control events by default in the Options menu, every control flow annotation in the report will also be expanded.

Options Menu

The Options menu items are as follows. Jump to warning location by default. When selected, Warning Report pages will be automatically scrolled to the warning location when they are loaded. Show control events by default. When selected, all control flow annotations will be treated as "primary events": they are displayed by default, and when Only primary events is selected. Show other warnings. When selected, CodeSonar will display additional annotations at locations in the code excerpt where other warnings were issued (if any). Each annotation specifies the class and location of a warning, and provides a link to the associated warning report: This setting is not persistent: it is always deselected when you navigate away from the page. Show line numbers. When selected, line numbers will be displayed to the left of the code excerpt. When deselected, no line numbers are displayed. Wrap lines. When selected, lines in the excerpt will wrap to fit the browser window, as will all annotation text. When deselected, no wrapping will occur and it may be necessary to scroll across to see all code and annotations. With the exception of Show other warnings, CodeSonar will remember your settings and apply them to all warning reports. If you are logged in, the settings will be associated with your username and will still be applied the next time you log in. Otherwise, they will be applied for the remainder of your user session.

Annotated Code Excerpt

The annotated code excerpt shows the context in which the warning was issued. CodeSonar provides additional information to explain the conditions leading to the warning and aid in diagnosis:

Change History (if any)

The sequence of comments attached to this warning (shared by all warnings in a group). These consist of all the user Notes added to the group, plus all the messages automatically generated by CodeSonar when a user changes the Priority, State, Finding, or Owner for the warning group.

To add a new comment, scroll to the Change Warning form and proceed as described below.

Related Warning Notifications (if any)

Notifications and links for other warnings related to this one. Two kinds of relationship are described: warning groups and warning clusters.

Change Warning Form

You can do any combination of the following with the Change Warning form.

• Change the Priority, State, Finding, or Owner for the warning group
• Apply one or more warning processors.
• Append a Note to the change history.

Note: You must be signed in to edit a Warning Report page. If you are not already signed in, you will be asked to sign in after you click Save changes.

1. Scroll down to the Change Warning section, or click edit properties in the warning properties section to navigate directly to the form.
2. If the warning is one of several in a warning group, there are two possibilities.
   • If it is the overall representative instance for the group, CodeSonar will list the other analysis warnings in the group at the top of the Change Warning form, noting that these warnings share annotations.
   • If it is not the overall representative instance, CodeSonar will provide a link to that instance instead of fields for changing the warning. Click the link to navigate to the representative instance, and make your changes on that page.
3. If the warning belongs to a non-singleton warning cluster, CodeSonar will list the other warnings in the cluster at the top of the Change Warning form, noting that these warnings "do not share annotations by default, but may be related".
   If you wish to annotate all warnings in the cluster:
   1. Click the view all related link to navigate to the corresponding Warning Cluster page.
   2. Inspect the warnings in the Warning Cluster table to make sure you want to apply the same annotations to all of them.
   3. If so, use the Change Multiple Warnings functionality on that page to annotate some or all of the warnings in the cluster.
      Otherwise, use your browser's Back button to
4. Make your desired changes.

   Priority, State, Finding	Select new values from the pull-down menus. To specify a new, custom value for Priority, State, or Finding: Select Other... from the appropriate pull-down menu. Enter a name for your new value in the text field that appears under the menu.
   Owner	Select a new value from the pull-down menu. If you are modifying a previously-unmodified warning and do not set an Owner, the warning will be assigned to you unless automatic assignment is disabled.
   Warning Processors	If any warning processors are available for application, a labeled checkbox for each processor will be displayed after the Priority, State, Finding, and Owner menus. Check the box next to each processor you want to apply. Some installed warning processors may not be displayed. A warning processor will only be displayed if: you have both WPROCESSOR_EXISTS and WPROCESSOR_EXECUTE permissions for that processor, and the processor's display script makes it available in the current context. A warning processor can only change a warning's Owner to a user who has ANALYSIS_OWN_WARNINGS permission for this analysis.
   Note	Enter a new note in the Note field.

5. Save your changes.
   • Click Save changes to save your changes and reload the current Warning Report.
   • Click Save and Next to save your changes and load the next Warning Report in the current warning browse sequence. (If the current Warning Report does not belong to a warning browse sequence, this button will not be available.)
   Only signed-in users can save changes to the hub: if you are not already signed in when you click Save changes or Save and Next, CodeSonar will ask you to Sign In before saving your changes.
6. If the warning belongs to a non-singleton warning cluster, CodeSonar will display a message suggesting that you may also wish to annotate the other warnings in the cluster. Click the link in the message to navigate to the corresponding Warning Cluster page, where you can inspect and annotate the other warnings.

Automatic Assignment

When automatic assignment is enabled and a user makes changes to a warning that has never previously been modified, that user will be made the Owner of the warning unless their modifications include setting an Owner.

By default, automatic assignment is enabled. To disable automatic assignment:

1. Navigate to the Change Warnings section of a Warning Report page.
2. Click the "?" link next to Auto-Assign Enabled (on the same line as the Owner selector).
   The page will expand to display some information about automatic assignment, along with a checkbox for enabling automatic assignment.
3. Deselect the checkbox.

To re-enable, follow the same process but select the checkbox.

Disabling for automatic assignment is managed through browser cookies with an expiry time of 7 days. Therefore:

• Enabling and disabling take effect as soon as you change the setting.
• Automatic assignment will be re-enabled after a week.
• If you clear your cookies, automatic assignment will be re-enabled.
• If you wish to disable automatic assignment, you will need to go through the process outlined above:
  • every 7 days,
  • for every browser you use,
  • on every machine you use.

Standard Footer

See CodeSonar GUI Reference: Standard Footer.

Annotations

Warning Reports have annotations at program points that are particularly relevant to the warning, along with annotations for locations in the code excerpt that are important for reasons unrelated to the warning. These annotations are described in GUI Reference: Warning Report Annotations.

Interaction and Navigation

Code excerpts in warning reports provide the following functionality in addition to the standard Source Coloring and Interactivity provided in the CodeSonar GUI.

Element	Interaction
Function call sites	For warnings associated with paths, function call sites along the path can be expanded to show the code for the called function. Click the [+] symbol to expand the associated call site inside the current page; click the [-] symbol to collapse an expanded item. Call site expansion is not provided for library functions and undefined functions.
Macros	To expand a macro definition, click the macro name and select Expand macro definition from the menu that opens. Click the [hide] link in the top right corner of the expansion box to close it, or click the macro name a second time and deselect Expand macro definition.
and	When CodeSonar is displaying only part of a file, and links allow you to extend the excerpt further back and forward, respectively. This is especially useful if you want to see additional context. Refresh the browser window to revert to the excerpt selected by CodeSonar.
	CodeSonar will sometimes elide code from inside an excerpt, replacing it with a note stating which lines have been removed. Lines on the warning's core path will never be elided. Click the link to expand the elided code. Refresh the browser window to revert to the excerpt selected by CodeSonar.

Navigating from

Related Tasks

• Find warnings that match specific criteria
• View a warning report