need detailed instructions for submitting the patch

need detailed instructions for submitting the patch

[Ivanov Dmitry]

The http://orgmode.org/worg/org-contribute.php#sec-3 says:

"Git can be used to make patches and send them via email - this is perfectly fine for minor changes. These patches will be automatically registered at John Wiegley's patchwork server"

Please, tell me, what commands should I run to create a patch, upload it and get any feedback from the senior developers?

I think, that these commands should be added to the manual, so everybody would know, how to do it.

Re: need detailed instructions for submitting the patch

[Juan]

On Tue, Aug 10, 2010 at 01:59:57AM +0400, Ivanov Dmitry wrote:
> The http://orgmode.org/worg/org-contribute.php#sec-3 says:
> "Git can be used to make patches and send them via email - this is
> perfectly fine for minor changes. These patches will be
> automatically registered at John Wiegley's patchwork server"
>
> Please, tell me, what commands should I run to create a patch,
> upload it and get any feedback from the senior developers?

The following command will make a patch between the staging area
(in your computer), and the file you modified:

    git diff -p org-whatever.el

If you already committed your changes to your index (staging area),
then you should compare against a particular branch (in this example,
origin/master):

    git diff -p origin/master org-whatever.el

You email the output to this mailing list, adding [PATCH] to the
subject, and description of what you fixed or changed.

At least, this is how I do it.

Regards,
.j.

Re: need detailed instructions for submitting the patch

[Bernt Hansen]

Juan <pechiar@computer.org> writes:

> On Tue, Aug 10, 2010 at 01:59:57AM +0400, Ivanov Dmitry wrote:
>> The http://orgmode.org/worg/org-contribute.php#sec-3 says:
>> "Git can be used to make patches and send them via email - this is
>> perfectly fine for minor changes. These patches will be
>> automatically registered at John Wiegley's patchwork server"
>>
>> Please, tell me, what commands should I run to create a patch,
>> upload it and get any feedback from the senior developers?
>
> The following command will make a patch between the staging area
> (in your computer), and the file you modified:
>
>     git diff -p org-whatever.el
>
> If you already committed your changes to your index (staging area),
> then you should compare against a particular branch (in this example,
> origin/master):
>
>     git diff -p origin/master org-whatever.el
>
> You email the output to this mailing list, adding [PATCH] to the
> subject, and description of what you fixed or changed.
>
> At least, this is how I do it.
>
> Regards,
> .j.

It's easier to make real commits on a topic branch and use either git
send-email or git format-patch to create the properly formatted patch
files.

I personally use git send-email --annotate -N (where N is the number of
commits I want to create patches for.  For example,
git send-email --annotate -1 if it is a single commit)

I have the following in my .git/config so that git send-email knows
where to send the resulting patches

,----[ .git/config ]
| [sendemail]
| 	to = emacs-orgmode@gnu.org
`----

Alternatively, git format-patch will create sequentially numbered files
which you can edit and mail manually from your email client.

HTH,
Bernt

Re[2]: need detailed instructions for submitting the patch

[Ivanov Dmitry]

Carsten, can you kindly add this to http://orgmode.org/worg/org-contribute.php#sec-3

"
To submit the patch follow the instructions:

This command will make a patch between the staging area
(in your computer), and the file you modified:

    git diff -p org-whatever.el > org-whatever.el.diff

If you already committed your changes to your index (staging area),
then you should compare against a particular branch (in this example,
origin/master):

    git diff -p origin/master org-whatever.el > org-whatever.el.diff

You email the output to the mailing list, adding [PATCH] to the
subject, and description of what you fixed or changed.
"

Should I add  "> org-whatever.el.diff" to output the diff into a file, cause in Juans message it was missing?

It will be helpful to the new developers, I think.

Re: Re[2]: need detailed instructions for submitting the patch

[Bastien]

Ivanov Dmitry <usr345@gmail.com> writes:

> Carsten, can you kindly add this to
> http://orgmode.org/worg/org-contribute.php#sec-3

Ivanov, please register at http://repo.or.cz and drop me an email with
your username -- then you'll be able to improve this page.

Please reread Bernt's email before doing so, it might help keeping
things clear.

Thanks!

-- 
 Bastien

Re[2]: Re[2]: need detailed instructions for submitting the patch

[Ivanov Dmitry]

> Ivanov, please register at http://repo.or.cz and drop me an email with
> your username -- then you'll be able to improve this page.


My username is usr345


> Please reread Bernt's email before doing so, it might help keeping
> things clear.

I was trying to understand, how to create a topic branch from Bernts email, but I couldn't. I understood only one:

1. Put the email into .git/config

| [sendemail]
|       to = emacs-orgmode@gnu.org

For example, I have a modified file org-whatever.el. What commands must I run?

Re: Re[2]: need detailed instructions for submitting the patch

[Bastien]

Hi Ivanov,

Ivanov Dmitry <usr345@gmail.com> writes:

>> Ivanov, please register at http://repo.or.cz and drop me an email with
>> your username -- then you'll be able to improve this page.
>
> My username is usr345

Thanks - I added you, you can now push changes to Worg.

> 1. Put the email into .git/config
>
> | [sendemail]
> |       to = emacs-orgmode@gnu.org

Caution: this is for Org-mode changes, not Worg.  There is no mailing
list for Worg, please don't use this setting in your Worg/.git/config

You might use

,----
| [sendemail]
|       to = bzg@gnu.org
`----



in ~/install/git/Worg/.git/config (or the proper location) to send me
Worg patches directly, but since you have push access now there is no
real need for this.

> For example, I have a modified file org-whatever.el. What commands
> must I run?

Please follow the instructions on Worg and let us know what is not
crystal-clear -- that will help improve the doc if necessary.

HTH,

-- 
 Bastien

Re: Re[2]: need detailed instructions for submitting the patch

[Nick Dokos]

Bastien <bastien.guerry@wikimedia.fr> wrote:


> > For example, I have a modified file org-whatever.el. What commands
> > must I run?
> 
> Please follow the instructions on Worg and let us know what is not
> crystal-clear -- that will help improve the doc if necessary.
> 

I think Dmitry is asking for the git commands and I'm not sure those
are described anywhere on Worg.

Something like this perhaps:

         # create a topic branch to deal with a specific topic: use
         # a descriptive name!
         git checkout -b topic-branch-foo master
         <make changes specific to topic>
         git commit -a
         git format-patch
         <send out patch in email to appropriate mailing list>
         
Then when the patch hits mainline (or it is irrevocably rejected), get
rid of the branch:

         git branch -D topic-branch

Nick

Re: need detailed instructions for submitting the patch

[Dan Davison]

Nick Dokos <nicholas.dokos@hp.com> writes:

> Bastien <bastien.guerry@wikimedia.fr> wrote:
>
>
>> > For example, I have a modified file org-whatever.el. What commands
>> > must I run?
>> 
>> Please follow the instructions on Worg and let us know what is not
>> crystal-clear -- that will help improve the doc if necessary.
>> 
>
> I think Dmitry is asking for the git commands and I'm not sure those
> are described anywhere on Worg.
>
> Something like this perhaps:
>
>          # create a topic branch to deal with a specific topic: use
>          # a descriptive name!
>          git checkout -b topic-branch-foo master
>          <make changes specific to topic>
>          git commit -a
>          git format-patch
>          <send out patch in email to appropriate mailing list>

One point I'm not yet clear on:

For the patchwork system, what methods of inclusion of patch in email
are acceptable?

+ attachment type text/plain?
+ attachment type text/x-diff?
+ attach using C-c C-a in gnus but choose "inline" rather than as
  "attachment"?
+ paste inline?
+ paste inline with special gnus separators --8<-- ?

does it matter how the patch file is named?

Also, what requirements are there on how to *reply* so that your message
gets lumped by patchwork into the same patch item, rather than creating
a new item? Can the subject line be modified?

Dan


>          
> Then when the patch hits mainline (or it is irrevocably rejected), get
> rid of the branch:
>
>          git branch -D topic-branch
>
> Nick
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Re: need detailed instructions for submitting the patch

[David Maus]

[-- Attachment #1.1: Type: text/plain, Size: 2003 bytes --]

Dan Davison wrote:
>Nick Dokos <nicholas.dokos@hp.com> writes:

>> Bastien <bastien.guerry@wikimedia.fr> wrote:
>>
>>
>>> > For example, I have a modified file org-whatever.el. What commands
>>> > must I run?
>>>
>>> Please follow the instructions on Worg and let us know what is not
>>> crystal-clear -- that will help improve the doc if necessary.
>>>
>>
>> I think Dmitry is asking for the git commands and I'm not sure those
>> are described anywhere on Worg.
>>
>> Something like this perhaps:
>>
>>          # create a topic branch to deal with a specific topic: use
>>          # a descriptive name!
>>          git checkout -b topic-branch-foo master
>>          <make changes specific to topic>
>>          git commit -a
>>          git format-patch
>>          <send out patch in email to appropriate mailing list>

>One point I'm not yet clear on:

>For the patchwork system, what methods of inclusion of patch in email
>are acceptable?

>+ attachment type text/plain?
Works.

>+ attachment type text/x-diff?
Works.

>+ attach using C-c C-a in gnus but choose "inline" rather than as
>  "attachment"?

"inline" or "attachment" is irrelevant: It is just a hint to a
displaying MUA how to visualize an attachment (Cf. RFC2183: The
Content-Disposition Header Field).

>+ paste inline?
Should work.

>+ paste inline with special gnus separators --8<-- ?
Dunno.

>does it matter how the patch file is named?
AFAIK it doesn't.

>Also, what requirements are there on how to *reply* so that your message
>gets lumped by patchwork into the same patch item, rather than creating
>a new item? Can the subject line be modified?

AFAIK the subject line doesn't matter because what identifies a
message (for patchtracker and in general) is the message-id header
field.  So it should be a proper reply to the message: Using the
message-id header field in the in-reply-to and references header
field.

Best,
  -- David
--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #1.2: Type: application/pgp-signature, Size: 230 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re[2]: Re[2]: need detailed instructions for submitting the patch

[Ivanov Dmitry]

Yes, Nick, I was asking about the git commands. Thanks. It seems, that creating a topic branch is more complicated, then simply editing the local master copy, creating a diff file and sending it to the mailing list. I think it should be used only in complicated cases.

Dmitry

Re: Re[2]: Re[2]: need detailed instructions for submitting the patch

[Nick Dokos]

Ivanov Dmitry <usr345@gmail.com> wrote:

> Yes, Nick, I was asking about the git commands. Thanks. It seems, that
> creating a topic branch is more complicated, then simply editing the
> local master copy, creating a diff file and sending it to the mailing
> list. I think it should be used only in complicated cases.
> 

I prefer to keep a pristine master branch and create lots of topics branches,
(most of which die a quick and merciful death.) It's not really hard to create
a branch and it keeps things *much* neater, so I would recommend that approach
even for simple changes.

Nick

Re: Re[2]: Re[2]: need detailed instructions for submitting the patch

[Thomas S. Dye]

Aloha Dmitry,

Another reason for working in topic branches is it leaves your master  
branch clean so that changes in the remote are easily merged.  You're  
are probably more computer savvy than I am, but my struggles with  
merges after making changes to the master branch have been trying.  I  
try to leave master clean at all times now.

All the best,
Tom

On Aug 10, 2010, at 8:14 AM, Ivanov Dmitry wrote:

> Yes, Nick, I was asking about the git commands. Thanks. It seems,  
> that creating a topic branch is more complicated, then simply  
> editing the local master copy, creating a diff file and sending it  
> to the mailing list. I think it should be used only in complicated  
> cases.
>
> Dmitry
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: ReRe[2]: need detailed instructions for submitting the patch

[Noorul Islam K M]

"Thomas S. Dye" <tsd@tsdye.com> writes:

> Aloha Dmitry,
>
> Another reason for working in topic branches is it leaves your master
> branch clean so that changes in the remote are easily merged.  You're
> are probably more computer savvy than I am, but my struggles with
> merges after making changes to the master branch have been trying.  I
> try to leave master clean at all times now.
>

I would like to try this approach. I have been finding it very hard to
maintain the master branch with the other approach.

Thanks
Noorul

Re: Re[2]: need detailed instructions for submitting the patch

[Bastien]

Ivanov Dmitry <usr345@gmail.com> writes:

> Yes, Nick, I was asking about the git commands. Thanks. It seems, that
> creating a topic branch is more complicated, then simply editing the
> local master copy, creating a diff file and sending it to the mailing
> list. I think it should be used only in complicated cases.

For very quick patches, you can also do:

- git pull
- edit a file within (a recent) emacs
- `C-x v =' 

The last command with open a new window and display the diff between
your version of the file and that of the last git pull.

-- 
 Bastien

Re: Re[2]: need detailed instructions for submitting the patch

[Bastien]

Nick Dokos <nicholas.dokos@hp.com> writes:

> Bastien <bastien.guerry@wikimedia.fr> wrote:
>
>
>> > For example, I have a modified file org-whatever.el. What commands
>> > must I run?
>> 
>> Please follow the instructions on Worg and let us know what is not
>> crystal-clear -- that will help improve the doc if necessary.
>> 
>
> I think Dmitry is asking for the git commands and I'm not sure those
> are described anywhere on Worg.

Okay - I've added a page on Worg summarising various advice given here:

  http://orgmode.org/worg/worg-git-advanced.php

Let me know if that helps.

Best,

-- 
 Bastien

Re: Re[2]: need detailed instructions for submitting the patch

[Eric Schulte]

Added. Thanks -- Eric

Ivanov Dmitry <usr345@gmail.com> writes:

> Carsten, can you kindly add this to http://orgmode.org/worg/org-contribute.php#sec-3
>
> "
> To submit the patch follow the instructions:
>
> This command will make a patch between the staging area
> (in your computer), and the file you modified:
>
>     git diff -p org-whatever.el > org-whatever.el.diff
>
> If you already committed your changes to your index (staging area),
> then you should compare against a particular branch (in this example,
> origin/master):
>
>     git diff -p origin/master org-whatever.el > org-whatever.el.diff
>
> You email the output to the mailing list, adding [PATCH] to the
> subject, and description of what you fixed or changed.
> "
>
> Should I add  "> org-whatever.el.diff" to output the diff into a file, cause in Juans message it was missing?
>
> It will be helpful to the new developers, I think.
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode