Skip to contentSkip to conversation

git-send-email: Add --suppress-all-from option.

PATCH In review David Brown 6 participants 17 messages Jun 15, 2016 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 git-send-email: Add --suppress-all-from option.

Sometimes, it is useful to be able to send a patch to a third party without the author of the patch being copied on the message. An common example would be an internal discussion at a company to ask if a particular patch should be applied. Some environments may even have policy against such mail being sent outside of the company.

Add the --suppress-all-from/--no-suppress-all-from options to avoid sending patches to the patch author, even if different from the sender. Add the sendemail.suppressallfrom config option to allow this to have a different default.

---
 Documentation/git-send-email.txt |    7 +++++++
 git-send-email.perl              |    9 ++++++++-
 2 files changed, 15 insertions(+), 1 deletions(-)
Documentation/git-send-email.txt +7 -0
index f0bd285..5d06264 100644
@@ -117,6 +117,13 @@ The --cc option must be repeated for each user you want on the cc list.
         Default is the value of 'sendemail.suppressfrom' configuration value;
         if that is unspecified, default to --no-suppress-from.
 
+--suppress-all-from, --no-suppress-all-from::
+        If this is set, do not add the From: address to the cc: list,
+        even if it is different than the person sending the email.
+        Default is the value of the 'sendemail.suppressallfrom'
+        configuration value; if that is unspecified, default to
+        -no-suppress-all-from.
+
 --thread, --no-thread::
 	If this is set, the In-Reply-To header will be set on each email sent.
 	If disabled with "--no-thread", no emails will have the In-Reply-To
git-send-email.perl +8 -1
index 248d035..80265b5 100755
@@ -90,6 +90,9 @@ Options:
 
    --suppress-from Suppress sending emails to yourself. Defaults to off.
 
+   --suppress-all-from Never automatically send to a patch author.
+                  Defaults to off.
+
    --thread       Specify that the "In-Reply-To:" header should be set on all
                   emails. Defaults to on.
 
@@ -174,7 +177,8 @@ if ($@) {
 my ($quiet, $dry_run) = (0, 0);
 
 # Variables with corresponding config settings
-my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
+my ($thread, $chain_reply_to, $suppress_from, $suppress_all_from);
+my ($signed_off_cc, $cc_cmd);
 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_authpass, $smtp_ssl);
 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
 
@@ -182,6 +186,7 @@ my %config_bool_settings = (
     "thread" => [\$thread, 1],
     "chainreplyto" => [\$chain_reply_to, 1],
     "suppressfrom" => [\$suppress_from, 0],
+    "suppressallfrom" => [\$suppress_all_from, 0],
     "signedoffcc" => [\$signed_off_cc, 1],
     "smtpssl" => [\$smtp_ssl, 0],
 );
@@ -218,6 +223,7 @@ my $rc = GetOptions("sender|from=s" => \$sender,
 		    "quiet" => \$quiet,
 		    "cc-cmd=s" => \$cc_cmd,
 		    "suppress-from!" => \$suppress_from,
+		    "suppress-all-from!" => \$suppress_all_from,
 		    "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc,
 		    "dry-run" => \$dry_run,
 		    "envelope-sender=s" => \$envelope_sender,
@@ -700,6 +706,7 @@ foreach my $t (@files) {
 					$subject = $1;
 
 				} elsif (/^(Cc|From):\s+(.*)$/) {
+					next if ($suppress_all_from);
 					if (unquote_rfc2047($2) eq $sender) {
 						next if ($suppress_from);
 					}
Signature · 1 line
1.5.3.7
#1 lore raw
Quoted 1 line · David Brown

Sometimes, it is useful to be able to send a patch to a third party

s/Sometimes/Most of the time/g

Quoted 11 lines

without the author of the patch being copied on the message. An common example would be an internal discussion at a company to ask if a particular patch should be applied. Some environments may even have policy against such mail being sent outside of the company.

Add the --suppress-all-from/--no-suppress-all-from options to avoid sending patches to the patch author, even if different from the sender. Add the sendemail.suppressallfrom config option to allow this to have a different default.

Please-dog-yes: Joel Becker <[email protected]>

Quoted 78 lines
---
 Documentation/git-send-email.txt |    7 +++++++
 git-send-email.perl              |    9 ++++++++-
 2 files changed, 15 insertions(+), 1 deletions(-)
Documentation/git-send-email.txt +7 -0
index f0bd285..5d06264 100644
@@ -117,6 +117,13 @@ The --cc option must be repeated for each user you want on the cc list.
         Default is the value of 'sendemail.suppressfrom' configuration value;
         if that is unspecified, default to --no-suppress-from.
 
+--suppress-all-from, --no-suppress-all-from::
+        If this is set, do not add the From: address to the cc: list,
+        even if it is different than the person sending the email.
+        Default is the value of the 'sendemail.suppressallfrom'
+        configuration value; if that is unspecified, default to
+        -no-suppress-all-from.
+
 --thread, --no-thread::
 	If this is set, the In-Reply-To header will be set on each email sent.
 	If disabled with "--no-thread", no emails will have the In-Reply-To
git-send-email.perl +8 -1
index 248d035..80265b5 100755
@@ -90,6 +90,9 @@ Options:
 
    --suppress-from Suppress sending emails to yourself. Defaults to off.
 
+   --suppress-all-from Never automatically send to a patch author.
+                  Defaults to off.
+
    --thread       Specify that the "In-Reply-To:" header should be set on all
                   emails. Defaults to on.
 
@@ -174,7 +177,8 @@ if ($@) {
 my ($quiet, $dry_run) = (0, 0);
 
 # Variables with corresponding config settings
-my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
+my ($thread, $chain_reply_to, $suppress_from, $suppress_all_from);
+my ($signed_off_cc, $cc_cmd);
 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_authpass, $smtp_ssl);
 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
 
@@ -182,6 +186,7 @@ my %config_bool_settings = (
     "thread" => [\$thread, 1],
     "chainreplyto" => [\$chain_reply_to, 1],
     "suppressfrom" => [\$suppress_from, 0],
+    "suppressallfrom" => [\$suppress_all_from, 0],
     "signedoffcc" => [\$signed_off_cc, 1],
     "smtpssl" => [\$smtp_ssl, 0],
 );
@@ -218,6 +223,7 @@ my $rc = GetOptions("sender|from=s" => \$sender,
 		    "quiet" => \$quiet,
 		    "cc-cmd=s" => \$cc_cmd,
 		    "suppress-from!" => \$suppress_from,
+		    "suppress-all-from!" => \$suppress_all_from,
 		    "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc,
 		    "dry-run" => \$dry_run,
 		    "envelope-sender=s" => \$envelope_sender,
@@ -700,6 +706,7 @@ foreach my $t (@files) {
 					$subject = $1;
 
 				} elsif (/^(Cc|From):\s+(.*)$/) {
+					next if ($suppress_all_from);
 					if (unquote_rfc2047($2) eq $sender) {
 						next if ($suppress_from);
 					}
Signature · 6 lines
1.5.3.7

-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Signature · 9 lines
Life's Little Instruction Book #456

	"Send your loved one flowers.  Think of a reason later."

Joel Becker
Principal Software Developer
Oracle
E-mail: [email protected]
Phone: (650) 506-8127
#2 lore raw
In reply to David Brown

[David Brown <[email protected]>]

Quoted 6 lines

Sometimes, it is useful to be able to send a patch to a third party without the author of the patch being copied on the message. An common example would be an internal discussion at a company to ask if a particular patch should be applied. Some environments may even have policy against such mail being sent outside of the company.

Quoted 6 lines

Add the --suppress-all-from/--no-suppress-all-from options to avoid sending patches to the patch author, even if different from the sender. Add the sendemail.suppressallfrom config option to allow this to have a different default.

Yes-Please: Brian Swetland <[email protected]>

This has caused me some pain previously, and just earlier today I received an internal patch mail from somebody at another company who almost certainly did not intend to cc me.

Brian

#3 lore raw
In reply to David Brown
Quoted 2 lines · David Brown

Sometimes, it is useful to be able to send a patch to a third party without the author of the patch being copied on the message.

I would agree with the cause, but not necessarily with the execution.

Documentation/git-send-email.txt The --cc option must be repeated for each user you want on the cc list. · line 125

Quoted 6 lines

+--suppress-all-from, --no-suppress-all-from::

Documentation/git-send-email.txt +5 -0
+        If this is set, do not add the From: address to the cc: list,
+        even if it is different than the person sending the email.
+        Default is the value of the 'sendemail.suppressallfrom'
+        configuration value; if that is unspecified, default to
+        -no-suppress-all-from.

The option name feels as if it is somehow affecting From: but this is all about recipients. It needs to be named better.

Even more importantly, git-send-email has too many places that pick up additional recipients. I doubt --suppress-foo to suppress one such source "foo" is sustainable. We should try to clean up the mess, not adding to it.

So let's analyze the current situation first. It seems that we currently pick up the list of recipients from the following places:

* obviously, --to command line;
* mbox Cc: header lines;
* mbox From: header lines;
* lots-of-email first line
* $cc_cmd output;
* Signed-off-by: lines in body;
* Cc: lines in body;

The --no-signed-off-cc option is about omitting the last two from the recipients. We do not have a way to squelch other sources of extra recipients, hence the need for your patch.

The --suppress-from option is about not giving an extra copy to the sender. It is "suppress from-address from the recipient list", so the option name makes sense.

Your --suppress-all-from, from a cursory read of your patch, omits only mbox Cc: and From: line recipients -- it is far from "all", isn't it? --signed-off-cc defaults to true so you would need to suppress that at least to call it "all".

A cleaner approach might be:

- introduce a helper function add_to_recipients that take \@cc, $recipient and the "source class". Make this function responsible for not adding the sender to the list (i.e. --suppress-from, which is currently checked everywhere), and for not adding recipients from specified classes of sources, like this:

        sub add_to_recipients {
                my ($cc, $source, $recipient) = @_;
                return 0 if ($suppress_from and $sender eq $recipient);
                return 0 if ($suppressed_recipient_source{$source});
                push @$cc, $recipient;
                return 1;
        }

Instead of returning 1 unconditionally, it might make sense to omit pushing duplicate here and to return 0 when $recipient was already in @$cc.

- adjust the places where "push @cc" happens to use the above helper; the existing suppress logic in the callers can and should be removed as the add_to_recipients will be responsible for it, like this (an example for cc-cmd part):

        if (defined $cc_cmd) {
        open(F, "$cc_cmd $t |")
                or die "(cc-cmd) Could not execute '$cc_cmd'";
        while(<F>) {
                my $c = $_;
                $c =~ s/^\s*//g;
                $c =~ s/\n$//g;
-               next if ($c eq $sender and $suppress_from);
-               push @cc, $c;
+               next if (!add_to_recipients(\@cc, 'cccmd', $c));
                printf("(cc-cmd) Adding cc: %s from: '%s'\n",
                        $c, $cc_cmd) unless $quiet;
        }

- define a global %suppressed_recipient_source hash to be used in add_to_recipients(). The existing --no-signed-off-cc is about adding two sources to this hash.

- make the %suppressed_recipient_source configurable from the command line and repository configuration.

As to the "recipient source" classes, I think they can be categorized as:

* 'cc', to cover mbox Cc: header, lots-of-email first line, and

    Cc: lines in body;

* 'sob', to cover Signed-off-by: lines in body;

* 'cccmd', to cover $cc_cmd output;

Hmm?

#4 lore raw
Quoted 7 lines · Junio C Hamano

The option name feels as if it is somehow affecting From: but this is all about recipients. It needs to be named better.

Even more importantly, git-send-email has too many places that pick up additional recipients. I doubt --suppress-foo to suppress one such source "foo" is sustainable. We should try to clean up the mess, not adding to it.

Yay, even better that we're going to evaluate the sucker (I was
just complaining about this yesterday to someone, so how apropos that it comes up on-list).
First and foremost, I think git-send-email should not default to
anything. It was quite a surprise, the first time I tried to use it, to discover I had to add two options to ~/.gitconfig just for sane behavior. Never mind that I couldn't suppress the author-cc. I think that a naive "git send-email --to [email protected] foo.patch" should only go to bob, period.
We can then add ways to auto-cc. I don't mind typing the extra
bits. Heck, we could even define a --review that does what is currently the default - cc-everyone-who-might-care-as-we-go-upstream.

Joel

Signature · 9 lines
Life's Little Instruction Book #99

	"Think big thoughts, but relish small pleasures."

Joel Becker
Principal Software Developer
Oracle
E-mail: [email protected]
Phone: (650) 506-8127
#5 lore raw
Quoted 4 lines · Joel Becker

Yay, even better that we're going to evaluate the sucker (I was
just complaining about this yesterday to someone, so how apropos that it comes up on-list).
First and foremost, I think git-send-email should not default to

Quoted 8 lines

anything. It was quite a surprise, the first time I tried to use it, to discover I had to add two options to ~/.gitconfig just for sane behavior. Never mind that I couldn't suppress the author-cc. I think that a naive "git send-email --to [email protected] foo.patch" should only go to bob, period.
We can then add ways to auto-cc. I don't mind typing the extra
bits. Heck, we could even define a --review that does what is currently the default - cc-everyone-who-might-care-as-we-go-upstream.

Where e-mail addresses are used by default by git-send-email should probably be a git configuration option (and then we will need to document the heck out of this when we change it, so this is probably a git-1.6.0 thing), so projects can tell all of their contributors if they need to make changes in their config file for the proper defaults. Right now the defaults are more or less perfect for the Linux Kernel development processes, but other folks might not like them. On the flip side, just removing all of the current auto-cc's would be awfully inconvenient for the Linux kernel development community.

- Ted

#6 lore raw
In reply to Junio C Hamano
Quoted 7 lines · Junio C Hamano
Quoted 2 lines · David Brown

Sometimes, it is useful to be able to send a patch to a third party without the author of the patch being copied on the message.

I would agree with the cause, but not necessarily with the execution.

Ok. I will look into the overall cleanup, but probably not until this weekend.

Dave

#7 lore raw

PATCH 1/1 git-send-email: Generalize auto-cc recipient mechanism.

In reply to David Brown

There are a few options to git-send-email to suppress the automatic generation of 'Cc' fields: --suppress-from, and --signed-off-cc. However, there are other times that git-send-email automatically includes Cc'd recipients. This is not desirable for all development environments.

Add a new option --suppress-cc, which can be specified one or more times to list the categories of auto-cc fields that should be suppressed. If not specified, it defaults to values to give the same behavior as specified by --suppress-from, and --signed-off-cc. The categories are:

self - patch sender. Same as --suppress-from.
author - patch author.

  cc     - cc lines mentioned in the patch.
  cccmd  - avoid running the cccmd.
  sob    - signed off by lines.

---
I tried to generalize as suggested in Junio's email, but it just didn't fit well with the decision tree in the code.

What bothers me most about this change is that --signed-of-cc and --suppress-from are silently ignored if --suppress-cc is given, either on the command line, or in the config.

 Documentation/git-send-email.txt |   13 +++++++++++++
 git-send-email.perl              |   34 ++++++++++++++++++++++++++++++----
 2 files changed, 43 insertions(+), 4 deletions(-)
Documentation/git-send-email.txt +13 -0
index f0bd285..432f336 100644
@@ -70,6 +70,7 @@ The --cc option must be repeated for each user you want on the cc list.
         cc list.
         Default is the value of 'sendemail.signedoffcc' configuration value;
         if that is unspecified, default to --signed-off-by-cc.
+        Note that this has no effect if --suppress-cc is given.
 
 --quiet::
 	Make git-send-email less verbose.  One line per email should be
@@ -116,6 +117,18 @@ The --cc option must be repeated for each user you want on the cc list.
         If this is set, do not add the From: address to the cc: list.
         Default is the value of 'sendemail.suppressfrom' configuration value;
         if that is unspecified, default to --no-suppress-from.
+        Note that this has no effect if --suppress-cc is given.
+
+--suppress-cc::
+	Specify an additional category of recipients to suppress the
+	auto-cc of.  'self' will avoid including the sender, 'author' will
+	avoid including the patch author, 'cc' will avoid including anyone
+	mentioned in Cc lines in the patch, 'sob' will avoid including
+	anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
+	running the --cc-cmd.
+	Default is the value of 'sendemail.suppresscc' configuration value;
+	if that is unspecified, default to 'self' if --suppress-from is
+	specified, as well as 'sob' if --no-signed-off-cc is specified.
 
 --thread, --no-thread::
 	If this is set, the In-Reply-To header will be set on each email sent.
git-send-email.perl +30 -4
index e47994a..cb9adf2 100755
@@ -88,6 +88,11 @@ Options:
 
    --smtp-ssl     If set, connects to the SMTP server using SSL.
 
+   --suppress-cc  Suppress the specified category of auto-CC.  The category
+                  can be one of 'author' for the patch author, 'self' to
+                  avoid copying yourself, 'sob' for Signed-off-by lines,
+                  and 'cccmd' for the output of the cccmd.
+
    --suppress-from Suppress sending emails to yourself. Defaults to off.
 
    --thread       Specify that the "In-Reply-To:" header should be set on all
@@ -177,6 +182,7 @@ my ($quiet, $dry_run) = (0, 0);
 my ($thread, $chain_reply_to, $suppress_from, $signed_off_cc, $cc_cmd);
 my ($smtp_server, $smtp_server_port, $smtp_authuser, $smtp_authpass, $smtp_ssl);
 my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
+my (@suppress_cc);
 
 my %config_bool_settings = (
     "thread" => [\$thread, 1],
@@ -196,6 +202,7 @@ my %config_settings = (
     "aliasfiletype" => \$aliasfiletype,
     "bcc" => \@bcclist,
     "aliasesfile" => \@alias_files,
+    "suppresscc" => \@suppress_cc,
 );
 
 # Begin by accumulating all the variables (defined above), that we will end up
@@ -218,6 +225,7 @@ my $rc = GetOptions("sender|from=s" => \$sender,
 		    "quiet" => \$quiet,
 		    "cc-cmd=s" => \$cc_cmd,
 		    "suppress-from!" => \$suppress_from,
+		    "suppress-cc=s" => \@suppress_cc,
 		    "signed-off-cc|signed-off-by-cc!" => \$signed_off_cc,
 		    "dry-run" => \$dry_run,
 		    "envelope-sender=s" => \$envelope_sender,
@@ -262,6 +270,20 @@ foreach my $setting (values %config_bool_settings) {
 	${$setting->[0]} = $setting->[1] unless (defined (${$setting->[0]}));
 }
 
+# Set CC suppressions
+my(%suppress_cc);
+if (@suppress_cc) {
+	foreach my $entry (@suppress_cc) {
+		die "Unknown --suppress-cc field: '$entry'\n"
+			unless $entry =~ /^(cccmd|cc|author|self|sob)$/;
+		$suppress_cc{$entry} = 1;
+	}
+} else {
+	# Convert the old-style options.
+	$suppress_cc{'self'} = 1 if $suppress_from;
+	$suppress_cc{'sob'} = 1 unless $signed_off_cc;
+}
+
 my ($repoauthor) = $repo->ident_person('author');
 my ($repocommitter) = $repo->ident_person('committer');
 
@@ -701,11 +723,14 @@ foreach my $t (@files) {
 
 				} elsif (/^(Cc|From):\s+(.*)$/) {
 					if (unquote_rfc2047($2) eq $sender) {
-						next if ($suppress_from);
+						next if ($suppress_cc{'self'});
 					}
 					elsif ($1 eq 'From') {
 						($author, $author_encoding)
 						  = unquote_rfc2047($2);
+						next if ($suppress_cc{'author'});
+					} else {
+						next if ($suppress_cc{'cc'});
 					}
 					printf("(mbox) Adding cc: %s from line '%s'\n",
 						$2, $_) unless $quiet;
@@ -732,7 +757,7 @@ foreach my $t (@files) {
 				# line 2 = subject
 				# So let's support that, too.
 				$input_format = 'lots';
-				if (@cc == 0) {
+				if (@cc == 0 && !$suppress_cc{'cc'}) {
 					printf("(non-mbox) Adding cc: %s from line '%s'\n",
 						$_, $_) unless $quiet;
 
@@ -750,9 +775,10 @@ foreach my $t (@files) {
 		} else {
 			$message .=  $_;
 			if (/^(Signed-off-by|Cc): (.*)$/i && $signed_off_cc) {
+				next if ($suppress_cc{'sob'});
 				my $c = $2;
 				chomp $c;
-				next if ($c eq $sender and $suppress_from);
+				next if ($c eq $sender and $suppress_cc{'self'});
 				push @cc, $c;
 				printf("(sob) Adding cc: %s from line '%s'\n",
 					$c, $_) unless $quiet;
@@ -761,7 +787,7 @@ foreach my $t (@files) {
 	}
 	close F;
 
-	if (defined $cc_cmd) {
+	if (defined $cc_cmd && !$suppress_cc{'cccmd'}) {
 		open(F, "$cc_cmd $t |")
 			or die "(cc-cmd) Could not execute '$cc_cmd'";
 		while(<F>) {
Signature · 1 line
1.5.3.7
#8 lore raw

Re: [PATCH] git-send-email: Generalize auto-cc recipient mechanism.

Quoted 10 lines · David Brown

There are a few options to git-send-email to suppress the automatic generation of 'Cc' fields: --suppress-from, and --signed-off-cc. However, there are other times that git-send-email automatically includes Cc'd recipients. This is not desirable for all development environments.

Add a new option --suppress-cc, which can be specified one or more times to list the categories of auto-cc fields that should be suppressed. If not specified, it defaults to values to give the same behavior as specified by --suppress-from, and --signed-off-cc. The categories are:

Quoted 5 lines

self - patch sender. Same as --suppress-from.
author - patch author.

  cc     - cc lines mentioned in the patch.
  cccmd  - avoid running the cccmd.
  sob    - signed off by lines.

+ all - all of the above, thus only honoring '--to', '--cc', and

             '--bcc'

Joel

Signature · 9 lines
"The nice thing about egotists is that they don't talk about other
 people."
         - Lucille S. Harper

Joel Becker
Principal Software Developer
Oracle
E-mail: [email protected]
Phone: (650) 506-8127
#9 lore raw

PATCH 1/1 git-send-email: Add --suppress-cc all

Add the 'all' option to --suppress-cc, allowing easier suppression of everything.

---

Quoted 2 lines · Joel Becker

+ all - all of the above, thus only honoring '--to', '--cc', and

            '--bcc'

I can squash this with the other patch if that would be cleaner.

Dave

 Documentation/git-send-email.txt |    2 +-
 git-send-email.perl              |   11 ++++++++++-
 2 files changed, 11 insertions(+), 2 deletions(-)
Documentation/git-send-email.txt +1 -1
index 432f336..fdfb56e 100644
@@ -125,7 +125,7 @@ The --cc option must be repeated for each user you want on the cc list.
 	avoid including the patch author, 'cc' will avoid including anyone
 	mentioned in Cc lines in the patch, 'sob' will avoid including
 	anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
-	running the --cc-cmd.
+	running the --cc-cmd.  'all' will suppress all auto cc values.
 	Default is the value of 'sendemail.suppresscc' configuration value;
 	if that is unspecified, default to 'self' if --suppress-from is
 	specified, as well as 'sob' if --no-signed-off-cc is specified.
git-send-email.perl +10 -1
index cb9adf2..ef16824 100755
@@ -275,7 +275,7 @@ my(%suppress_cc);
 if (@suppress_cc) {
 	foreach my $entry (@suppress_cc) {
 		die "Unknown --suppress-cc field: '$entry'\n"
-			unless $entry =~ /^(cccmd|cc|author|self|sob)$/;
+			unless $entry =~ /^(all|cccmd|cc|author|self|sob)$/;
 		$suppress_cc{$entry} = 1;
 	}
 } else {
@@ -284,6 +284,15 @@ if (@suppress_cc) {
 	$suppress_cc{'sob'} = 1 unless $signed_off_cc;
 }
 
+if ($suppress_cc{'all'}) {
+	foreach my $entry (qw (ccmd cc author self sob)) {
+		$suppress_cc{$entry} = 1;
+	}
+	delete $suppress_cc{'all'};
+}
+
+printf "Suppressions: %s\n", join(',', keys(%suppress_cc));
+
 my ($repoauthor) = $repo->ident_person('author');
 my ($repocommitter) = $repo->ident_person('committer');
 
Signature · 1 line
1.5.3.7
#10 lore raw

Re: [PATCH] git-send-email: Add --suppress-cc all

Quoted 2 lines · David Brown

Add the 'all' option to --suppress-cc, allowing easier suppression of everything.

Thank you!

Quoted 60 lines

---

Quoted 2 lines · Joel Becker

+ all - all of the above, thus only honoring '--to', '--cc', and

            '--bcc'

I can squash this with the other patch if that would be cleaner.

Dave

 Documentation/git-send-email.txt |    2 +-
 git-send-email.perl              |   11 ++++++++++-
 2 files changed, 11 insertions(+), 2 deletions(-)
Documentation/git-send-email.txt +1 -1
index 432f336..fdfb56e 100644
@@ -125,7 +125,7 @@ The --cc option must be repeated for each user you want on the cc list.
 	avoid including the patch author, 'cc' will avoid including anyone
 	mentioned in Cc lines in the patch, 'sob' will avoid including
 	anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
-	running the --cc-cmd.
+	running the --cc-cmd.  'all' will suppress all auto cc values.
 	Default is the value of 'sendemail.suppresscc' configuration value;
 	if that is unspecified, default to 'self' if --suppress-from is
 	specified, as well as 'sob' if --no-signed-off-cc is specified.
git-send-email.perl +9 -1
index cb9adf2..ef16824 100755
@@ -275,7 +275,7 @@ my(%suppress_cc);
 if (@suppress_cc) {
 	foreach my $entry (@suppress_cc) {
 		die "Unknown --suppress-cc field: '$entry'\n"
-			unless $entry =~ /^(cccmd|cc|author|self|sob)$/;
+			unless $entry =~ /^(all|cccmd|cc|author|self|sob)$/;
 		$suppress_cc{$entry} = 1;
 	}
 } else {
@@ -284,6 +284,15 @@ if (@suppress_cc) {
 	$suppress_cc{'sob'} = 1 unless $signed_off_cc;
 }
 +if ($suppress_cc{'all'}) {
+	foreach my $entry (qw (ccmd cc author self sob)) {
+		$suppress_cc{$entry} = 1;
+	}
+	delete $suppress_cc{'all'};
+}
+
+printf "Suppressions: %s\n", join(',', keys(%suppress_cc));
+
 my ($repoauthor) = $repo->ident_person('author');
 my ($repocommitter) = $repo->ident_person('committer');
 
Signature · 1 line
1.5.3.7
Signature · 9 lines
"Can any of you seriously say the Bill of Rights could get through
 Congress today?  It wouldn't even get out of committee."
	- F. Lee Bailey

Joel Becker
Principal Software Developer
Oracle
E-mail: [email protected]
Phone: (650) 506-8127
#11 lore raw

PATCH 1/1 git-send-email: Generalize auto-cc recipient mechanism.

In reply to David Brown

There are a few options to git-send-email to suppress the automatic generation of 'Cc' fields: --suppress-from, and --signed-off-cc. However, there are other times that git-send-email automatically includes Cc'd recipients. This is not desirable for all development environments.

Add a new option --suppress-cc, which can be specified one or more times to list the categories of auto-cc fields that should be suppressed. If not specified, it defaults to values to give the same behavior as specified by --suppress-from, and --signed-off-cc. The categories are:

self - patch sender. Same as --suppress-from.
author - patch author.

  cc     - cc lines mentioned in the patch.
  cccmd  - avoid running the cccmd.
  sob    - signed off by lines.
  all    - all non-explicit recipients

---
Adds the 'all' category suggested by Joel Becker.

 Documentation/git-send-email.txt |   13 +++++++++++
 git-send-email.perl              |   42 ++++++++++++++++++++++++++++++++++---
 2 files changed, 51 insertions(+), 4 deletions(-)
Documentation/git-send-email.txt +13 -0
index f0bd285..fdfb56e 100644
@@ -70,6 +70,7 @@ The --cc option must be repeated for each user you want on the cc list.
         cc list.
         Default is the value of 'sendemail.signedoffcc' configuration value;
         if that is unspecified, default to --signed-off-by-cc.
+        Note that this has no effect if --suppress-cc is given.
 
 --quiet::
 	Make git-send-email less verbose.  One line per email should be
@@ -116,6 +117,18 @@ The --cc option must be repeated for each user you want on the cc list.
         If this is set, do not add the From: address to the cc: list.
         Default is the value of 'sendemail.suppressfrom' configuration value;
         if that is unspecified, default to --no-suppress-from.
+        Note that this has no effect if --suppress-cc is given.
+
+--suppress-cc::
+	Specify an additional category of recipients to suppress the
+	auto-cc of.  'self' will avoid including the sender, 'author' will
+	avoid including the patch author, 'cc' will avoid including anyone
+	mentioned in Cc lines in the patch, 'sob' will avoid including
+	anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
+	running the --cc-cmd.  'all' will suppress all auto cc values.
+	Default is the value of 'sendemail.suppresscc' configuration value;
+	if that is unspecified, default to 'self' if --suppress-from is
+	specified, as well as 'sob' if --no-signed-off-cc is specified.
 
 --thread, --no-thread::
 	If this is set, the In-Reply-To header will be set on each email sent.
git-send-email.perl +38 -4

102 lines not on this page · raw message

Signature · 1 line
1.5.3.7
#12 lore raw

Re: [PATCH] git-send-email: Generalize auto-cc recipient mechanism.

Quoted 8 lines · David Brown

...
self - patch sender. Same as --suppress-from.
author - patch author.

  cc     - cc lines mentioned in the patch.
  cccmd  - avoid running the cccmd.
  sob    - signed off by lines.
  all    - all non-explicit recipients
Quoted 5 lines

...
What bothers me most about this change is that --signed-of-cc and --suppress-from are silently ignored if --suppress-cc is given, either on the command line, or in the config.

The order in which various variables are set in the current code before your patch is like this:

* my ($var) introduces them -- they are undefined at the beginning;

* GetOptions() may set them to explicit values;

* read_config(), first for the specific sendemail identity and then for the generic ones, fill the ones that are still undefined;

* the built-in default from %config_bool_settings are used to fill the ones that are still undefined at this point;

Now, I think you can build on top of the above by adding the following after that sequence:

* fill %suppress_cc with explicit @suppress_cc GetOptions and read_config() read;

* if the --suppress-from and/or --signed-off-by-cc, either from GetOptions() or from read_config() are given, make them override what @suppress_cc says. So giving --suppress-cc=all and --signed-off-by-cc at the same time will still send cc to people who signed off the patch (because these old-style ones are more specific).

Perhaps something like this (untested, of course!) patch on top of yours.

 git-send-email.perl |   16 +++++++++-------
 1 files changed, 9 insertions(+), 7 deletions(-)
git-send-email.perl +9 -7
index 1f03d12..cde5ffb 100755
@@ -188,8 +188,8 @@ my (@suppress_cc);
 my %config_bool_settings = (
     "thread" => [\$thread, 1],
     "chainreplyto" => [\$chain_reply_to, 1],
-    "suppressfrom" => [\$suppress_from, 0],
-    "signedoffcc" => [\$signed_off_cc, 1],
+    "suppressfrom" => [\$suppress_from, undef],
+    "signedoffcc" => [\$signed_off_cc, undef],
     "smtpssl" => [\$smtp_ssl, 0],
 );
 
@@ -279,18 +279,20 @@ if (@suppress_cc) {
 			unless $entry =~ /^(all|cccmd|cc|author|self|sob)$/;
 		$suppress_cc{$entry} = 1;
 	}
-} else {
-	# Convert the old-style options.
-	$suppress_cc{'self'} = 1 if $suppress_from;
-	$suppress_cc{'sob'} = 1 unless $signed_off_cc;
 }
-
 if ($suppress_cc{'all'}) {
 	foreach my $entry (qw (ccmd cc author self sob)) {
 		$suppress_cc{$entry} = 1;
 	}
 	delete $suppress_cc{'all'};
 }
+# If explicit old-style ones are specified, they trump supress-cc
+if (defined $suppress_from) {
+	$suppress_cc{'self'} = $suppress_from;
+}
+if (defined $signed_off_cc) {
+	$suppress_cc{'sob'} = !$signed_off_cc;
+}
 
 my ($repoauthor) = $repo->ident_person('author');
 my ($repocommitter) = $repo->ident_person('committer');
#13 lore raw

PATCH 1/1 git-send-email: Generalize auto-cc recipient mechanism.

There are a few options to git-send-email to suppress the automatic generation of 'Cc' fields: --suppress-from, and --signed-off-cc. However, there are other times that git-send-email automatically includes Cc'd recipients. This is not desirable for all development environments.

Add a new option --suppress-cc, which can be specified one or more times to list the categories of auto-cc fields that should be suppressed. If not specified, it defaults to values to give the same behavior as specified by --suppress-from, and --signed-off-cc. The categories are:

self - patch sender. Same as --suppress-from.
author - patch author.

  cc     - cc lines mentioned in the patch.
  cccmd  - avoid running the cccmd.
  sob    - signed off by lines.
  all    - all non-explicit recipients

---
I've now added changes similar to those suggested by Junio Hamano so that signed-off-cc and suppress-from override values set by signed-off-by.

Dave

 Documentation/git-send-email.txt |   11 +++++++
 git-send-email.perl              |   56 +++++++++++++++++++++++++++++++++-----
 2 files changed, 60 insertions(+), 7 deletions(-)
Documentation/git-send-email.txt +11 -0
index f0bd285..3dcea86 100644
@@ -117,6 +117,17 @@ The --cc option must be repeated for each user you want on the cc list.
         Default is the value of 'sendemail.suppressfrom' configuration value;
         if that is unspecified, default to --no-suppress-from.
 
+--suppress-cc::
+	Specify an additional category of recipients to suppress the
+	auto-cc of.  'self' will avoid including the sender, 'author' will
+	avoid including the patch author, 'cc' will avoid including anyone
+	mentioned in Cc lines in the patch, 'sob' will avoid including
+	anyone mentioned in Signed-off-by lines, and 'cccmd' will avoid
+	running the --cc-cmd.  'all' will suppress all auto cc values.
+	Default is the value of 'sendemail.suppresscc' configuration value;
+	if that is unspecified, default to 'self' if --suppress-from is
+	specified, as well as 'sob' if --no-signed-off-cc is specified.
+
 --thread, --no-thread::
 	If this is set, the In-Reply-To header will be set on each email sent.
 	If disabled with "--no-thread", no emails will have the In-Reply-To
git-send-email.perl +49 -7

120 lines not on this page · raw message

Signature · 1 line
1.5.3.7
#14 lore raw

Re: [PATCH] git-send-email: Generalize auto-cc recipient mechanism.

Quoted 6 lines · On Tue, 25 Dec 2007 19:56:29 -0800 David Brown <[email protected]> wrote:

Add a new option --suppress-cc, which can be specified one or more times to list the categories of auto-cc fields that should be suppressed. If not specified, it defaults to values to give the same behavior as specified by --suppress-from, and --signed-off-cc. The categories are:

Quoted 7 lines

self - patch sender. Same as --suppress-from.
author - patch author.

  cc     - cc lines mentioned in the patch.
  cccmd  - avoid running the cccmd.
  sob    - signed off by lines.
  all    - all non-explicit recipients

Hi Dave,

It's great to see you're taking care of this issue, it's one that i've tripped over a few times. If your patch is accepted as-is, i think it's an improvement.

But i wonder about the case where a user has "sendemail.suppresscc = all" in their
~/.gitconfig. For the occasion when they do want to cc the author of
a patch, what do they do? The above UI seems to lack a way to enable a cc option that has been disabled by default.

Cheers,
Sean

#15 lore raw

Re: [PATCH] git-send-email: Generalize auto-cc recipient mechanism.

Quoted 4 lines · Sean

But i wonder about the case where a user has "sendemail.suppresscc = all" in their
~/.gitconfig. For the occasion when they do want to cc the author of
a patch, what do they do? The above UI seems to lack a way to enable a cc option that has been disabled by default.

Well, in that instance, --no-suppress-from would override that, if I did it right. Perhaps we could add an unsuppress-cc option, but then the whole thing is starting to get more complicated than I think it really needs to be.

My suggestion would be to keep this patch as is, and if the people using it decide they want the override option, we/I can figure out how to add it.

Dave

#16 lore raw

Re: [PATCH] git-send-email: Generalize auto-cc recipient mechanism.

In reply to Junio C Hamano

git-send-email.perl if (@suppress_cc) { · line 295

Quoted 7 lines · Junio C Hamano
git-send-email.perl +7 -0
+# If explicit old-style ones are specified, they trump supress-cc
+if (defined $suppress_from) {
+	$suppress_cc{'self'} = $suppress_from;
+}
+if (defined $signed_off_cc) {
+	$suppress_cc{'sob'} = !$signed_off_cc;
+}

This changes the default behavior to --no-signed-off-cc, if nothing is specified. I'll see if I can add something that will set that if no suppress-cc's are set.

Patch to follow shortly.

David