summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJacob Stopak <jacob@initialcommit.io>2023-10-16 21:15:03 -0700
committerJunio C Hamano <gitster@pobox.com>2023-10-28 09:02:06 +0900
commit6b79a2183c85749996f561d0f27bd0dc799aaae9 (patch)
treef00055b218de32bc8937453bb597b65947bb5340
parent43c8a30d150ecede9709c1f2527c8fba92c65f40 (diff)
downloadgit-6b79a2183c85749996f561d0f27bd0dc799aaae9.tar.gz
Include gettext.h in MyFirstContribution tutorial
The tutorial in Documentation/MyFirstContribution.txt has steps to print some text using the "_" function. However, this leads to compiler errors when running "make" since "gettext.h" is not #included. Update docs with a note to #include "gettext.h" in "builtin/psuh.c". Signed-off-by: Jacob Stopak <jacob@initialcommit.io> Reviewed-by: Emily Shaffer <nasamuffin@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/MyFirstContribution.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 62d11a5cd7..7cfed60c2e 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -160,10 +160,11 @@ in order to keep the declarations alphabetically sorted:
int cmd_psuh(int argc, const char **argv, const char *prefix);
----
-Be sure to `#include "builtin.h"` in your `psuh.c`.
+Be sure to `#include "builtin.h"` in your `psuh.c`. You'll also need to
+`#include "gettext.h"` to use functions related to printing output text.
-Go ahead and add some throwaway printf to that function. This is a decent
-starting point as we can now add build rules and register the command.
+Go ahead and add some throwaway printf to the `cmd_psuh` function. This is a
+decent starting point as we can now add build rules and register the command.
NOTE: Your throwaway text, as well as much of the text you will be adding over
the course of this tutorial, is user-facing. That means it needs to be