Browse Source

doc: update doc/KERNEL.md to reflect the fact that kernel names are no longer hard-coded.

build-mingw
Noel Maersk 11 years ago
parent
commit
9b68b2773c
  1. 15
      doc/KERNEL.md

15
doc/KERNEL.md

@ -13,7 +13,7 @@ In general, switching kernels requires reconfiguring mining parameters, @@ -13,7 +13,7 @@ In general, switching kernels requires reconfiguring mining parameters,
such as (but not necessarily limited to) `thread-concurrency`, `intensity`,
`gpu-engine` and `gpu-memclock`.
A description of how to do this is available in `doc/MINING`.
A description of how to do this is available in `doc/MINING.md`.
### alexkarnew
@ -53,7 +53,7 @@ Pavel Semjanov optimised kernel, SHA256 speedups. @@ -53,7 +53,7 @@ Pavel Semjanov optimised kernel, SHA256 speedups.
Zuikkis' optimised kernel, based on `ckolivas`.
Only supports `vectors=1`, `lookup-gap=2` and `worksize=256`.
Only supports `vectors=1` and `lookup-gap=2`.
[Announcement](https://litecointalk.org/index.php?topic=6058.msg90873#msg90873).
@ -70,8 +70,8 @@ Only supports `vectors=1`, `lookup-gap=2` and `worksize=256`. @@ -70,8 +70,8 @@ Only supports `vectors=1`, `lookup-gap=2` and `worksize=256`.
### Procedure
* Copy the kernel you wish to modify, change the file encoding to UTF-8
and commit it without any further modifications.
* Copy the kernel you wish to modify, make sure the character encoding is
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.
@ -80,13 +80,6 @@ the commit message which kernel is used as a base. @@ -80,13 +80,6 @@ the commit message which kernel is used as a base.
This allows to produce a diff that makes sense.
* 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.
* Recompile and test that the kernel actually works.
* Add yourself to the "kernels" section in `AUTHORS.md`. Keep it short.

Loading…
Cancel
Save