Subject: [PATCH] Update documentation for git-get-tar-commit-id and add a copyright notice.
From: Rene Scharfe <hidden>
Date: 2016-06-15 22:42:05
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Signed-off-by: Rene Scharfe <redacted> --- Documentation/git-get-tar-commit-id.txt | 23 +++++++++++------------ get-tar-commit-id.c | 3 +++ 2 files changed, 14 insertions(+), 12 deletions(-) 5144a0393d17d721c83a42ce743d2ce46909f222
diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt
--- a/Documentation/git-get-tar-commit-id.txt
+++ b/Documentation/git-get-tar-commit-id.txt@@ -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
diff --git a/get-tar-commit-id.c b/get-tar-commit-id.c
--- a/get-tar-commit-id.c
+++ b/get-tar-commit-id.c@@ -1,3 +1,6 @@ +/* + * Copyright (C) 2005 Rene Scharfe + */ #include <stdio.h> #include <string.h> #include <unistd.h>