git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael Witten <mfwitten@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Matthieu Moy" <Matthieu.Moy@grenoble-inp.fr>,
	"Carlos Martín Nieto" <cmn@elego.de>,
	vra5107 <venkatram.akkineni@gmail.com>,
	git@vger.kernel.org
Subject: [PATCH v2] Docs: git checkout --orphan: `root commit' and `branch head'
Date: Tue, 27 Sep 2011 15:46:22 -0000	[thread overview]
Message-ID: <69d6fb3199bc4f74b25dae7992a9f132-mfwitten@gmail.com> (raw)
In-Reply-To: <vpq39fi9gf5.fsf@bauges.imag.fr>

See:

  Re: Can a git changeset be created with no parent
  Carlos Martín Nieto <cmn@elego.de>
  Message-ID: <1317073309.5579.9.camel@centaur.lab.cmartin.tk>
  http://article.gmane.org/gmane.comp.version-control.git/182170

and:

  git help glossary

Signed-off-by: Michael Witten <mfwitten@gmail.com>
---
 Documentation/git-checkout.txt |   32 ++++++++++++++++----------------
 1 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index c0a96e6..68ae6c9 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -125,29 +125,22 @@ explicitly give a name with '-b' in such a case.
 	below for details.
 
 --orphan::
-	Create a new 'orphan' branch, named <new_branch>, started from
-	<start_point> and switch to it.  The first commit made on this
-	new branch will have no parents and it will be the root of a new
-	history totally disconnected from all the other branches and
-	commits.
+	Tell git to make the next commit you create a root commit (that is,
+	a commit without any parent); creating the next commit is similar to
+	creating the first commit after running "git init", except that the
+	new commit will be referenced by the branch head <new_branch> rather
+	than "master".
 +
-The index and the working tree are adjusted as if you had previously run
-"git checkout <start_point>".  This allows you to start a new history
-that records a set of paths similar to <start_point> by easily running
-"git commit -a" to make the root commit.
+Furthermore, the index and the working tree are adjusted as if you ran
+"git checkout <start_point>"; by just running "git commit -a", you can
+create a root commit that records a tree similar to that of <start_point>.
 +
-This can be useful when you want to publish the tree from a commit
-without exposing its full history. You might want to do this to publish
-an open source branch of a project whose current tree is "clean", but
-whose full history contains proprietary or otherwise encumbered bits of
-code.
-+
-If you want to start a disconnected history that records a set of paths
-that is totally different from the one of <start_point>, then you should
-clear the index and the working tree right after creating the orphan
-branch by running "git rm -rf ." from the top level of the working tree.
-Afterwards you will be ready to prepare your new files, repopulating the
-working tree, by copying them from elsewhere, extracting a tarball, etc.
+Naturally, before creating the commit, you may manipulate the index in any
+way you want. For example, if you want to create a root commit that records
+a tree that is totally different from the one of <start_point>, then just
+clear the working tree and index by running "git rm -rf ." from the top
+level of the working tree, after which you may prepare your new working
+tree and index as desired.
 
 -m::
 --merge::
-- 
1.7.6.409.ge7a85

  reply	other threads:[~2011-09-27 15:52 UTC|newest]

Thread overview: 57+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-09-25 14:15 Can a git changeset be created with no parent vra5107
2011-09-25 14:33 ` Andreas Ericsson
2011-09-25 14:33 ` Carlos Martín Nieto
2011-09-26 19:25   ` Junio C Hamano
2011-09-26 21:41     ` Carlos Martín Nieto
2011-09-27 14:43       ` [PATCH] Docs: git checkout --orphan: `root commit' and `branch head' Michael Witten
2011-09-27 15:02         ` Matthieu Moy
2011-09-27 15:46           ` Michael Witten [this message]
2011-09-27 16:01             ` [PATCH v2] " Matthieu Moy
2011-09-27 16:13               ` Michael Witten
2011-09-27 16:53                 ` Matthieu Moy
2011-09-27 17:09                   ` Michael Witten
2011-09-27 20:59               ` Philip Oakley
2011-09-28 16:23                 ` [PATCH v3] " Michael Witten
2011-09-28 20:34                   ` Junio C Hamano
2011-09-29 15:52                     ` Michael Witten
2011-09-29 15:44                       ` [PATCH v4] Docs: git checkout --orphan: Copyedit, and s/root commit/orphan branch/ Michael Witten
2011-09-29 16:44                         ` Michael Witten
2011-09-29 20:05                         ` Philip Oakley
2011-09-29 18:11                       ` In favor of "git commit --no-parent" Junio C Hamano
2011-09-29 18:52                         ` Michael Witten
2011-09-29 18:59                         ` [PATCH] Documentation/git-checkout.txt: Explain --orphan without introducing an undefined "orphan branch" Junio C Hamano
2011-09-29 19:02                           ` Michael Witten
2011-09-29 21:02                         ` In favor of "git commit --no-parent" Phil Hord
2011-09-29 21:28                           ` Michael Witten
2011-09-29 21:50                             ` Phil Hord
2011-09-29 22:01                               ` Michael Witten
     [not found]                         ` <CABURp0q8YhTS-GDYOANEa19P-V2wf_EUTo=RHqnhDB619w=y-w@mail.gmail.com>
     [not found]                           ` <7vd3ejrqin.fsf@alter.siamese.dyndns.org>
2011-09-29 21:54                             ` Junio C Hamano
2011-09-29 22:07                               ` Phil Hord
2011-09-29 22:29                                 ` Michael Witten
2011-09-29 22:32                                   ` Michael Witten
2011-09-29 23:08                                 ` Junio C Hamano
2011-09-30  0:51                                   ` Michael Witten
2011-09-30  2:28                                     ` Junio C Hamano
2011-09-29 22:07                               ` Michael Witten
2011-09-27 15:49         ` [PATCH] Docs: git checkout --orphan: `root commit' and `branch head' Michael J Gruber
2011-09-27 16:02           ` Michael Witten
2011-09-27 17:25             ` Junio C Hamano
2011-09-27 17:50               ` Michael Witten
2011-09-27 20:34               ` Eric Raible
2011-09-27 21:31                 ` Philip Oakley
2011-09-27 21:42                   ` Jeff King
2011-09-27 23:28                     ` Michael Witten
2011-09-27 23:35                       ` Jeff King
2011-09-27 23:44                         ` Michael Witten
2011-09-28  0:32                         ` Junio C Hamano
2011-09-28 13:40                           ` Michael Witten
2011-09-28 13:45                             ` Matthieu Moy
2011-09-28 13:50                               ` Michael Witten
2011-09-28 14:09                                 ` Matthieu Moy
2011-09-28 14:35                                   ` Michael Witten
2011-09-28 14:45                                     ` Matthieu Moy
2011-09-28 15:06                                       ` Michael Witten
2011-09-28 18:17                                   ` Junio C Hamano
2011-09-28  4:04               ` Jay Soffian
2011-09-28  4:37                 ` Michael Witten
2011-09-28  8:00               ` Michael J Gruber

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=69d6fb3199bc4f74b25dae7992a9f132-mfwitten@gmail.com \
    --to=mfwitten@gmail.com \
    --cc=Matthieu.Moy@grenoble-inp.fr \
    --cc=cmn@elego.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=venkatram.akkineni@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.
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 NNTP newsgroup(s).