Thread (3 messages) flat view 3 messages, 2 authors, 2016-06-15

Re: [PATCH] show-ref: place angle brackets around variables in usage string

From: Alex Henrie <hidden>
Date: 2016-06-15 23:06:20

2015-08-29 4:21 GMT-06:00 Philip Oakley [off-list ref]:
Should the '<' stdin redirection be shown?

It looks (at first glance) as if this gained a double '< <' at the beginning
of 'ref-list', rather than being a clean indication of the redirection.
Perhaps change 'ref-list' to 'ref-list-file' for a slight improvement in
clarity - this it's only occurance, and the redirection would best match a
file.
This syntax occurs in three other places in Git:

git cat-file (--batch | --batch-check) [--follow-symlinks] < <list-of-objects>

git check-attr --stdin [-z] [-a | --all | <attr>...] < <list-of-paths>

git hash-object  --stdin-paths < <list-of-paths>

So if we need to say <ref-list-file> for clarity, we should also say
<object-list-file> and <path-list-file> for these other commands.

I think the most sane thing to do is to commit this patch as-is, and
then someone can submit a separate patch to reword all four usage
strings for increased clarity.

-Alex
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help