From: Junio C Hamano <gitster@pobox.com>
Date: Sat, 05 Oct 2019 09:07:04 GMT
Subject: Re: [PATCH] git-rev-list.txt: prune options in synopsis
Message-ID: <xmqqmuef7e87.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <645cc54c4c86493c855ec6b0b892a0bc8e999249.1570234118.git.liu.denton@gmail.com>

Denton Liu <liu.denton@gmail.com> writes:

> The synopsis section in git-rev-list.txt has grown to be a huge list
> that probably needs its own synopsis. Since the list is huge, users may
> be given the false impression that the list is complete, however it is
> not. It is missing many of the available options.
>
> Since the list of options in the synopsis is not only annoying but
> actively harmful, replace it with `[<options>]` so users know to
> explicitly look through the documentation for further information.

I am not sure listing only the most often used ones is harmful.  It
indeed is annoying and it is a good idea to shrink it down like this
patch does.

Thanks.