Re: [Sablevm-developer] CODING file

[Chris P. <chr...@ma...>]

Furthermore ... I think it would help the syntax coloring if _svmt_* was 
replaced by _svmt_*_t ... emacs will color this green and the 
corresponding variable declaration yellow ... I find it greatly improves 
readability.

Chris Pickett wrote:

> Here is a very short coding standards file.  I don't know where in 
> sablevm/src you want to put it.  You might want to change the name, 
> you might want it as part of the README.  It's up to you :)
>
> Cheers,
> Chris
>
>------------------------------------------------------------------------
>
>This document briefly describes coding standards in SableVM.
>
>1) Learn to use m4.  The m4 manual (% info m4),
>macros.m4, and examples throughout the
>source code will help you with this.  It makes the code easier to maintain.
>Do not use the C preprocessor #define command for macros 
>(constants are an exception).
>
>2) All constants defined should go in constants.h
>
>3) All typedefs should go in types.h, or in system.h for system-specific stuff.
>
>4) All include directives should go in libsablevm.c
>
>5) If you change the source code, make sure you change appropriate comments
>that relate to the code you have changed.
>  
>