llvm / llvm/offload-test-suite
Document how to run tests against golden images
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 18
- Forks
- 39
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 40
Description
We don't currently document the existence of https://github.com/llvm/offload-golden-images or how to use it with the offload test suite at all. We should correct this.
Note: We should probably rename the `GOLDENIMAGE_DIR` cmake flag to something like `OFFLOAD_TEST_GOLDENIMAGE_DIR` while we do this - the current one could easily collide with something in the future.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the offload test suite documentation and all uses of the GOLDENIMAGE_DIR CMake flag. Read the llvm/offload-golden-images repository instructions and the test-suite entry points to document how golden images are obtained and used. Done means the workflow is documented and the flag rename, if made, is applied consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cmake, cpp
- Domain
- build-system, documentation, testing
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100