[PATCH] Documentation: Explain a second alternative for multi-line macros.
- From: "Robert P. J. Day" <rpjday@xxxxxxxxxxxxxx>
- Date: Sun, 31 Dec 2006 14:32:25 -0500 (EST)
Add an explanation for defining multi-line macros using the ({ })
notation to CodingStyle.
Signed-off-by: Robert P. J. Day <rpjday@xxxxxxxxxxxxxx>
---
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 9069189..1d0ddb8 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -549,13 +549,24 @@ may be named in lower case.
Generally, inline functions are preferable to macros resembling functions.
-Macros with multiple statements should be enclosed in a do - while block:
+There are two techniques for defining macros that contain multiple
+statements.
-#define macrofun(a, b, c) \
- do { \
+ (a) Enclose those statements in a do - while block:
+
+ #define macrofun(a, b, c) \
+ do { \
+ if (a == 5) \
+ do_this(b, c); \
+ } while (0)
+
+ (b) Use the gcc extension that a compound statement enclosed in
+ parentheses represents an expression:
+
+ #define macrofun(a, b, c) ({ \
if (a == 5) \
do_this(b, c); \
- } while (0)
+ })
Things to avoid when using macros:
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
- Follow-Ups:
- Re: [PATCH] Documentation: Explain a second alternative for multi-line macros.
- From: Muli Ben-Yehuda
- Re: [PATCH] Documentation: Explain a second alternative for multi-line macros.
- Prev by Date: Re: replace "memset(...,0,PAGE_SIZE)" calls with "clear_page()"?
- Next by Date: Re: [patch 2.6.20-rc1 0/6] arch-neutral GPIO calls
- Previous by thread: compile failure on 2.6.19
- Next by thread: Re: [PATCH] Documentation: Explain a second alternative for multi-line macros.
- Index(es):
Relevant Pages
|
