git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 7/9] Documentation: clarify branch creation

From
Sean Estabrooks <seanlkml@sympatico.ca>
Date
Oct 9, 2009, 16:21 UTC
Message-ID
<BLU0-SMTP425A9541141B09D790814EAECB0@phx.gbl>
In-Reply-To
<20091009101940.GG16558@progeny.tock>

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

Show 5 quoted lines
> +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.

Show 9 quoted lines
>  <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.
Previous: Jonathan NiederNext: Jonathan Nieder
Message 13 of 19 in “Documentation tweaks”
  1. 0/9 Documentation tweaksJonathan Nieder, Oct 9, 2009
  2. 1/9 Describe DOCBOOK_XSL_172, ASCIIDOC_NO_ROFF options in MakefileJonathan Nieder, Oct 9, 2009
  3. 2/9 Documentation: git fmt-merge-message is not a scriptJonathan Nieder, Oct 9, 2009
  4. 3/9 Documentation: fix singular/plural mismatchJonathan Nieder, Oct 9, 2009
  5. 4/9 Documentation: say "the same" instead of "equal"Jonathan Nieder, Oct 9, 2009
  6. 4/9 Documentation: clarify mergeoptions descriptionJonathan Nieder, Oct 9, 2009
  7. 5/9 Documentation: clone: clarify discussion of initial branchJonathan Nieder, Oct 9, 2009
  8. Junio C HamanoOct 9, 2009
  9. 5/9 Documentation: clone: clarify discussion of initial branchJonathan Nieder, Oct 9, 2009
  10. 6/9 Documentation: branch: update --merged descriptionJonathan Nieder, Oct 9, 2009
  11. Junio C HamanoOct 10, 2009
  12. 7/9 Documentation: clarify branch creationJonathan Nieder, Oct 9, 2009
  13. Sean EstabrooksOct 9, 2009
  14. Jonathan NiederOct 9, 2009
  15. Junio C HamanoOct 10, 2009
  16. 8/9 Documentation: clarify "working tree" definitionJonathan Nieder, Oct 9, 2009
  17. 9/9 racy-git.txt: explain nsec problem in more detailJonathan Nieder, Oct 9, 2009
  18. Junio C HamanoOct 10, 2009
  19. Junio C HamanoOct 10, 2009

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.