From: "Vanderhoof, Tzadik" <tzadik.vanderhoof@optum360.com>
To: Jeff King <peff@peff.net>, Junio C Hamano <gitster@pobox.com>
Cc: Mike Rappazzo <rappazzo@gmail.com>,
"git@vger.kernel.org" <git@vger.kernel.org>
Subject: RE: merge --no-ff is NOT mentioned in help
Date: Fri, 18 Nov 2016 14:51:06 +0000 [thread overview]
Message-ID: <2C8817BDA27E034F8E9A669458E375EF2BFC37@APSWP0428.ms.ds.uhc.com> (raw)
In-Reply-To: <20161117222142.mca6lmhj5mvl4gbp@sigill.intra.peff.net>
> On Thu, Nov 17, 2016 at 09:10:22AM -0800, Junio C Hamano wrote:
>
> > People interested may want to try the attached single-liner patch to
> > see how the output from _ALL_ commands that use parse-options API
> > looks when given "-h". It could be that the result may not be too
> > bad.
>
> The output is less ugly than I expected, but still a bit cluttered IMHO.
> I was surprised that the column-adjustment did not need tweaked, but the code correctly increments "pos" from the return value of fprintf, which just works.
>
> Looking at the output for --ff, though:
>
> --[no-]ff allow fast-forward (default)
>
> I do not think it's improving the situation nearly as much as if we made the primary option "--no-ff" with a NONEG flga, and then added back in a HIDDEN "--ff". I thought we had done that in other cases, but I can't seem to find any. But it would make "--no-ff" the primary form, which makes sense, as "--ff" is already the default.
>
> Another option would be to teach parse-options to somehow treat the negated form as primary in the help text. That's a bit more code, but might be usable in other places.
>
> -Peff
>
What about leaving the help as is, but adding a sentence at the end (or beginning?) like: "The following options may be negated by adding 'no-' after the double dashes"?
This e-mail, including attachments, may include confidential and/or
proprietary information, and may be used only by the person or entity
to which it is addressed. If the reader of this e-mail is not the intended
recipient or his or her authorized agent, the reader is hereby notified
that any dissemination, distribution or copying of this e-mail is
prohibited. If you have received this e-mail in error, please notify the
sender by replying to this message and delete this e-mail immediately.
prev parent reply other threads:[~2016-11-18 14:51 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-16 15:16 merge --no-ff is NOT mentioned in help Vanderhoof, Tzadik
2016-11-16 15:36 ` Mike Rappazzo
2016-11-16 15:48 ` Vanderhoof, Tzadik
2016-11-16 15:57 ` Mike Rappazzo
2016-11-17 14:03 ` Vanderhoof, Tzadik
2016-11-17 17:10 ` Junio C Hamano
2016-11-17 19:18 ` Torsten Bögershausen
2016-11-17 22:21 ` Jeff King
2016-11-18 14:51 ` Vanderhoof, Tzadik [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
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=2C8817BDA27E034F8E9A669458E375EF2BFC37@APSWP0428.ms.ds.uhc.com \
--to=tzadik.vanderhoof@optum360.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=rappazzo@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.
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).