[PATCH] send-email: Fix documentation of --signed-off-by-cc option

[PATCH] send-email: Fix documentation of --signed-off-by-cc option

[Namhyung Kim]

From: Namhyung Kim <namhyung.kim@lge.com>

The man page says it'll control the Cc: lines being added also,
but this is not true.

Reported-by: Minchan Kim <minchan@kernel.org>
Signed-off-by: Namhyung Kim <namhyung.kim@lge.com>
---
 Documentation/git-send-email.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 40a9a9a..5694d98 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -238,7 +238,7 @@ Automating
 	the value of 'sendemail.identity'.
 
 --[no-]signed-off-by-cc::
-	If this is set, add emails found in Signed-off-by: or Cc: lines to the
+	If this is set, add emails found in Signed-off-by: lines to the
 	cc list. Default is the value of 'sendemail.signedoffbycc' configuration
 	value; if that is unspecified, default to --signed-off-by-cc.
 
-- 
1.7.11.7

Re: [PATCH] send-email: Fix documentation of --signed-off-by-cc option

[Ramkumar Ramachandra]

Namhyung Kim wrote:
> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
> index 40a9a9a..5694d98 100644
> --- a/Documentation/git-send-email.txt
> +++ b/Documentation/git-send-email.txt
> @@ -238,7 +238,7 @@ Automating
>         the value of 'sendemail.identity'.
>
>  --[no-]signed-off-by-cc::
> -       If this is set, add emails found in Signed-off-by: or Cc: lines to the
> +       If this is set, add emails found in Signed-off-by: lines to the
>         cc list. Default is the value of 'sendemail.signedoffbycc' configuration
>         value; if that is unspecified, default to --signed-off-by-cc.

Correct, but I'd urge you to step back and look at all the options.
Cc lines in the body (called bodycc) are parsed: see
git-send-email.perl:1361.  By default, everyone (cc, author, self,
sob, bodycc) is cc'ed by default.  You can turn off each of these
individually using --supress-cc which can take values
(all|cccmd|cc|author|self|sob|body|bodycc).  As you can see from
git-send-email.perl:400, the real purpose of --signed-off-by-cc is to
override a sendemail.suppresscc=sob; however, it can't override any
stronger values of suppresscc (body, all).  So, it's mostly a
no-option, and there is no corresponding --[no-]bodycc-cc.  Overall,
the way out of this horrible mess of options is to deprecate
--[no-]signed-off-by-cc, and modify --supress-cc to have a
--no-suppress-cc counterpart, just like --[no-]suppress-from.

Thanks.