moparisthebest
/
pacman
mirror of https://github.com/moparisthebest/pacman
1
0
Fork 0
Code Issues Releases Wiki Activity

Spruce up HACKING a bit 

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Dan McGee 2007-11-19 15:46:02 -06:00
parent 84ebf82319
commit 4576000c39
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
HACKING
View File

@ -1,21 +1,23 @@
Contributing to pacman Contributing to pacman
====================== ======================
Please read 'submitting-patches' and 'translation-help' in the same directory In addition to this file, please read 'submitting-patches' and
as this file. 'translation-help' in the same directory for additional info on contributing.
Coding style Coding style
------------ ------------
1. All code should be indented with tabs. (Ignore the use of only spaces in 1. All code should be indented with tabs. (Ignore the use of only spaces in
this file) By default, source files contain the following VIM modeline: this file) By default, source files contain the following VIM modeline:
/* vim: set ts=2 sw=2 noet: */ /* vim: set ts=2 sw=2 noet: */
2. When opening new blocks such as 'while', 'if', or 'for', leave the opening 2. When opening new blocks such as 'while', 'if', or 'for', leave the opening
brace on the same line as the beginning of the codeblock. The closing brace brace on the same line as the beginning of the codeblock. The closing brace
gets its own line (the only exception being 'else'). Do not use extra gets its own line (the only exception being 'else'). Do not use extra
spaces around the parentheses of the block. ALWAYS use opening/closing spaces around the parentheses of the block. ALWAYS use opening/closing
braces, even if it's just a one-line block. braces, even if it's just a one-line block. This reduces future error when
blocks are expanded beyond one line.
for(lp = list; lp; lp = lp->next) { for(lp = list; lp; lp = lp->next) {
newlist = _alpm_list_add(newlist, strdup(lp->data)); newlist = _alpm_list_add(newlist, strdup(lp->data));
@ -36,18 +38,22 @@ Coding style
own line. Also, when declaring a pointer, do not put a space between the own line. Also, when declaring a pointer, do not put a space between the
asterisk and the variable name. asterisk and the variable name.
pmlist_t *_alpm_list_add(pmlist_t *list, void *data) alpm_list_t *alpm_list_add(alpm_list_t *list, void *data)
{ {
pmlist_t *ptr, *lp; alpm_list_t *ptr, *lp;
ptr = list; ptr = list;
if(ptr == NULL) { if(ptr == NULL) {
... ...
} }
4. Comments should be ANSI-C89 compliant. That means no "// Comment" style; 4. Comments should be ANSI-C89 compliant. That means no "// Comment" style;
use only "/* Comment */" style. use only "/* Comment */" style.
/* This is a comment */
NOT
// This is a comment
5. Return statements should be written like a function call. 5. Return statements should be written like a function call.
return(0); return(0);
@ -62,6 +68,16 @@ Coding style
NOT NOT
sizeof(*mylist); sizeof(*mylist);
7. When using strcmp() (or any function that returns 0 on success) in a
conditional statement, use != 0 or == 0 and not the negation (!) operator.
It reads much cleaner for humans (using a negative to check for success is
confusing) and the compiler will treat it correctly anyway.
if(strcmp(a, b) == 0)
NOT
if(!strcmp(a, b))
Other Concerns Other Concerns
-------------- --------------