From: Junio C Hamano <gitster@pobox.com>
To: Ramkumar Ramachandra <artagnon@gmail.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: [PATCH 2/2] diffcore-pickaxe doc: document -S and -G properly
Date: Sun, 02 Jun 2013 12:56:15 -0700 [thread overview]
Message-ID: <7v7gicnv6o.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <CALkWK0m+kUa0QUotHXSYK40vFviFFv2yETnf6sEZMh05gOgLKg@mail.gmail.com> (Ramkumar Ramachandra's message of "Fri, 31 May 2013 17:34:54 +0530")
Ramkumar Ramachandra <artagnon@gmail.com> writes:
>> Without
>> --pickaxe-all, only the filepairs matching the given
>> criterion is left in the output; all filepairs are left in
>> the output when --pickaxe-all is used and if at least one
>> filepair matches the given criterion.
>
> Why do a poor-man's version of --pickaxe-all here, when the last
> paragraph already does justice to this?
The point of the first paragraph is to serve to help both:
(1) people who read about this rather technical part of the
diffcore pipeline machinery, to prepare them by listing what
they will learn about in the section; and
(2) those who already have read and want to skim over, by giving a
concise summary.
It may have been "poor" because it was merely "something like this"
patch, though.
> While what you're saying is technically true, I think it is important
> to explain the interaction between diffcore-pickaxe and
> diffcore-rename as I have done. Someone who wants to understand what
> `git log -S` does will come to this page and read this section:
> without reading diffcore-rename, she will have an incomplete picture;
> what's the harm in explaining diffcore-rename in the context of
> diffcore-pickaxe?
That is a red-herring; that is exactly why we upfront say that the
diffcore machinery is a pipeline and we describe upstream processing
like rename before we talk about pickaxe in the same document.
This document is the most accurate _technical_ documentation of how
the pipeline works (and it is not in section 1 of the manual set).
If you want to improve end-user documentation by adding explanation
for interactions between pipeline stages and also pathspec, I am all
for it, but I think that belongs to the larger "git help diff", not
"git help diffcore".
next prev parent reply other threads:[~2013-06-02 19:56 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-05-24 10:33 [PATCH v3 0/2] Improve diffcore-pickaxe documentation Ramkumar Ramachandra
2013-05-24 10:33 ` [PATCH 1/2] diffcore-pickaxe: make error messages more consistent Ramkumar Ramachandra
2013-05-24 10:33 ` [PATCH 2/2] diffcore-pickaxe doc: document -S and -G properly Ramkumar Ramachandra
2013-05-24 17:31 ` Junio C Hamano
2013-05-31 12:04 ` Ramkumar Ramachandra
2013-06-02 19:56 ` Junio C Hamano [this message]
2013-06-02 20:28 ` Ramkumar Ramachandra
-- strict thread matches above, loose matches on Subject: below --
2013-05-31 12:12 [PATCH v4 0/2] Improve diffcore-pickaxe documentation Ramkumar Ramachandra
2013-05-31 12:12 ` [PATCH 2/2] diffcore-pickaxe doc: document -S and -G properly Ramkumar Ramachandra
2013-06-03 17:54 ` Junio C Hamano
2013-05-17 12:23 [PATCH v2 0/2] Improve diffcore-pickaxe documentation Ramkumar Ramachandra
2013-05-17 12:23 ` [PATCH 2/2] diffcore-pickaxe doc: document -S and -G properly Ramkumar Ramachandra
2013-05-18 1:24 ` Junio C Hamano
2013-05-19 7:33 ` Junio C Hamano
2013-05-24 9:37 ` Ramkumar Ramachandra
2013-05-24 14:58 ` Phil Hord
2013-05-24 16:01 ` Ramkumar Ramachandra
2013-05-24 16:54 ` Junio C Hamano
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=7v7gicnv6o.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=artagnon@gmail.com \
--cc=git@vger.kernel.org \
/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).