git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sean Estabrooks <seanlkml@sympatico.ca>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 7/9] Documentation: clarify branch creation
Date: Fri, 9 Oct 2009 09:21:51 -0700	[thread overview]
Message-ID: <BLU0-SMTP425A9541141B09D790814EAECB0@phx.gbl> (raw)
In-Reply-To: <20091009101940.GG16558@progeny.tock>

On Fri, 9 Oct 2009 05:19:40 -0500
Jonathan Nieder <jrnieder@gmail.com> wrote:

> +In the command's second form, creates a new branch named <branchname>.
> +The branch will start out with head pointing to the commit
> +<start-point>.  If no <start-point> is given, the branch will start
> +out with head pointing to the tip of the currently checked out branch,
> +or the currently checked out commit if no branch is checked out.

The first sentence here doesn't quite work, perhaps drop the "In".  But
the whole thing is a bit verbose, what about just:

The command's second form creates a new branch named <branchname> which
points to the current HEAD or <start-point> if given.

>  <start-point>::
> -	The new branch will be created with a HEAD equal to this.  It may
> -	be given as a branch name, a commit-id, or a tag.  If this option
> -	is omitted, the current branch is assumed.
> +	The new branch head will point to this commit.  It may be
> +	given as a branch name, a commit-id, or a tag.  If this
> +	option is omitted, the currently checked out branch head
> +	is used, or the current commit if no branch is checked
> +	out.

Maybe it's not worth worrying about, but couldn't the last sentence
be just:

   If this option is omitted, the current HEAD will be used instead.

Sean

P.S.  Patches 3 and 4 in this series would be better as a single patch.

  reply	other threads:[~2009-10-09 16:25 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-10-09 10:14 [PATCH 0/9] Documentation tweaks Jonathan Nieder
2009-10-09 10:15 ` [PATCH 1/9] Describe DOCBOOK_XSL_172, ASCIIDOC_NO_ROFF options in Makefile Jonathan Nieder
2009-10-09 10:16 ` [PATCH 2/9] Documentation: git fmt-merge-message is not a script Jonathan Nieder
2009-10-09 10:16 ` [PATCH 3/9] Documentation: fix singular/plural mismatch Jonathan Nieder
2009-10-09 10:17 ` [PATCH 4/9] Documentation: say "the same" instead of "equal" Jonathan Nieder
2009-10-09 18:51   ` [PATCH 3-4/9 v2] Documentation: clarify mergeoptions description Jonathan Nieder
2009-10-09 10:18 ` [PATCH 5/9] Documentation: clone: clarify discussion of initial branch Jonathan Nieder
2009-10-09 21:48   ` Junio C Hamano
2009-10-09 23:07     ` [PATCH 5/9 v2] " Jonathan Nieder
2009-10-09 10:18 ` [PATCH 6/9] Documentation: branch: update --merged description Jonathan Nieder
2009-10-10  0:56   ` Junio C Hamano
2009-10-09 10:19 ` [PATCH 7/9] Documentation: clarify branch creation Jonathan Nieder
2009-10-09 16:21   ` Sean Estabrooks [this message]
2009-10-09 18:34     ` Jonathan Nieder
2009-10-10  0:57       ` Junio C Hamano
2009-10-09 10:20 ` [PATCH 8/9] Documentation: clarify "working tree" definition Jonathan Nieder
2009-10-09 10:25 ` [PATCH 9/9] racy-git.txt: explain nsec problem in more detail Jonathan Nieder
2009-10-10  0:56   ` Junio C Hamano
2009-10-10  0:58 ` [PATCH 0/9] Documentation tweaks 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

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

  git send-email \
    --in-reply-to=BLU0-SMTP425A9541141B09D790814EAECB0@phx.gbl \
    --to=seanlkml@sympatico.ca \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@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).