git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Duy Nguyen <pclouds@gmail.com>,
	Mark Levedahl <mlevedahl@gmail.com>,
	Mikael Magnusson <mikachu@gmail.com>,
	Eric Sunshine <sunshine@sunshineco.com>
Subject: [PATCH v2 07/23] Documentation/git-worktree: add EXAMPLES section
Date: Fri,  3 Jul 2015 20:17:16 -0400	[thread overview]
Message-ID: <1435969052-540-8-git-send-email-sunshine@sunshineco.com> (raw)
In-Reply-To: <1435969052-540-1-git-send-email-sunshine@sunshineco.com>

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 410f0b4..028bbd9 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -105,6 +105,28 @@ to `/path/main/.git/worktrees/test-next` then a file named
 `test-next` entry from being pruned.  See
 linkgit:gitrepository-layout[5] for details.
 
+EXAMPLES
+--------
+You are middle of a refactoring session and your boss comes in and demands
+that you fix something immediately. You might typically use
+linkgit:git-stash[1] to store your changes away temporarily, however, your
+worktree is in such a state of disarray (with new, removed, moved files,
+and other bits and pieces strewn around) that you don't want to risk
+disturbing any of it. Instead, you create a temporary linked worktree to
+make the emergency fix, remove it when done, and then resume your earlier
+refactoring session.
+
+------------
+$ git branch emergency-fix master
+$ git checkout --to ../temp emergency-fix
+$ pushd ../temp
+# ... hack hack hack ...
+$ git commit -a -m 'emergency fix for boss'
+$ popd
+$ rm -rf ../temp
+$ git worktree prune
+------------
+
 BUGS
 ----
 Multiple checkout support for submodules is incomplete. It is NOT
-- 
2.5.0.rc1.197.g417e668

  parent reply	other threads:[~2015-07-04  0:18 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-04  0:17 [PATCH v2 00/23] replace "checkout --to" with "worktree add" Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 01/23] Documentation/git-checkout: fix incorrect worktree prune command Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 02/23] Documentation/git-worktree: associate options with commands Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 03/23] Documentation: move linked worktree description from checkout to worktree Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 04/23] Documentation/git-worktree: add BUGS section Eric Sunshine
2015-07-04  2:41   ` Duy Nguyen
2015-07-04  8:48     ` Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 05/23] Documentation/git-worktree: split technical info from general description Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 06/23] Documentation/git-worktree: add high-level 'lock' overview Eric Sunshine
2015-07-04  0:17 ` Eric Sunshine [this message]
2015-07-04  2:23   ` [PATCH v2 07/23] Documentation/git-worktree: add EXAMPLES section Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 08/23] checkout: fix bug with --to and relative HEAD Eric Sunshine
2015-07-04  2:45   ` Duy Nguyen
2015-07-04  8:49     ` Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 09/23] checkout: relocate --to's "no branch specified" check Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 10/23] checkout: prepare_linked_checkout: drop now-unused 'new' argument Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 11/23] checkout: make --to unconditionally verbose Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 12/23] checkout: drop 'checkout_opts' dependency from prepare_linked_checkout Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 13/23] worktree: introduce "add" command Eric Sunshine
2015-07-04  2:53   ` Duy Nguyen
2015-07-04  8:54     ` Eric Sunshine
2015-07-06  9:24       ` Duy Nguyen
2015-07-04  0:17 ` [PATCH v2 14/23] worktree: add --force option Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 15/23] worktree: add --detach option Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 16/23] worktree: add -b/-B options Eric Sunshine
2015-07-04  3:19   ` Duy Nguyen
2015-07-04  8:57     ` Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 17/23] tests: worktree: retrofit "checkout --to" tests for "worktree add" Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 18/23] checkout: retire --to option Eric Sunshine
2015-07-04  3:04   ` Duy Nguyen
2015-07-04  8:59     ` Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 19/23] checkout: require worktree unconditionally Eric Sunshine
2015-07-04  2:33   ` Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 20/23] worktree: extract basename computation to new function Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 21/23] worktree: add: make -b/-B default to HEAD when <branch> is omitted Eric Sunshine
2015-07-06 19:14   ` Junio C Hamano
2015-07-04  0:17 ` [PATCH v2 22/23] worktree: add: auto-vivify new branch " Eric Sunshine
2015-07-04  0:17 ` [PATCH v2 23/23] checkout: retire --ignore-other-worktrees in favor of --force Eric Sunshine

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=1435969052-540-8-git-send-email-sunshine@sunshineco.com \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=mikachu@gmail.com \
    --cc=mlevedahl@gmail.com \
    --cc=pclouds@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).