Re: [PATCH 4/5] submodule--helper: move config-sanitizing to submodule.c

From: Jeff King <peff@peff.net>
Date: Apr 28, 2016, 15:37 UTC
Message-ID: <20160428153751.GE31063@sigill.intra.peff.net>
In-Reply-To: <CAGZ79kbJvgseY6aBV6vh0aEFNmHDtSvQuM8xHvp7_pYZSXCq+A@mail.gmail.com>

On Thu, Apr 28, 2016 at 08:30:45AM -0700, Stefan Beller wrote:

Show 9 quoted lines

> > +/*
> > + * This function is intended as a callback for use with
> > + * git_config_from_parameters(). It ignores any config options which
> > + * are not suitable for passing along to a submodule, and accumulates the rest
> > + * in "data", which must be a pointer to a strbuf.
> 
> So why is it a void* then? You could make it a strbuf* here, so you
> would not have to document it?
> Oh right, because of git_config_from_parameters(sanitize_submodule_config, ...

Exactly (and why it is all the more important do document it!).

Show 8 quoted lines

> > The end result can
> > + * be put into $GIT_CONFIG_PARAMETERS for passing to a sub-process.
> 
> s/sub-process/process operating on submodules/, maybe ?
> 
> While it is technically a sub-process, I started to have an aversion
> against "sub"-things
> unless strictly required. :)

Technically it can be any process which then spawns a process operating on a submodule. Maybe "another process" would be enough?

-Peff