gdb/doc/
authorJan Kratochvil <jan.kratochvil@redhat.com>
Fri, 13 Jan 2012 14:31:55 +0000 (14:31 +0000)
committerJan Kratochvil <jan.kratochvil@redhat.com>
Fri, 13 Jan 2012 14:31:55 +0000 (14:31 +0000)
* gdbint.texinfo (Coding Standards): Require braces for two lines of
code.

gdb/doc/ChangeLog
gdb/doc/gdbint.texinfo

index 2914190f9fe959ddc9cd5db217e66c47cdb7e1c1..8ef5340586b2ec156f6c1490892a79bf20495e8e 100644 (file)
@@ -1,3 +1,9 @@
+2012-01-13  Jan Kratochvil  <jan.kratochvil@redhat.com>
+           Eli Zaretskii  <eliz@gnu.org>
+
+       * gdbint.texinfo (Coding Standards): Require braces for two lines of
+       code.
+
 2012-01-11  Paul Hilfinger  <hilfingr@adacore.com>
 
        * gdb.texinfo (Variables): Document use of :: for non-static
index 136f77f0e2f1df2217c0371988a3a377f6b624ec..026dc599f9cb54f6ae9472db2ea77003bb583b0d 100644 (file)
@@ -5849,6 +5849,26 @@ the following guidelines:
 @tab (pointer dereference)
 @end multitable
 
+Any two or more lines in code should be wrapped in braces, even if
+they are comments, as they look like separate statements:
+
+@smallexample
+if (i)
+  @{
+    /* Return success.  */
+    return 0;
+  @}
+@end smallexample
+
+@noindent
+and not:
+
+@smallexample
+if (i)
+  /* Return success.  */
+  return 0;
+@end smallexample
+
 @subsection Comments
 
 @cindex comment formatting