Files
Gopesh Bhardwaj 43eaa1d127 [Documentation] Quick reference guide for rocprofv3 (#953)
* quick reference guide for rocprofv3

* Addressed feedback and updated with rocpd information

* rocpd docs update

* rocpd query option

* Addressing feedback

* Fixed misssing newline

* Addressing feedback

* Addressing feedback

* Addressing feedback

* Addressing feedback

* Adding process attachment
2025-10-10 09:36:28 +05:30

98 строки
4.3 KiB
Plaintext

# Anywhere {branch} is used, the branch name will be substituted.
# These comments will also be removed.
defaults:
numbered: false
maxdepth: 4
root: index
subtrees:
- caption: Install
entries:
- file: install/installation
- caption: Quick Reference
entries:
- file: quick_guide
title: ROCprofiler-SDK Quick Reference Guide
- caption: How to
entries:
- file: how-to/samples
title: Samples
- file: how-to/using-rocprofv3
- file: how-to/using-rocprofv3-avail
- file: how-to/using-rocprofv3-process-attachment
- file: how-to/using-rocpd-output-format
- file: how-to/using-rocprofiler-sdk-roctx
- file: how-to/using-rocprofv3-with-mpi
- file: how-to/using-rocprofv3-with-openmp
- file: how-to/using-pc-sampling
- file: how-to/using-thread-trace
- caption: API reference
entries:
- file: api-reference/tool_library
title: Tool library
- file: api-reference/intercept_table
title: Runtime intercept tables
- file: api-reference/process_attachment
title: Process attachment
- file: api-reference/buffered_services
title: Buffered services
- file: api-reference/callback_services
title: Callback tracing services
- file: api-reference/counter_collection_services
title: Counter collection services
- file: api-reference/pc_sampling
title: PC sampling
- file: api-reference/thread_trace
title: Thread trace and ROCprof Trace Decoder
- file: api-reference/rocprofiler-sdk_api_reference
subtrees:
- entries:
- file: api-reference/rocprofiler-sdk_api/modules
subtrees:
- entries:
- file: api-reference/rocprofiler-sdk_api/modules/agent_information
- file: api-reference/rocprofiler-sdk_api/modules/buffer_handling
- file: api-reference/rocprofiler-sdk_api/modules/buffer_tracing
- file: api-reference/rocprofiler-sdk_api/modules/callback_tracing
- file: api-reference/rocprofiler-sdk_api/modules/context_management
- file: api-reference/rocprofiler-sdk_api/modules/counter_config
- file: api-reference/rocprofiler-sdk_api/modules/counters
- file: api-reference/rocprofiler-sdk_api/modules/device_counting_service
- file: api-reference/rocprofiler-sdk_api/modules/dispatch_counting_service
- file: api-reference/rocprofiler-sdk_api/modules/external_correalation
- file: api-reference/rocprofiler-sdk_api/modules/intercept_table
- file: api-reference/rocprofiler-sdk_api/modules/internal_threading_management
- file: api-reference/rocprofiler-sdk_api/modules/ompt_registration
- file: api-reference/rocprofiler-sdk_api/modules/pc_sampling_service
- file: api-reference/rocprofiler-sdk_api/modules/thread_trace
- file: api-reference/rocprofiler-sdk_api/modules/tool_registration
- file: api-reference/rocprofiler-sdk_api/global_data_structures_topics_files
subtrees:
- entries:
- file: api-reference/rocprofiler-sdk_api/global_data_structures_topics_files/global_basic_data_types
- file: _doxygen/rocprofiler-sdk/html/topics
- file: _doxygen/rocprofiler-sdk/html/annotated
- file: _doxygen/rocprofiler-sdk/html/files
- file: api-reference/rocprofiler-sdk-roctx_api_reference
subtrees:
- entries:
- file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules
subtrees:
- entries:
- file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/markers
- file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/ranges
- file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/profiler-control
- file: api-reference/rocprofiler-sdk-roctx_api/roctx_modules/naming-utilities
- file: api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files
subtrees:
- entries:
- file: api-reference/rocprofiler-sdk-roctx_api/global_roctx_data_structures_topics_files/global_roctx_basic_data_types
- file: _doxygen/roctx/html/topics
- file: _doxygen/roctx/html/files
- caption: Conceptual
entries:
- file: conceptual/comparing-with-legacy-tools
- caption: License
entries:
- file: license