All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 1/2] Documentation: No argument of ALLOC_GROW should have side-effects
Date: Fri, 8 Oct 2010 11:46:59 -0500	[thread overview]
Message-ID: <20101008164659.GC9212@burratino> (raw)
In-Reply-To: <20101008164536.GB9212@burratino>

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>
---
 cache.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/cache.h b/cache.h
index 2ef2fa3..23d6d45 100644
--- a/cache.h
+++ b/cache.h
@@ -438,7 +438,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 { \
-- 
1.7.2.3

  reply	other threads:[~2010-10-08 16:50 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-10-08  0:52 [PATCH/RFC] Unify argument and option notation in the docs Štěpán Němec
2010-10-08  7:43 ` Jonathan Nieder
2010-10-08 11:13   ` Štěpán Němec
2010-10-08 17:31     ` [PATCH 0/6] " Štěpán Němec
2010-10-08 17:44       ` Jonathan Nieder
2010-10-08 19:43       ` Junio C Hamano
2010-10-08 20:15         ` Štěpán Němec
2010-10-21 22:21           ` Jonathan Nieder
2010-10-24 15:51             ` [PATCH] CodingGuidelines: Add a section on writing documentation Štěpán Němec
2010-10-29  2:56               ` Mark Lodato
2010-10-29 11:54                 ` Štěpán Němec
2010-10-29 17:14                   ` Sverre Rabbelier
2010-11-01 17:00                     ` Štěpán Němec
2010-11-04 17:12                       ` [PATCH v2] " Štěpán Němec
2010-11-04 17:18                       ` [PATCH] diff,difftool: Don't use the {0,2} notation in usage strings Štěpán Němec
2010-11-04 17:22                         ` Sverre Rabbelier
2010-11-04 17:49                         ` Jeff King
2010-11-04 18:02                           ` Jonathan Nieder
2010-11-04 18:13                             ` Jeff King
2010-11-04 18:38                               ` Jonathan Nieder
2010-11-04 18:55                                 ` Jeff King
2010-11-04 20:26                                   ` Štěpán Němec
2010-11-04 20:43                                     ` Jeff King
2010-11-04 21:17                                       ` [PATCH] docs: clarify git diff modes of operation Jeff King
2010-11-04 21:50                                         ` Jonathan Nieder
2010-11-05  1:57                                           ` Mark Lodato
2010-11-04 21:51                                         ` Štěpán Němec
2010-11-04 21:30                                       ` [PATCH] diff,difftool: Don't use the {0,2} notation in usage strings Štěpán Němec
2010-10-08 17:31     ` [PATCH 1/6] Use angles for placeholders consistently Štěpán Němec
2010-10-08 17:31     ` [PATCH 2/6] Fix odd markup in --diff-filter documentation Štěpán Němec
2010-10-08 17:39       ` Jonathan Nieder
2010-10-08 17:57         ` Štěpán Němec
2010-10-08 18:03           ` Jonathan Nieder
2010-10-08 18:40             ` Štěpán Němec
2010-10-08 18:53               ` Jonathan Nieder
2010-10-08 17:31     ` [PATCH 3/6] Use parentheses and `...' where appropriate Štěpán Němec
2010-10-08 17:31     ` [PATCH 4/6] Remove stray quotes in --pretty and --format documentation Štěpán Němec
2010-10-08 17:31     ` [PATCH 5/6] Put a space between `<' and argument in pack-objects usage string Štěpán Němec
2010-10-08 17:31     ` [PATCH 6/6] Fix {update,checkout}-index usage strings Štěpán Němec
2010-10-08 16:45   ` [PATCH 0/2] pack-objects: use ALLOC_GROW in place of manual growth Jonathan Nieder
2010-10-08 16:46     ` Jonathan Nieder [this message]
2010-10-08 16:47     ` [PATCH 2/2] pack-objects: use ALLOC_GROW Jonathan Nieder
2010-10-08 17:02     ` [PATCH 3/2] Allow side-effects in second argument to ALLOC_GROW Jonathan Nieder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20101008164659.GC9212@burratino \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.