Skip to content

Commit 2930a52

Browse files
Merge branch 'gpu_through_scope_path' into 'dev'
[C++] Update description of nvtxScopeAttr_v1::path
2 parents a0d133c + b2e76fd commit 2930a52

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

c/include/nvtx3/nvToolsExtPayload.h

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -913,20 +913,23 @@ typedef struct nvtxScopeAttr_v1
913913
size_t structSize;
914914

915915
/**
916-
* Path delimited by '/' characters, relative to parentScope. Leading
916+
* Path delimited by '/' characters, relative to @ref parentScope. Leading
917917
* slashes are ignored. Nodes in the path may use name[key] syntax to
918918
* indicate an array of sibling nodes, which may be combined with other
919919
* non-array nodes or different arrays at the same scope. Node names should
920920
* be UTF8 printable characters. '\' has to be used to escape '/', '[', and
921921
* ']' characters in node names. An empty C string "" and `NULL` are valid
922922
* inputs and treated equivalently.
923923
*
924-
* A GPU can be specified using its
925-
* - unique identifier (UUID) with "GPU[UUID:#]",
924+
* A GPU can be specified using its:
925+
* - Unique identifier (UUID) with "GPU[UUID:#]",
926926
* - CUDA device ID (sensitive to CUDA_VISIBLE_DEVICES) with "GPU[CUDAID:#]",
927927
* - NVML (nvidia-smi) device ID with "GPU[NVSMI:#]"
928+
*
928929
* (replace `#` with the actual device ID).
929930
* For display purposes, a tool is recommended to show a pretty name.
931+
* To clearly identify a GPU, the @ref parentScope should also match
932+
* the GPU's execution context.
930933
*/
931934
const char* path;
932935

0 commit comments

Comments
 (0)