From 6d3a5b3c5b0e25a9768a3a3d440e871fdb9032b3 Mon Sep 17 00:00:00 2001 From: Jan Frenzel <jan.frenzel@tu-dresden.de> Date: Mon, 22 Nov 2021 11:01:37 +0100 Subject: [PATCH] Removed "click here" links from papi.md. --- doc.zih.tu-dresden.de/docs/software/papi.md | 29 ++++++++++----------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/software/papi.md b/doc.zih.tu-dresden.de/docs/software/papi.md index 9d96cc58f..2de80b4e8 100644 --- a/doc.zih.tu-dresden.de/docs/software/papi.md +++ b/doc.zih.tu-dresden.de/docs/software/papi.md @@ -20,8 +20,8 @@ To collect performance events, PAPI provides two APIs, the *high-level* and *low The high-level API provides the ability to record performance events inside instrumented regions of serial, multi-processing (MPI, SHMEM) and thread (OpenMP, Pthreads) parallel applications. It is -designed for simplicity, not flexibility. For more details click -[here](https://bitbucket.org/icl/papi/wiki/PAPI-HL.md). +designed for simplicity, not flexibility. More details can be found in the +[PAPI wiki High-Level API description](https://bitbucket.org/icl/papi/wiki/PAPI-HL.md). The following code example shows the use of the high-level API by marking a code section. @@ -86,19 +86,19 @@ more output files in JSON format. ### Low-Level API -The low-level API manages hardware events in user-defined groups -called Event Sets. It is meant for experienced application programmers and tool developers wanting -fine-grained measurement and control of the PAPI interface. It provides access to both PAPI preset -and native events, and supports all installed components. For more details on the low-level API, -click [here](https://bitbucket.org/icl/papi/wiki/PAPI-LL.md). +The low-level API manages hardware events in user-defined groups called Event Sets. It is meant for +experienced application programmers and tool developers wanting fine-grained measurement and +control of the PAPI interface. It provides access to both PAPI preset and native events, and +supports all installed components. The PAPI wiki contains also a page with more details on the +[low-level API](https://bitbucket.org/icl/papi/wiki/PAPI-LL.md). ## Usage on ZIH Systems Before you start a PAPI measurement, check which events are available on the desired architecture. -For this purpose PAPI offers the tools `papi_avail` and `papi_native_avail`. If you want to measure +For this purpose, PAPI offers the tools `papi_avail` and `papi_native_avail`. If you want to measure multiple events, please check which events can be measured concurrently using the tool -`papi_event_chooser`. For more details on the PAPI tools click -[here](https://bitbucket.org/icl/papi/wiki/PAPI-Overview.md#markdown-header-papi-utilities). +`papi_event_chooser`. The PAPI wiki contains more details on +[the PAPI tools](https://bitbucket.org/icl/papi/wiki/PAPI-Overview.md#markdown-header-papi-utilities). !!! hint @@ -133,8 +133,7 @@ compile your application against the PAPI library. !!! hint The PAPI modules on ZIH systems are only installed with the default `perf_event` component. If you - want to measure, e.g., GPU events, you have to install your own PAPI. Instructions on how to - download and install PAPI can be found - [here](https://bitbucket.org/icl/papi/wiki/Downloading-and-Installing-PAPI.md). To install PAPI - with additional components, you have to specify them during configure, for details click - [here](https://bitbucket.org/icl/papi/wiki/PAPI-Overview.md#markdown-header-components). + want to measure, e.g., GPU events, you have to install your own PAPI. Please see the + [external instructions on how to download and install PAPI](https://bitbucket.org/icl/papi/wiki/Downloading-and-Installing-PAPI.md). + To install PAPI with additional components, you have to specify them during configure as + described for the [Installation of Components](https://bitbucket.org/icl/papi/wiki/PAPI-Overview.md#markdown-header-components). -- GitLab