devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Updated conventions

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@1679 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Björn Stenberg 2002-08-12 08:23:03 +00:00
parent f150d997ba
commit a03499c940
1 changed files with 33 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

43
firmware/CONTRIBUTING
View file

@ -3,17 +3,40 @@ $Id$
In order for the project to run as smoothly as possible, it's best if all
contributors adhere to a few simple conventions:
- Write all code in C. Sometimes assembly is faster, but C is always more
readable and maintainable.
Language
--------
Write all code in C. Sometimes assembly is faster, but C is always more
readable and maintainable.
- Write normal C code. Don't redefine the language. No new types,
no C++isms or Javaisms. Also, do not use "const".
Language features
-----------------
Write normal C code. Don't redefine the language. No new types (structs are
structs, not typedefs), no C++isms or Javaisms. Also, avoid using "const".
- Variables and function names should be all lower case.
Preprocessor symbols should be all uppercase.
Names
-----
Variables and function names should be all lower case.
Preprocessor symbols should be all uppercase.
- Use the brace placement style of your choice, but indent your code with
four spaces. Don't use TAB characters, as that will mess up code display in
CVS, printing, and a zillion other places.
Style
-----
When changing code, follow the code style of the file you are editing.
- Use "unix style" line feeds: "LF" only. Do not use "CR+LF".
When writing new files, you may use the brace placement style of your choice.
Always indent your code with four spaces. Don't use TAB characters, as that
will mess up code display in CVS, printing, and a zillion other places.
Keep lines below 80 columns length. Use whitespace and newlines to make the
code easy to browse/read.
Text format
-----------
Use "unix style" line feeds: "LF" only. Do not use "CR+LF".
Patches
-------
Create a patch using 'cvs diff -ub'. Trim your patches so they only contain
relevant changes.
Submit all patches to the mailing list. Put [PATCH] first on the subject line
of your mail. If the patch is very large (>50k), gzip it before you send it.