Documentation: No argument of ALLOC_GROW should have side-effects
The explanatory comment before the definition of ALLOC_GROW carefully lists arguments that will be used more than once and thus cannot have side-effects; a lazy reader might conclude that the arguments not listed are used only once and side effects safe. Correct it to list all three arguments, avoiding this confusion. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Oct 8, 2010 at 11:46 UTC
01f6fd4b4e59bc131941d917138cdd2cc6662382
1 file changed
+1
-1
cache.h
+1
-1
@@ -445,7 +445,7 @@ extern int init_db(const char *template_dir, unsigned int flags);
445
* at least 'nr' entries; the number of entries currently allocated
446
* is 'alloc', using the standard growing factor alloc_nr() macro.
447
*
448
- * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
448
+ * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
449
*/
450
#define ALLOC_GROW(x, nr, alloc) \
451
do { \