From: Thomas Gummerer <t.gummerer@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Duy Nguyen <pclouds@gmail.com>,
Philip Oakley <philipoakley@iee.org>,
Git Mailing List <git@vger.kernel.org>,
Jonathan Nieder <jrnieder@gmail.com>,
Elijah Newren <newren@gmail.com>
Subject: Re: [PATCH v2] glossary: add definition for overlay
Date: Fri, 15 Mar 2019 23:10:54 +0000 [thread overview]
Message-ID: <20190315231054.GK16414@hank.intra.tgummerer.com> (raw)
In-Reply-To: <xmqq5zsnh7my.fsf@gitster-ct.c.googlers.com>
On 03/13, Junio C Hamano wrote:
> Thomas Gummerer <t.gummerer@gmail.com> writes:
>
> > diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> > index 023ca95e7c..53df6ecb0a 100644
> > --- a/Documentation/glossary-content.txt
> > +++ b/Documentation/glossary-content.txt
> > @@ -287,6 +287,13 @@ This commit is referred to as a "merge commit", or sometimes just a
> > origin/name-of-upstream-branch, which you can see using
> > `git branch -r`.
> >
> > +[[def_overlay]]overlay::
> > + Only update and add files to the working directory, but don't
> > + delete them, similar to how 'cp -R' would work. This is the
> > + default mode in a <<def_checkout,checkout>>. In contrast,
> > + no-overlay mode will also delete tracked files not present in
> > + the source, similar to 'rsync --delete'.
> > +
>
> At least the mention of "checkout" needs to be a lot tightened to
> clarify that it is talking about "checkout <pathspec>", aka
> "checking out files out of the index or a tree-ish", as opposed to
> "checking out a branch to work on it", as checking out a branch will
> not work in the overlay fashion. What's not in the newly checked
> out branch will disappear from the working tree.
Good point, I'll fix that in v3.
> If readers happen to be not paying close attention to the fact that
> the difference between overlay and non-overlay is about the
> destination, "similar to how 'cp -R' would work" may not click to
> their minds. "similar to how 'cp -R' updates the contents in the
> destination directory" may avoid such a risk, albeit it might be a
> bit too verbose. I dunno.
I feel like it's okay to be a bit more verbose in the glossary. I
think your suggestion above is better than what I had, I'll use that
in v3, thanks!
next prev parent reply other threads:[~2019-03-15 23:10 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-06 1:34 What's cooking in git.git (Mar 2019, #01; Wed, 6) Junio C Hamano
2019-03-06 1:41 ` Denton Liu
2019-03-06 23:43 ` Junio C Hamano
2019-03-06 4:43 ` Jeff King
2019-03-06 23:45 ` Junio C Hamano
2019-03-06 9:44 ` Duy Nguyen
2019-03-06 23:46 ` Junio C Hamano
2019-03-07 12:34 ` Philip Oakley
2019-03-07 12:54 ` Duy Nguyen
2019-03-09 17:27 ` Thomas Gummerer
2019-03-09 18:04 ` Elijah Newren
2019-03-10 18:27 ` Thomas Gummerer
2019-03-12 23:30 ` [PATCH v2] glossary: add definition for overlay Thomas Gummerer
2019-03-13 1:13 ` Duy Nguyen
2019-03-15 22:31 ` Thomas Gummerer
2019-03-13 1:42 ` Junio C Hamano
2019-03-15 23:10 ` Thomas Gummerer [this message]
2019-03-17 20:19 ` [PATCH v3] " Thomas Gummerer
2019-03-21 14:48 ` Philip Oakley
2019-03-22 4:54 ` Junio C Hamano
2019-03-28 21:05 ` Thomas Gummerer
2019-03-08 0:02 ` What's cooking in git.git (Mar 2019, #01; Wed, 6) Junio C Hamano
2019-03-06 12:39 ` Johannes Schindelin
2019-03-18 7:08 ` Junio C Hamano
2019-03-06 12:47 ` Johannes Schindelin
2019-03-06 23:55 ` Junio C Hamano
2019-03-06 13:26 ` Johannes Schindelin
2019-03-06 13:41 ` ps/stash-in-c, was " Johannes Schindelin
2019-03-06 23:56 ` Junio C Hamano
2019-03-06 18:10 ` Jonathan Tan
2019-03-07 0:19 ` 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=20190315231054.GK16414@hank.intra.tgummerer.com \
--to=t.gummerer@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=newren@gmail.com \
--cc=pclouds@gmail.com \
--cc=philipoakley@iee.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).