Patch Submission Format

[rogue]

Are there specific guidelines anywhere on how to submit a patch? More specifically, on the format of the patch itself?

I've only submitted one patch, and it was about a year ago. I noticed that people were submitting patches as .diff files, so I read up on how to create .diff files and submitted my patch in that format. However, the process felt awkward and inelegant, and I don't think I did it quite right.

As such, I think it would be great if there was a sticky post in this forum detailing how to get a patch into the format the developers would prefer for submission.

Thanks in advance to anybody who can post this information.

[Boucman]

good point, I'll post a couple of guidelines for patch submission, and make that topic sticky while I'm at it....

All patches should be submitted at patches.wesnoth.org
You can post them here too for discussion, but we need to track what is their status and p.w.o helps a lot

patch should be generated using "svn diff
SVN provides a cool command to generate diff, just run "svn diff >mypatch.patch" to create the patch, and its all nice and ready

it even records precisely the commit against which it was generated, it makes things really easy for us...

Dont forget to add an entry to the Changelog
Add yourself in about.cfg
including your name and/or nick it makes it easier for us.
new contributors should go in the contributor section of the about file

when changing WML, please add a pointer in the wiki to where it should be updated when commited

be patient, sometime we are not very responsive
don't be suprised if we discuss the patch a lot
thus, you should leave us a way to contact you, either a forum nick, an email adress, or submit with a registered gna account.

we try as much as possible to apply patch "as is" which means that we will usually ask you to change a patch rather than changing it ourselves...

The patch should generate no warnings
wesnoth has a large number of warnings enabled, all of them are usefull, if your code spits warning, please have a look, and ask yourself why you are doing what causes the warning.

When adding a file, don't forget src/Makefile.am, src/SConscript, src/CMakeLists.txt, projectfiles/VC9/wesnoth.vcproj
it makes things simpler for us, and is often forgotten

sometime patches are rejected, don't be suprised if it happens

that's all for the moment, we'll probably add some more later[/b]

[freecraft]

When adding a file, don't forget Makefile.am

Sorry I don't understand this. Can you clarify that? What and when should I do with Makefile.am? I think I could fix some bugs ...

[Soliton]

When adding a file, don't forget Makefile.am

Sorry I don't understand this. Can you clarify that? What and when should I do with Makefile.am? I think I could fix some bugs ...

If you fix bugs you'll probably not add files but if you do you need to list the file(s) in src/Makefile.am for the build process to work.

[freecraft]

Ah now I understand. Thank you soliton

[TheScribe]

patch should be generated using "svn diff
SVN provides a cool command to generate diff, just run "svn diff >mypatch.patch" to create the patch, and its all nice and ready

I have no idea what this means. Could somebody clarify it?

[Boucman]

did you use svn do do your checkout ? (get the source)

if yes, you should have a command line tool called "svn"

go into your terminal, run "svn diff" and redirect the output to a text file. that text file is what you should submit for inclusion

[TheScribe]

did you use svn do do your checkout ? (get the source)

if yes, you should have a command line tool called "svn"

go into your terminal, run "svn diff" and redirect the output to a text file. that text file is what you should submit for inclusion

I don't know if I used svn. How do I tell? For that matter, what is svn?

And also, what do you mean by a command line tool?

[Boucman]

ok, all this stuff is for developers and code contributors... do you have modifications you want to contribute back (i.e code change in C++)

if no, you shouldn't concern yourself with patches...

[TheScribe]

I was gonna do something with LUA. It's not finished yet though.