linux-kernel - [PATCH] CodingStyle: Add tab indentation avoidance tips

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Wed, 20 Mar 2013 09:26:54 -0700
From:	Joe Perches <joe@...ches.com>
To:	Al Viro <viro@...IV.linux.org.uk>
Cc:	Dan Carpenter <dan.carpenter@...cle.com>,
	Alice Ferrazzi <alice.ferrazzi@...il.com>,
	gregkh@...uxfoundation.org, devel@...verdev.osuosl.org,
	linux-kernel@...r.kernel.org
Subject: [PATCH] CodingStyle: Add tab indentation avoidance tips

Add Al's comments in from https://lkml.org/lkml/2013/3/20/345

Signed-off-by: Joe Perches <joe@...ches.com>
---
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index e00b8f0..c4ba183 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -836,6 +836,141 @@ next instruction in the assembly output:
 	     : /* outputs */ : /* inputs */ : /* clobbers */);
 
 
+		Chapter 20:
+
+Tips to avoid overly tab indented code.
+
+Tip 1:
+	if (foo) {
+		A /* two lines */
+	} else {
+		B /* huge pile of shite */
+	}
+	return result;
+
+is equivalent to
+
+	if (foo) {
+		A
+		return result;
+	}
+	B
+	return result;
+
+Tip 2:
+	while (1) {
+		A	/* a couple of lines */
+		if (foo) {
+			break;
+		} else {
+			B /* huge pile of shite */
+		}
+	}
+
+is equivalent to
+
+	while (1) {
+		A
+		if (foo)
+			break;
+		B
+	}
+
+Tip 3:
+	while (1) {
+		A       /* moderate pile of shite, assigning foo */
+		if (foo) {
+			B /* huge pile of shite */
+		}
+	}
+
+is equivalent to
+
+	while (1) {
+		A
+		if (!foo)
+			continue;
+		B
+	}
+
+Tip 4:
+
+functions are there for purpose.  When you have two identical piles of
+garbage (avert your eyes, or risk taking another look at your dinner)
+such as
+				int unit, sign, min;
+				unit =
+				    (data.value >> 10) &
+				    0x7;
+				sign =
+				    (data.value >> 13) &
+				    0x1;
+				min =
+				    (data.value >> 14) &
+				    0xfffff;
+
+				switch (unit) {
+				case 0:{
+						min =
+						    min
+						    *
+						    1000000;
+					}
+					break;
+				case 1:{
+						min =
+						    min
+						    *
+						    1000;
+					}
+					break;
+				case 2:{
+						min =
+						    min
+						    * 1;
+					}
+					break;
+				}
+				if (sign)
+					min = -min;
+
+you just might consider turning that pile of excrements into a helper
+function.  Incidentally, min = min * 1 is somewhat, er, pointless...
+
+Tip 5:
+	for (i = 0; i <= 4; i++) {
+	{
+		switch (i) {
+		case 0: c = non_NULL_1; ... break;
+		case 1: c = non_NULL_2; ... break;
+		case 2: c = non_NULL_3; ... break;
+		case 3: c = non_NULL_4; ... break;
+		case 4: c = non_NULL_5; ... break;
+		default: c = NULL; break;
+		}
+		if (c) {
+			pile_of_shite
+		}
+	}
+might, perhaps, be taking defensive programming a bit too far...
+
+Tip 6:
+The Vogon whose brain has produced that code up had been brought up on Pascal,
+Ada or something worse, and had been badly traumatized by semantics of switch
+and break.
+	switch (foo) {
+		case 0: {
+			bar = baz;
+		} break;
+		case 1: {
+		.....
+	}
+	is not quite conventional for C.
+
+Tip 7:
+Code flow is down, not across...
+
+
 
 		Appendix I: References
 



--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/