Repository navigation
[Documentaion] updating roctx library linkage documentation #2251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -13,6 +13,10 @@ In certain situations, such as debugging performance issues in large-scale GPU p | |||||||||||||||||||
| In such cases, it is helpful to define specific tasks to be traced. To specify the tasks for tracing, enclose the respective source code with the API calls provided by the ROCTx library. | ||||||||||||||||||||
| This process is also known as instrumentation. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| To use ``rocprofv3`` for marker tracing, including and linking to old ``ROCTx`` works but it's recommended to switch to the new ``ROCTx`` to utilize new APIs. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||
| To use the new ``ROCTx``, include header ``"rocprofiler-sdk-roctx/roctx.h"`` and link your application with ``librocprofiler-sdk-roctx.so``. | ||||||||||||||||||||
| To see the complete list of ``ROCTx`` APIs, see public header file ``"rocprofiler-sdk-roctx/roctx.h"``. | ||||||||||||||||||||
|
|
||||||||||||||||||||
|
Comment on lines
+17
to
+19
|
||||||||||||||||||||
| To use the new ``ROCTx``, include header ``"rocprofiler-sdk-roctx/roctx.h"`` and link your application with ``librocprofiler-sdk-roctx.so``. | |
| To see the complete list of ``ROCTx`` APIs, see public header file ``"rocprofiler-sdk-roctx/roctx.h"``. | |
| To use the new ``ROCTx``, include the header ``"rocprofiler-sdk-roctx/roctx.h"`` and link your application with ``librocprofiler-sdk-roctx.so``. If the library is not in a standard location (such as `/usr/lib` or `/usr/local/lib`), specify the library path during linking using the ``-L`` flag, for example: | |
| .. code-block:: bash | |
| g++ your_source.cpp -I/path/to/rocprofiler-sdk-roctx/include -L/path/to/rocprofiler-sdk-roctx/lib -lrocprofiler-sdk-roctx | |
| To see the complete list of ``ROCTx`` APIs, see the public header file ``"rocprofiler-sdk-roctx/roctx.h"``. |
Uh oh!
There was an error while loading. Please reload this page.