summaryrefslogtreecommitdiff
path: root/Documentation/git-stripspace.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-10-16 18:27:42 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-10-16 22:27:52 (GMT)
commit33e8fc87407505c3a96792fc47189d57b97b34c3 (patch)
tree19f879dcf9af22e72f1d0c61411d661bb77bf4d6 /Documentation/git-stripspace.txt
parent3c3d3f629a6176b401ebec455c5dd59ed1b5f910 (diff)
downloadgit-33e8fc87407505c3a96792fc47189d57b97b34c3.zip
git-33e8fc87407505c3a96792fc47189d57b97b34c3.tar.gz
git-33e8fc87407505c3a96792fc47189d57b97b34c3.tar.bz2
usage: do not insist that standard input must come from a file
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>
Diffstat (limited to 'Documentation/git-stripspace.txt')
-rw-r--r--Documentation/git-stripspace.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt
index 60328d5..2438f76 100644
--- a/Documentation/git-stripspace.txt
+++ b/Documentation/git-stripspace.txt
@@ -9,14 +9,15 @@ git-stripspace - Remove unnecessary whitespace
SYNOPSIS
--------
[verse]
-'git stripspace' [-s | --strip-comments] < input
-'git stripspace' [-c | --comment-lines] < input
+'git stripspace' [-s | --strip-comments]
+'git stripspace' [-c | --comment-lines]
DESCRIPTION
-----------
-Clean the input in the manner used by Git for text such as commit
-messages, notes, tags and branch descriptions.
+Read text, such as commit messages, notes, tags and branch
+descriptions, from the standard input and clean it in the manner
+used by Git.
With no arguments, this will: