Browse Source

[PATCH] Update documentation for git-get-tar-commit-id

... and add a copyright notice.

[jc: also move its entry in git.txt from undocumented section.]

Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Rene Scharfe 20 years ago committed by Junio C Hamano
parent
commit
760b663446
  1. 23
      Documentation/git-get-tar-commit-id.txt
  2. 5
      Documentation/git.txt
  3. 3
      get-tar-commit-id.c

23
Documentation/git-get-tar-commit-id.txt

@ -3,25 +3,24 @@ git-get-tar-commit-id(1) @@ -3,25 +3,24 @@ git-get-tar-commit-id(1)

NAME
----
git-get-tar-commit-id - Some git command not yet documented.
git-get-tar-commit-id - Extract commit ID from an archive created using git-tar-tree.


SYNOPSIS
--------
'git-get-tar-commit-id' [ --option ] <args>...
'git-get-tar-commit-id' < <tarfile>


DESCRIPTION
-----------
Does something not yet documented.


OPTIONS
-------
--option::
Some option not yet documented.

<args>...::
Some argument not yet documented.
Acts as a filter, extracting the commit ID stored in archives created by
git-tar-tree. It reads only the first 1024 bytes of input, thus its
runtime is not influenced by the size of <tarfile> very much.

If no commit ID is found, git-get-tar-commit-id quietly exists with a
return code of 1. This can happen if <tarfile> had not been created
using git-tar-tree or if the first parameter of git-tar-tree had been
a tree ID instead of a commit ID or tag.


Author

5
Documentation/git.txt

@ -319,6 +319,8 @@ link:git-patch-id.html[git-patch-id]:: @@ -319,6 +319,8 @@ link:git-patch-id.html[git-patch-id]::
link:git-send-email-script.html[git-send-email]::
Send patch e-mails out of "format-patch --mbox" output.

link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
Extract commit ID from an archive created using git-tar-tree.

Commands not yet documented
---------------------------
@ -338,9 +340,6 @@ link:git-diff-script.html[git-diff-script]:: @@ -338,9 +340,6 @@ link:git-diff-script.html[git-diff-script]::
link:git-format-patch-script.html[git-format-patch-script]::
git-format-patch-script.

link:git-get-tar-commit-id.html[git-get-tar-commit-id]::
git-get-tar-commit-id.

link:git-request-pull-script.html[git-request-pull-script]::
git-request-pull-script.


3
get-tar-commit-id.c

@ -1,3 +1,6 @@ @@ -1,3 +1,6 @@
/*
* Copyright (C) 2005 Rene Scharfe
*/
#include <stdio.h>
#include <string.h>
#include <unistd.h>

Loading…
Cancel
Save