Skip to contentSkip to conversation

MyFirstObjectWalk: include necessary header files

PATCH New Vinayak Dev 1 participant 1 message Jul 1, 2023 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 MyFirstObjectWalk: include necessary header files

In Documentation/MyFirstObjectWalk.txt, the functions trace_printf() and oid_to_hex() are used to enable trace output and get object ids as strings respectively. However, the files "trace.h" and "hex.h" are not included, which produces an error when the code from the tutorial is compiled, with the compiler complaining that the functions are not defined before usage. Therefore, add includes for "trace.h" and "hex.h" in the tutorial.

---
 Documentation/MyFirstObjectWalk.txt | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)
Documentation/MyFirstObjectWalk.txt +12 -6
index eee513e86f..bb99e2bb6e 100644
@@ -41,6 +41,7 @@ Open up a new file `builtin/walken.c` and set up the command handler:
  */
 
 #include "builtin.h"
+#include "trace.h"
 
 int cmd_walken(int argc, const char **argv, const char *prefix)
 {
@@ -49,12 +50,13 @@ int cmd_walken(int argc, const char **argv, const char *prefix)
 }
 ----
 
-NOTE: `trace_printf()` differs from `printf()` in that it can be turned on or
-off at runtime. For the purposes of this tutorial, we will write `walken` as
-though it is intended for use as a "plumbing" command: that is, a command which
-is used primarily in scripts, rather than interactively by humans (a "porcelain"
-command). So we will send our debug output to `trace_printf()` instead. When
-running, enable trace output by setting the environment variable `GIT_TRACE`.
+NOTE: `trace_printf()`, defined in `trace.h`, differs from `printf()` in
+that it can be turned on or off at runtime. For the purposes of this
+tutorial, we will write `walken` as though it is intended for use as
+a "plumbing" command: that is, a command which is used primarily in
+scripts, rather than interactively by humans (a "porcelain" command).
+So we will send our debug output to `trace_printf()` instead.
+When 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).
@@ -805,6 +807,10 @@ just walks of commits. First, we'll make our handlers chattier - modify
 go:
 
 ----
+#include "hex.h"
+
+...
+
 static void walken_show_commit(struct commit *cmt, void *buf)
 {
 	trace_printf("commit: %s\n", oid_to_hex(&cmt->object.oid));

base-commit: a9e066fa63149291a55f383cfa113d8bdbdaa6b3

Signature · 1 line
2.41.0