git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Junio C Hamano <gitster@pobox.com>
Cc: Git Mailing list <git@vger.kernel.org>
Subject: Re: [PATCH] doc: Remove explanation of "--" from several man pages
Date: Mon, 13 Nov 2017 04:56:22 -0500 (EST)	[thread overview]
Message-ID: <alpine.LFD.2.21.1711130450570.11083@localhost.localdomain> (raw)
In-Reply-To: <xmqqlgja8q74.fsf@gitster.mtv.corp.google.com>

On Mon, 13 Nov 2017, Junio C Hamano wrote:

> "Robert P. J. Day" <rpjday@crashcourse.ca> writes:
>
> >> > diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt
> >> > index aa3b2bf2f..0ae2523e0 100644
> >> > --- a/Documentation/git-check-attr.txt
> >> > +++ b/Documentation/git-check-attr.txt
> >> > @@ -36,10 +36,6 @@ OPTIONS
> >> >  	If `--stdin` is also given, input paths are separated
> >> >  	with a NUL character instead of a linefeed character.
> >> >
> >> > -\--::
> >> > -	Interpret all preceding arguments as attributes and all following
> >> > -	arguments as path names.
> >> > -
> >>
> >> This also has a similar issue.  "--" here is not between revs and
> >> pathspecs but is between attributes and pathspecs.
> >
> >   that can already be seen in the SYNOPSIS for that command, it does
> > not require further explanation:
> >
> >   SYNOPSIS
> >        git check-attr [-a | --all | attr...] [--] pathname...
>
> Nah.  With the same logic you could say --all is already on synopsis
> and no need for explanation.

  uh, that's not what i meant. what i *meant* was that the purpose of
"--" was already in the SYNOPSIS (as it appears to be in *all* man
pages) to visually show that it is a separator between the first part
of the command and possible pathnames. i was *not* suggesting that, if
something is in the SYNOPSIS, there is no further need to explain it.

  anyway, i can see this is a losing battle so i'll let it go.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

      reply	other threads:[~2017-11-13  9:56 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-12 21:02 [PATCH] doc: Remove explanation of "--" from several man pages Robert P. J. Day
2017-11-13  4:15 ` Junio C Hamano
2017-11-13  9:22   ` Robert P. J. Day
2017-11-13  9:48     ` Junio C Hamano
2017-11-13  9:56       ` Robert P. J. Day [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=alpine.LFD.2.21.1711130450570.11083@localhost.localdomain \
    --to=rpjday@crashcourse.ca \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).