[Crossfire-wiki] [Crossfire DokuWiki] page changed: coding_style_guide

[no-reply_wiki at metalforge.org]

A page in your DokuWiki was added or changed. Here are the details:

Date        : 2009/06/18 01:41
User        : leaf
Edit Summary: Spelling corrections

@@ -155,20 +155,21 @@
  
  =====Diagnostics and Error Handling=====
  
    - Log errors/diagnostics with the LOG function.  When doing so, please include the function name - this is especially true for errors.
+ 
  
  ====== Sending in Patches: ======
  
    - Send patches on a bug fix or feature enhancement basis individually, and do not make mega-patches.  A diff that changes 10 things is more difficult for developers to review and understand as unrelated changes might be going on.  It is also harder to reject part of a patch (feature X is nice, but Y doesn't work).
    - Please state in the message included with the patch what it fixes/changes. Too often, patches are just a bunch of source code, with no indication why it should be incorporated.  Without such commentary, it may be difficult to even determine if the bug it fixes is still there in the source it patches. Please also state what version of crossfire the diff is for.
-   - I will assume any patches mailed directly to me are to be included. If posting a patch on the mailing list (either source or ftp location), please explicitly state whether or not you want that patch incorporated into the master source.  Many times, a patch may be made available on an expirimental basis which is not ready for widespread distribution.  
+   - I will assume any patches mailed directly to me are to be included. If posting a patch on the mailing list (either source or ftp location), please explicitly state whether or not you want that patch incorporated into the master source.  Many times, a patch may be made available on an experimental basis which is not ready for widespread distribution.  
    - When making patches, please make context diffs.  Please also include the directory that the file is in (run the diff in the top level directory).  Please make 5 line context diffs - larger line context diffs are fine if you think that may make it easier.\\ Example:<code>
- diff -c5 (oldfile) (newfile)</code>You can also do diffs of entire directories.  Do do this, type:<code>
+ diff -c5 (oldfile) (newfile)</code>You can also do diffs of entire directories.  To do this, type:<code>
  diff -c5 -r (old_directory) (new_directory)</code>An example:<code>
  diff -c5 -r crossfire-0.90.1 crossfire-0.90.2</code>
    - Gnu diff will include files that did not exist before.  Other diff programs may not do this.
    - If your diff looks excessively long and you made a lot of formatting changes, you can add -w to the diff options to have it ignore whitespace. Note that this will then mean that those formatting changes will then be lost.
    - There is no need to make a separate diff file for each file that is different (ie, treasure.diff, player.diff, etc).  Assuming you follow steps 1-6, all the diffs can be contained in one file, and patch will deal with it just fine.
    - If you need to send a map, new archetypes, or other new files where a diff doesn't make sense, a uuencoded tar file will suffice.
  
  Submit all patches to the Sourceforge patch tracker on http://sourceforge.net/projects/crossfire, and mail an announcement to [[crossfire-devel at lists.real-time.com]].


IP-Address  : 216.243.156.5
Old Revision: http://wiki.metalforge.net/doku.php/coding_style_guide?rev=1200775155
New Revision: http://wiki.metalforge.net/doku.php/coding_style_guide

-- 
This mail was generated by DokuWiki at
http://wiki.metalforge.net/