X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=HACKING;h=404bd1af76d5db08e69e9c3d3ee1e8f530f3d38f;hp=d1edc8715673d26f5d6dc7a858a7137d7fbaf724;hb=10906507eb3d32346506a12d4387205f7c7c6e72;hpb=8df906e5b0da130f104e67eeb15b379c12a1916b diff --git a/HACKING b/HACKING index d1edc871..404bd1af 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! @@ -38,7 +39,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 +68,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 -------------------