GOSTSec/sgminer
1
0
Fork 0
mirror of https://github.com/GOSTSec/sgminer synced 2025-01-10 06:48:05 +00:00
Code Issues Releases Wiki Activity
35a23942b1
sgminer/doc/KERNEL.md
Noel Maersk 2f1fafedb9 doc: skeleton KERNEL documentation. 
On how to submit new kernels. This should allow a broad community review.
2014-01-21 16:28:43 +02:00

939 B
Raw Blame History

Kernels

Available OpenCL kernels

See directory kernel.

Submitting new kernels

Requirements

TODO

Procedure

  1. Copy the kernel you wish to modify and commit it verbatim.

This way, it is easy to verify that there are no hidden changes. Note in the commit message which kernel is used as a base.

  1. Make changes to the kernel. Commit them.

This way, it can be easily shown what was changed.

  1. Search for KL_CKOLIVAS and CKOLIVAS_KERNNAME in the top-level source directory and make additions to the listed files in order to integrate the new kernel.

Now it can be selected when starting via the --kernel argument or kernel configuration option.

  1. Add yourself to the "kernels" section in AUTHORS.md. Keep it short.

  2. Submit a pull request on GitHub, or file it at the issue tracker, listing your git repository and branch name. The current repository and issue tracker links should be in README.md.