From fd9da7dc43e57d79b22aec3e009b2d2ff3c95bc7 Mon Sep 17 00:00:00 2001 From: "Nagaraj, Sriraksha" Date: Fri, 6 Dec 2024 17:41:28 -0600 Subject: [PATCH] Updating rocprofv3 doc for pc sampling beta option (#59) * Updating rocprofv3 doc for pc sampling beta option * Update source/docs/rocprofv3_input_schema.json * Update using-rocprofv3.rst --------- Co-authored-by: Elwazir, Ammar [ROCm/rocprofiler-sdk commit: c509fe799d32c84df669ae73c586f6c5df39c802] --- .../rocprofiler-sdk/source/docs/how-to/using-rocprofv3.rst | 6 ++++++ .../rocprofiler-sdk/source/docs/rocprofv3_input_schema.json | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/projects/rocprofiler-sdk/source/docs/how-to/using-rocprofv3.rst b/projects/rocprofiler-sdk/source/docs/how-to/using-rocprofv3.rst index 4236337629..edf173e335 100644 --- a/projects/rocprofiler-sdk/source/docs/how-to/using-rocprofv3.rst +++ b/projects/rocprofiler-sdk/source/docs/how-to/using-rocprofv3.rst @@ -161,6 +161,10 @@ Here is the sample of commonly used ``rocprofv3`` command-line options. Some opt * - ``--perfetto-shmem-size-hint KB`` - Perfetto shared memory size hint in KB. default: 64 KB - Extension + + * - ``--pc-sampling-beta-enabled`` + - pc sampling support is in beta version + - This flag set the ROCPROFILER_PC_SAMPLING_BETA_ENABLED environment variable * - ``--pc-sampling-method`` - Type of PC Sampling, currently only host trap method is supported @@ -759,6 +763,8 @@ Properties - **``pc_sampling_unit``** *(string)*: pc sampling unit. - **``pc_sampling_method``** *(string)*: pc sampling method. - **``pc_sampling_interval``** *(integer)*: pc sampling interval. + - **``pc-sampling-beta-enabled``** *(boolean)*: enable pc + sampling support; beta version. .. code-block:: shell diff --git a/projects/rocprofiler-sdk/source/docs/rocprofv3_input_schema.json b/projects/rocprofiler-sdk/source/docs/rocprofv3_input_schema.json index 63eb21ef79..c32c3f4f40 100644 --- a/projects/rocprofiler-sdk/source/docs/rocprofv3_input_schema.json +++ b/projects/rocprofiler-sdk/source/docs/rocprofv3_input_schema.json @@ -156,6 +156,10 @@ "pc_sampling_interval": { "type": "integer", "description": "pc sampling interval" + }, + "pc-sampling-beta-enabled": { + "type": "boolean", + "description": "enable pc sampling support; beta version" } } }