From: Junio C Hamano <gitster@pobox.com>
To: Adam Spiers <git@adamspiers.org>
Cc: git list <git@vger.kernel.org>
Subject: Re: [PATCH] api-allocation-growing.txt: encourage better variable naming
Date: Sun, 06 Jan 2013 12:29:33 -0800 [thread overview]
Message-ID: <7v38yenjgy.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1357486505-21357-1-git-send-email-git@adamspiers.org> (Adam Spiers's message of "Sun, 6 Jan 2013 15:35:05 +0000")
Adam Spiers <git@adamspiers.org> writes:
> The documentation for the ALLOC_GROW API implicitly encouraged
> developers to use "ary" as the variable name for the array which is
> dynamically grown. However "ary" is an unusual abbreviation hardly
> used anywhere else in the source tree, and it is also better to name
> variables based on their contents not on their type.
Sounds good. To follow "not type but contents", a further rewrite
with s/array/item/ is even better, no?
I can obviously squash it in without resending, if you agree, or you
can point out why item[] is not a good idea and array[] is better.
>
> Signed-off-by: Adam Spiers <git@adamspiers.org>
> ---
> Documentation/technical/api-allocation-growing.txt | 14 ++++++++------
> 1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/technical/api-allocation-growing.txt b/Documentation/technical/api-allocation-growing.txt
> index 43dbe09..3894815 100644
> --- a/Documentation/technical/api-allocation-growing.txt
> +++ b/Documentation/technical/api-allocation-growing.txt
> @@ -5,7 +5,9 @@ Dynamically growing an array using realloc() is error prone and boring.
>
> Define your array with:
>
> -* a pointer (`ary`) that points at the array, initialized to `NULL`;
> +* a pointer (`array`) that points at the array, initialized to `NULL`
> + (although please name the variable based on its contents, not on its
> + type);
>
> * an integer variable (`alloc`) that keeps track of how big the current
> allocation is, initialized to `0`;
> @@ -13,22 +15,22 @@ Define your array with:
> * another integer variable (`nr`) to keep track of how many elements the
> array currently has, initialized to `0`.
>
> -Then before adding `n`th element to the array, call `ALLOC_GROW(ary, n,
> +Then before adding `n`th element to the array, call `ALLOC_GROW(array, n,
> alloc)`. This ensures that the array can hold at least `n` elements by
> calling `realloc(3)` and adjusting `alloc` variable.
>
> ------------
> -sometype *ary;
> +sometype *array;
> size_t nr;
> size_t alloc
>
> for (i = 0; i < nr; i++)
> - if (we like ary[i] already)
> + if (we like array[i] already)
> return;
>
> /* we did not like any existing one, so add one */
> -ALLOC_GROW(ary, nr + 1, alloc);
> -ary[nr++] = value you like;
> +ALLOC_GROW(array, nr + 1, alloc);
> +array[nr++] = value you like;
> ------------
>
> You are responsible for updating the `nr` variable.
next prev parent reply other threads:[~2013-01-06 20:29 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-12-27 2:32 [PATCH v3 00/19] new git check-ignore sub-command Adam Spiers
2012-12-27 2:32 ` [PATCH v3 01/19] api-directory-listing.txt: update to match code Adam Spiers
2012-12-27 2:32 ` [PATCH v3 02/19] Improve documentation and comments regarding directory traversal API Adam Spiers
2013-01-01 20:52 ` Junio C Hamano
2013-01-02 12:54 ` Adam Spiers
2013-01-06 12:02 ` Adam Spiers
2012-12-27 2:32 ` [PATCH v3 03/19] dir.c: rename cryptic 'which' variable to more consistent name Adam Spiers
2012-12-27 2:32 ` [PATCH v3 04/19] dir.c: rename path_excluded() to is_path_excluded() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 05/19] dir.c: rename excluded_from_list() to is_excluded_from_list() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 06/19] dir.c: rename excluded() to is_excluded() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 07/19] dir.c: refactor is_excluded_from_list() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 08/19] dir.c: refactor is_excluded() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 09/19] dir.c: refactor is_path_excluded() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 10/19] dir.c: rename free_excludes() to clear_exclude_list() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 11/19] dir.c: use a single struct exclude_list per source of excludes Adam Spiers
2013-01-04 21:03 ` Junio C Hamano
2013-01-05 7:54 ` Junio C Hamano
2013-01-06 15:27 ` Adam Spiers
2013-01-06 15:35 ` [PATCH] api-allocation-growing.txt: encourage better variable naming Adam Spiers
2013-01-06 20:29 ` Junio C Hamano [this message]
2013-01-06 20:52 ` Adam Spiers
2013-01-06 20:58 ` Junio C Hamano
2013-01-06 15:20 ` [PATCH v3 11/19] dir.c: use a single struct exclude_list per source of excludes Adam Spiers
2013-01-06 20:25 ` Junio C Hamano
2013-01-06 22:53 ` Adam Spiers
2013-01-06 23:17 ` Adam Spiers
2013-01-06 23:19 ` Junio C Hamano
2012-12-27 2:32 ` [PATCH v3 12/19] dir.c: keep track of where patterns came from Adam Spiers
2012-12-27 2:32 ` [PATCH v3 13/19] dir.c: provide clear_directory() for reclaiming dir_struct memory Adam Spiers
2012-12-27 2:32 ` [PATCH v3 14/19] add.c: refactor treat_gitlinks() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 15/19] add.c: remove unused argument from validate_pathspec() Adam Spiers
2012-12-27 2:32 ` [PATCH v3 16/19] pathspec.c: move reusable code from builtin/add.c Adam Spiers
2012-12-28 20:32 ` Junio C Hamano
2012-12-28 20:45 ` Adam Spiers
2012-12-29 0:40 ` Adam Spiers
2012-12-28 20:48 ` Junio C Hamano
2012-12-28 21:15 ` Adam Spiers
2012-12-27 2:32 ` [PATCH v3 17/19] pathspec.c: extract new validate_path() for reuse Adam Spiers
2012-12-28 20:44 ` Junio C Hamano
2012-12-28 21:08 ` Adam Spiers
2012-12-27 2:32 ` [PATCH v3 18/19] setup.c: document get_pathspec() Adam Spiers
2012-12-28 20:36 ` Junio C Hamano
2012-12-28 20:40 ` Adam Spiers
2012-12-29 0:52 ` Adam Spiers
2012-12-29 1:36 ` Junio C Hamano
2012-12-27 2:32 ` [PATCH v3 19/19] Add git-check-ignore sub-command Adam Spiers
2012-12-28 21:21 ` Junio C Hamano
2012-12-29 1:23 ` Adam Spiers
2012-12-29 3:32 ` Adam Spiers
2012-12-27 5:15 ` [PATCH v3 00/19] new git check-ignore sub-command Michael Leal
2012-12-28 18:50 ` Junio C Hamano
2012-12-28 19:39 ` Adam Spiers
2012-12-28 20:15 ` Antoine Pelisse
2012-12-28 21:31 ` Junio C Hamano
2012-12-28 21:23 ` Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7v38yenjgy.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=git@adamspiers.org \
--cc=git@vger.kernel.org \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).