# Running the OpenSHMEM Tools within the Parallel Language Development Tools

1. Within the project, create a source file that includes OpenSHMEM code.
2. In the Project Explorer View, select the source file to analyze, to find the OpenSHMEM artifacts. To do this, select the source file in the Project Explorer on the left to highlight it.

   Select the "Show OpenSHMEM Artifacts" menu item in the PLDT icon menu in the tool bar.
   (Note: if it complains that a source file is not selected the first time, select it again and retry.)

   The workbench with the selection and menu item is shown below:

3. The OpenSHMEM Artifact View is opened, if it was not present. It is populated with OpenSHMEM artifacts found.

4. Double click on any line in the OpenSHMEM Artifact View to navigate the editor to that line in the source file.

5. Rows in the OpenSHMEM Artifact View can be sorted by any of the columns. Select the column heading to sort.

6. Select the "Clear OpenSHMEM Artifacts Markers" button (red X) in the tool bar of the OpenSHMEM Artifact View to remove all the OpenSHMEM artifact markers.

7. You can run the analysis on another file and its markers will be added to the view.

8. You can run the analysis on more than one file (multiple selection) or a container (folder or project), to analyze more than one file at a time. Click on a project or a folder, then select the "Show OpenSHMEM Artifacts" action to run it on all C source files in that folder.

9. Hover Help
   In the editor, hover over an OpenSHMEM api and a popup box shows details of that API.

10. Content Assist
    Type an incomplete OpenSHMEM function name e.g. "shmem_" and hit Ctrl-Space. The information that is shown is populated with CDT completions including argument types, but in addition, the PTP-OpenSHMEM tools also provide specific information about actual OpenSHMEM functions where appropriate, and a yellow popup with additional textual descriptive information about the function. Pick the one you want with the arrow keys or the mouse, to add the API to your source file.

11. Context sensitive help
    Also, if F1 is pressed when the cursor is within a function name, a help view appears which shows additional information. (In Linux press Ctrl-F1; in Mac Use Help button or use menu Help > Dynamic Help)

    Click on the link to navigate to the doc file for that API.

Back to Top | Back to Table of Contents