[PATCH] strbuf_stripspace(): rename skip_comments arg to strip_comments

[PATCH] strbuf_stripspace(): rename skip_comments arg to strip_comments

[Oswald Buddenhagen]

That makes its function much clearer and more consistent with the
context.

Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
---
 strbuf.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/strbuf.c b/strbuf.c
index 1c57ac6574..49e8beaa4c 100644
--- a/strbuf.c
+++ b/strbuf.c
@@ -1118,10 +1118,10 @@ static size_t cleanup(char *line, size_t len)
  *
  * If last line does not have a newline at the end, one is added.
  *
- * Enable skip_comments to skip every line starting with comment
+ * Enable strip_comments to strip every line starting with a comment
  * character.
  */
-void strbuf_stripspace(struct strbuf *sb, int skip_comments)
+void strbuf_stripspace(struct strbuf *sb, int strip_comments)
 {
 	size_t empties = 0;
 	size_t i, j, len, newlen;
@@ -1134,7 +1134,7 @@ void strbuf_stripspace(struct strbuf *sb, int skip_comments)
 		eol = memchr(sb->buf + i, '\n', sb->len - i);
 		len = eol ? eol - (sb->buf + i) + 1 : sb->len - i;
 
-		if (skip_comments && len && sb->buf[i] == comment_line_char) {
+		if (strip_comments && len && sb->buf[i] == comment_line_char) {
 			newlen = 0;
 			continue;
 		}
-- 
2.40.0.152.g15d061e6df

Re: [PATCH] strbuf_stripspace(): rename skip_comments arg to strip_comments

[Oswald Buddenhagen]

ping!

On Thu, Mar 23, 2023 at 05:22:34PM +0100, Oswald Buddenhagen wrote:
>That makes its function much clearer and more consistent with the
>context.
>

Re: [PATCH] strbuf_stripspace(): rename skip_comments arg to strip_comments

[Jeff King]

On Thu, Apr 27, 2023 at 09:49:48AM +0200, Oswald Buddenhagen wrote:

> ping!
> 
> On Thu, Mar 23, 2023 at 05:22:34PM +0100, Oswald Buddenhagen wrote:
> > That makes its function much clearer and more consistent with the
> > context.

A quick aside on workflow:

  - It's customary on this list to just re-send the patch (with a note
    that it's a re-send below the "---"), rather than a "ping" email.
    They both potentially get more people's attention, but one doesn't
    require people to dig up the old thread. :)

  - We usually reserve cc-ing for people who have touched that area, or
    participated in previous discussions on the topic. That helps people
    manage the list traffic by seeing which threads somebody else
    thought would be important for them to see. But here I think I'm on
    the cc because I'm a sucker who will review anything that gets cc'd
    to me. A better cc might be folks who added the parameter, though it
    has been long enough that they may or may not be active.

I'll quote liberally from the original below:

On Thu, Mar 23, 2023 at 05:22:34PM +0100, Oswald Buddenhagen wrote:

> That makes its function much clearer and more consistent with the
> context.
> 
> Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
> ---
>  strbuf.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/strbuf.c b/strbuf.c
> index 1c57ac6574..49e8beaa4c 100644
> --- a/strbuf.c
> +++ b/strbuf.c
> @@ -1118,10 +1118,10 @@ static size_t cleanup(char *line, size_t len)
>   *
>   * If last line does not have a newline at the end, one is added.
>   *
> - * Enable skip_comments to skip every line starting with comment
> + * Enable strip_comments to strip every line starting with a comment
>   * character.
>   */
> -void strbuf_stripspace(struct strbuf *sb, int skip_comments)
> +void strbuf_stripspace(struct strbuf *sb, int strip_comments)

I don't have a strong opinion either way. The original name was just
copied from stripspace()'s similar parameter, which came from 9690c118fa
(Fix git-stripspace to process correctly long lines and spaces.,
2007-06-25). I don't think it carries any particular significance,
though I find either name easy enough to understand.

-Peff

Re: [PATCH] strbuf_stripspace(): rename skip_comments arg to strip_comments

[Felipe Contreras]

Jeff King wrote:
> I'll quote liberally from the original below:
> 
> On Thu, Mar 23, 2023 at 05:22:34PM +0100, Oswald Buddenhagen wrote:
> 
> > That makes its function much clearer and more consistent with the
> > context.
> > 
> > Signed-off-by: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
> > ---
> >  strbuf.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/strbuf.c b/strbuf.c
> > index 1c57ac6574..49e8beaa4c 100644
> > --- a/strbuf.c
> > +++ b/strbuf.c
> > @@ -1118,10 +1118,10 @@ static size_t cleanup(char *line, size_t len)
> >   *
> >   * If last line does not have a newline at the end, one is added.
> >   *
> > - * Enable skip_comments to skip every line starting with comment
> > + * Enable strip_comments to strip every line starting with a comment
> >   * character.
> >   */
> > -void strbuf_stripspace(struct strbuf *sb, int skip_comments)
> > +void strbuf_stripspace(struct strbuf *sb, int strip_comments)
> 
> I don't have a strong opinion either way. The original name was just
> copied from stripspace()'s similar parameter, which came from 9690c118fa
> (Fix git-stripspace to process correctly long lines and spaces.,
> 2007-06-25). I don't think it carries any particular significance,
> though I find either name easy enough to understand.

To me strip_comments makes more sense, because it implies an active
action, skip_comments implies nothing will be done on them.

-- 
Felipe Contreras