From 9e9ac30af0c299680018773adcec9a6c3dc4a697 Mon Sep 17 00:00:00 2001 From: Noel Maersk Date: Thu, 6 Feb 2014 14:54:08 +0200 Subject: [PATCH] doc: KERNEL.md formatting. --- doc/KERNEL.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/doc/KERNEL.md b/doc/KERNEL.md index d7ee6a27..8cf06295 100644 --- a/doc/KERNEL.md +++ b/doc/KERNEL.md @@ -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`.