-
Notifications
You must be signed in to change notification settings - Fork 55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Hipcc docs #69
Hipcc docs #69
Conversation
Closing and reopening this PR to retrigger doc builds |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. But there is a small change we will need in regard to the hipcc/hipconfig C++/Perl scripts.
``hipcc`` is a compiler driver utility that will call clang or nvcc, depending on target, and pass the appropriate include and library options for the target compiler and HIP infrastructure. | ||
|
||
There is both a Perl version, and a C++ executable version of the ``hipcc`` and ``hipconfig`` compiler driver utilities provided. By default the Perl version is used when ``hipcc`` is run. To enable the C++ versions, set the environment variable ``HIP_USE_PERL_SCRIPTS=0``. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For ROCm 6.2, hipcc and hipconfig will default to use the C++ versions instead of the Perl versions - the opposite of what we have here and what was done in previous releases. So, can we change the wording to something like this:
In ROCm 6.2, the C++ executables "hipcc.bin" and "hipconfig.bin" will be invoked by default whenever "hipcc" or "hipconfig" are called, respectively. To have the Perl versions called instead, set the environment variable "HIP_USE_PERL_SCRIPTS=1" before calling "hipcc" or "hipconfig".
The Perl versions of the scripts are deprecated, and will be removed in a future ROCm release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want, we can use this PR in 6.1.1, and I can change it for 6.2 as you have indicated. If you just want to use this for 6.2 I will change it as requested.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change, in default behaviour, is only for ROCm 6.2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, so we can use this change (doc restructuring) as-is for ROCm 6.1.1. And change the wording for ROCm 6.2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can make the wording change about default behaviour of hipcc/hipconfig using C++ binaries, for ROCm 6.2. But this change, restructuring of the docs, is good for ROCm 6.1.1.
Reorganized docs for consistent presentation
Combined Build and Test topics
Added links