[fireball] 22315: Slightly update the doc to make it correspond to nowadays reality

Author: fireball
Date: Mon Jun 12 01:05:25 2006
New Revision: 22315

URL: http://svn.reactos.ru/svn/reactos?rev=22315&view=rev
Log:
Slightly update the doc to make it correspond to nowadays reality

Modified:
    trunk/reactos/media/doc/HACKING

Modified: trunk/reactos/media/doc/HACKING
URL: http://svn.reactos.ru/svn/reactos/trunk/reactos/media/doc/HACKING?rev=22315&...
==============================================================================
--- trunk/reactos/media/doc/HACKING (original)
+++ trunk/reactos/media/doc/HACKING Mon Jun 12 01:05:25 2006
@@ -26,19 +26,14 @@
       
 * Style

-There is no coding style used for ReactOS, however the following guidelines
-make things easier
+There is a coding style used for ReactOS, it's described in a ReactOS's Wiki
+page called Coding Style: http://www.reactos.org/wiki/index.php/Coding_Style

-     Include information at the top of a module about its purpose, contact
-     information for its programmer and any useful notes. 
-     
-     Include a comment by each non-trival function describing its arguments,
-     purpose and any other notes.
-     
-     Update the documentation in this directory
-     
-These guidelines are an ideal, no one manages to implement them all the
-time, straightforward working code is probably just as good.
+However, not all codebase complies with the rules outlined in that page, so
+if you need to hack some code which has not been yet formatted, it's wise
+to keep the kind of formatting it already has, to make it looking good until
+it receives a formatting patch.
+

* Debugging

@@ -105,11 +100,11 @@

There is a mailing list for kernel development,

-            [e-mail]
+            [e-mail]
        
-    The main developers use a cvs account to coordinate changes, ask 
-    rex ([e-mail]) for an account if you are going to be adding
-    a lot of code. Smaller patches can go to the mailing list or to the
+    The main developers use a svn account to coordinate changes, ask 
+    Aleksey ([e-mail]) for an account if you are going to be
+    adding a lot of code. Smaller patches can go to the mailing list or to the
     relevant developer (usually the comment at the top of a module will have
     an email address). Regular snapshots are made available for download,
     see the mailing list for announcements.