HACKING

   1 Pacman - Contributing
   2 =====================
   3
   4 This file is meant to give you a brief overview of coding style and other
   5 concerns when hacking on pacman. If you are interested in contributing, please
   6 read link:submitting-patches.html[submitting-patches] and
   7 link:translation-help.html[translation-help] as well.
   8
   9 Coding style
  10 ------------
  11
  12 1.  All code should be indented with tabs. (Ignore the use of only spaces in
  13     this file) By default, source files contain the following VIM modeline:
  14 +
  15 [source,C]
  16 -------------------------------------------
  17 /* vim: set ts=2 sw=2 noet: */
  18 -------------------------------------------
  19
  20 2.  When opening new blocks such as 'while', 'if', or 'for', leave the opening
  21     brace on the same line as the beginning of the codeblock. The closing brace
  22     gets its own line (the only exception being 'else'). Do not use extra
  23     spaces around the parentheses of the block. ALWAYS use opening and closing
  24     braces, even if it's just a one-line block. This reduces future error when
  25     blocks are expanded beyond one line.
  26 +
  27 [source,C]
  28 -------------------------------------------
  29 for(lp = list; lp; lp = lp->next) {
  30   newlist = _alpm_list_add(newlist, strdup(lp->data));
  31 }
  32
  33 while(it) {
  34   ptr = it->next;
  35   if(fn) {
  36     fn(it->data);
  37   } else {
  38     return(1);
  39   }
  40   free(it);
  41   it = ptr;
  42 }
  43 -------------------------------------------
  44
  45 3.  When declaring a new function, put the opening and closing braces on their
  46     own line. Also, when declaring a pointer, do not put a space between the
  47     asterisk and the variable name.
  48 +
  49 [source,C]
  50 -------------------------------------------
  51 alpm_list_t *alpm_list_add(alpm_list_t *list, void *data)
  52 {
  53   alpm_list_t *ptr, *lp;
  54
  55   ptr = list;
  56   if(ptr == NULL) {
  57   ...
  58   }
  59   ...
  60 }
  61 -------------------------------------------
  62
  63 4.  Comments should be ANSI-C89 compliant. That means no `// Comment` style;
  64     use only `/* Comment */` style.
  65
  66     /* This is a comment */
  67        NOT
  68     // This is a comment
  69
  70 5.  Return statements should be written like a function call.
  71
  72     return(0);
  73        NOT
  74     return 0;
  75
  76 6.  The sizeof() operator should accept a type, not a value. (TODO: in certain
  77     cases, it may be better- should this be a set guideline? Read "The Practice
  78     of Programming")
  79
  80     sizeof(alpm_list_t);
  81        NOT
  82     sizeof(*mylist);
  83
  84 7.  When using strcmp() (or any function that returns 0 on success) in a
  85     conditional statement, use != 0 or == 0 and not the negation (!) operator.
  86     It reads much cleaner for humans (using a negative to check for success is
  87     confusing) and the compiler will treat it correctly anyway.
  88
  89     if(strcmp(a, b) == 0)
  90        NOT
  91     if(!strcmp(a, b))
  92
  93
  94 Other Concerns
  95 --------------
  96
  97 Header Includes
  98 ~~~~~~~~~~~~~~~
  99
 100 Currently our #include usage is in messy shape, but this is no reason to
 101 continue down this messy path. When adding an include to a file, follow this
 102 general pattern, including blank lines:
 103
 104 [source,C]
 105 -------------------------------------------
 106 #include "config.h"
 107
 108 #include <standardheader.h>
 109 #include <another.h>
 110 #include <...>
 111 -------------------------------------------
 112
 113 Follow this with some more headers, depending on whether the file is in libalpm
 114 or pacman proper. For libalpm:
 115
 116 [source,C]
 117 -------------------------------------------
 118 /* libalpm */
 119 #include "yourfile.h"
 120 #include "alpm_list.h"
 121 #include "anythingelse.h"
 122 -------------------------------------------
 123
 124 For pacman:
 125
 126 [source,C]
 127 -------------------------------------------
 128 #include <alpm.h>
 129 #include <alpm_list.h>
 130
 131 /* pacman */
 132 #include "yourfile.h"
 133 #include "anythingelse.h"
 134 -------------------------------------------
 135
 136 GDB and Valgrind Usage
 137 ~~~~~~~~~~~~~~~~~~~~~~
 138
 139 When using GDB or valgrind on pacman, you will want to run it on the actual
 140 binary rather than the shell script wrapper produced by libtool. The actual
 141 binary lives at `src/pacman/.libs/lt-pacman`, and will exist after running
 142 `./src/pacman/pacman` at least once.
 143
 144 For example, to run valgrind:
 145
 146     ./src/pacman/pacman
 147     valgrind --leak-check=full -- src/pacman/.libs/lt-pacman -Syu
 148
 149 /////
 150 vim: set ts=2 sw=2 syntax=asciidoc et:
 151 /////