Re: [PATCH 3/3] doc: give examples for send-email cc-cmd operation

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Jul 20, 2015, 20:36 UTC
Message-ID: <CAPig+cRbRfOyyx7bx4hM9akN_cO5geZo=cy0+JAprBpnm6qQcw@mail.gmail.com>
In-Reply-To: <1E307B9A21744983970834F69116F358@PhilipOakley>

On Mon, Jul 20, 2015 at 3:36 PM, Philip Oakley <philipoakley@iee.org> wrote:

Show 13 quoted lines

> From: "Eric Sunshine" <sunshine@sunshineco.com>
>>> +       echo <<\EOF
>>> +       person1@example.com
>>> +       person2@example.com
>>> +       EOF
>>
>> I don't know if it deserves mention that the script must be executable
>> (chmod +x) or should we assume that readers are smart enough to
>> understand this implicitly? (It probably should be mentioned.)
>
> It's there, but it's after the wrap-around. Maybe
> s/(executable)/(must be executable: `chmod +x`)/
> to be fully pedantic.

I did see the "(executable)", but wasn't sure if it meant executable in the 'chmod +x' sense or executable as another name for "program".

Show 12 quoted lines

>> This entire above text about "cat $addressfile" seems awfully
>> inappropriate for a manual page, especially the bit about the terrible
>> "cat $file #" hack.
>
> Given that this invocation is why this all kicked off ...
> 'cat list.txt', being the most simple of commands and a first cargo-cult try
> for many, I definitely think it's worthwhile including somehow.
>
> Perhaps one needs to be more direct with the right invocation.
>
> "A simple `--cc-cmd='cat list.txt #'` is a quick-and-dirty way of using an
> address list, while ignoring the patch content."

It seems utterly sinful to promulgate this sort of hack to a wider audience. If reading addresses from a file is likely to be a common need, then perhaps it ought to have direct support in git-send-email (via a new command-line option or something).

Also, this all may be moot once rl/send-email-aliases[1] lands in a release since users will then be able to say:

    --cc="$(cat recipients.txt)"

provided that the email addresses in recipients.txt are comma-separated and a POSIX-like shell is being used. Perhaps that deserves an example in the documentation?

[1]: b1c8a11 (send-email: allow multiple emails using --cc, --to and --bcc, 2015-06-30)