moparisthebest/hexchat
1
0
Fork 0
mirror of https://github.com/moparisthebest/hexchat synced 2024-11-26 11:12:19 -05:00
Code Issues Releases Wiki Activity

Convert HACKING to Markdown format

Browse Source
This commit is contained in:
Berke Viktor 2012-10-27 19:31:51 +02:00
parent 29c5385d6e
commit d33a16ae01
2 changed files with 59 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
share/doc/HACKING
View File

@ -1,51 +0,0 @@
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"

59
share/doc/hacking.md Normal file
View File

@ -0,0 +1,59 @@
# HexChat Hacking Guidelines
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:
<pre>void
routine (void)
{
if (function (a, b, c))
{
x = a + 1;
}
}</pre>
(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.:
<pre>fh = open ("file", OFLAGS | O_RDONLY);</pre>
* Use closesocket() for sockets, and close() for normal files.
* Don't read() from sockets, use recv() instead.
* Please provide unified format diffs (run diff -u).
* Call your patch something more meaningfull than hexchat.diff.
* To make a really nice and clean patch, do something like this:
* Have two directories, unpacked from the original archive:
<pre>hexchat-2.9.0/
hexchat-2.9.0p1/</pre>
* Then edit/compile the hexchat-2.9.0p1 directory. To create a patch:
* Windows:
<pre>rmdir /q /s hexchat-2.9.0p1/win32/build
rmdir /q /s hexchat-2.9.0p1/win32/build-xp
diff -ruN --strip-trailing-cr hexchat-2.9.0 hexchat-2.9.0p1 > hexchat-something.diff
</pre>
* Unix:
<pre>diff -ruN hexchat-2.9.0 hexchat-2.9.0p1 > hexchat-something.diff</pre>