mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
33e8fc8740
The synopsys text and the usage string of subcommands that read list of things from the standard input are often shown like this: git gostak [--distim] < <list-of-doshes> This is problematic in a number of ways: * The way to use these commands is more often to feed them the output from another command, not feed them from a file. * Manual pages outside Git, commands that operate on the data read from the standard input, e.g "sort", "grep", "sed", etc., are not described with such a "< redirection-from-file" in their synopsys text. Our doing so introduces inconsistency. * We do not insist on where the output should go, by saying git gostak [--distim] < <list-of-doshes> > <output> * As it is our convention to enclose placeholders inside <braket>, the redirection operator followed by a placeholder filename becomes very hard to read, both in the documentation and in the help text. Let's clean them all up, after making sure that the documentation clearly describes the modes that take information from the standard input and what kind of things are expected on the input. [jc: stole example for fmt-merge-msg from Jonathan] Helped-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
41 lines
968 B
C
41 lines
968 B
C
/*
|
|
* Copyright (c) 2005, 2006 Rene Scharfe
|
|
*/
|
|
#include "cache.h"
|
|
#include "commit.h"
|
|
#include "tar.h"
|
|
#include "builtin.h"
|
|
#include "quote.h"
|
|
|
|
static const char builtin_get_tar_commit_id_usage[] =
|
|
"git get-tar-commit-id";
|
|
|
|
/* ustar header + extended global header content */
|
|
#define RECORDSIZE (512)
|
|
#define HEADERSIZE (2 * RECORDSIZE)
|
|
|
|
int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix)
|
|
{
|
|
char buffer[HEADERSIZE];
|
|
struct ustar_header *header = (struct ustar_header *)buffer;
|
|
char *content = buffer + RECORDSIZE;
|
|
const char *comment;
|
|
ssize_t n;
|
|
|
|
if (argc != 1)
|
|
usage(builtin_get_tar_commit_id_usage);
|
|
|
|
n = read_in_full(0, buffer, HEADERSIZE);
|
|
if (n < HEADERSIZE)
|
|
die("git get-tar-commit-id: read error");
|
|
if (header->typeflag[0] != 'g')
|
|
return 1;
|
|
if (!skip_prefix(content, "52 comment=", &comment))
|
|
return 1;
|
|
|
|
n = write_in_full(1, comment, 41);
|
|
if (n < 41)
|
|
die_errno("git get-tar-commit-id: write error");
|
|
|
|
return 0;
|
|
}
|