builtin/pack-refs: factor out core logic into a shared library

The implementation of `git pack-refs` is monolithic within
`cmd_pack_refs()`, making it impossible to share its logic with other
commands. To enable code reuse for the upcoming `git refs optimize`
subcommand, refactor the core logic into a shared helper function.

Split the original `builtin/pack-refs.c` file into two parts:

- A new shared library file, `pack-refs.c`, which contains the
  core option parsing and packing logic in a new `pack_refs_core()`
  helper function.

- The original `builtin/pack-refs.c`, which is now a thin wrapper
  responsible only for defining the `git pack-refs` command and
  calling the shared helper.

A new `pack-refs.h` header is also introduced to define the public
interface for this shared logic.

Mentored-by: Patrick Steinhardt <ps@pks.im>
Mentored-by: shejialuo <shejialuo@gmail.com>
Signed-off-by: Meet Soni <meetsoni3017@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
main
Meet Soni 2025-09-19 13:56:43 +05:30 committed by Junio C Hamano
parent 0bef41319c
commit 0d4ec33922
5 changed files with 86 additions and 49 deletions

View File

@ -1094,6 +1094,7 @@ LIB_OBJS += pack-bitmap.o
LIB_OBJS += pack-check.o
LIB_OBJS += pack-mtimes.o
LIB_OBJS += pack-objects.o
LIB_OBJS += pack-refs.o
LIB_OBJS += pack-revindex.o
LIB_OBJS += pack-write.o
LIB_OBJS += packfile.o

View File

@ -1,60 +1,16 @@
#include "builtin.h"
#include "config.h"
#include "environment.h"
#include "gettext.h"
#include "parse-options.h"
#include "refs.h"
#include "revision.h"

static char const * const pack_refs_usage[] = {
N_("git pack-refs [--all] [--no-prune] [--auto] [--include <pattern>] [--exclude <pattern>]"),
NULL
};
#include "pack-refs.h"

int cmd_pack_refs(int argc,
const char **argv,
const char *prefix,
struct repository *repo)
{
struct ref_exclusions excludes = REF_EXCLUSIONS_INIT;
struct string_list included_refs = STRING_LIST_INIT_NODUP;
struct pack_refs_opts pack_refs_opts = {
.exclusions = &excludes,
.includes = &included_refs,
.flags = PACK_REFS_PRUNE,
static char const * const pack_refs_usage[] = {
N_("git pack-refs " PACK_REFS_OPTS),
NULL
};
struct string_list option_excluded_refs = STRING_LIST_INIT_NODUP;
struct string_list_item *item;
int pack_all = 0;
int ret;

struct option opts[] = {
OPT_BOOL(0, "all", &pack_all, N_("pack everything")),
OPT_BIT(0, "prune", &pack_refs_opts.flags, N_("prune loose refs (default)"), PACK_REFS_PRUNE),
OPT_BIT(0, "auto", &pack_refs_opts.flags, N_("auto-pack refs as needed"), PACK_REFS_AUTO),
OPT_STRING_LIST(0, "include", pack_refs_opts.includes, N_("pattern"),
N_("references to include")),
OPT_STRING_LIST(0, "exclude", &option_excluded_refs, N_("pattern"),
N_("references to exclude")),
OPT_END(),
};
repo_config(repo, git_default_config, NULL);
if (parse_options(argc, argv, prefix, opts, pack_refs_usage, 0))
usage_with_options(pack_refs_usage, opts);

for_each_string_list_item(item, &option_excluded_refs)
add_ref_exclusion(pack_refs_opts.exclusions, item->string);

if (pack_all)
string_list_append(pack_refs_opts.includes, "*");

if (!pack_refs_opts.includes->nr)
string_list_append(pack_refs_opts.includes, "refs/tags/*");

ret = refs_optimize(get_main_ref_store(repo), &pack_refs_opts);

clear_ref_exclusions(&excludes);
string_list_clear(&included_refs, 0);
string_list_clear(&option_excluded_refs, 0);
return ret;
return pack_refs_core(argc, argv, prefix, repo, pack_refs_usage);
}

View File

@ -407,6 +407,7 @@ libgit_sources = [
'pack-check.c',
'pack-mtimes.c',
'pack-objects.c',
'pack-refs.c',
'pack-revindex.c',
'pack-write.c',
'packfile.c',

56
pack-refs.c Normal file
View File

@ -0,0 +1,56 @@
#include "builtin.h"
#include "config.h"
#include "environment.h"
#include "pack-refs.h"
#include "parse-options.h"
#include "refs.h"
#include "revision.h"

int pack_refs_core(int argc,
const char **argv,
const char *prefix,
struct repository *repo,
const char * const *usage_opts)
{
struct ref_exclusions excludes = REF_EXCLUSIONS_INIT;
struct string_list included_refs = STRING_LIST_INIT_NODUP;
struct pack_refs_opts pack_refs_opts = {
.exclusions = &excludes,
.includes = &included_refs,
.flags = PACK_REFS_PRUNE,
};
struct string_list option_excluded_refs = STRING_LIST_INIT_NODUP;
struct string_list_item *item;
int pack_all = 0;
int ret;

struct option opts[] = {
OPT_BOOL(0, "all", &pack_all, N_("pack everything")),
OPT_BIT(0, "prune", &pack_refs_opts.flags, N_("prune loose refs (default)"), PACK_REFS_PRUNE),
OPT_BIT(0, "auto", &pack_refs_opts.flags, N_("auto-pack refs as needed"), PACK_REFS_AUTO),
OPT_STRING_LIST(0, "include", pack_refs_opts.includes, N_("pattern"),
N_("references to include")),
OPT_STRING_LIST(0, "exclude", &option_excluded_refs, N_("pattern"),
N_("references to exclude")),
OPT_END(),
};
repo_config(repo, git_default_config, NULL);
if (parse_options(argc, argv, prefix, opts, usage_opts, 0))
usage_with_options(usage_opts, opts);

for_each_string_list_item(item, &option_excluded_refs)
add_ref_exclusion(pack_refs_opts.exclusions, item->string);

if (pack_all)
string_list_append(pack_refs_opts.includes, "*");

if (!pack_refs_opts.includes->nr)
string_list_append(pack_refs_opts.includes, "refs/tags/*");

ret = refs_optimize(get_main_ref_store(repo), &pack_refs_opts);

clear_ref_exclusions(&excludes);
string_list_clear(&included_refs, 0);
string_list_clear(&option_excluded_refs, 0);
return ret;
}

23
pack-refs.h Normal file
View File

@ -0,0 +1,23 @@
#ifndef PACK_REFS_H
#define PACK_REFS_H

struct repository;

/*
* Shared usage string for options common to git-pack-refs(1)
* and git-refs-optimize(1). The command-specific part (e.g., "git refs optimize ")
* must be prepended by the caller.
*/
#define PACK_REFS_OPTS \
"[--all] [--no-prune] [--auto] [--include <pattern>] [--exclude <pattern>]"

/*
* The core logic for pack-refs and its clones.
*/
int pack_refs_core(int argc,
const char **argv,
const char *prefix,
struct repository *repo,
const char * const *usage_opts);

#endif /* PACK_REFS_H */