Re: [PATCH v2 1/2] docs: fix places that break compilation in MyFirstObjectWalk
flat view
From: Eric Sunshine <hidden>
Date: 2021-10-29 18:05:01
On Fri, Oct 29, 2021 at 1:58 PM John Cai via GitGitGadget [off-list ref] wrote:
quoted hunk ↗ jump to hunk
Two errors in the example code caused compilation failures due to a missing semicolon as well as initialization with an empty struct. This commit fixes that to make the MyFirstObjectWalk tutorial easier to follow. Signed-off-by: John Cai <redacted> ---diff --git a/Documentation/MyFirstObjectWalk.txt b/Documentation/MyFirstObjectWalk.txt@@ -58,6 +58,7 @@ running, enable trace output by setting the environment variable `GIT_TRACE`. Add usage text and `-h` handling, like all subcommands should consistently do (our test suite will notice and complain if you fail to do so). +We'll need to include the `parse-options.h` header.
It seems like this change belongs in patch [2/2].
quoted hunk ↗ jump to hunk
@@ -65,7 +66,7 @@ int cmd_walken(int argc, const char **argv, const char *prefix) const char * const walken_usage[] = { N_("git walken"), NULL, - } + };
Whereas, this change correctly resides in patch [1/2].
quoted hunk ↗ jump to hunk
struct option options[] = { OPT_END() };@@ -195,7 +196,8 @@ Similarly to the default values, we don't have anything to do here yet ourselves; however, we should call `git_default_config()` if we aren't calling any other existing config callbacks. -Add a new function to `builtin/walken.c`: +Add a new function to `builtin/walken.c`. +We'll also need to include the `config.h` header:
Should be in patch [2/2].
quoted hunk ↗ jump to hunk
@@ -229,7 +231,9 @@ typically done by calling `repo_init_revisions()` with the repository you intend to target, as well as the `prefix` argument of `cmd_walken` and your `rev_info` struct. -Add the `struct rev_info` and the `repo_init_revisions()` call: +Add the `struct rev_info` and the `repo_init_revisions()` call. +We'll also need to include the `revision.h` header:
Patch [2/2].
quoted hunk ↗ jump to hunk
@@ -624,7 +628,8 @@ static void walken_object_walk(struct rev_info *rev) Let's start by calling just the unfiltered walk and reporting our counts. -Complete your implementation of `walken_object_walk()`: +Complete your implementation of `walken_object_walk()`. +We'll also need to include the `list-objects.h` header.
Also patch [2/2].
quoted hunk ↗ jump to hunk
@@ -697,7 +702,7 @@ First, we'll need to `#include "list-objects-filter-options.h"` and set up the static void walken_object_walk(struct rev_info *rev) { - struct list_objects_filter_options filter_options = {}; + struct list_objects_filter_options filter_options = { 0 };
Good, this change belongs here in patch [1/2].