mirror of
https://github.com/git/git.git
synced 2024-10-31 14:27:54 +01: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>
27 lines
483 B
Text
27 lines
483 B
Text
git-show-index(1)
|
|
=================
|
|
|
|
NAME
|
|
----
|
|
git-show-index - Show packed archive index
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git show-index'
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Read the idx file for a Git packfile created with
|
|
'git pack-objects' command from the standard input, and
|
|
dump its contents.
|
|
|
|
The information it outputs is subset of what you can get from
|
|
'git verify-pack -v'; this command only shows the packfile
|
|
offset and SHA-1 of each object.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|