threads / patch / 60380

patchInclude gettext.h in MyFirstContribution tutorial

Subject: [PATCH] Include gettext.h in MyFirstContribution tutorial

## tl;dr

3 messages between Oct 17, 2023 and Oct 26, 2023. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Jacob Stopak· Oct 17, 2023, 04:15 UTC · lore

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>
---
 Documentation/MyFirstContribution.txt | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Show changes to Documentation/MyFirstContribution.txt +4 −3
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

-- 
2.42.0.398.ga9ecda2788.dirty
Junio C Hamano· Oct 18, 2023, 21:35 UTC · re: Jacob Stopak · lore

Re: [PATCH] Include gettext.h in MyFirstContribution tutorial

Jacob Stopak <jacob@initialcommit.io> writes:
Show 10 quoted lines
> 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>
> ---
>  Documentation/MyFirstContribution.txt | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)

Who's the first responder on this document these days? I think the "psuh" was Emily's invention, so sending it in her direction.

Thanks.
Show 19 quoted lines
> 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
Emily Shaffer· Oct 26, 2023, 21:21 UTC · re: Junio C Hamano · lore

Re: [PATCH] Include gettext.h in MyFirstContribution tutorial

On Wed, Oct 18, 2023 at 02:35:17PM -0700, Junio C Hamano wrote:
Show 18 quoted lines
> 
> Jacob Stopak <jacob@initialcommit.io> writes:
> 
> > 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>
> > ---
> >  Documentation/MyFirstContribution.txt | 7 ++++---
> >  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> Who's the first responder on this document these days?  I think the
> "psuh" was Emily's invention, so sending it in her direction.
> 
> Thanks.

Thanks for the nudge and sorry for the slow response (and thanks to Jack for pointing out to me that I was delinquent).

I like this change. Nice touch disambiguating "function" in the following paragraph.

Reviewed-by: Emily Shaffer <nasamuffin@google.com>
Show 20 quoted lines
> 
> > 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

← back to recent threads