Documentation Updates (#470)

* Updating installation doc * updating README * Addressing Yifan's feedback * trivial updates * Added limitation for individual xcc in readme * Added rocprofv3 page * README updates * Updating rocprofv3 * source formatting (clang-format v11) (#538) Co-authored-by: bgopesh <7112102+bgopesh@users.noreply.github.com> * Merging documentation team's update * Update source/docs/installation.md Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: bgopesh <7112102+bgopesh@users.noreply.github.com> Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com> [ROCm/rocprofiler-sdk commit: 665c546e65]
2024-03-08 08:35:16 +05:30
parent d820cf3018
commit 1295c42022
12 changed files with 581 additions and 57 deletions
@@ -0,0 +1,38 @@
+# Samples
+
+## Running Samples
+
+```eval_rst
+.. toctree::
+   :glob:
+   :maxdepth: 4
+```
+
+Samples and tool can be run in order to see the profiler in action. This section covers on how to build these samples and run the tool.
+Once the rocm build is installed, samples are installed under:
+
+```bash
+/opt/rocm/share/rocprofiler-sdk/samples
+```
+
+rocprofv3 tool is installed under:
+
+```bash
+/opt/rocm/bin
+```
+
+### Building Samples
+
+From any directory, run:
+
+```bash
+cmake -B build-rocprofiler-sdk-samples /opt/rocm/share/rocprofiler-sdk/samples -DCMAKE_PREFIX_PATH=/opt/rocm
+cmake --build build-rocprofiler-sdk-samples --target all --parallel 8
+
+
+### Running samples
+
+To run the built samples, cd into the `build-rocprofiler-sdk-samples` directory and run:
+
+```bash
+ctest -V