git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Philip Oakley <philipoakley@iee.email>
To: Jeff King <peff@peff.net>, Denton Liu <liu.denton@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH] git-rev-list.txt: prune options in synopsis
Date: Fri, 11 Oct 2019 17:02:33 +0100	[thread overview]
Message-ID: <c9e7fbd6-7ad6-bce9-1e17-6391ab3e0630@iee.email> (raw)
In-Reply-To: <20191011060457.GC20094@sigill.intra.peff.net>

On 11/10/2019 07:04, Jeff King wrote:
> On Fri, Oct 04, 2019 at 05:13:08PM -0700, Denton Liu wrote:
>
>> 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.
>>
>> While we're at it, update the optional path notation so that it is more
>> modern.
> Yes, thank you! This has bugged me for a while. I suspect there are
> other pages that could use similar treatment, but I don't mind at all
> doing it incrementally.
>
> (One of them is git-branch, where I think the synopsis should focus on
> showing the major modes and not listing every possible branch-listing
> option).
>
> -Peff
I'd agree that simplifying the rev-list page is good.

Another case, of a different style, is that of `git bundle --all` which 
does need mentioning that particular rev-list option as a major usage (I 
couldn't manage to understand the three layers of man page that needed 
reading).

I had proposed a patch many years ago [1] but the feedback wasn't 
positive, though my SO question continues [2] to get votes.

Philip

[1] 
https://public-inbox.org/git/1348010734-664-2-git-send-email-philipoakley@iee.org/
[2] 
https://stackoverflow.com/questions/11792671/how-to-git-bundle-a-complete-repo


  reply	other threads:[~2019-10-11 16:02 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-05  0:13 [PATCH] git-rev-list.txt: prune options in synopsis Denton Liu
2019-10-05  9:07 ` Junio C Hamano
2019-10-11  6:04 ` Jeff King
2019-10-11 16:02   ` Philip Oakley [this message]
2019-10-11 16:11     ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c9e7fbd6-7ad6-bce9-1e17-6391ab3e0630@iee.email \
    --to=philipoakley@iee.email \
    --cc=git@vger.kernel.org \
    --cc=liu.denton@gmail.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).