git-commit-vandalism/builtin
Junio C Hamano 33e8fc8740 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>
2015-10-16 15:27:52 -07:00
..
add.c Merge branch 'sb/remove-unused-var-from-builtin-add' into maint 2015-08-19 14:41:33 -07:00
am.c Merge branch 'pt/am-builtin' into maint 2015-10-16 14:32:45 -07:00
annotate.c
apply.c Merge branch 'gb/apply-comment-typofix' 2015-09-14 11:44:44 -07:00
archive.c
bisect--helper.c
blame.c Merge branch 'jk/blame-first-parent' into maint 2015-10-16 14:32:34 -07:00
branch.c write_file(): drop "fatal" parameter 2015-08-24 13:09:02 -07:00
bundle.c
cat-file.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
check-attr.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
check-ignore.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
check-mailmap.c
check-ref-format.c
checkout-index.c
checkout.c Merge branch 'jc/calloc-pathspec' into maint 2015-09-03 19:18:00 -07:00
clean.c
clone.c Merge branch 'jk/guess-repo-name-regression-fix' into maint 2015-08-25 16:09:17 -07:00
column.c
commit-tree.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
commit.c Merge branch 'dt/commit-preserve-base-index-upon-opportunistic-cache-tree-update' 2015-09-01 16:31:29 -07:00
config.c get_urlmatch: avoid useless strbuf write 2015-08-20 13:16:50 -07:00
count-objects.c
credential.c
describe.c Merge branch 'sg/describe-contains' 2015-08-31 15:39:10 -07:00
diff-files.c
diff-index.c
diff-tree.c
diff.c
fast-export.c
fetch-pack.c
fetch.c Merge branch 'mh/get-remote-group-fix' into maint 2015-09-03 19:17:48 -07:00
fmt-merge-msg.c
for-each-ref.c
fsck.c Merge branch 'jc/fsck-dropped-errors' into maint 2015-10-16 14:32:50 -07:00
gc.c Merge branch 'mh/tempfile' 2015-08-25 14:57:09 -07:00
get-tar-commit-id.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
grep.c
hash-object.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
help.c
index-pack.c Merge branch 'jc/finalize-temp-file' 2015-08-19 14:48:55 -07:00
init-db.c write_file(): drop caller-supplied LF from calls to create a one-liner file 2015-08-25 12:49:19 -07:00
interpret-trailers.c
log.c builtin/log.c: minor reformat 2015-08-25 13:11:21 -07:00
ls-files.c ps_matched: xcalloc() takes nmemb and then element size 2015-08-20 09:57:38 -07:00
ls-remote.c ls-remote.txt: delete unsupported option 2015-09-28 11:07:04 -07:00
ls-tree.c
mailinfo.c
mailsplit.c
merge-base.c
merge-file.c Sync with 2.3.10 2015-09-28 15:28:31 -07:00
merge-index.c
merge-ours.c
merge-recursive.c
merge-tree.c react to errors in xdi_diff 2015-09-28 14:57:10 -07:00
merge.c memoize common git-path "constant" files 2015-08-10 15:37:14 -07:00
mktag.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
mktree.c
mv.c
name-rev.c
notes.c Merge branch 'jk/notes-merge-config' 2015-08-31 15:39:05 -07:00
pack-objects.c Merge branch 'ah/pack-objects-usage-strings' 2015-09-01 16:31:12 -07:00
pack-redundant.c
pack-refs.c
patch-id.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
prune-packed.c
prune.c
pull.c Merge branch 'pt/pull-builtin' into maint 2015-10-16 14:32:32 -07:00
push.c push: add a config option push.gpgSign for default signed pushes 2015-08-19 12:58:58 -07:00
read-tree.c Merge branch 'ah/read-tree-usage-string' 2015-09-01 16:31:16 -07:00
receive-pack.c Merge branch 'jx/do-not-crash-receive-pack-wo-head' into maint 2015-08-19 14:41:26 -07:00
reflog.c Merge branch 'ah/reflog-typofix-in-error' 2015-09-01 16:31:18 -07:00
remote-ext.c
remote-fd.c
remote.c remote.c: drop extraneous local variable from migrate_file 2015-08-10 15:37:12 -07:00
repack.c prefer mkpathdup to mkpath in assignments 2015-08-10 15:37:12 -07:00
replace.c
rerere.c Sync with v2.5.4 2015-09-28 19:16:54 -07:00
reset.c memoize common git-path "constant" files 2015-08-10 15:37:14 -07:00
rev-list.c rev-list: make it obvious that we do not support notes 2015-08-24 10:33:15 -07:00
rev-parse.c
revert.c
rm.c
send-pack.c push: add a config option push.gpgSign for default signed pushes 2015-08-19 12:58:58 -07:00
shortlog.c
show-branch.c Sync with 2.5.2 2015-09-09 14:30:35 -07:00
show-ref.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
stripspace.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
symbolic-ref.c
tag.c tag, update-ref: improve description of option "create-reflog" 2015-09-11 09:50:02 -07:00
unpack-file.c
unpack-objects.c usage: do not insist that standard input must come from a file 2015-10-16 15:27:52 -07:00
update-index.c
update-ref.c tag, update-ref: improve description of option "create-reflog" 2015-09-11 09:50:02 -07:00
update-server-info.c
upload-archive.c
var.c
verify-commit.c
verify-pack.c
verify-tag.c
worktree.c Merge branch 'jc/am-state-fix' 2015-08-31 15:39:03 -07:00
write-tree.c