Documentation: No argument of ALLOC_GROW should have side-effects

jrn · gitster · commit 01f6fd4b4e59 · 2010-10-08T13:17:10.000-07:00
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 &lt;jrnieder@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/cache.h b/cache.h
@@ -445,7 +445,7 @@ extern int init_db(const char *template_dir, unsigned int flags);
  * at least 'nr' entries; the number of entries currently allocated
  * is 'alloc', using the standard growing factor alloc_nr() macro.
  *
- * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
+ * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
  */
 #define ALLOC_GROW(x, nr, alloc) \
 	do { \

Original file line number	Diff line number	Diff line change
`@@ -445,7 +445,7 @@ extern int init_db(const char *template_dir, unsigned int flags);`
`445`	`445`	`* at least 'nr' entries; the number of entries currently allocated`
`446`	`446`	`* is 'alloc', using the standard growing factor alloc_nr() macro.`
`447`	`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`	`449`	`*/`
`450`	`450`	`#define ALLOC_GROW(x, nr, alloc) \`
`451`	`451`	`do { \`