HACKING

   1 -------------------------------------------------------------------------------
   2 HACKING
   3 -------------------------------------------------------------------------------
   4
   5 Coding style
   6 ------------
   7
   8 This project is programmed using the Linux kernel coding style, see
   9 http://lxr.linux.no/linux/Documentation/CodingStyle for details.
  10
  11 Please use the same style for any code contributions, thanks!
  12
  13 In some exceptional cases deviations from the above coding guidelines are
  14 OK (in order to meet Qt/C++ related guidelines, for example).
  15
  16
  17 Contributions
  18 -------------
  19
  20  - Patches should be sent to the development mailinglist at
  21    sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
  22
  23    https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  24
  25  - Alternatively, you can also clone the git repository and let us know
  26    from where to pull/review your changes. You can use gitorious.org,
  27    github.com, or any other public git hosting site.
  28
  29
  30 Random notes
  31 ------------
  32
  33  - Consistently use g_try_malloc() / g_try_malloc0(). Do not use standard
  34    malloc()/calloc() if it can be avoided (sometimes other libs such
  35    as libftdi can return malloc()'d memory, for example).
  36
  37  - Always properly match allocations with the proper *free() functions. If
  38    glib's g_try_malloc()/g_try_malloc0() was used, use g_free() to free the
  39    memory. Otherwise use standard free(). Never use the wrong function!
  40
  41  - Never use g_malloc() or g_malloc0(). These functions do not return NULL
  42    if not enough memory is available but rather lead to an exit() or segfault
  43    instead. This behaviour is not acceptable.
  44    Use g_try_malloc()/g_try_malloc0() instead and check the return value.
  45
  46  - Use glib's gboolean / TRUE / FALSE for boolean types consistently.
  47    Do not use <stdbool.h> and its true / false, and do not invent private
  48    definitions for this either.
  49
  50  - Consistently use the same naming convention for #include guards in headers:
  51    <PROJECTNAME>_<PATH_TO_FILE>_<FILE>
  52    This ensures that all #include guards are always unique and consistent.
  53    Example: PULSEVIEW_PV_VIEW_RULER_H
  54
  55  - Consistently use the same naming convention for functions, if appropriate:
  56
  57    Getter/setter function names should usually end with "_get" or "_set".
  58    Functions creating new "objects" should end with "_new".
  59    Functions destroying "objects" should end with "_destroy".
  60    Functions adding or removing items (e.g. from lists) should end with
  61    either "_add" or "_remove".
  62    Functions operating on all items from a list (not on only one of them),
  63    should end with "_all", e.g. "_remove_all", "_get_all", and so on.
  64    Use "_remove_all" in favor of "_clear" for consistency.
  65
  66  - In Doxygen comments, put an empty line between the block of @param lines
  67    and the final @return line. The @param lines themselves (if there is more
  68    than one) are not separated by empty lines.
  69
  70
  71 Release engineering
  72 -------------------
  73
  74 See
  75
  76  http://sigrok.org/wiki/Developers/Release_process
  77
  78 for a list of items that need to be done when releasing a new tarball.
  79