Preparing Code

From Second Life Wiki
Revision as of 14:14, 31 May 2007 by Nicholaz Beresford (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

If you have a piece of source code (be it a fix or a new feature) submit the patches in a way that makes it easy for the Lindens to incorporate them into the source code.

Good Patch Practise


The best way to think about patches is that the people who are reviewing and applying your patches are the bottleneck in the system. If you can make it easier for us to understand and apply patches without lots of cleanup, we can spend more time reviewing and incorporating your work.

Coding Standard

Please read and follow the coding standard: Second Life coding standard


Please do not add issue numbers or your name to patches. We have to remove these by hand. Also, please be careful in how you add comments. Bracketing a patch with comments like "// PATCH START" and "// PATCH END" does not add any information, and adds to the manual cleanup we have to do.

In short, just add to the patch what is expected to appear in the final source.

One Patch for one Issue

Each patch should do exactly one thing. If you have three different bugs to fix, please submit three different patches. When you fold unrelated hunks into a single patch, we have to try to figure out which part of the patch applies to which bug, and split it out by hand, sometimes into several patches. Combo patches are particularly time consuming, and the manual splitting up makes it very easy to lose pieces of patches altogether.

Creating a Patch

Patches should be submitted in Unidiff-Format. This format is simlar to simple diffs but with more detailed information and can be automatically integrated into the source. It is generated by calling diff -u <original file> <new file> (under Windows you will find the diff command as part of the CygWin project in C:\CYGWIN\BIN).

With the file names it is best to rename the original file to something like viewer_orig.cpp have the new file the same name as in the Second Life project and redirect the output to a file that ends with .patch

The patch command for a change viewer.cpp would then be something like diff -u viewer_orig.cpp viewer.cpp >viewer.patch and would create output file named viewer.patch like this:

--- linden\indra\newview\viewer_orig.cpp    2007-05-14 16:47:26.000000000 +0200
+++ linden\indra\newview\viewer.cpp 2007-05-22 08:49:50.484375000 +0200
@@ -6302,7 +6326,7 @@

    llinfos << "Cleaning Up" << llendflush;

-   LLKeyframeMotion::flushKeyframeCache();
+   LLKeyframeMotion::flushKeyframeCache(TRUE); 

    // Must clean up texture references before viewer window is destroyed.
@@ -6562,6 +6586,8 @@
    delete gVFS;
    gVFS = NULL;

+   LLCurl::cleanup(); 
    // This will eventually be done in LLApp

Submitting the Patch for Peer Review

Especially with larger or sensitive patches it is a good idea to first submit the patch for peer review on the mailing list. This way fellow developers can review the patch, uncover possible bugs, comment on undesired interactions or generally share ideas with you.

Just subscribe to the mailing list, then write an email to the list with your .patch file attached and with a description of what it does in the text or also as an attachment.

Submitting the Patch on JIRA

Finally, when you think the patch is ready for the Lindens, submit the patch on the Bug Tracker. Either create a new issue there or attach the patch to an existing entry. Attach the .patch file itself as a file attachment and make sure that the check mark for Patch attached is set (you can do that when creating the issue or by choosing Edit for an existing one).

Also, offer a description of the patch (the why and what) as a separate file and/or as a description or comment with the issue.

Before you do that however, just have a look at existing patches through the Issues with patches attached filter on the JIRA main page to get a general idea how it is done.

Good luck!