From 02c3e75b29e5c6c7d91cf6ec4b5a759d2eba10f4 Mon Sep 17 00:00:00 2001 From: Ben Sander Date: Mon, 29 Aug 2016 18:40:23 -0500 Subject: [PATCH] Add guideline for HIP_INIT_API Change-Id: Ib8fa1e952f31158e9435dfc37ff23db9fda6fd7e --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd785fe336..060e70e519 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,6 +117,10 @@ Differences or limitations of HIP APIs as compared to CUDA APIs should be clearl - Keyword TODO refers to a note that should be addressed in long-term. Could be style issue, software architecture, or known bugs. - FIXME refers to a short-term bug that needs to be addressed. +- HIP_INIT_API() should be placed at the start of each top-level HIP API. This function will make sure the HIP runtime is initialized, + and also constructs an appropriate API string for tracing and CodeXL marker tracing. The arguments to HIP_INIT_API should match + those of the parent fucntion. + #### Presubmit Testing: Before checking in or submitting a pull request, run all Rodinia tests and ensure pass results match starting point: