Changes between Version 38 and Version 39 of Hacking

Timestamp:

02/02/25 18:56:29 (3 weeks ago)

Author:

zaytsev

Comment:

--

Hacking

@@ -1 @@
-
 = HACKING =
 
@@ -10 +9 @@
  * Follow the GNU-Style guidelines.
 
-To format the code, use the '''indent''' utility with following options:
-{{{
-indent \
-  --gnu-style \
-  --format-first-column-comments \
-  --indent-level4 \
-  --brace-indent0 \
-  --line-length100 \
-  --no-tabs \
-  --blank-lines-after-procedures 
-}}}
-
-or in short notation:
-{{{
-indent -gnu -fc1 -i4 -bli0 -nut -bap -l100
-}}}
-
-or just run
+To format the code, use the '''clang-format''' (version 19):
+
 {{{
 make indent
@@ -50 +33 @@
 (void) edit_delete (edit);
 
-/*  This is a one line comment. Allocate additional memory.  */
+// This is a one line comment. Allocate additional memory.
 mem = (char *) malloc (memneed);
 
@@ -72 +55 @@
 //This is a one line comment.
 
-/*This is a one line comment.*/
-
 /* This is a multi line comment,
    with some more words...*/
@@ -110 +91 @@
 === Braces ===
 
-Braces for code blocks used by '''for, if, switch, while, do..while''', etc. should begin on the next line after the statement keyword and end on a line of their own. 
+Braces for code blocks used by '''for, if, switch, while, do..while''', etc. should begin on the next line after the statement keyword and end on a line of their own.
 
 Functions are different and the beginning left brace should be located in the first column on the next line.
@@ -116 +97 @@
 If the beginning statement has to be broken across lines due to length, the beginning brace should be on a line of its own.
 
-Do not unnecessarily use braces where a single statement will do. 
+Do not unnecessarily use braces where a single statement will do.
 
 '''This is right:'''
@@ -146 +127 @@
 === Goto ===
 
-Use "goto" only when necessary. "goto"s are evil, but they can greatly enhance readability and reduce memory leaks when used as the single exit point from a function. 
+Use "goto" only when necessary. "goto"s are evil, but they can greatly enhance readability and reduce memory leaks when used as the single exit point from a function.
 
 '''This is right:'''
@@ -318 +299 @@
     WPanel *panel = current_panel;
     int i;
-    
+
     const ComputeDirSizeUI *ui = compute_dir_size_create_ui ();
 
@@ -376 +357 @@
 
 #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 "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"
 }}}
@@ -393 +374 @@
 #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/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"
@@ -407 +388 @@
 '''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() */
-}}}
+#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()
+}}}