threads / patch / 19769

patchdoc tweak for git-send-email

Subject: [PATCH] doc tweak for git-send-email

## tl;dr

5 messages between Jun 10, 2009 and Jun 12, 2009. Diffs are folded; open one to read it.

replies: 4people: 3as markdown or json

Paolo Bonzini· Jun 10, 2009, 17:56 UTC · lore

The git-send-email docs do not mention except in the usage lines the combined patch formatting/sending ability of git-send-email. This fills the hole.

Signed-off-by: Paolo Bonzini <bonzini@gnu.org>
---
 Documentation/git-send-email.txt |    3 +++
 1 files changed, 3 insertions(+), 0 deletions(-)

Show changes to Documentation/git-send-email.txt +3 −0

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index eb851b3..02bb0d3 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -33,6 +33,9 @@ script
 This format expects the first line of the file to contain the "Cc:" value
 and the "Subject:" of the message as the second line.
 
+In addition, git send-email can be asked to generate patches with git
+format-patch and send them.
+
 
 OPTIONS
 -------

-- 
1.6.0.3

Stephen Boyd· Jun 11, 2009, 00:57 UTC · re: Paolo Bonzini · lore

Re: [PATCH] doc tweak for git-send-email

Paolo Bonzini wrote:

Show 20 quoted lines

> The git-send-email docs do not mention except in the usage lines
> the combined patch formatting/sending ability of git-send-email.
> This fills the hole.
>
> Signed-off-by: Paolo Bonzini <bonzini@gnu.org>
> ---
>  Documentation/git-send-email.txt |    3 +++
>  1 files changed, 3 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
> index eb851b3..02bb0d3 100644
> --- a/Documentation/git-send-email.txt
> +++ b/Documentation/git-send-email.txt
> @@ -33,6 +33,9 @@ script
>  This format expects the first line of the file to contain the "Cc:" value
>  and the "Subject:" of the message as the second line.
>  
> +In addition, git send-email can be asked to generate patches with git
> +format-patch and send them.
> +

You are right that the docs don't mention this feature very clearly, but this patch doesn't fill the hole for me.

How do I tell send-email to generate patches with format-patch? I know from looking at the code that send-email actually calls format-patch with the rev-list passed on the command line.

Maybe it would be more clear to say that rev-list can be specified in the same way as format-patch? Also, could you update the first sentence in the description section? Obviously send-email takes more than just patches on the command line.

Paolo Bonzini· Jun 11, 2009, 07:30 UTC · re: Stephen Boyd · lore

[PATCH v2] doc tweak for git-send-email

The git-send-email docs do not mention except in the usage lines the combined patch formatting/sending ability of git-send-email. This patch expands on the possible arguments to git-send-email and explains the meaning of the rev-list argument.

Signed-off-by: Paolo Bonzini <bonzini@gnu.org>
---
 Documentation/git-send-email.txt |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

Show changes to Documentation/git-send-email.txt +4 −0

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 794224b..a282190 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -14,6 +14,10 @@ SYNOPSIS
 DESCRIPTION
 -----------
 Takes the patches given on the command line and emails them out.
+Patches can be specified as files, directories (which will send all
+files in the directory), or directly as a revision list.  In the
+last case, any format accepted by linkgit:git-format-patch[1] can
+be passed to git send-email.
 
 The header of the email is configurable by command line options.  If not
 specified on the command line, the user will be prompted with a ReadLine

-- 
1.6.0.3

Stephen Boyd· Jun 11, 2009, 21:57 UTC · re: Paolo Bonzini · lore

Re: [PATCH v2] doc tweak for git-send-email

Paolo Bonzini wrote:

Show 12 quoted lines

> @@ -14,6 +14,10 @@ SYNOPSIS
>  DESCRIPTION
>  -----------
>  Takes the patches given on the command line and emails them out.
> +Patches can be specified as files, directories (which will send all
> +files in the directory), or directly as a revision list.  In the
> +last case, any format accepted by linkgit:git-format-patch[1] can
> +be passed to git send-email.
>  
>  The header of the email is configurable by command line options.  If not
>  specified on the command line, the user will be prompted with a ReadLine
>

Thanks, this is getting better. Just a quick note, the subject of this patch is sort of vague. You might want to come up with a better one, especially because the body of the message is clear.

Junio C Hamano· Jun 12, 2009, 06:20 UTC · re: Stephen Boyd · lore

Re: [PATCH v2] doc tweak for git-send-email

Stephen Boyd <bebarino@gmail.com> writes:

> Thanks, this is getting better. Just a quick note, the subject of this
> patch is sort of vague. You might want to come up with a better one,
> especially because the body of the message is clear.

Thanks; I'll retitle it to:

    Documentation: git-send-mail can take rev-list arg to drive format-patch