GOSTSec/sgminer
1
0
Fork 0
mirror of https://github.com/GOSTSec/sgminer synced 2025-01-08 22:08:02 +00:00
Code Issues Releases Wiki Activity

doc: KERNEL.md formatting.

Browse Source
This commit is contained in:
Noel Maersk 2014-02-06 14:54:08 +02:00
parent 4300e42aa8
commit 9e9ac30af0
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/KERNEL.md
View File

@ -64,33 +64,36 @@ Only supports `vectors=1`, `lookup-gap=2` and `worksize=256`.
* OpenCL source code only, licenced under GPLv3 (or later).
* Not hard-coded for a specific GPU model or manufacturer.
* Known limitations and any specific configuration quirks must be mentioned.
* Known limitations and any specific configuration quirks must be
mentioned.
### Procedure
1. Copy the kernel you wish to modify, change the file encoding to UTF-8
* Copy the kernel you wish to modify, change the file encoding to UTF-8
and commit it without any further modifications.
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.
2. Make changes to the kernel. Commit them.
* Make changes to the kernel. Commit them.
This allows to produce a diff that makes sense.
3. Search for KL_CKOLIVAS and CKOLIVAS_KERNNAME in the top-level source
* 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.
4. Recompile and test that the kernel actually works.
* Recompile and test that the kernel actually works.
5. Add yourself to the "kernels" section in `AUTHORS.md`. Keep it short.
* Add yourself to the "kernels" section in `AUTHORS.md`. Keep it short.
6. Submit a pull request on GitHub, or file it at the issue tracker,
outlining the changes made, known limitations, and tested GPUs. List
* Submit a pull request on GitHub, file it at the issue tracker, or mail
it.
Outline the changes made, known limitations, and tested GPUs. List
your git repository and branch name. The current repository and issue
tracker links should be in `README.md`.