summaryrefslogtreecommitdiffhomepage
path: root/doc/coding_conventions.md
diff options
context:
space:
mode:
authorYukihiro Matsumoto <[email protected]>2012-09-20 18:27:08 +0900
committerYukihiro Matsumoto <[email protected]>2012-09-20 18:27:08 +0900
commit15cf8fdea4a6598aa470e698e8cbc9b9b492319d (patch)
tree0341ec1fa3394e72768435db973a3714f41e615f /doc/coding_conventions.md
parent44b28a83f853e39bd6377a51b75f02924aaeebf2 (diff)
parent1afda93c7ae70d85e713a2a44e9c32dd604f1a5a (diff)
downloadmruby-15cf8fdea4a6598aa470e698e8cbc9b9b492319d.tar.gz
mruby-15cf8fdea4a6598aa470e698e8cbc9b9b492319d.zip
Merge branch 'master' of github.com:mruby/mruby
Diffstat (limited to 'doc/coding_conventions.md')
-rw-r--r--doc/coding_conventions.md48
1 files changed, 0 insertions, 48 deletions
diff --git a/doc/coding_conventions.md b/doc/coding_conventions.md
deleted file mode 100644
index aa47fe980..000000000
--- a/doc/coding_conventions.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# Coding conventions
-
-How to style your C and Ruby code which you want to submit.
-
-## C code
-
-The core part (parser, bytecode-interpreter, core-lib, etc.) of mruby is
-written in the C programming language. Please note the following hints for your
-C code:
-
-### Comply with C99 (ISO/IEC 9899:1999)
-
-mruby should be highly portable to other systems and compilers. For that it is
-recommended to keep your code as close as possible to the C99 standard
-(http://www.open-std.org/jtc1/sc22/WG14/www/docs/n1256.pdf).
-
-Although we target C99, VC is also an important target for mruby, so that we
-avoid local variable declaration in the middle.
-
-### Reduce library dependencies to a minimum
-
-The dependencies to libraries should be put to an absolute minimum. This
-increases the portability but makes it also easier to cut away parts of mruby
-on-demand.
-
-### Don't use C++ style comments
-
- /* This is the prefered comment style */
-
-Use C++ style comments only for temporary comment e.g. commenting out some code lines.
-
-### Insert a break after the method return value:
-
- int
- main(void)
- {
- ...
- }
-
-## Ruby code
-
-Parts of the standard library of mruby is written in the Ruby programming language
-itself. Please note the following hints for your Ruby code:
-
-### Comply with the Ruby standard (ISO/IEC 30170:2012)
-
-mruby is currently targeting to execute Ruby code which complies to ISO/IEC
-30170:2012 (http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59579).