tycho / xchat-aqua

X-Chat Aqua for Mac OS X

This URL has Read+Write access

xchat-aqua / HACKING
100644 51 lines (35 sloc) 1.42 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
Just some tips if you're going to help with xchat 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 xchat.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:
xchat-2.0.0/
xchat-2.0.0p1/
Then edit/compile the xchat-2.0.0p1 directory. When you're done, make
a patch with:
 
cd xchat-2.0.0p1
make distclean
cd ..
diff -urN xchat-2.0.0 xchat-2.0.0p1 > xchat-something.diff
 
If using nmake (Windows) replace "make distclean" with "nmake -f makefile.msc clean"