git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: kelly elton <its.the.doc@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: Missing --relative documentation
Date: Thu, 10 May 2018 10:22:42 -0400	[thread overview]
Message-ID: <20180510142242.GA25617@sigill.intra.peff.net> (raw)
In-Reply-To: <CALVfKe9K+qoDNXf1PbnvXWdYn-Vtv8xUJF-1PctC8uN1p4gyiA@mail.gmail.com>

On Fri, Apr 27, 2018 at 12:24:26PM -0500, kelly elton wrote:

> git format-patch is missing documentation for --relative.
> There is also no auto complete(or tab complete, whatever it's called)
> for the --relative switch/argument.

The missing documentation is due to the ancient d4cb003fff (format-patch
documentation: Remove diff options that are not useful, 2009-11-07).
Unfortunately I couldn't find any discussion on why those options were
thought to be useless.

I assume the notion was that the point of format-patch is to generate
full text patches for somebody else to apply, and thus something like
--relative usually wouldn't make sense. I could see it being useful if
you are doing something funny, though, like generating patches for a
subset of the repository as if they were at the top level.

I'm not sure if it would make sense to add the option back to the
documentation, though, since the point was to try to de-clutter the
format-patch manpage. I wonder if we could say something like "this
command supports all the diff options; see git-diff[1] for the full
list".

-Peff

      reply	other threads:[~2018-05-10 14:22 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-27 17:24 Missing --relative documentation kelly elton
2018-05-10 14:22 ` Jeff King [this message]

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

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

  git send-email \
    --in-reply-to=20180510142242.GA25617@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=its.the.doc@gmail.com \
    /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.
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 NNTP newsgroup(s).