diff mbox series

[1/5] backfill: add builtin boilerplate

Message ID 0300aa1b8c37dcd0d529cc24588ae77960fdfbff.1733515638.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series PATH WALK III: Add 'git backfill' command | expand

Commit Message

Derrick Stolee Dec. 6, 2024, 8:07 p.m. UTC 
From: Derrick Stolee <derrickstolee@github.com>

In anticipation of implementing 'git backfill', populate the necessary files
with the boilerplate of a new builtin.

Signed-off-by: Derrick Stolee <stolee@gmail.com>
---
 .gitignore                     |  1 +
 Documentation/git-backfill.txt | 23 +++++++++++++++++++++++
 Makefile                       |  1 +
 builtin.h                      |  1 +
 builtin/backfill.c             | 29 +++++++++++++++++++++++++++++
 command-list.txt               |  1 +
 git.c                          |  1 +
 7 files changed, 57 insertions(+)
 create mode 100644 Documentation/git-backfill.txt
 create mode 100644 builtin/backfill.c

Comments

Patrick Steinhardt Jan. 16, 2025, 10:11 a.m. UTC | #1 
On Fri, Dec 06, 2024 at 08:07:14PM +0000, Derrick Stolee via GitGitGadget wrote:
> diff --git a/Documentation/git-backfill.txt b/Documentation/git-backfill.txt
> new file mode 100644
> index 00000000000..640144187d3
> --- /dev/null
> +++ b/Documentation/git-backfill.txt
> @@ -0,0 +1,23 @@
> +git-backfill(1)
> +===============
> +
> +NAME
> +----
> +git-backfill - Download missing objects in a partial clone
> +
> +
> +SYNOPSIS
> +--------
> +[verse]
> +'git backfill' [<options>]

Ah, one thing I forgot about: this could use the new `[synopsis]` style,
which removes some need for formatting directives.

Patrick
Junio C Hamano Jan. 16, 2025, 5:52 p.m. UTC | #2 
Patrick Steinhardt <ps@pks.im> writes:

> On Fri, Dec 06, 2024 at 08:07:14PM +0000, Derrick Stolee via GitGitGadget wrote:
>> diff --git a/Documentation/git-backfill.txt b/Documentation/git-backfill.txt
>> new file mode 100644
>> index 00000000000..640144187d3
>> --- /dev/null
>> +++ b/Documentation/git-backfill.txt
>> @@ -0,0 +1,23 @@
>> +git-backfill(1)
>> +===============
>> +
>> +NAME
>> +----
>> +git-backfill - Download missing objects in a partial clone
>> +
>> +
>> +SYNOPSIS
>> +--------
>> +[verse]
>> +'git backfill' [<options>]
>
> Ah, one thing I forgot about: this could use the new `[synopsis]` style,
> which removes some need for formatting directives.

Yeah, I thought it was more or less simultaneous development and it
was OK to convert after the dust settles, but it seems to predate
the series by 3 months.

$ git show -s --format=reference 029eff9e34f 375852e20
029eff9e34 (doc: update the guidelines to reflect the current formatting rules, 2024-09-24)
375852e20f (backfill: add builtin boilerplate, 2024-12-20)

ds/backfill:Documentation/CodingGuidelines does tell us '[synopsis]'
is available, even ;-)

Thanks for noticing.
Derrick Stolee Feb. 3, 2025, 2:38 p.m. UTC | #3 
On 1/16/25 12:52 PM, Junio C Hamano wrote:
> Patrick Steinhardt <ps@pks.im> writes:
> 
>> On Fri, Dec 06, 2024 at 08:07:14PM +0000, Derrick Stolee via GitGitGadget wrote:
>>> diff --git a/Documentation/git-backfill.txt b/Documentation/git-backfill.txt
>>> new file mode 100644
>>> index 00000000000..640144187d3
>>> --- /dev/null
>>> +++ b/Documentation/git-backfill.txt
>>> @@ -0,0 +1,23 @@
>>> +git-backfill(1)
>>> +===============
>>> +
>>> +NAME
>>> +----
>>> +git-backfill - Download missing objects in a partial clone
>>> +
>>> +
>>> +SYNOPSIS
>>> +--------
>>> +[verse]
>>> +'git backfill' [<options>]
>>
>> Ah, one thing I forgot about: this could use the new `[synopsis]` style,
>> which removes some need for formatting directives.
> 
> Yeah, I thought it was more or less simultaneous development and it
> was OK to convert after the dust settles, but it seems to predate
> the series by 3 months.
> 
> $ git show -s --format=reference 029eff9e34f 375852e20
> 029eff9e34 (doc: update the guidelines to reflect the current formatting rules, 2024-09-24)
> 375852e20f (backfill: add builtin boilerplate, 2024-12-20)
> 
> ds/backfill:Documentation/CodingGuidelines does tell us '[synopsis]'
> is available, even ;-)

Thanks. I was not aware of this new style. Will be fixed in the next version.

Thanks,
-Stolee
diff mbox series

Patch

diff --git a/.gitignore b/.gitignore
index 6687bd6db4c..0f9e7de2ec3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -20,6 +20,7 @@ 
 /git-apply
 /git-archimport
 /git-archive
+/git-backfill
 /git-bisect
 /git-blame
 /git-branch
diff --git a/Documentation/git-backfill.txt b/Documentation/git-backfill.txt
new file mode 100644
index 00000000000..640144187d3
--- /dev/null
+++ b/Documentation/git-backfill.txt
@@ -0,0 +1,23 @@ 
+git-backfill(1)
+===============
+
+NAME
+----
+git-backfill - Download missing objects in a partial clone
+
+
+SYNOPSIS
+--------
+[verse]
+'git backfill' [<options>]
+
+DESCRIPTION
+-----------
+
+SEE ALSO
+--------
+linkgit:git-clone[1].
+
+GIT
+---
+Part of the linkgit:git[1] suite
diff --git a/Makefile b/Makefile
index 50413d96492..e18e0f4e447 100644
--- a/Makefile
+++ b/Makefile
@@ -1203,6 +1203,7 @@  BUILTIN_OBJS += builtin/am.o
 BUILTIN_OBJS += builtin/annotate.o
 BUILTIN_OBJS += builtin/apply.o
 BUILTIN_OBJS += builtin/archive.o
+BUILTIN_OBJS += builtin/backfill.o
 BUILTIN_OBJS += builtin/bisect.o
 BUILTIN_OBJS += builtin/blame.o
 BUILTIN_OBJS += builtin/branch.o
diff --git a/builtin.h b/builtin.h
index f7b166b3348..89928ccf92f 100644
--- a/builtin.h
+++ b/builtin.h
@@ -120,6 +120,7 @@  int cmd_am(int argc, const char **argv, const char *prefix, struct repository *r
 int cmd_annotate(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_apply(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_archive(int argc, const char **argv, const char *prefix, struct repository *repo);
+int cmd_backfill(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_bisect(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_blame(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_branch(int argc, const char **argv, const char *prefix, struct repository *repo);
diff --git a/builtin/backfill.c b/builtin/backfill.c
new file mode 100644
index 00000000000..38e6aaeaa03
--- /dev/null
+++ b/builtin/backfill.c
@@ -0,0 +1,29 @@ 
+#include "builtin.h"
+#include "config.h"
+#include "parse-options.h"
+#include "repository.h"
+#include "object.h"
+
+static const char * const builtin_backfill_usage[] = {
+	N_("git backfill [<options>]"),
+	NULL
+};
+
+int cmd_backfill(int argc, const char **argv, const char *prefix, struct repository *repo)
+{
+	struct option options[] = {
+		OPT_END(),
+	};
+
+	if (argc == 2 && !strcmp(argv[1], "-h"))
+		usage_with_options(builtin_backfill_usage, options);
+
+	argc = parse_options(argc, argv, prefix, options, builtin_backfill_usage,
+			     0);
+
+	repo_config(repo, git_default_config, NULL);
+
+	die(_("not implemented"));
+
+	return 0;
+}
diff --git a/command-list.txt b/command-list.txt
index e0bb87b3b5c..c537114b468 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -60,6 +60,7 @@  git-annotate                            ancillaryinterrogators
 git-apply                               plumbingmanipulators            complete
 git-archimport                          foreignscminterface
 git-archive                             mainporcelain
+git-backfill                            mainporcelain           history
 git-bisect                              mainporcelain           info
 git-blame                               ancillaryinterrogators          complete
 git-branch                              mainporcelain           history
diff --git a/git.c b/git.c
index 2fbea24ec92..00d9b3ec8a9 100644
--- a/git.c
+++ b/git.c
@@ -509,6 +509,7 @@  static struct cmd_struct commands[] = {
 	{ "annotate", cmd_annotate, RUN_SETUP },
 	{ "apply", cmd_apply, RUN_SETUP_GENTLY },
 	{ "archive", cmd_archive, RUN_SETUP_GENTLY },
+	{ "backfill", cmd_backfill, RUN_SETUP },
 	{ "bisect", cmd_bisect, RUN_SETUP },
 	{ "blame", cmd_blame, RUN_SETUP },
 	{ "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },