Changes between Version 12 and Version 13 of Hacking

Timestamp:

02/15/11 21:51:25 (14 years ago)

Author:

angel_il

Comment:

--

Hacking

@@ -225 +225 @@
 }}}
 
-typical structure of *.c file
+=== Headers ===
+
+Do not mix headers
+
+'''This is right:'''
+{{{
+
+#include <errno.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#include "lib/global.h"
+#include "lib/tty/tty.h"        /* LINES, tty_touch_screen() */
+#include "lib/tty/win.h"        /* do_enter_ca_mode() */
+
+#include "src/subshell.h"       /* use_subshell */
+#include "src/help.h"           /* interactive_display() */
+#include "src/setup.h"
+
+}}}
+
+'''This is wrong:'''
+{{{
+#include <errno.h>
+#include <sys/types.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <sys/stat.h>
+
+#include "src/subshell.h"       /* use_subshell */
+#include "src/help.h"           /* interactive_display() */
+
+#include "lib/tty/tty.h"        /* LINES, tty_touch_screen() */
+#include "lib/tty/win.h"        /* do_enter_ca_mode() */
+
+#include "src/setup.h"
+#include "lib/global.h"
+
+}}}
+
+Use short comment for header file
+
+'''This is right:'''
+{{{
+#include "lib/tty/tty.h"        /* LINES, tty_touch_screen() */
+#include "lib/tty/win.h"        /* do_enter_ca_mode() */
+#include "src/subshell.h"       /* use_subshell */
+#include "src/help.h"           /* interactive_display() */
+
+}}}
+
+Do not mix global and local variables and functions.
+Do not mix static and non-static statments.
+
+Follow typical structure of *.c file:
 
 {{{