* [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options
@ 2008-09-22 15:58 Michael Witten
2008-09-22 15:58 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
2008-09-25 20:44 ` [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
0 siblings, 2 replies; 14+ messages in thread
From: Michael Witten @ 2008-09-22 15:58 UTC (permalink / raw)
To: git
Specifically, boolean options are now listed in the form
--[no-]option
and both forms of documentation now consistently use
--[no-]signed-off-by-cc
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
Documentation/git-send-email.txt | 21 +++++++++++++--------
git-send-email.perl | 8 ++++----
2 files changed, 17 insertions(+), 12 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 3c3e1b0..9b31626 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -40,8 +40,7 @@ The --cc option must be repeated for each user you want on the cc list.
Output of this command must be single email address per line.
Default is the value of 'sendemail.cccmd' configuration value.
---chain-reply-to::
---no-chain-reply-to::
+--[no-]chain-reply-to::
If this is set, each email will be sent as a reply to the previous
email sent. If disabled with "--no-chain-reply-to", all emails after
the first will be sent as replies to the first email sent. When using
@@ -66,8 +65,7 @@ The --cc option must be repeated for each user you want on the cc list.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
---signed-off-by-cc::
---no-signed-off-by-cc::
+--[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list.
Default is the value of 'sendemail.signedoffcc' configuration value;
@@ -146,8 +144,7 @@ user is prompted for a password while the input is masked for privacy.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
---suppress-from::
---no-suppress-from::
+--[no-]suppress-from::
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.
@@ -163,8 +160,7 @@ user is prompted for a password while the input is masked for privacy.
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::
+--[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
header set.
@@ -183,6 +179,15 @@ user is prompted for a password while the input is masked for privacy.
variable; if that is unspecified, choosing the envelope sender is left
to your MTA.
+--no-validate::
+ Don't perform any sanity checks on patches.
+ Currently, validation means the following:
++
+--
+ * Warn of patches that contain lines longer than 998 characters; this
+ is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
+--
+
--to::
Specify the primary recipient of the emails generated.
Generally, this will be the upstream maintainer of the
diff --git a/git-send-email.perl b/git-send-email.perl
index d2fd899..9f56162 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -64,11 +64,11 @@ Options:
Only used if --compose is also set. If --compose is not
set, this will be prompted for.
- --chain-reply-to If set, the replies will all be to the previous
+ --[no-]chain-reply-to If set, the replies will all be to the previous
email sent, rather than to the first email sent.
Defaults to on.
- --signed-off-cc Automatically add email addresses that appear in
+ --[no-]signed-off-by-cc Automatically add email addresses that appear in
Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
--identity The configuration identity, a subsection to prioritise over
@@ -95,9 +95,9 @@ Options:
'cccmd' for the output of the cccmd, or 'all' to suppress
all of these.
- --suppress-from Suppress sending emails to yourself. Defaults to off.
+ --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
- --thread Specify that the "In-Reply-To:" header should be set on all
+ --[no-]thread Specify that the "In-Reply-To:" header should be set on all
emails. Defaults to on.
--quiet Make git-send-email less verbose. One line per email
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 2/6] Docs: send-email usage cleanup 1
2008-09-22 15:58 [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
@ 2008-09-22 15:58 ` Michael Witten
2008-09-22 15:58 ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
2008-09-25 20:44 ` [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
1 sibling, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-22 15:58 UTC (permalink / raw)
To: git
The usage text mainly uses spaces to layout the text,
so I replaced the few tabs that exit with spaces.
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
git-send-email.perl | 36 ++++++++++++++++++------------------
1 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/git-send-email.perl b/git-send-email.perl
index 9f56162..d390364 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -51,25 +51,25 @@ Options:
per file specific cc address entries
--bcc Specify a list of email addresses that should be Bcc:
- on all the emails.
+ on all the emails.
--compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
- an introductory message for the patch series.
+ an introductory message for the patch series.
--subject Specify the initial "Subject:" line.
Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
+ is not set, this will be prompted for.
--in-reply-to Specify the first "In-Reply-To:" header line.
Only used if --compose is also set. If --compose is not
- set, this will be prompted for.
+ set, this will be prompted for.
--[no-]chain-reply-to If set, the replies will all be to the previous
- email sent, rather than to the first email sent.
- Defaults to on.
+ email sent, rather than to the first email sent.
+ Defaults to on.
--[no-]signed-off-by-cc Automatically add email addresses that appear in
- Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
+ Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
--identity The configuration identity, a subsection to prioritise over
the default section.
@@ -85,29 +85,29 @@ Options:
--smtp-pass The password for SMTP-AUTH.
--smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
- Any other value disables the feature.
+ Any other value disables the feature.
--smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
--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,
- 'cccmd' for the output of the cccmd, or 'all' to suppress
- all of these.
+ can be one of 'author' for the patch author, 'self' to
+ avoid copying yourself, 'sob' for Signed-off-by lines,
+ 'cccmd' for the output of the cccmd, or 'all' to suppress
+ all of these.
--[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
--[no-]thread Specify that the "In-Reply-To:" header should be set on all
- emails. Defaults to on.
+ emails. Defaults to on.
- --quiet Make git-send-email less verbose. One line per email
- should be all that is output.
+ --quiet Make git-send-email less verbose. One line per email
+ should be all that is output.
- --dry-run Do everything except actually send the emails.
+ --dry-run Do everything except actually send the emails.
- --envelope-sender Specify the envelope sender used to send the emails.
+ --envelope-sender Specify the envelope sender used to send the emails.
- --no-validate Don't perform any sanity checks on patches.
+ --no-validate Don't perform any sanity checks on patches.
EOT
exit(1);
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 3/6] Docs: send-email usage text much sexier
2008-09-22 15:58 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
@ 2008-09-22 15:58 ` Michael Witten
2008-09-22 15:58 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
0 siblings, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-22 15:58 UTC (permalink / raw)
To: git
All of the descriptions are aligned, and no
line is greater than 78 columns.
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
git-send-email.perl | 94 +++++++++++++++++++++++++++------------------------
1 files changed, 50 insertions(+), 44 deletions(-)
diff --git a/git-send-email.perl b/git-send-email.perl
index d390364..b86a3f3 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -40,74 +40,80 @@ sub usage {
print <<EOT;
git send-email [options] <file | directory>...
Options:
- --from Specify the "From:" line of the email to be sent.
+ --from Specify the "From:" line of the email to be sent.
- --to Specify the primary "To:" line of the email.
+ --to Specify the primary "To:" line of the email.
- --cc Specify an initial "Cc:" list for the entire series
- of emails.
+ --cc Specify an initial "Cc:" list for the entire series
+ of emails.
- --cc-cmd Specify a command to execute per file which adds
- per file specific cc address entries
+ --cc-cmd Specify a command to execute per file which adds
+ per file specific cc address entries
- --bcc Specify a list of email addresses that should be Bcc:
- on all the emails.
+ --bcc Specify a list of email addresses that should be
+ Bcc: on all the emails.
- --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
- an introductory message for the patch series.
+ --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or
+ \$VISUAL to edit an introductory message for the
+ patch series.
- --subject Specify the initial "Subject:" line.
- Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
+ --subject Specify the initial "Subject:" line. Only necessary
+ if --compose is also set. If --compose is not set,
+ this will be prompted for.
- --in-reply-to Specify the first "In-Reply-To:" header line.
- Only used if --compose is also set. If --compose is not
- set, this will be prompted for.
+ --in-reply-to Specify the first "In-Reply-To:" header line. Only
+ used if --compose is also set. If --compose is not
+ set, this will be prompted for.
- --[no-]chain-reply-to If set, the replies will all be to the previous
- email sent, rather than to the first email sent.
- Defaults to on.
+ --[no-]chain-reply-to If set, the replies will all be to the previous
+ email sent, rather than to the first email sent.
+ Defaults to on.
--[no-]signed-off-by-cc Automatically add email addresses that appear in
- Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
+ Signed-off-by: or Cc: lines to the cc: list.
+ Defaults to on.
- --identity The configuration identity, a subsection to prioritise over
- the default section.
+ --identity The configuration identity to use.
- --smtp-server If set, specifies the outgoing SMTP server to use.
- Defaults to localhost. Port number can be specified here with
- hostname:port format or by using --smtp-server-port option.
+ --smtp-server If set, specifies the outgoing SMTP server to use.
+ Defaults to localhost. Port number can be
+ specified here with hostname:port format or by
+ using --smtp-server-port option.
- --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
+ --smtp-server-port Specify a port on the outgoing SMTP server to
+ connect to.
- --smtp-user The username for SMTP-AUTH.
+ --smtp-user The username for SMTP-AUTH.
- --smtp-pass The password for SMTP-AUTH.
+ --smtp-pass The password for SMTP-AUTH.
- --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
- Any other value disables the feature.
+ --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for
+ SSL. Any other value disables the feature.
- --smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
+ --smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
- --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,
- 'cccmd' for the output of the cccmd, or 'all' to suppress
- all of these.
+ --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, 'cccmd' for the output
+ of the cccmd, or 'all' to suppress all of these.
+ (Note: Linus uses 'self' and 'sob' interchangeably)
- --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
+ --[no-]suppress-from Suppress sending emails to yourself. Defaults to
+ off.
- --[no-]thread Specify that the "In-Reply-To:" header should be set on all
- emails. Defaults to on.
+ --[no-]thread Specify that the "In-Reply-To:" header should be
+ set on all emails. Defaults to on.
- --quiet Make git-send-email less verbose. One line per email
- should be all that is output.
+ --quiet Make git-send-email less verbose. One line per
+ email should be all that is output.
- --dry-run Do everything except actually send the emails.
+ --dry-run Do everything except actually send the emails.
- --envelope-sender Specify the envelope sender used to send the emails.
+ --envelope-sender Specify the envelope sender used to send the
+ emails.
- --no-validate Don't perform any sanity checks on patches.
+ --no-validate Don't perform any sanity checks on patches.
EOT
exit(1);
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text
2008-09-22 15:58 ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
@ 2008-09-22 15:58 ` Michael Witten
2008-09-22 15:58 ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
0 siblings, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-22 15:58 UTC (permalink / raw)
To: git
The man page seems to have listed the options in alphabetical order,
while the usage text used what I would consider an `intuitive' order
that groups related items and presents them in the order peopl think
when writing an email.
The manual page has been updated to mirror this order.
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
Documentation/git-send-email.txt | 77 +++++++++++++++++++-------------------
1 files changed, 39 insertions(+), 38 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 9b31626..6031eb7 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -24,10 +24,19 @@ OPTIONS
-------
The options available are:
---bcc::
- Specify a "Bcc:" value for each email.
+--from::
+ Specify the sender of the emails. This will default to
+ the value GIT_COMMITTER_IDENT, as returned by "git var -l".
+ The user will still be prompted to confirm this entry.
+
+--to::
+ Specify the primary recipient of the emails generated.
+ Generally, this will be the upstream maintainer of the
+ project involved.
+ Default is the value of the 'sendemail.to' configuration value;
+ if that is unspecified, this will be prompted for.
+
-The --bcc option must be repeated for each user you want on the bcc list.
+The --to option must be repeated for each user you want on the to list.
--cc::
Specify a starting "Cc:" value for each email.
@@ -40,23 +49,19 @@ The --cc option must be repeated for each user you want on the cc list.
Output of this command must be single email address per line.
Default is the value of 'sendemail.cccmd' configuration value.
---[no-]chain-reply-to::
- If this is set, each email will be sent as a reply to the previous
- email sent. If disabled with "--no-chain-reply-to", all emails after
- the first will be sent as replies to the first email sent. When using
- this, it is recommended that the first file given be an overview of the
- entire patch series.
- Default is the value of the 'sendemail.chainreplyto' configuration
- value; if that is unspecified, default to --chain-reply-to.
+--bcc::
+ Specify a "Bcc:" value for each email.
++
+The --bcc option must be repeated for each user you want on the bcc list.
--compose::
Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
introductory message for the patch series.
---from::
- Specify the sender of the emails. This will default to
- the value GIT_COMMITTER_IDENT, as returned by "git var -l".
- The user will still be prompted to confirm this entry.
+--subject::
+ Specify the initial subject of the email thread.
+ Only necessary if --compose is also set. If --compose
+ is not set, this will be prompted for.
--in-reply-to::
Specify the contents of the first In-Reply-To header.
@@ -65,16 +70,21 @@ The --cc option must be repeated for each user you want on the cc list.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
+--[no-]chain-reply-to::
+ If this is set, each email will be sent as a reply to the previous
+ email sent. If disabled with "--no-chain-reply-to", all emails after
+ the first will be sent as replies to the first email sent. When using
+ this, it is recommended that the first file given be an overview of the
+ entire patch series.
+ Default is the value of the 'sendemail.chainreplyto' configuration
+ value; if that is unspecified, default to --chain-reply-to.
+
--[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list.
Default is the value of 'sendemail.signedoffcc' configuration value;
if that is unspecified, default to --signed-off-by-cc.
---quiet::
- Make git-send-email less verbose. One line per email should be
- all that is output.
-
--identity::
A configuration identity. When given, causes values in the
'sendemail.<identity>' subsection to take precedence over
@@ -139,16 +149,6 @@ user is prompted for a password while the input is masked for privacy.
--smtp-ssl::
Legacy alias for '--smtp-encryption=ssl'.
---subject::
- Specify the initial subject of the email thread.
- Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
-
---[no-]suppress-from::
- 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.
-
--suppress-cc::
Specify an additional category of recipients to suppress the
auto-cc of. 'self' will avoid including the sender, 'author' will
@@ -159,6 +159,12 @@ user is prompted for a password while the input is masked for privacy.
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.
+ (Note: Linus uses 'self' and 'sob' interchangeably).
+
+--[no-]suppress-from::
+ 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.
--[no-]thread::
If this is set, the In-Reply-To header will be set on each email sent.
@@ -167,6 +173,10 @@ user is prompted for a password while the input is masked for privacy.
Default is the value of the 'sendemail.thread' configuration value;
if that is unspecified, default to --thread.
+--quiet::
+ Make git-send-email less verbose. One line per email should be
+ all that is output.
+
--dry-run::
Do everything except actually send the emails.
@@ -188,15 +198,6 @@ user is prompted for a password while the input is masked for privacy.
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
--
---to::
- Specify the primary recipient of the emails generated.
- Generally, this will be the upstream maintainer of the
- project involved.
- Default is the value of the 'sendemail.to' configuration value;
- if that is unspecified, this will be prompted for.
-+
-The --to option must be repeated for each user you want on the to list.
-
CONFIGURATION
-------------
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate
2008-09-22 15:58 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
@ 2008-09-22 15:58 ` Michael Witten
2008-09-22 15:58 ` [PATCH RFC 6/6] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
0 siblings, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-22 15:58 UTC (permalink / raw)
To: git
There is also now a configuration variable:
sendemail[.<identity>].validate
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
Documentation/git-send-email.txt | 9 +++++++--
git-send-email.perl | 10 ++++++----
2 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 6031eb7..fe53e9b 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -189,14 +189,16 @@ user is prompted for a password while the input is masked for privacy.
variable; if that is unspecified, choosing the envelope sender is left
to your MTA.
---no-validate::
- Don't perform any sanity checks on patches.
+--[no-]validate::
+ Perform sanity checks on patches.
Currently, validation means the following:
+
--
* Warn of patches that contain lines longer than 998 characters; this
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
--
++
+This option can be set with sendemail[.<identity>].validate; default to --validate
CONFIGURATION
@@ -249,6 +251,9 @@ sendemail.smtpencryption::
sendemail.smtpssl::
Legacy boolean that sets 'smtpencryption=ssl' if enabled.
+sendemail.validate::
+ Boolean override for --[no-]validate.
+
Author
------
Written by Ryan Anderson <ryan@michonline.com>
diff --git a/git-send-email.perl b/git-send-email.perl
index b86a3f3..8bc204f 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -113,7 +113,8 @@ Options:
--envelope-sender Specify the envelope sender used to send the
emails.
- --no-validate Don't perform any sanity checks on patches.
+ --[no-]validate Perform any sanity checks on patches.
+ Default to on.
EOT
exit(1);
@@ -195,7 +196,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_encryption);
my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
-my ($no_validate);
+my ($validate);
my (@suppress_cc);
my %config_bool_settings = (
@@ -203,6 +204,7 @@ my %config_bool_settings = (
"chainreplyto" => [\$chain_reply_to, 1],
"suppressfrom" => [\$suppress_from, undef],
"signedoffcc" => [\$signed_off_cc, undef],
+ "validate" => [\$validate, 1],
);
my %config_settings = (
@@ -269,7 +271,7 @@ my $rc = GetOptions("sender|from=s" => \$sender,
"dry-run" => \$dry_run,
"envelope-sender=s" => \$envelope_sender,
"thread!" => \$thread,
- "no-validate" => \$no_validate,
+ "validate!" => \$validate,
);
unless ($rc) {
@@ -422,7 +424,7 @@ for my $f (@ARGV) {
}
}
-if (!$no_validate) {
+if ($validate) {
foreach my $f (@files) {
unless (-p $f) {
my $error = validate_patch($f);
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options
2008-09-22 15:58 [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-22 15:58 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
@ 2008-09-25 20:44 ` Michael Witten
2008-09-25 20:44 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
1 sibling, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-25 20:44 UTC (permalink / raw)
To: gitster; +Cc: git
Specifically, boolean options are now listed in the form
--[no-]option
and both forms of documentation now consistently use
--[no-]signed-off-by-cc
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
Documentation/git-send-email.txt | 21 +++++++++++++--------
git-send-email.perl | 8 ++++----
2 files changed, 17 insertions(+), 12 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 3c3e1b0..9b31626 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -40,8 +40,7 @@ The --cc option must be repeated for each user you want on the cc list.
Output of this command must be single email address per line.
Default is the value of 'sendemail.cccmd' configuration value.
---chain-reply-to::
---no-chain-reply-to::
+--[no-]chain-reply-to::
If this is set, each email will be sent as a reply to the previous
email sent. If disabled with "--no-chain-reply-to", all emails after
the first will be sent as replies to the first email sent. When using
@@ -66,8 +65,7 @@ The --cc option must be repeated for each user you want on the cc list.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
---signed-off-by-cc::
---no-signed-off-by-cc::
+--[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list.
Default is the value of 'sendemail.signedoffcc' configuration value;
@@ -146,8 +144,7 @@ user is prompted for a password while the input is masked for privacy.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
---suppress-from::
---no-suppress-from::
+--[no-]suppress-from::
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.
@@ -163,8 +160,7 @@ user is prompted for a password while the input is masked for privacy.
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::
+--[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
header set.
@@ -183,6 +179,15 @@ user is prompted for a password while the input is masked for privacy.
variable; if that is unspecified, choosing the envelope sender is left
to your MTA.
+--no-validate::
+ Don't perform any sanity checks on patches.
+ Currently, validation means the following:
++
+--
+ * Warn of patches that contain lines longer than 998 characters; this
+ is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
+--
+
--to::
Specify the primary recipient of the emails generated.
Generally, this will be the upstream maintainer of the
diff --git a/git-send-email.perl b/git-send-email.perl
index d2fd899..9f56162 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -64,11 +64,11 @@ Options:
Only used if --compose is also set. If --compose is not
set, this will be prompted for.
- --chain-reply-to If set, the replies will all be to the previous
+ --[no-]chain-reply-to If set, the replies will all be to the previous
email sent, rather than to the first email sent.
Defaults to on.
- --signed-off-cc Automatically add email addresses that appear in
+ --[no-]signed-off-by-cc Automatically add email addresses that appear in
Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
--identity The configuration identity, a subsection to prioritise over
@@ -95,9 +95,9 @@ Options:
'cccmd' for the output of the cccmd, or 'all' to suppress
all of these.
- --suppress-from Suppress sending emails to yourself. Defaults to off.
+ --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
- --thread Specify that the "In-Reply-To:" header should be set on all
+ --[no-]thread Specify that the "In-Reply-To:" header should be set on all
emails. Defaults to on.
--quiet Make git-send-email less verbose. One line per email
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 2/6] Docs: send-email usage cleanup 1
2008-09-25 20:44 ` [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
@ 2008-09-25 20:44 ` Michael Witten
2008-09-25 20:44 ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
0 siblings, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-25 20:44 UTC (permalink / raw)
To: gitster; +Cc: git
The usage text mainly uses spaces to layout the text,
so I replaced the few tabs that exit with spaces.
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
git-send-email.perl | 36 ++++++++++++++++++------------------
1 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/git-send-email.perl b/git-send-email.perl
index 9f56162..d390364 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -51,25 +51,25 @@ Options:
per file specific cc address entries
--bcc Specify a list of email addresses that should be Bcc:
- on all the emails.
+ on all the emails.
--compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
- an introductory message for the patch series.
+ an introductory message for the patch series.
--subject Specify the initial "Subject:" line.
Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
+ is not set, this will be prompted for.
--in-reply-to Specify the first "In-Reply-To:" header line.
Only used if --compose is also set. If --compose is not
- set, this will be prompted for.
+ set, this will be prompted for.
--[no-]chain-reply-to If set, the replies will all be to the previous
- email sent, rather than to the first email sent.
- Defaults to on.
+ email sent, rather than to the first email sent.
+ Defaults to on.
--[no-]signed-off-by-cc Automatically add email addresses that appear in
- Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
+ Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
--identity The configuration identity, a subsection to prioritise over
the default section.
@@ -85,29 +85,29 @@ Options:
--smtp-pass The password for SMTP-AUTH.
--smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
- Any other value disables the feature.
+ Any other value disables the feature.
--smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
--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,
- 'cccmd' for the output of the cccmd, or 'all' to suppress
- all of these.
+ can be one of 'author' for the patch author, 'self' to
+ avoid copying yourself, 'sob' for Signed-off-by lines,
+ 'cccmd' for the output of the cccmd, or 'all' to suppress
+ all of these.
--[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
--[no-]thread Specify that the "In-Reply-To:" header should be set on all
- emails. Defaults to on.
+ emails. Defaults to on.
- --quiet Make git-send-email less verbose. One line per email
- should be all that is output.
+ --quiet Make git-send-email less verbose. One line per email
+ should be all that is output.
- --dry-run Do everything except actually send the emails.
+ --dry-run Do everything except actually send the emails.
- --envelope-sender Specify the envelope sender used to send the emails.
+ --envelope-sender Specify the envelope sender used to send the emails.
- --no-validate Don't perform any sanity checks on patches.
+ --no-validate Don't perform any sanity checks on patches.
EOT
exit(1);
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 3/6] Docs: send-email usage text much sexier
2008-09-25 20:44 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
@ 2008-09-25 20:44 ` Michael Witten
2008-09-25 20:44 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
0 siblings, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-25 20:44 UTC (permalink / raw)
To: gitster; +Cc: git
All of the descriptions are aligned, and no
line is greater than 78 columns.
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
git-send-email.perl | 94 +++++++++++++++++++++++++++------------------------
1 files changed, 50 insertions(+), 44 deletions(-)
diff --git a/git-send-email.perl b/git-send-email.perl
index d390364..b86a3f3 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -40,74 +40,80 @@ sub usage {
print <<EOT;
git send-email [options] <file | directory>...
Options:
- --from Specify the "From:" line of the email to be sent.
+ --from Specify the "From:" line of the email to be sent.
- --to Specify the primary "To:" line of the email.
+ --to Specify the primary "To:" line of the email.
- --cc Specify an initial "Cc:" list for the entire series
- of emails.
+ --cc Specify an initial "Cc:" list for the entire series
+ of emails.
- --cc-cmd Specify a command to execute per file which adds
- per file specific cc address entries
+ --cc-cmd Specify a command to execute per file which adds
+ per file specific cc address entries
- --bcc Specify a list of email addresses that should be Bcc:
- on all the emails.
+ --bcc Specify a list of email addresses that should be
+ Bcc: on all the emails.
- --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
- an introductory message for the patch series.
+ --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or
+ \$VISUAL to edit an introductory message for the
+ patch series.
- --subject Specify the initial "Subject:" line.
- Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
+ --subject Specify the initial "Subject:" line. Only necessary
+ if --compose is also set. If --compose is not set,
+ this will be prompted for.
- --in-reply-to Specify the first "In-Reply-To:" header line.
- Only used if --compose is also set. If --compose is not
- set, this will be prompted for.
+ --in-reply-to Specify the first "In-Reply-To:" header line. Only
+ used if --compose is also set. If --compose is not
+ set, this will be prompted for.
- --[no-]chain-reply-to If set, the replies will all be to the previous
- email sent, rather than to the first email sent.
- Defaults to on.
+ --[no-]chain-reply-to If set, the replies will all be to the previous
+ email sent, rather than to the first email sent.
+ Defaults to on.
--[no-]signed-off-by-cc Automatically add email addresses that appear in
- Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
+ Signed-off-by: or Cc: lines to the cc: list.
+ Defaults to on.
- --identity The configuration identity, a subsection to prioritise over
- the default section.
+ --identity The configuration identity to use.
- --smtp-server If set, specifies the outgoing SMTP server to use.
- Defaults to localhost. Port number can be specified here with
- hostname:port format or by using --smtp-server-port option.
+ --smtp-server If set, specifies the outgoing SMTP server to use.
+ Defaults to localhost. Port number can be
+ specified here with hostname:port format or by
+ using --smtp-server-port option.
- --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
+ --smtp-server-port Specify a port on the outgoing SMTP server to
+ connect to.
- --smtp-user The username for SMTP-AUTH.
+ --smtp-user The username for SMTP-AUTH.
- --smtp-pass The password for SMTP-AUTH.
+ --smtp-pass The password for SMTP-AUTH.
- --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
- Any other value disables the feature.
+ --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for
+ SSL. Any other value disables the feature.
- --smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
+ --smtp-ssl Synonym for '--smtp-encryption=ssl'. Deprecated.
- --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,
- 'cccmd' for the output of the cccmd, or 'all' to suppress
- all of these.
+ --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, 'cccmd' for the output
+ of the cccmd, or 'all' to suppress all of these.
+ (Note: Linus uses 'self' and 'sob' interchangeably)
- --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
+ --[no-]suppress-from Suppress sending emails to yourself. Defaults to
+ off.
- --[no-]thread Specify that the "In-Reply-To:" header should be set on all
- emails. Defaults to on.
+ --[no-]thread Specify that the "In-Reply-To:" header should be
+ set on all emails. Defaults to on.
- --quiet Make git-send-email less verbose. One line per email
- should be all that is output.
+ --quiet Make git-send-email less verbose. One line per
+ email should be all that is output.
- --dry-run Do everything except actually send the emails.
+ --dry-run Do everything except actually send the emails.
- --envelope-sender Specify the envelope sender used to send the emails.
+ --envelope-sender Specify the envelope sender used to send the
+ emails.
- --no-validate Don't perform any sanity checks on patches.
+ --no-validate Don't perform any sanity checks on patches.
EOT
exit(1);
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text
2008-09-25 20:44 ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
@ 2008-09-25 20:44 ` Michael Witten
2008-09-25 20:44 ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-26 22:40 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Jeff King
0 siblings, 2 replies; 14+ messages in thread
From: Michael Witten @ 2008-09-25 20:44 UTC (permalink / raw)
To: gitster; +Cc: git
The man page seems to have listed the options in alphabetical order,
while the usage text used what I would consider an `intuitive' order
that groups related items and presents them in the order peopl think
when writing an email.
The manual page has been updated to mirror this order.
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
Documentation/git-send-email.txt | 77 +++++++++++++++++++-------------------
1 files changed, 39 insertions(+), 38 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 9b31626..6031eb7 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -24,10 +24,19 @@ OPTIONS
-------
The options available are:
---bcc::
- Specify a "Bcc:" value for each email.
+--from::
+ Specify the sender of the emails. This will default to
+ the value GIT_COMMITTER_IDENT, as returned by "git var -l".
+ The user will still be prompted to confirm this entry.
+
+--to::
+ Specify the primary recipient of the emails generated.
+ Generally, this will be the upstream maintainer of the
+ project involved.
+ Default is the value of the 'sendemail.to' configuration value;
+ if that is unspecified, this will be prompted for.
+
-The --bcc option must be repeated for each user you want on the bcc list.
+The --to option must be repeated for each user you want on the to list.
--cc::
Specify a starting "Cc:" value for each email.
@@ -40,23 +49,19 @@ The --cc option must be repeated for each user you want on the cc list.
Output of this command must be single email address per line.
Default is the value of 'sendemail.cccmd' configuration value.
---[no-]chain-reply-to::
- If this is set, each email will be sent as a reply to the previous
- email sent. If disabled with "--no-chain-reply-to", all emails after
- the first will be sent as replies to the first email sent. When using
- this, it is recommended that the first file given be an overview of the
- entire patch series.
- Default is the value of the 'sendemail.chainreplyto' configuration
- value; if that is unspecified, default to --chain-reply-to.
+--bcc::
+ Specify a "Bcc:" value for each email.
++
+The --bcc option must be repeated for each user you want on the bcc list.
--compose::
Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
introductory message for the patch series.
---from::
- Specify the sender of the emails. This will default to
- the value GIT_COMMITTER_IDENT, as returned by "git var -l".
- The user will still be prompted to confirm this entry.
+--subject::
+ Specify the initial subject of the email thread.
+ Only necessary if --compose is also set. If --compose
+ is not set, this will be prompted for.
--in-reply-to::
Specify the contents of the first In-Reply-To header.
@@ -65,16 +70,21 @@ The --cc option must be repeated for each user you want on the cc list.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.
+--[no-]chain-reply-to::
+ If this is set, each email will be sent as a reply to the previous
+ email sent. If disabled with "--no-chain-reply-to", all emails after
+ the first will be sent as replies to the first email sent. When using
+ this, it is recommended that the first file given be an overview of the
+ entire patch series.
+ Default is the value of the 'sendemail.chainreplyto' configuration
+ value; if that is unspecified, default to --chain-reply-to.
+
--[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list.
Default is the value of 'sendemail.signedoffcc' configuration value;
if that is unspecified, default to --signed-off-by-cc.
---quiet::
- Make git-send-email less verbose. One line per email should be
- all that is output.
-
--identity::
A configuration identity. When given, causes values in the
'sendemail.<identity>' subsection to take precedence over
@@ -139,16 +149,6 @@ user is prompted for a password while the input is masked for privacy.
--smtp-ssl::
Legacy alias for '--smtp-encryption=ssl'.
---subject::
- Specify the initial subject of the email thread.
- Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
-
---[no-]suppress-from::
- 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.
-
--suppress-cc::
Specify an additional category of recipients to suppress the
auto-cc of. 'self' will avoid including the sender, 'author' will
@@ -159,6 +159,12 @@ user is prompted for a password while the input is masked for privacy.
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.
+ (Note: Linus uses 'self' and 'sob' interchangeably).
+
+--[no-]suppress-from::
+ 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.
--[no-]thread::
If this is set, the In-Reply-To header will be set on each email sent.
@@ -167,6 +173,10 @@ user is prompted for a password while the input is masked for privacy.
Default is the value of the 'sendemail.thread' configuration value;
if that is unspecified, default to --thread.
+--quiet::
+ Make git-send-email less verbose. One line per email should be
+ all that is output.
+
--dry-run::
Do everything except actually send the emails.
@@ -188,15 +198,6 @@ user is prompted for a password while the input is masked for privacy.
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
--
---to::
- Specify the primary recipient of the emails generated.
- Generally, this will be the upstream maintainer of the
- project involved.
- Default is the value of the 'sendemail.to' configuration value;
- if that is unspecified, this will be prompted for.
-+
-The --to option must be repeated for each user you want on the to list.
-
CONFIGURATION
-------------
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate
2008-09-25 20:44 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
@ 2008-09-25 20:44 ` Michael Witten
2008-09-25 20:44 ` [PATCH RFC 6/6] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-26 22:40 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Jeff King
1 sibling, 1 reply; 14+ messages in thread
From: Michael Witten @ 2008-09-25 20:44 UTC (permalink / raw)
To: gitster; +Cc: git
There is also now a configuration variable:
sendemail[.<identity>].validate
Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
Documentation/git-send-email.txt | 9 +++++++--
git-send-email.perl | 10 ++++++----
2 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 6031eb7..fe53e9b 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -189,14 +189,16 @@ user is prompted for a password while the input is masked for privacy.
variable; if that is unspecified, choosing the envelope sender is left
to your MTA.
---no-validate::
- Don't perform any sanity checks on patches.
+--[no-]validate::
+ Perform sanity checks on patches.
Currently, validation means the following:
+
--
* Warn of patches that contain lines longer than 998 characters; this
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
--
++
+This option can be set with sendemail[.<identity>].validate; default to --validate
CONFIGURATION
@@ -249,6 +251,9 @@ sendemail.smtpencryption::
sendemail.smtpssl::
Legacy boolean that sets 'smtpencryption=ssl' if enabled.
+sendemail.validate::
+ Boolean override for --[no-]validate.
+
Author
------
Written by Ryan Anderson <ryan@michonline.com>
diff --git a/git-send-email.perl b/git-send-email.perl
index b86a3f3..8bc204f 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -113,7 +113,8 @@ Options:
--envelope-sender Specify the envelope sender used to send the
emails.
- --no-validate Don't perform any sanity checks on patches.
+ --[no-]validate Perform any sanity checks on patches.
+ Default to on.
EOT
exit(1);
@@ -195,7 +196,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_encryption);
my ($identity, $aliasfiletype, @alias_files, @smtp_host_parts);
-my ($no_validate);
+my ($validate);
my (@suppress_cc);
my %config_bool_settings = (
@@ -203,6 +204,7 @@ my %config_bool_settings = (
"chainreplyto" => [\$chain_reply_to, 1],
"suppressfrom" => [\$suppress_from, undef],
"signedoffcc" => [\$signed_off_cc, undef],
+ "validate" => [\$validate, 1],
);
my %config_settings = (
@@ -269,7 +271,7 @@ my $rc = GetOptions("sender|from=s" => \$sender,
"dry-run" => \$dry_run,
"envelope-sender=s" => \$envelope_sender,
"thread!" => \$thread,
- "no-validate" => \$no_validate,
+ "validate!" => \$validate,
);
unless ($rc) {
@@ -422,7 +424,7 @@ for my $f (@ARGV) {
}
}
-if (!$no_validate) {
+if ($validate) {
foreach my $f (@files) {
unless (-p $f) {
my $error = validate_patch($f);
--
1.6.0.2.302.ge6cbd1
^ permalink raw reply related [flat|nested] 14+ messages in thread* Re: [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text
2008-09-25 20:44 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
2008-09-25 20:44 ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
@ 2008-09-26 22:40 ` Jeff King
2008-09-27 1:13 ` Michael Witten
1 sibling, 1 reply; 14+ messages in thread
From: Jeff King @ 2008-09-26 22:40 UTC (permalink / raw)
To: Michael Witten; +Cc: gitster, git
On Thu, Sep 25, 2008 at 03:44:34PM -0500, Michael Witten wrote:
> The man page seems to have listed the options in alphabetical order,
> while the usage text used what I would consider an `intuitive' order
> that groups related items and presents them in the order peopl think
> when writing an email.
>
> The manual page has been updated to mirror this order.
I think overall this serious is well-intentioned the results look sane
to me (I diffed the manpage and usage text before and after).
My only concerns are:
4/6: I am not sure about making the order of options the same, as the
two formats serve different purposes. I think "git send-email
--foo" should present the options based on commonality of use.
You clearly got the usage wrong, so I think it is helping you to
figure out quickly what you probably meant.
The manpage, on the other hand, is a comprehensive reference and
so should probably be alphabetized for easy reading.
That being said, I find the length of the current usage statement
somewhat ridiculous. I wonder if it would be better still to just
mention in the usage the overall syntax (i.e., "send-email
[options] <file | directory>", the few most common options (with
minimal description), and then refer to the manpage for complete.
With the goal of taking no more than 10 or so lines (the current
output is 71 lines!).
5/6: This isn't really a documentation patch, as it adds a new config
option. I think the result is reasonable, but it was a surprise
after reading the rest of the series.
I was also going to complain that there was no entry in
Documentation/config.txt for the new option, but I see that none
of the sendemail options are there. Maybe while you are working
on this, it is worth factoring them out to send-email-options.txt
and including it in both git-send-email.txt and config.txt.
-Peff
^ permalink raw reply [flat|nested] 14+ messages in thread* Re: [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text
2008-09-26 22:40 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Jeff King
@ 2008-09-27 1:13 ` Michael Witten
0 siblings, 0 replies; 14+ messages in thread
From: Michael Witten @ 2008-09-27 1:13 UTC (permalink / raw)
To: Jeff King; +Cc: git, Junio C Hamano
On 26 Sep 2008, at 5:40 PM, Jeff King wrote:
> I think overall this serious is well-intentioned the results look sane
> to me (I diffed the manpage and usage text before and after).
>
> My only concerns are:
>
> 4/6: ...
> The manpage, on the other hand, is a comprehensive reference and
> so should probably be alphabetized for easy reading.
I can buy it. I'll change it back.
> ...
> That being said, I find the length of the current usage
> statement
> somewhat ridiculous.
I'll take care of it.
> 5/6: This isn't really a documentation patch, as it adds a new config
> option. I think the result is reasonable, but it was a surprise
> after reading the rest of the series.
I didn't mean to mark those as Docs. I'll fix that too.
> I was also going to complain that there was no entry in
> Documentation/config.txt for the new option, but I see that none
> of the sendemail options are there. Maybe while you are working
> on this, it is worth factoring them out to send-email-
> options.txt
> and including it in both git-send-email.txt and config.txt.
Grumble grumble grumble... erm.. hmm.. grrr.. ok.
^ permalink raw reply [flat|nested] 14+ messages in thread
end of thread, other threads:[~2008-09-27 1:18 UTC | newest]
Thread overview: 14+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-09-22 15:58 [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-22 15:58 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
2008-09-22 15:58 ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
2008-09-22 15:58 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
2008-09-22 15:58 ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-22 15:58 ` [PATCH RFC 6/6] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-25 20:44 ` [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-25 20:44 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
2008-09-25 20:44 ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
2008-09-25 20:44 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
2008-09-25 20:44 ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-25 20:44 ` [PATCH RFC 6/6] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-26 22:40 ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Jeff King
2008-09-27 1:13 ` Michael Witten
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).