Re: [PATCH 3/3] fast-import: rename object_count to pack_object_count

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Sep 18, 2011, 21:40 UTC
Message-ID: <20110918214010.GK2308@elie>
In-Reply-To: <CA+gfSn8aOWPm=xmTE9WzuXsQY0EfYypFxRAyVb-x3_kmhNUb-Q@mail.gmail.com>

Dmitry Ivankov wrote:

> --- a/fast-import.c
> +++ b/fast-import.c

[...]

Show 15 quoted lines

> @@ -310,8 +309,16 @@ static unsigned int atom_cnt;
>  static struct atom_str **atom_table;
> 
>  /* The .pack file being generated */
> +/*
> + * objects that are being written to the current pack
> + * all *must* have current pack_id in struct object_entry.
> + * And object_count *must* be a count of object_entry's
> + * having current pack_id. This data is used to create
> + * index file once current pack_file is finished.
> + */
>  static struct pack_idx_option pack_idx_opts;
>  static unsigned int pack_id;
> +static unsigned long object_count;
>  static struct sha1file *pack_file;

Closer. Now I am tempted to nitpick and say that this should be a single comment, formatted in complete sentences, and written to be descriptive rather than normative when possible (since norms will inevitably change over time, and future readers should not have an excuse to be afraid to adjust the comment to match code changes).

	/*
	 * The .pack file being generated
	 *
	 * Objects that are being written to the current pack store the
	 * current value of "pack_id" in struct object_entry.
	 * "object_count" counts the object_entrys with the current
	 * pack_id.  These values are used to create the pack index
	 * file when the current pack is finished.
	 */
	static struct pack_idx_option pack_idx_opts;
	static unsigned int pack_id;
	...