need complete and documented plugin example included in source/docs
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 16
- Forks
- 7
- Avg merge
- 6h 34m
- Merged PRs (30d)
- 3
Description
The adiak plugin interface needs a complete documented example included showing:
- what a plugin must and might do (and when, in lifecycle terms).
- what threading contract the plugin must comply with (looks like adiak is by design single-threaded, but I don't find it stated anywhere). e.g. will it be called from inside openmp non-gpu threads? pthreads?
It's not clear to me if tests/testlib.c is a plugin demo or if it is complete wrt both how a plugin is called and what other things in the adiak api a plugin can call.
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 with the plugin interface and the existing tests/testlib.c example, then inspect source/docs for the current API and lifecycle guidance. Determine what a plugin must and may do, including its threading contract and callable Adiak APIs. Done means source/docs contains a complete documented plugin example that resolves these questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, cpp
- Domain
- documentation, hpc
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100