git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [RFC PATCH 02/12] commit-graph: add 'check' subcommand

From
Jakub Narebski <jnareb@gmail.com>
Date
Apr 19, 2018, 13:24 UTC
Message-ID
<86o9iffhxl.fsf@gmail.com>
In-Reply-To
<20180417181028.198397-3-dstolee@microsoft.com>
Derrick Stolee <dstolee@microsoft.com> writes:
> If the commit-graph file becomes corrupt, we need a way to verify
> its contents match the object database. In the manner of 'git fsck'
> we will implement a 'git commit-graph check' subcommand to report
> all issues with the file.
Bikeshed: should the subcommand be called 'check' or 'verify'?
>
> Add the 'check' subcommand to the 'commit-graph' builtin and its
> documentation. Add a simple test that ensures the command returns
> a zero error code.

It would be nice to have the information that the 'check' subcommand is currently a [almost no-op] stub in the subject... but that might not have been possible to fit.

Show 21 quoted lines
>
> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
> ---
>  Documentation/git-commit-graph.txt |  7 +++++-
>  builtin/commit-graph.c             | 38 ++++++++++++++++++++++++++++++
>  commit-graph.c                     |  5 ++++
>  commit-graph.h                     |  2 ++
>  t/t5318-commit-graph.sh            |  5 ++++
>  5 files changed, 56 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt
> index 4c97b555cc..93c7841ba2 100644
> --- a/Documentation/git-commit-graph.txt
> +++ b/Documentation/git-commit-graph.txt
> @@ -9,10 +9,10 @@ git-commit-graph - Write and verify Git commit graph files
>  SYNOPSIS
>  --------
>  [verse]
> +'git commit-graph check' [--object-dir <dir>]
>  'git commit-graph read' [--object-dir <dir>]
>  'git commit-graph write' <options> [--object-dir <dir>]

I still think that [--object-dir <dir>] should be the optional parameter to the "git" wrapper, not to the "git commit-graph" command, i.e.

   'git [--object-dir=<dir>] commit-graph <command>'
But this can be done later, in a separate patch series.
>  
> -
Stray change.
Show 12 quoted lines
>  DESCRIPTION
>  -----------
>  
> @@ -52,6 +52,11 @@ existing commit-graph file.
>  Read a graph file given by the commit-graph file and output basic
>  details about the graph file. Used for debugging purposes.
>  
> +'check'::
> +
> +Read the commit-graph file and verify its contents against the object
> +database. Used to check for corrupted data.
> +

I wonder if we should offer to verify file without checking against the object database (which is the costly part, I think). But this too can be added later if needed.

Show 15 quoted lines
>  
>  EXAMPLES
>  --------
> diff --git a/builtin/commit-graph.c b/builtin/commit-graph.c
> index 37420ae0fd..77c1a04932 100644
> --- a/builtin/commit-graph.c
> +++ b/builtin/commit-graph.c
> @@ -7,11 +7,17 @@
>  
>  static char const * const builtin_commit_graph_usage[] = {
>  	N_("git commit-graph [--object-dir <objdir>]"),
> +	N_("git commit-graph check [--object-dir <objdir>]"),
>  	N_("git commit-graph read [--object-dir <objdir>]"),
>  	N_("git commit-graph write [--object-dir <objdir>] [--append] [--stdin-packs|--stdin-commits]"),
>  	NULL

Isn't the case that each command would support the [--object-dir <objdir>] parameter?

Show 7 quoted lines
>  };
>  
> +static const char * const builtin_commit_graph_check_usage[] = {
> +	N_("git commit-graph check [--object-dir <objdir>]"),
> +	NULL
> +};
> +
Looks good to me.
Show 11 quoted lines
>  static const char * const builtin_commit_graph_read_usage[] = {
>  	N_("git commit-graph read [--object-dir <objdir>]"),
>  	NULL
> @@ -29,6 +35,36 @@ static struct opts_commit_graph {
>  	int append;
>  } opts;
>  
> +
> +static int graph_check(int argc, const char **argv)
> +{
> +	struct commit_graph *graph = 0;
This is NULL, isn't it?  Shouldn't it be stated as such?
Show 6 quoted lines
> +	char *graph_name;
> +
> +	static struct option builtin_commit_graph_check_options[] = {
> +		OPT_STRING(0, "object-dir", &opts.obj_dir,
> +			   N_("dir"),
> +			   N_("The object directory to store the graph")),

This again is not the directory to _store_ the graph; this is the directory to _read_ graph from, or directory where the commit graph is _stored_.

Show 15 quoted lines
> +		OPT_END(),
> +	};
> +
> +	argc = parse_options(argc, argv, NULL,
> +			     builtin_commit_graph_check_options,
> +			     builtin_commit_graph_check_usage, 0);
> +
> +	if (!opts.obj_dir)
> +		opts.obj_dir = get_object_directory();
> +
> +	graph_name = get_commit_graph_filename(opts.obj_dir);
> +	graph = load_commit_graph_one(graph_name);
> +
> +	if (!graph)
> +		die("graph file %s does not exist", graph_name);

Shouldn't we quote pathname? Shouldn't this error message be marked for translation? Shouldn't we use "commit graph file" explicitly?

Show 30 quoted lines
> +	FREE_AND_NULL(graph_name);
> +
> +	return check_commit_graph(graph);
> +}
> +
>  static int graph_read(int argc, const char **argv)
>  {
>  	struct commit_graph *graph = NULL;
> @@ -160,6 +196,8 @@ int cmd_commit_graph(int argc, const char **argv, const char *prefix)
>  			     PARSE_OPT_STOP_AT_NON_OPTION);
>  
>  	if (argc > 0) {
> +		if (!strcmp(argv[0], "check"))
> +			return graph_check(argc, argv);
>  		if (!strcmp(argv[0], "read"))
>  			return graph_read(argc, argv);
>  		if (!strcmp(argv[0], "write"))
> diff --git a/commit-graph.c b/commit-graph.c
> index 3f0c142603..cd0634bba0 100644
> --- a/commit-graph.c
> +++ b/commit-graph.c
> @@ -819,3 +819,8 @@ void write_commit_graph(const char *obj_dir,
>  	oids.alloc = 0;
>  	oids.nr = 0;
>  }
> +
> +int check_commit_graph(struct commit_graph *g)
> +{
> +	return !g;
> +}

I understand that it is just a start of implementing this feature, but it looks a bit strange that 'read' command does more sanity checks that the 'check' command...

Show 23 quoted lines
> diff --git a/commit-graph.h b/commit-graph.h
> index 96cccb10f3..e8c8d99dff 100644
> --- a/commit-graph.h
> +++ b/commit-graph.h
> @@ -53,4 +53,6 @@ void write_commit_graph(const char *obj_dir,
>  			int nr_commits,
>  			int append);
>  
> +int check_commit_graph(struct commit_graph *g);
> +
>  #endif
> diff --git a/t/t5318-commit-graph.sh b/t/t5318-commit-graph.sh
> index 77d85aefe7..e91053271a 100755
> --- a/t/t5318-commit-graph.sh
> +++ b/t/t5318-commit-graph.sh
> @@ -230,4 +230,9 @@ test_expect_success 'perform fast-forward merge in full repo' '
>  	test_cmp expect output
>  '
>  
> +test_expect_success 'git commit-graph check' '
> +	cd "$TRASH_DIRECTORY/full" &&
> +	git commit-graph check >output
> +'

There should also be negative check, that 'git commit-graph check' fails if there is no commit-graph file, isn't it?

> +
>  test_done
Best,
-- 
Jakub Narębski
Previous: Derrick StoleeNext: Derrick Stolee
Message 21 of 149 in “Integrate commit-graph into 'fsck' and 'gc'”
  1. 00/12 Integrate commit-graph into 'fsck' and 'gc'Derrick Stolee, Apr 17, 2018
  2. 01/12 fixup! commit-graph: always load commit-graph informationDerrick Stolee, Apr 17, 2018
  3. 04/12 commit-graph: parse commit from chosen graphDerrick Stolee, Apr 17, 2018
  4. Jakub NarebskiApr 19, 2018
  5. 06/12 commit: force commit to parse from object databaseDerrick Stolee, Apr 17, 2018
  6. Jakub NarebskiApr 20, 2018
  7. 07/12 commit-graph: load a root tree from specific graphDerrick Stolee, Apr 17, 2018
  8. Jakub NarebskiApr 20, 2018
  9. 10/12 commit-graph: add '--reachable' optionDerrick Stolee, Apr 17, 2018
  10. Jakub NarebskiApr 20, 2018
  11. 12/12 commit-graph: update design documentDerrick Stolee, Apr 17, 2018
  12. Jakub NarebskiApr 20, 2018
  13. 11/12 gc: automatically write commit-graph filesDerrick Stolee, Apr 17, 2018
  14. Jakub NarebskiApr 20, 2018
  15. Ævar Arnfjörð BjarmasonApr 20, 2018
  16. 09/12 fsck: check commit-graphDerrick Stolee, Apr 17, 2018
  17. Jakub NarebskiApr 20, 2018
  18. 08/12 commit-graph: verify commit contents against odbDerrick Stolee, Apr 17, 2018
  19. Jakub NarebskiApr 20, 2018
  20. 02/12 commit-graph: add 'check' subcommandDerrick Stolee, Apr 17, 2018
  21. Jakub NarebskiApr 19, 2018
  22. 03/12 commit-graph: check file header informationDerrick Stolee, Apr 17, 2018
  23. Jakub NarebskiApr 19, 2018
  24. 05/12 commit-graph: check fanout and lookup tableDerrick Stolee, Apr 17, 2018
  25. Jakub NarebskiApr 20, 2018
  26. Derrick StoleeApr 17, 2018
  27. 00/12 Integrate commit-graph into fsck, gc, and fetchDerrick Stolee, May 10, 2018
  28. 01/12 commit-graph: add 'verify' subcommandDerrick Stolee, May 10, 2018
  29. Martin ÅgrenMay 10, 2018
  30. 02/12 commit-graph: verify file header informationDerrick Stolee, May 10, 2018
  31. Martin ÅgrenMay 10, 2018
  32. 04/12 commit-graph: verify fanout and lookup tableDerrick Stolee, May 10, 2018
  33. Martin ÅgrenMay 10, 2018
  34. Derrick StoleeMay 11, 2018
  35. 06/12 commit-graph: load a root tree from specific graphDerrick Stolee, May 10, 2018
  36. 08/12 fsck: verify commit-graphDerrick Stolee, May 10, 2018
  37. 12/12 commit-graph: update design documentDerrick Stolee, May 10, 2018
  38. 11/12 fetch: compute commit-graph by defaultDerrick Stolee, May 10, 2018
  39. 07/12 commit-graph: verify commit contents against odbDerrick Stolee, May 10, 2018
  40. 09/12 commit-graph: add '--reachable' optionDerrick Stolee, May 10, 2018
  41. 10/12 gc: automatically write commit-graph filesDerrick Stolee, May 10, 2018
  42. 05/12 commit: force commit to parse from object databaseDerrick Stolee, May 10, 2018
  43. 03/12 commit-graph: parse commit from chosen graphDerrick Stolee, May 10, 2018
  44. Martin ÅgrenMay 10, 2018
  45. Stefan BellerMay 10, 2018
  46. Derrick StoleeMay 11, 2018
  47. Martin ÅgrenMay 11, 2018
  48. Ævar Arnfjörð BjarmasonMay 10, 2018
  49. Derrick StoleeMay 11, 2018
  50. 00/12 Integrate commit-graph into fsck and gcDerrick Stolee, May 11, 2018
  51. 02/12 commit-graph: verify file header informationDerrick Stolee, May 11, 2018
  52. Martin ÅgrenMay 12, 2018
  53. Derrick StoleeMay 14, 2018
  54. Jakub NarebskiMay 20, 2018
  55. 01/12 commit-graph: add 'verify' subcommandDerrick Stolee, May 11, 2018
  56. Martin ÅgrenMay 12, 2018
  57. Derrick StoleeMay 14, 2018
  58. Jakub NarebskiMay 20, 2018
  59. 03/12 commit-graph: test that 'verify' finds corruptionDerrick Stolee, May 11, 2018
  60. Martin ÅgrenMay 12, 2018
  61. Jakub NarebskiMay 21, 2018
  62. Derrick StoleeMay 24, 2018
  63. 04/12 commit-graph: parse commit from chosen graphDerrick Stolee, May 11, 2018
  64. Martin ÅgrenMay 12, 2018
  65. 05/12 commit-graph: verify fanout and lookup tableDerrick Stolee, May 11, 2018
  66. 06/12 commit: force commit to parse from object databaseDerrick Stolee, May 11, 2018
  67. Martin ÅgrenMay 12, 2018
  68. 09/12 fsck: verify commit-graphDerrick Stolee, May 11, 2018
  69. Martin ÅgrenMay 17, 2018
  70. 11/12 gc: automatically write commit-graph filesDerrick Stolee, May 11, 2018
  71. Martin ÅgrenMay 17, 2018
  72. 12/12 commit-graph: update design documentDerrick Stolee, May 11, 2018
  73. 07/12 commit-graph: load a root tree from specific graphDerrick Stolee, May 11, 2018
  74. Martin ÅgrenMay 12, 2018
  75. 08/12 commit-graph: verify commit contents against odbDerrick Stolee, May 11, 2018
  76. Martin ÅgrenMay 12, 2018
  77. Derrick StoleeMay 14, 2018
  78. Martin ÅgrenMay 15, 2018
  79. 10/12 commit-graph: add '--reachable' optionDerrick Stolee, May 11, 2018
  80. Martin ÅgrenMay 17, 2018
  81. 00/20 Integrate commit-graph into 'fsck' and 'gc'Derrick Stolee, May 24, 2018
  82. 01/20 commit-graph: UNLEAK before die()Derrick Stolee, May 24, 2018
  83. Stefan BellerMay 24, 2018
  84. Derrick StoleeMay 25, 2018
  85. 04/20 commit: force commit to parse from object databaseDerrick Stolee, May 24, 2018
  86. Jakub NarebskiMay 27, 2018
  87. 03/20 commit-graph: parse commit from chosen graphDerrick Stolee, May 24, 2018
  88. Jakub NarebskiMay 27, 2018
  89. Derrick StoleeMay 29, 2018
  90. 06/20 commit-graph: add 'verify' subcommandDerrick Stolee, May 24, 2018
  91. Jakub NarebskiMay 27, 2018
  92. Derrick StoleeMay 30, 2018
  93. Jakub NarebskiJun 2, 2018
  94. Derrick StoleeJun 4, 2018
  95. 07/20 commit-graph: verify catches corrupt signatureDerrick Stolee, May 24, 2018
  96. Jakub NarebskiMay 28, 2018
  97. Derrick StoleeMay 29, 2018
  98. Jakub NarebskiJun 2, 2018
  99. 05/20 commit-graph: load a root tree from specific graphDerrick Stolee, May 24, 2018
  100. Jakub NarebskiMay 27, 2018
  101. 08/20 commit-graph: verify required chunks are presentDerrick Stolee, May 24, 2018
  102. Jakub NarebskiMay 28, 2018
  103. 02/20 commit-graph: fix GRAPH_MIN_SIZEDerrick Stolee, May 24, 2018
  104. Jakub NarebskiMay 26, 2018
  105. brian m. carlsonMay 26, 2018
  106. Jakub NarebskiJun 2, 2018
  107. 09/20 commit-graph: verify corrupt OID fanout and lookupDerrick Stolee, May 24, 2018
  108. Jakub NarebskiMay 30, 2018
  109. Derrick StoleeMay 30, 2018
  110. Duy NguyenJun 2, 2018
  111. Derrick StoleeJun 4, 2018
  112. Duy NguyenJun 4, 2018
  113. 10/20 commit-graph: verify objects existDerrick Stolee, May 24, 2018
  114. Jakub NarebskiMay 30, 2018
  115. Derrick StoleeMay 31, 2018
  116. 11/20 commit-graph: verify root tree OIDsDerrick Stolee, May 24, 2018
  117. Jakub NarebskiMay 30, 2018
  118. Derrick StoleeMay 31, 2018
  119. Jakub NarebskiJun 2, 2018
  120. 12/20 commit-graph: verify parent listDerrick Stolee, May 24, 2018
  121. Jakub NarebskiJun 1, 2018
  122. 14/20 commit-graph: verify commit dateDerrick Stolee, May 24, 2018
  123. Jakub NarebskiJun 2, 2018
  124. 16/20 commit-graph: verify contents match checksumDerrick Stolee, May 24, 2018
  125. SZEDER GáborMay 30, 2018
  126. Jakub NarebskiJun 2, 2018
  127. Derrick StoleeJun 4, 2018
  128. 19/20 gc: automatically write commit-graph filesDerrick Stolee, May 24, 2018
  129. Jakub NarebskiJun 2, 2018
  130. Derrick StoleeJun 4, 2018
  131. 20/20 commit-graph: update design documentDerrick Stolee, May 24, 2018
  132. Jakub NarebskiJun 2, 2018
  133. 17/20 fsck: verify commit-graphDerrick Stolee, May 24, 2018
  134. Jakub NarebskiJun 2, 2018
  135. Derrick StoleeJun 4, 2018
  136. 15/20 commit-graph: test for corrupted octopus edgeDerrick Stolee, May 24, 2018
  137. Jakub NarebskiJun 2, 2018
  138. Derrick StoleeJun 4, 2018
  139. 18/20 commit-graph: add '--reachable' optionDerrick Stolee, May 24, 2018
  140. Jakub NarebskiJun 2, 2018
  141. Derrick StoleeJun 4, 2018
  142. 13/20 commit-graph: verify generation numberDerrick Stolee, May 24, 2018
  143. Jakub NarebskiJun 2, 2018
  144. Derrick StoleeJun 4, 2018
  145. Ævar Arnfjörð BjarmasonMay 24, 2018
  146. Junio C HamanoMay 25, 2018
  147. Junio C HamanoMay 29, 2018
  148. Derrick StoleeMay 29, 2018
  149. Junio C HamanoMay 29, 2018

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.