[PATCH v4] prune-packed: remove USE_THE_REPOSITORY_VARIABLE

From: Shashank S Mogaveera <shashu8660@gmail.com>

The prune_packed_objects() function uses the global the_repository variable. To help with the libification effort, change this function so it takes a 'struct repository' pointer as an argument instead.

The function for_each_loose_file_in_source() uses a callback that only takes a single 'void *data' pointer. This means we cannot pass both the repository pointer and the 'opts' integer at the same time. To fix this, create a new 'struct prune_data' to hold both of them together, and update the prune_subdir() and prune_object() callbacks to read from this new struct.

Update the builtins that call this function to pass their local `repo` parameters. As all of those builtins are declared with `RUN_SETUP` we know that they won't execute outside a repository and thus the repository parameter will be set. Unless the command was invoked with "-h" to print help, but all new uses of the `repo` variable are after a call to `parse_options()` which knows to exit early in case it sees "-h"

Finally, drop the USE_THE_REPOSITORY_VARIABLE macro from prune-packed.c.

Signed-off-by: Shashank S Mogaveera <shashu8660@gmail.com>
---
    [Outreachy] prune-packed: remove use_the_repository_variable

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2266%2Fshashu8660%2Foutreachy2-v4
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2266/shashu8660/outreachy2-v4
Pull-Request: https://github.com/gitgitgadget/git/pull/2266

Range-diff vs v3:

 1:  0b474e3433 ! 1:  66f3becea8 prune-packed: remove USE_THE_REPOSITORY_VARIABLE
     @@ Commit message
          to hold both of them together, and update the prune_subdir() and
          prune_object() callbacks to read from this new struct.
      
     -    Update the builtins that call this function to pass their local 'repo'
     -    variables. We can safely remove the UNUSED macro from them because
     -    while 'repo' may be NULL if the command is invoked with "-h", the
     -    call to parse_options() will give the short help and exit before the
     -    dereference occurs.
     +    Update the builtins that call this function to pass their local
     +    `repo` parameters. As all of those builtins are declared with
     +    `RUN_SETUP` we know that they won't execute outside a repository
     +    and thus the repository parameter will be set. Unless the command
     +    was invoked with "-h" to print help, but all new uses of the `repo`
     +    variable are after a call to `parse_options()` which knows to exit
     +    early in case it sees "-h"
      
          Finally, drop the USE_THE_REPOSITORY_VARIABLE macro from
          prune-packed.c.
     @@ prune-packed.c
      -void prune_packed_objects(int opts)
      +void prune_packed_objects(struct repository *r, int opts)
       {
     --	if (opts & PRUNE_PACKED_VERBOSE)
     --		progress = start_delayed_progress(the_repository,
     --						  _("Removing duplicate objects"), 256);
     -+    struct prune_data cb_data = {
     -+	.r = r,
     -+	.opts = opts
     -+    };
     ++	struct prune_data cb_data = {
     ++		.r = r,
     ++		.opts = opts
     ++	};
      +
     -+    if (opts & PRUNE_PACKED_VERBOSE)
     -+	progress = start_delayed_progress(r,
     -+			  _("Removing duplicate objects"), 256);
     + 	if (opts & PRUNE_PACKED_VERBOSE)
     +-		progress = start_delayed_progress(the_repository,
     ++		progress = start_delayed_progress(r,
     + 						  _("Removing duplicate objects"), 256);
       
      -	for_each_loose_file_in_source(the_repository->objects->source,
      -				      prune_object, NULL, prune_subdir, &opts);
     -+    for_each_loose_file_in_source(r->objects->source,
     -+		      prune_object, NULL, prune_subdir, &cb_data);
     ++	for_each_loose_file_in_source(r->objects->source,
     ++				      prune_object, NULL, prune_subdir, &cb_data);
       
     --	/* Ensure we show 100% before finishing progress */
     --	display_progress(progress, 256);
     --	stop_progress(&progress);
     -+    /* Ensure we show 100% before finishing progress */
     -+    display_progress(progress, 256);
     -+    stop_progress(&progress);
     - }
     + 	/* Ensure we show 100% before finishing progress */
     + 	display_progress(progress, 256);
      
       ## prune-packed.h ##
      @@

 builtin/prune-packed.c |  4 ++--
 builtin/prune.c        |  2 +-
 builtin/repack.c       |  2 +-
 prune-packed.c         | 32 ++++++++++++++++++++------------
 prune-packed.h         |  4 +++-
 5 files changed, 27 insertions(+), 17 deletions(-)