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

Re: [PATCH 7/8] docs: use <commit> instead of <commit-ish>

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Dec 18, 2010, 08:39 UTC
Message-ID
<20101218083925.GD6187@burratino>
In-Reply-To
<1292650725-21149-8-git-send-email-lodatom@gmail.com>
Mark Lodato wrote:
Show 10 quoted lines
> --- a/Documentation/git-describe.txt
> +++ b/Documentation/git-describe.txt
> @@ -26,8 +26,8 @@ see the -a and -s options to linkgit:git-tag[1].
>  
>  OPTIONS
>  -------
> -<committish>...::
> -	Committish object names to describe.
> +<commit>...::
> +	Commit object names to describe.
Or even
	Commits to describe.
:)
Show 10 quoted lines
> --- a/Documentation/git-fast-import.txt
> +++ b/Documentation/git-fast-import.txt
> @@ -350,8 +350,8 @@ change to the project.
>  	('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
>  	'committer' (SP <name>)? SP LT <email> GT SP <when> LF
>  	data
> -	('from' SP <committish> LF)?
> -	('merge' SP <committish> LF)?
> +	('from' SP <commit> LF)?
> +	('merge' SP <commit> LF)?

As the audience of this manual page is people mostly familiar with other version control systems, it needs to be very explicit. Not sure what the best solution is, just pointing out the worry.

Previous: Mark LodatoNext: Mark Lodato
Message 15 of 19 in “[PATCHv2 0/8] docs: use metavariables consistently”
  1. Mark LodatoDec 18, 2010
  2. 1/8 fsck docs: remove outdated and useless diagnosticMark Lodato, Dec 18, 2010
  3. 2/8 docs: use `...' instead of `*' for multiplicityMark Lodato, Dec 18, 2010
  4. Jakub NarebskiDec 18, 2010
  5. Mark LodatoDec 18, 2010
  6. 3/8 docs: use <sha1> to mean unabbreviated IDMark Lodato, Dec 18, 2010
  7. Jonathan NiederDec 18, 2010
  8. Junio C HamanoDec 18, 2010
  9. 4/8 http-fetch docs: use <commit-id> consistentlyMark Lodato, Dec 18, 2010
  10. Jonathan NiederDec 18, 2010
  11. 5/8 grep docs: grep accepts a <tree-ish>, not a <tree>Mark Lodato, Dec 18, 2010
  12. 6/8 docs: use <tree> instead of <tree-ish>Mark Lodato, Dec 18, 2010
  13. Jonathan NiederDec 18, 2010
  14. 7/8 docs: use <commit> instead of <commit-ish>Mark Lodato, Dec 18, 2010
  15. Jonathan NiederDec 18, 2010
  16. 8/8 describe docs: note that <commit> is optionalMark Lodato, Dec 18, 2010
  17. Jonathan NiederDec 18, 2010
  18. Mark LodatoDec 18, 2010
  19. Junio C HamanoDec 18, 2010

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.