From: Ben Pfaff <blp@nicira.com>
Date: Thu, 17 Sep 2009 22:12:34 +0000 (-0700)
Subject: util: Add comments.
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ba25c9d14ad6de05f13d3ebb1fa9242eebf34266;p=openvswitch

util: Add comments.
---

diff --git a/lib/util.h b/lib/util.h
index dad7b7c4..962bad2f 100644
--- a/lib/util.h
+++ b/lib/util.h
@@ -52,10 +52,19 @@
 
 extern const char *program_name;
 
+/* Returns the number of elements in ARRAY. */
 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
+
+/* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
+
+/* Returns X rounded up to the nearest multiple of Y. */
 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
+
+/* Returns X rounded down to the nearest multiple of Y. */
 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
+
+/* Returns true if X is a power of 2, otherwise false. */
 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
 
 #ifndef MIN