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

Re: [PATCH v3 07/11] Documentation/replace: tell that -f option bypasses the type check

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Sep 2, 2013, 22:26 UTC
Message-ID
<20130902222625.GB2668@elie.Belkin>
In-Reply-To
<857C171CD0E84268B296C9F3FCDFB277@PhilipOakley>
Philip Oakley wrote:
> The problem is the file format, in the sense that the earlier `git cat-file
> commit $orig` has a human readable output which is a description of the
> commit header, rather than the specific binary content.
Ah.  That's the actual "raw" commit object format, though.
The manpage for git-cat-file(1) says:
	SYNOPSIS
		git cat-file (-t | -s | -e | -p | <type> | --textconv ) <object>
		git cat-file (--batch | --batch-check) < <list-of-objects>
	DESCRIPTION
		In its first form, the command provides the content or the
		type of an object in the repository. [...]
	OUTPUT
		...
		If <type> is specified, the raw (though uncompressed)
		contents of the <object> will be returned.
I agree that this isn't as clear as it should be.  I see a few problems:
 (1) The synopsis treats "git cat-file -t/-s/-e/-p <object>",
     "git cat-file --textconv <tree>:<path>", and
     "git cat-file <type> <object>" as the same form of the command.
     It would be easier to explain these as three different forms.
 (2) There is no EXAMPLES section and no examples.
 (3) There is no pointer to the git object formats.  A pointer to a
     new gitobject(5) manpage would presumably make everything clearer.

https://www.kernel.org/pub/software/scm/git/docs/user-manual.html#examining-the-data might be a good source of text to start from for solving (1), since it explains the command a little better.

Thanks, Jonathan

Previous: Philip OakleyNext: Philip Oakley
Message 21 of 33 in “Check replacement object type and minor updates”
  1. 00/11 Check replacement object type and minor updatesChristian Couder, Aug 31, 2013
  2. 01/11 replace: forbid replacing an object with one of a different typeChristian Couder, Aug 31, 2013
  3. Philip OakleyAug 31, 2013
  4. Christian CouderSep 1, 2013
  5. Philip OakleySep 1, 2013
  6. 02/11 Documentation/replace: state that objects must be of the same typeChristian Couder, Aug 31, 2013
  7. 03/11 t6050-replace: test that objects are of the same typeChristian Couder, Aug 31, 2013
  8. 04/11 t6050-replace: add test to clean up all the replace refsChristian Couder, Aug 31, 2013
  9. 05/11 Documentation/replace: add Creating Replacement Objects sectionChristian Couder, Aug 31, 2013
  10. Philip OakleyAug 31, 2013
  11. Christian CouderSep 1, 2013
  12. 06/11 replace: bypass the type check if -f option is usedChristian Couder, Aug 31, 2013
  13. 07/11 Documentation/replace: tell that -f option bypasses the type checkChristian Couder, Aug 31, 2013
  14. Philip OakleyAug 31, 2013
  15. Christian CouderSep 1, 2013
  16. Philip OakleySep 1, 2013
  17. Christian CouderSep 2, 2013
  18. Philip OakleySep 2, 2013
  19. Jonathan NiederSep 2, 2013
  20. Philip OakleySep 2, 2013
  21. Jonathan NiederSep 2, 2013
  22. Philip OakleySep 2, 2013
  23. Christian CouderSep 3, 2013
  24. 08/11 t6050-replace: check that -f option bypasses the type checkChristian Couder, Aug 31, 2013
  25. Eric SunshineSep 1, 2013
  26. Christian CouderSep 1, 2013
  27. 09/11 replace: allow long option namesChristian Couder, Aug 31, 2013
  28. 10/11 Documentation/replace: list long option namesChristian Couder, Aug 31, 2013
  29. 11/11 t6050-replace: use some long option namesChristian Couder, Aug 31, 2013
  30. Philip OakleyAug 31, 2013
  31. Christian CouderSep 1, 2013
  32. Eric SunshineSep 1, 2013
  33. Christian CouderSep 1, 2013

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.