git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Thomas Gummerer <t.gummerer@gmail.com>
To: Duy Nguyen <pclouds@gmail.com>
Cc: Philip Oakley <philipoakley@iee.org>,
	Junio C Hamano <gitster@pobox.com>,
	Git Mailing List <git@vger.kernel.org>,
	Jonathan Nieder <jrnieder@gmail.com>,
	Elijah Newren <newren@gmail.com>
Subject: [PATCH v3] glossary: add definition for overlay
Date: Sun, 17 Mar 2019 20:19:56 +0000	[thread overview]
Message-ID: <20190317201956.GB1216@hank.intra.tgummerer.com> (raw)
In-Reply-To: <20190312233040.GE16414@hank.intra.tgummerer.com>

Add a definition for what overlay means in the context of git, to
clarify the recently introduced overlay-mode in git checkout.

Helped-by: Elijah Newren <newren@gmail.com>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com>
---

v3 incorporates Junios suggestions from [*1*], and clarifies that this
only applies to checking out from the index or a tree-ish, and
clarifies that the files are updated like in the destination directory
of 'cp -R'.  I thought of making the same clarification for 'rsync
--delete' as well, however I think with it being explicitly specified
for 'cp -R', readers should be able to deduce that we are talking
about the destination directory there as well.

*1*: <xmqq5zsnh7my.fsf@gitster-ct.c.googlers.com>

 Documentation/glossary-content.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 023ca95e7c..0f29075551 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -287,6 +287,15 @@ 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 update the contents
+	in the destination directory.  This is the default mode in a
+	<<def_checkout,checkout>> when checking out files from the
+	<<def_index,index>> or a <<def_tree-ish,tree-ish>>.  In
+	contrast, no-overlay mode also deletes tracked files not
+	present in the source, similar to 'rsync --delete'.
+
 [[def_pack]]pack::
 	A set of objects which have been compressed into one file (to save space
 	or to transmit them efficiently).
-- 
2.21.0.225.g810b269d1a

  parent reply	other threads:[~2019-03-17 20:20 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
2019-03-17 20:19           ` Thomas Gummerer [this message]
2019-03-21 14:48             ` [PATCH v3] " 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=20190317201956.GB1216@hank.intra.tgummerer.com \
    --to=t.gummerer@gmail.com \
    --cc=20190312233040.GE16414@hank.intra.tgummerer.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).