threads / patch / 48793

patchsequencer: use configured comment character

Subject: [PATCH] sequencer: use configured comment character

## tl;dr

5 messages between Jun 28, 2018 and Jun 29, 2018. Diffs are folded; open one to read it.

replies: 4people: 3as markdown or json

Aaron Schrab· Jun 28, 2018, 02:04 UTC · lore

Use configured comment character when generating comments about branches in an instruction sheet. Failure to honor this configuration causes a failure to parse the resulting instruction sheet.

Signed-off-by: Aaron Schrab <aaron@schrab.com>
---
 sequencer.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to sequencer.c +1 −1
diff --git a/sequencer.c b/sequencer.c
index 4034c0461b..caf91af29d 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -3991,7 +3991,7 @@ static int make_script_with_merges(struct pretty_print_context *pp,
 		entry = oidmap_get(&state.commit2label, &commit->object.oid);
 
 		if (entry)
-			fprintf(out, "\n# Branch %s\n", entry->string);
+			fprintf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
 		else
 			fprintf(out, "\n");
 
-- 
2.18.0.419.gfe4b301394
Johannes Schindelin· Jun 28, 2018, 09:57 UTC · re: Aaron Schrab · lore

Re: [PATCH] sequencer: use configured comment character

Hi Aaron,
On Wed, 27 Jun 2018, Aaron Schrab wrote:
> Use configured comment character when generating comments about branches
> in an instruction sheet.  Failure to honor this configuration causes a
> failure to parse the resulting instruction sheet.
Good catch.

Now, if you can refer to the "todo list" as "todo list" (or "todo script" if you must) instead of an "instruction sheet", you have my ACK.

Ciao, Johannes

Junio C Hamano· Jun 28, 2018, 20:38 UTC · re: Aaron Schrab · lore

Re: [PATCH] sequencer: use configured comment character

Aaron Schrab <aaron@schrab.com> writes:
Show 21 quoted lines
> Use configured comment character when generating comments about branches
> in an instruction sheet.  Failure to honor this configuration causes a
> failure to parse the resulting instruction sheet.
>
> Signed-off-by: Aaron Schrab <aaron@schrab.com>
> ---
>  sequencer.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/sequencer.c b/sequencer.c
> index 4034c0461b..caf91af29d 100644
> --- a/sequencer.c
> +++ b/sequencer.c
> @@ -3991,7 +3991,7 @@ static int make_script_with_merges(struct pretty_print_context *pp,
>  		entry = oidmap_get(&state.commit2label, &commit->object.oid);
>  
>  		if (entry)
> -			fprintf(out, "\n# Branch %s\n", entry->string);
> +			fprintf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
>  		else
>  			fprintf(out, "\n");
Would this interact OK with core.commentchar set to "auto"?
Johannes Schindelin· Jun 29, 2018, 14:12 UTC · re: Junio C Hamano · lore

Re: [PATCH] sequencer: use configured comment character

Hi Junio,
On Thu, 28 Jun 2018, Junio C Hamano wrote:
Show 25 quoted lines
> Aaron Schrab <aaron@schrab.com> writes:
> 
> > Use configured comment character when generating comments about branches
> > in an instruction sheet.  Failure to honor this configuration causes a
> > failure to parse the resulting instruction sheet.
> >
> > Signed-off-by: Aaron Schrab <aaron@schrab.com>
> > ---
> >  sequencer.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/sequencer.c b/sequencer.c
> > index 4034c0461b..caf91af29d 100644
> > --- a/sequencer.c
> > +++ b/sequencer.c
> > @@ -3991,7 +3991,7 @@ static int make_script_with_merges(struct pretty_print_context *pp,
> >  		entry = oidmap_get(&state.commit2label, &commit->object.oid);
> >  
> >  		if (entry)
> > -			fprintf(out, "\n# Branch %s\n", entry->string);
> > +			fprintf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
> >  		else
> >  			fprintf(out, "\n");
> 
> Would this interact OK with core.commentchar set to "auto"?
The idea of "auto" is:
	If set to "auto", `git-commit` would select a character that is not
	the beginning character of any line in existing commit messages.

As there are no pre-existing lines in that script (apart from the ones we are about to add with the todo_help), the setting "auto" is pretty moot and we will fall back to the default comment char (or, if there was a previous core.commentChar that was parsed, that one).

In short: the code is fine, but yes, I had to convince myself by looking through the code. (Hinting at a possible improvement of the commit message.)

Ciao, Dscho

Junio C Hamano· Jun 29, 2018, 15:56 UTC · re: Johannes Schindelin · lore

Re: [PATCH] sequencer: use configured comment character

Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:
> In short: the code is fine, but yes, I had to convince myself by looking
> through the code. (Hinting at a possible improvement of the commit
> message.)
Yup, that exactly was what I was hoping readers to realize.

← back to recent threads