Update documentation (#53)

- updated info about OMNITRACE_USE_MPI
- removed wiki links
- info about metadata.json
- update HW counters and fix typos
- fix update-docs.sh

[ROCm/rocprofiler-systems commit: bab90baf0b]
Dieser Commit ist enthalten in:
Jonathan R. Madsen
2022-05-08 02:51:35 -05:00
committet von GitHub
Ursprung 060da8159c
Commit 0094a471fd
5 geänderte Dateien mit 571 neuen und 187 gelöschten Zeilen
@@ -149,9 +149,9 @@ source ${OMNITRACE_ROOT}/share/omnitrace/setup-env.sh
#### MPI Support within Omnitrace
[Omnitrace](https://github.com/AMDResearch/omnitrace) can have full (`OMNITRACE_USE_MPI=ON`) or partial (`OMNITRACE_USE_MPI_HEADERS=ON`) MPI support.
The only difference between these two modes is whether or not the results collected via timemory can be aggregated into one output file. The primary
benefits of partial or full MPI support are the automatic wrapping of MPI functions and the ability to label output with suffixes which correspond to the
`MPI_COMM_WORLD` rank ID instead of using the system process identifier (i.e. PID).
The only difference between these two modes is whether or not the results collected via timemory and/or perfetto can be aggregated into a single
output file during finalization. The primary benefits of partial or full MPI support are the automatic wrapping of MPI functions and the ability
to label output with suffixes which correspond to the `MPI_COMM_WORLD` rank ID instead of using the system process identifier (i.e. PID).
In general, it is recommended to use partial MPI support with the OpenMPI headers as this is the most portable configuration.
If full MPI support is selected, make sure your target application is built against the same MPI distribution as omnitrace,
i.e. do not build omnitrace with MPICH and use it on a target application built against OpenMPI.