cache.h: drop LOCAL_REPO_ENV_SIZE

We keep a static array of variables that should be cleared when invoking a sub-process on another repo. We statically size the array with the LOCAL_REPO_ENV_SIZE macro so that any readers do not have to count it themselves. As it turns out, no readers actually use the macro, and it creates a maintenance headache, as modifications to the array need to happen in two places (one to add the new element, and another to bump the size). Since it's NULL-terminated, we can just drop the size macro entirely. While we're at it, we'll clean up some comments around it, and add a new mention of it at the top of the list of environment variable macros. Even though local_repo_env is right below that list, it's easy to miss, and additions to that list should consider local_repo_env. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed Mar 8, 2013 at 04:29 UTC 2163e5dbb4cad43d65a4ffc8daeacff5eedd7af9
2 files changed +8 -10
cache.h
+6 -6
@@ -341,6 +341,7 @@ static inline enum object_type object_type(unsigned int mode)
341 OBJ_BLOB;
342 }
343
344 +/* Double-check local_repo_env below if you add to this list. */
345 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
346 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
347 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
@@ -364,13 +365,12 @@ static inline enum object_type object_type(unsigned int mode)
365 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
366
367 /*
367 - * Repository-local GIT_* environment variables
368 - * The array is NULL-terminated to simplify its usage in contexts such
369 - * environment creation or simple walk of the list.
370 - * The number of non-NULL entries is available as a macro.
368 + * Repository-local GIT_* environment variables; these will be cleared
369 + * when git spawns a sub-process that runs inside another repository.
370 + * The array is NULL-terminated, which makes it easy to pass in the "env"
371 + * parameter of a run-command invocation, or to do a simple walk.
372 */
372 -#define LOCAL_REPO_ENV_SIZE 9
373 -extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
373 +extern const char * const local_repo_env[];
374
375 extern int is_bare_repository_cfg;
376 extern int is_bare_repository(void);
environment.c
+2 -4
@@ -76,11 +76,9 @@ static const char *git_dir;
76 static char *git_object_dir, *git_index_file, *git_graft_file;
77
78 /*
79 - * Repository-local GIT_* environment variables
80 - * Remember to update local_repo_env_size in cache.h when
81 - * the size of the list changes
79 + * Repository-local GIT_* environment variables; see cache.h for details.
80 */
83 -const char * const local_repo_env[LOCAL_REPO_ENV_SIZE + 1] = {
81 +const char * const local_repo_env[] = {
82 ALTERNATE_DB_ENVIRONMENT,
83 CONFIG_ENVIRONMENT,
84 CONFIG_DATA_ENVIRONMENT,