X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=HACKING;h=32c10dddbb280bc47d92971ca465b6fd75d3b3ad;hp=d1edc8715673d26f5d6dc7a858a7137d7fbaf724;hb=2795de2e7fdaeb6e9f672e0dc73dea328f35e585;hpb=8df906e5b0da130f104e67eeb15b379c12a1916b diff --git a/HACKING b/HACKING index d1edc871..32c10ddd 100644 --- a/HACKING +++ b/HACKING @@ -5,8 +5,9 @@ HACKING Coding style ------------ -This project is programmed using the Linux kernel coding style, see -http://lxr.linux.no/linux/Documentation/CodingStyle for details. +This project is programmed using the Linux kernel coding style: + + https://www.kernel.org/doc/html/latest/process/coding-style.html Please use the same style for any code contributions, thanks! @@ -17,15 +18,16 @@ OK (in order to meet Qt/C++ related guidelines, for example). Contributions ------------- - - Patches should be sent to the development mailinglist at + - In order to contribute you should ideally clone the git repository and + let us know (preferably via IRC, or via the mailing list) from where to + pull/review your changes. You can use github.com, or any other public git + hosting site. + + - Alternatively, patches can be sent to the development mailinglist at sigrok-devel@lists.sourceforge.net (please subscribe to the list first). https://lists.sourceforge.net/lists/listinfo/sigrok-devel - - Alternatively, you can also clone the git repository and let us know - from where to pull/review your changes. You can use gitorious.org, - github.com, or any other public git hosting site. - Random notes ------------ @@ -38,7 +40,7 @@ Random notes glib's g_try_malloc()/g_try_malloc0() was used, use g_free() to free the memory. Otherwise use standard free(). Never use the wrong function! - - Never use g_malloc() or g_malloc0(). These functions do not return NULL + - Never use g_malloc() or g_malloc0(). These functions do not return nullptr if not enough memory is available but rather lead to an exit() or segfault instead. This behaviour is not acceptable. Use g_try_malloc()/g_try_malloc0() instead and check the return value. @@ -67,6 +69,9 @@ Random notes and the final @return line. The @param lines themselves (if there is more than one) are not separated by empty lines. + - Use QIcon::fromTheme() for icons that are included in the freedesktop.org + icon naming specification. Do NOT use it for all other icons. + Release engineering -------------------