Re: [PATCH v2] Docs: git checkout --orphan: `root commit' and `branch head'
- From
Michael Witten <mfwitten@gmail.com>
- Date
- Sep 27, 2011, 16:13 UTC
- Message-ID
- <CAMOZ1Buf5KxbN59o8QK_dMmF_SEY_Ckuz4DALorZpwuL9gx-Pg@mail.gmail.com>
- In-Reply-To
- <vpqsjni6kkk.fsf@bauges.imag.fr>
On Tue, Sep 27, 2011 at 16:01, Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> wrote:
Show 22 quoted lines
> Michael Witten <mfwitten@gmail.com> writes: > >> -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. > > This part used to be just this in v1: > > -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 > +This can be useful when you want to publish a tree without exposing its > +full history; for instance, 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. > > is it intentionnal that you discarded completely the paragraph? If so, > then I disagree, the paragraph was one of the main motivation for > someone to use --orphan, without it, someone may understand _what_ it > does, but not _why_ it is useful.
It was intentional; I was finding it difficult to express that paragraph succintly in a way that is consistent with correct terminology. Then I realized it's fairly redundant, anyway.
I think that the last paragraph provides enough context to understand its usefulness. Also, anybody who ever independently decided to carve out proprietary bits in that way would immediately recognize the need for creating a commit without parents, a notion which would lead him or her pretty quickly to this documentation or jog his or her memory about it based on the text of v2.
If everyone else is quite set on keeping that paragraph, though, I'll take the challenge; however, I think that would be a waste of time.