[PATCH] git-format-patch(1)- add note about creating patch for single commit

[PATCH] git-format-patch(1)- add note about creating patch for single commit

[Dan McGee]

Signed-off-by: Dan McGee <dpmcgee@gmail.com>
---

I thought this would be helpful because it took me the beter part of an hour
to find a solution instead of specifying C~1..C or other crazy things. The
current documentation just leaves you hanging when what you really want is
just one formatted patch.

If there any suggestions on better wording, feel free to resubmit or whatever-
I just felt like this should be documented somewhere.

 Documentation/git-format-patch.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index adb4ea7..8518c33 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -46,7 +46,9 @@ applies to that command line and you do not get "everything
 since the beginning of the time".  If you want to format
 everything since project inception to one commit, say "git
 format-patch \--root <commit>" to make it clear that it is the
-latter case.
+latter case.  If you want to format only a single commit, say "git
+format-patch <commit>^!" (which excludes all parent revisions of the
+specified commit).
 
 By default, each output file is numbered sequentially from 1, and uses the
 first line of the commit message (massaged for pathname safety) as
-- 
1.6.0.2

Re: [PATCH] git-format-patch(1)- add note about creating patch for single commit

[Junio C Hamano]

Dan McGee <dpmcgee@gmail.com> writes:

> Signed-off-by: Dan McGee <dpmcgee@gmail.com>
> ---
>
> I thought this would be helpful because it took me the beter part of an hour
> to find a solution instead of specifying C~1..C or other crazy things. The
> current documentation just leaves you hanging when what you really want is
> just one formatted patch.
>
> If there any suggestions on better wording, feel free to resubmit or whatever-
> I just felt like this should be documented somewhere.
>
>  Documentation/git-format-patch.txt |    4 +++-
>  1 files changed, 3 insertions(+), 1 deletions(-)
>
> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
> index adb4ea7..8518c33 100644
> --- a/Documentation/git-format-patch.txt
> +++ b/Documentation/git-format-patch.txt
> @@ -46,7 +46,9 @@ applies to that command line and you do not get "everything
>  since the beginning of the time".  If you want to format
>  everything since project inception to one commit, say "git
>  format-patch \--root <commit>" to make it clear that it is the
> -latter case.
> +latter case.  If you want to format only a single commit, say "git
> +format-patch <commit>^!" (which excludes all parent revisions of the
> +specified commit).
>  
>  By default, each output file is numbered sequentially from 1, and uses the
>  first line of the commit message (massaged for pathname safety) as

Heh, a more natural way to say that is:

	git format-patch -1 $that_one

That uses the first option described in the documentation:

	-<n>::
        	Limits the number of patches to prepare.

Re: [PATCH] git-format-patch(1)- add note about creating patch for single commit

[Dan McGee]

On Sun, Oct 19, 2008 at 12:21 AM, Junio C Hamano <gitster@pobox.com> wrote:
> Dan McGee <dpmcgee@gmail.com> writes:
>
>> Signed-off-by: Dan McGee <dpmcgee@gmail.com>
>> ---
>>
>> I thought this would be helpful because it took me the beter part of an hour
>> to find a solution instead of specifying C~1..C or other crazy things. The
>> current documentation just leaves you hanging when what you really want is
>> just one formatted patch.
>>
>> If there any suggestions on better wording, feel free to resubmit or whatever-
>> I just felt like this should be documented somewhere.
>>
>>  Documentation/git-format-patch.txt |    4 +++-
>>  1 files changed, 3 insertions(+), 1 deletions(-)
>>
>> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
>> index adb4ea7..8518c33 100644
>> --- a/Documentation/git-format-patch.txt
>> +++ b/Documentation/git-format-patch.txt
>> @@ -46,7 +46,9 @@ applies to that command line and you do not get "everything
>>  since the beginning of the time".  If you want to format
>>  everything since project inception to one commit, say "git
>>  format-patch \--root <commit>" to make it clear that it is the
>> -latter case.
>> +latter case.  If you want to format only a single commit, say "git
>> +format-patch <commit>^!" (which excludes all parent revisions of the
>> +specified commit).
>>
>>  By default, each output file is numbered sequentially from 1, and uses the
>>  first line of the commit message (massaged for pathname safety) as
>
> Heh, a more natural way to say that is:
>
>        git format-patch -1 $that_one
>
> That uses the first option described in the documentation:
>
>        -<n>::
>                Limits the number of patches to prepare.

Wow, had no idea about that option. :)

Given that I didn't even notice this option when I did go to the
manpage, what if my above change was instead reworked a bit:
>> +latter case.  If you want to format only a single commit, say "git
>> +format-patch -1 <commit>" .

Re: [PATCH] git-format-patch(1)- add note about creating patch for single commit

[Junio C Hamano]

"Dan McGee" <dpmcgee@gmail.com> writes:

> On Sun, Oct 19, 2008 at 12:21 AM, Junio C Hamano <gitster@pobox.com> wrote:
>
>> Heh, a more natural way to say that is:
>>
>>        git format-patch -1 $that_one
>>
>> That uses the first option described in the documentation:
>>
>>        -<n>::
>>                Limits the number of patches to prepare.
>
> Wow, had no idea about that option. :)
>
> Given that I didn't even notice this option when I did go to the
> manpage, what if my above change was instead reworked a bit:
>>> +latter case.  If you want to format only a single commit, say "git
>>> +format-patch -1 <commit>" .

I thought about it, but saw "formatting three commits" example in the
manpage, and stopped there ;-)