Skip to content
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

Merged
merged 4 commits into from
May 3, 2024
Merged

Hipcc docs #69

merged 4 commits into from
May 3, 2024

Conversation

randyh62
Copy link

@randyh62 randyh62 commented May 1, 2024

Reorganized docs for consistent presentation
Combined Build and Test topics
Added links

@randyh62 randyh62 added the documentation Improvements or additions to documentation label May 1, 2024
@randyh62 randyh62 requested review from samjwu and searlmc1 May 1, 2024 23:06
@samjwu
Copy link
Member

samjwu commented May 2, 2024

Closing and reopening this PR to retrigger doc builds

@samjwu samjwu closed this May 2, 2024
@samjwu samjwu reopened this May 2, 2024
Copy link

@david-salinas david-salinas left a 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``.

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.

Copy link
Author

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.

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.

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.

Copy link

@david-salinas david-salinas left a 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.

@randyh62 randyh62 merged commit e51d33a into amd-staging May 3, 2024
3 of 4 checks passed
@samjwu samjwu deleted the hipcc_docs branch May 3, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants