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

[PATCH v2 2/2] docs: add headers in MyFirstObjectWalk

From
John Cai via GitGitGadget <gitgitgadget@gmail.com>
Date
Oct 29, 2021, 17:58 UTC
Message-ID
<7268f00c11fc0b9ece99f6a2940c124892791768.1635530296.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1063.v2.git.1635530296.gitgitgadget@gmail.com>
From: John Cai <johncai86@gmail.com>

In several places, headers need to be included or else the code won't compile. Since this is the first object walk, it would be nice to include them in the tutorial to make it easier to follow.

Signed-off-by: John Cai <johncai86@gmail.com>
---
 Documentation/MyFirstObjectWalk.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
diff --git a/Documentation/MyFirstObjectWalk.txt b/Documentation/MyFirstObjectWalk.txt
index e22615105c0..ca267941f3e 100644
--- a/Documentation/MyFirstObjectWalk.txt
+++ b/Documentation/MyFirstObjectWalk.txt
@@ -61,6 +61,10 @@ Add usage text and `-h` handling, like all subcommands should consistently do
 We'll need to include the `parse-options.h` header.
 
 ----
+#include "parse-options.h"
+
+...
+
 int cmd_walken(int argc, const char **argv, const char *prefix)
 {
 	const char * const walken_usage[] = {
@@ -200,6 +204,10 @@ Add a new function to `builtin/walken.c`.
 We'll also need to include the `config.h` header:
 
 ----
+#include "config.h"
+
+...
+
 static int git_walken_config(const char *var, const char *value, void *cb)
 {
 	/*
@@ -235,6 +243,10 @@ Add the `struct rev_info` and the `repo_init_revisions()` call.
 We'll also need to include the `revision.h` header:
 
 ----
+#include "revision.h"
+
+...
+
 int cmd_walken(int argc, const char **argv, const char *prefix)
 {
 	/* This can go wherever you like in your declarations.*/
@@ -632,6 +644,10 @@ Complete your implementation of `walken_object_walk()`.
 We'll also need to include the `list-objects.h` header.
 
 ----
+#include "list-objects.h"
+
+...
+
 	traverse_commit_list(rev, walken_show_commit, walken_show_object, NULL);
 
 	printf("commits %d\nblobs %d\ntags %d\ntrees %d\n", commit_count,
-- 
gitgitgadget
Previous: Eric SunshineNext: John Cai via GitGitGadget
Message 12 of 16 in “fix up example code in MyFirstObjectWalk tutorial”
  1. 0/2 fix up example code in MyFirstObjectWalk tutorialJohn Cai via GitGitGadget, Oct 27, 2021
  2. 1/2 docs: fix places that break compliation in MyFirstObjectWalkJohn Cai via GitGitGadget, Oct 27, 2021
  3. Eric SunshineOct 27, 2021
  4. 2/2 docs: add headers in MyFirstObjectWalkJohn Cai via GitGitGadget, Oct 27, 2021
  5. Eric SunshineOct 27, 2021
  6. Junio C HamanoOct 27, 2021
  7. Bagas SanjayaOct 30, 2021
  8. Eric SunshineOct 30, 2021
  9. 0/2 fix up example code in MyFirstObjectWalk tutorialJohn Cai via GitGitGadget, Oct 29, 2021
  10. 1/2 docs: fix places that break compilation in MyFirstObjectWalkJohn Cai via GitGitGadget, Oct 29, 2021
  11. Eric SunshineOct 29, 2021
  12. 2/2 docs: add headers in MyFirstObjectWalkJohn Cai via GitGitGadget, Oct 29, 2021
  13. 0/2 fix up example code in MyFirstObjectWalk tutorialJohn Cai via GitGitGadget, Oct 29, 2021
  14. 1/2 docs: fix places that break compilation in MyFirstObjectWalkJohn Cai via GitGitGadget, Oct 29, 2021
  15. 2/2 docs: add headers in MyFirstObjectWalkJohn Cai via GitGitGadget, Oct 29, 2021
  16. Eric SunshineOct 29, 2021

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.