Re: [PATCH v2 1/5] submodule: expose the '--for-status' option of summary

From: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Date: Aug 8, 2020, 14:40 UTC
Message-ID: <831df9f2-0663-0dfc-0871-d34864d1ecde@gmail.com>
In-Reply-To: <20200806164102.6707-2-shouryashukla.oo@gmail.com>

On 06-08-2020 22:10, Shourya Shukla wrote:

Show 15 quoted lines

> The 'for-status' option is used to compute the summary of submodule(s)
> in a superproject by skipping the ignored submdules i.e., those with
> 'submodule.<name>.ignore' set to 'all' in the '.gitmodules' or
> '.git/config', with the latter taking precedence over the former.
> 
> The option was introduced in d0f64dd44d (git-submodule summary:
> --for-status option, 2008-04-12), refined in 3ba7407b8b (submodule
> summary: ignore --for-status option, 2013-09-06) and finally perfected
> in 927b26f87a (submodule: don't print status output with ignore=all,
> 2013-09-01). But, it was not mentioned in the 'git submodule'
> Documentation.
> 
> Expose the '--for-status' option accepted by the command 'git submodule
> summary'.
>

I've had one concern about exposing '--for-status'. As of now, the name of the option has no relation with the behaviour that we get as a consequence. So long, the option has been internal and this wasn't a problem. Now that we're considering to expose it in the docs, usage and autocomplete, I would say it should be done after renaming it appropriately given that it's easy to do now than later. As to name suggestions, I really don't have any.

Also, as to whether exposing this would be useful at all, I really don't know.

-- 
Sivaraam