Intel® Advisor User Guide

ID 766448
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

Copy Annotations and Build Settings Using the Annotation Assistant Pane

The Intel® Advisor provides an annotation assistant near the bottom of the Survey Report and Survey Source windows, as well as with the No Data message. Use this assistant to view and copy selected annotated code snippets and build setting information into a code editor.

The assistant provides a drop-down list under Example: from which you select one of the following:

Select This

To Do This

Iteration Loop, Single Task

View and copy an annotation code snippet for a simple loop structure, where the task's code includes the entire loop body. Use this common task structure when only a single task is needed within a parallel site. For example code, see the help topic Site and Task Annotations for Simple Loops With One Task.

Click the button to copy the selected snippet to the clipboard.

Loop, One or More Tasks (bounded)

View and copy an annotation code snippet for a loops where the task code does not include all of the loop body, or for complex loops or code that requires specific task begin-end boundaries, including multiple task end annotations. Also use this structure when multiple tasks are needed within a parallel site. For example code, see the help topic Site and Task Annotations for Parallel Sites with Multiple Tasks.

Click the button to copy the selected snippet to the clipboard.

Function, One or More Tasks (bounded)

View and copy an annotation code snippet for code that calls multiple functions (task parallelism). Use this structure when multiple tasks are needed within a parallel site. For example code, see the help topic Site and Task Annotations for Parallel Sites with Multiple Tasks.

Click the button to copy the selected snippet to the clipboard.

Pause/Resume Collection

View and copy an annotation code snippet whose annotations temporarily pause data collection and later resume it. This lets you skip uninteresting parts of the target program's execution to minimize the data collected and speed up the analysis of large applications. Add these annotations outside a parallel site.

Click the button to copy the selected snippet to the clipboard.

Build Settings

View and copy build settings. The Build Settings are specific to the language in use.

Click the button to copy the selected snippet to the clipboard.

Site, task, and other annotations take name arguments. You should replace the placeholder name with a name that helps you quickly identify its source location. For example, in place of MySite5 in the argument to a site annotation, replace it with a meaningful function or loop name. The name you add must be unique amongst the annotations in this project.