NVIDIA / NVIDIA/cuCollections

[FEA] Add tests to verify headers are standalone

Open
#159 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue P1: Should have topic: build type: feature request
Dominant language
Cuda
Stars
667
Forks
120
Avg merge
7d 5h
Merged PRs (30d)
4

Description

Is your feature request related to a problem? Please describe.

After @PointKernel's excellent work in https://github.com/NVIDIA/cuCollections/pull/141 to ensure each cuco header is standalone, we should add some tests to ensure they stay that way.

Describe the solution you'd like

@allisonvacanti pointed out the fact that Thrust does this by simply including each header in an otherwise empty .cu file and ensuring it compiles. We should steal what they do.

See

CMake: https://github.com/NVIDIA/thrust/blob/main/cmake/ThrustHeaderTesting.cmake

Configured header: https://github.com/NVIDIA/thrust/blob/main/cmake/header_test.in

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Thrust CMake header-testing implementation and its header_test.in template. Add equivalent tests for cuCollections so each cuco header is included in an otherwise empty .cu file and compiles successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.