From fb8d1a383da0bb39465c2010d8d5a158e7490a28 Mon Sep 17 00:00:00 2001 From: Berke Viktor Date: Fri, 26 Oct 2012 01:03:52 +0200 Subject: Converting, renaming, relocating --- share/doc/HACKING | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 share/doc/HACKING (limited to 'share/doc/HACKING') diff --git a/share/doc/HACKING b/share/doc/HACKING new file mode 100644 index 00000000..5d68d0df --- /dev/null +++ b/share/doc/HACKING @@ -0,0 +1,51 @@ +Just some tips if you're going to help with HexChat code (patches etc): + +* Use tabs, not spaces, to indent code. + +* Use a tab size of 3 (most editors will let you choose this). + Type :set ts=3 in vim/gvim. + +* Try to stick to the same consistant coding style: + +void +routine (void) +{ + if (function (a, b, c)) + { + x = a + 1; + } +} + + (vertically aligned braces, a space after if, while, functions etc). + +* Don't use "//" C++ style comments, some compilers don't like them. + +* When opening a file with unix level functions (open, read/write, close) + as opposed to the C-level functions (fopen, fwrite/fread, fclose), use + the OFLAGS macro. This makes sure it'll work on Win32 aswell as unix e.g: + + fh = open ("file", OFLAGS | O_RDONLY); + +* Use closesocket() for sockets, and close() for normal files. + +* Don't read() from sockets, instead use recv(). + +* Please provide unified format diffs (run diff -u). + +* Call your patch something more meaningfull than hexchat.diff (I get a + million of these files!). + +* To make a really nice and clean patch, do something like this: + +Have two directories, unpacked from the original archive: +hexchat-2.0.0/ +hexchat-2.0.0p1/ +Then edit/compile the hexchat-2.0.0p1 directory. When you're done, make +a patch with: + +cd hexchat-2.0.0p1 +make distclean +cd .. +diff -urN hexchat-2.0.0 hexchat-2.0.0p1 > hexchat-something.diff + +If using nmake (Windows) replace "make distclean" with "nmake -f makefile.msc clean" -- cgit 1.4.1