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

[DOC]: List compiler support matrix in README #1967

Closed
1 task done
bernhardmgruber opened this issue Jul 10, 2024 · 6 comments · Fixed by #1970
Closed
1 task done

[DOC]: List compiler support matrix in README #1967

bernhardmgruber opened this issue Jul 10, 2024 · 6 comments · Fixed by #1970
Labels
doc Documentation-related items.

Comments

@bernhardmgruber
Copy link
Contributor

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

We should explicitly list the supported compilers for CCCL in the README's corresponding section.

Currently, the README refers to the CTK documentation for host compiler support, but the oldest supported CTK 11.1 is fairly vague. For example, it specifies that "the minimum recommended GCC compiler is at least GCC 5", suggestion that g++ below 5 is also somewhat supported. However, we have no devcontainers nor CI runs for g++ below 6, suggesting support for g++ 4.x and 5.x is partial, untested, ... ?

Ideally, we could add a table like the one in CTK 12.5. Maintenance of that table should be rare, but must be done each time support for a CTK is added or removed. However, IMO the benefit of being explicit and easily discoverable outweights that cost.

Adding warnings to cmake or compilation when an unsupported compiler is used could be a follow-up step, but this is not proposed by this issue.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

@jrhemstad
Copy link
Collaborator

I really don't want to have to maintain this table. This is the kind of thing that immediately goes out of date. The table from the CTK should be the source of truth.

@bernhardmgruber
Copy link
Contributor Author

@jrhemstad so, what's the minimum g++ version we support?

@wmaxey
Copy link
Member

wmaxey commented Jul 10, 2024

@jrhemstad We can't support what the CTK supports as we don't test everything the compiler supports. q++ on QNX or GCC 4-5 for example.

bernhardmgruber added a commit to bernhardmgruber/cccl that referenced this issue Jul 10, 2024
bernhardmgruber added a commit to bernhardmgruber/cccl that referenced this issue Jul 10, 2024
@jrhemstad
Copy link
Collaborator

@jrhemstad
Copy link
Collaborator

@jrhemstad We can't support what the CTK supports as we don't test everything the compiler supports. q++ on QNX or GCC 4-5 for example.

Why do we think the CTK supports gcc4-5?

QNX is a special case that I'm content to ignore for the time being.

@bernhardmgruber
Copy link
Contributor Author

bernhardmgruber commented Jul 11, 2024

@jrhemstad We can't support what the CTK supports as we don't test everything the compiler supports. q++ on QNX or GCC 4-5 for example.

Why do we think the CTK supports gcc4-5?

Because CCCL supports CTK 11.1, which supports GCC 4 and 5. The matrix you posted is from CTK 12.5. Are you telling me we only support what the latest CTK supports?

bernhardmgruber added a commit to bernhardmgruber/cccl that referenced this issue Jul 11, 2024
Fixes: NVIDIA#1967

Co-authored-by: Jake Hemstad <[email protected]>
bernhardmgruber added a commit to bernhardmgruber/cccl that referenced this issue Jul 11, 2024
Fixes: NVIDIA#1967

Co-authored-by: Jake Hemstad <[email protected]>
jrhemstad added a commit that referenced this issue Jul 11, 2024
Fixes: #1967

Co-authored-by: Jake Hemstad <[email protected]>
pciolkosz pushed a commit to pciolkosz/cccl that referenced this issue Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants