[Documentation]: hipamd/src/hip_prof_gen.py no explanation of its use.

[AphidGit]

Description of errors

I can't find how this script is used. It assumes some ubuntu defaults which makes hip non-compile-able on other platforms.

In particular, the parameter "OPT_PROF_API" I'm having a hard time finding. Exactly what should its value be?
It's called effectively like so, I believe;

python $BASEDIR/09_hip/clr/hipamd/src/hip_prof_gen.py -v ${OPT_PROF_API} ${PROF_API_HDR} ${PROF_API_SRC} ${PROF_API_STR} >${PROF_API_LOG}

Then, I specified the following, intending to use rocprofiler as profile API;

OPT_PROF_API="/opt/rocm/include/rocprofiler/rocprofiler.h "
PROF_API_STR="$BASEDIR/09_hip/clr/hipamd/include/hip/amd_detail/hip_prof_str.h"
PROF_API_HDR="$BASEDIR/09_hip/hip/include/hip/hip_runtime_api.h"
PROF_API_SRC="$BASEDIR/09_hip/clr/hipamd/src" 
PROF_API_LOG="$BASEDIR/09_hip/build/hip_prof_gen_log.txt"

But this fails to do the right thing, producing a malformed header file as it spits out this warning message:

/home/aphid/src/rocm/09_hip/clr/hipamd/src/hip_prof_gen.py Warning: src directory /home/aphid/src/rocm/09_hip/hip/include/hip/hip_runtime_api.h' not found

Clearly, the order of arguments is wrong or the arguments are badly specified or badly named. Now, I can analyze the code and try to piece back together exactly what the parameters should be, but expecting everyone who compiles it to do that work is a bit much...

Could this script get a standard linux/unix -h function that explains its use, and, in particular, what each parameter is. Or a man page. Ideally, include an example, in particular the standard way it's used within the cmake of hip/clr.

Attach any links, screenshots, or additional evidence you think will be helpful.

No response

[ppanchad-amd]

@AphidGit Internal ticket has been created to fix documentation. Thanks!