X-Git-Url: http://git.samba.org/?a=blobdiff_plain;f=README.Coding;h=956a733a4ce77e7d4b7dd4ceec0dd6449bc3a323;hb=9d6b6dcd963412b33fd5960bd792ae183cc63458;hp=3ea9c781aa1c566579e601d46d05e6e8ded93235;hpb=c6a6d884f98aead1f449bc94aee19c3069efca27;p=mat%2Fsamba.git diff --git a/README.Coding b/README.Coding index 3ea9c781aa..956a733a4c 100644 --- a/README.Coding +++ b/README.Coding @@ -16,11 +16,19 @@ style should never outweigh coding itself and so the guidelines described here are hopefully easy enough to follow as they are very common and supported by tools and editors. -The basic style, also mentioned in prog_guide4.txt, is the Linux kernel +The basic style for C code, also mentioned in prog_guide4.txt, is the Linux kernel coding style (See Documentation/CodingStyle in the kernel source tree). This closely matches what most Samba developers use already anyways, with a few exceptions as mentioned below. +The coding style for Python code is documented in PEP8, +http://www.python.org/pep/pep8 (with spaces). +If you have ever worked on another free software Python project, you are +probably already familiar with it. + +We try to stay compatible with Python 2.4, so please don't rely on any +features that were introduced later, such as the "with" statement. + But to save you the trouble of reading the Linux kernel style guide, here are the highlights. @@ -359,3 +367,13 @@ Bad Example: ret = some_function_my_name(get_some_name()); ... +Control-Flow changing macros +---------------------------- + +Macros like NT_STATUS_NOT_OK_RETURN that change control flow +(return/goto/etc) from within the macro are considered bad, because +they look like function calls that never change control flow. Please +do not use them in new code. + +The only exception is the test code that depends repeated use of calls +like CHECK_STATUS, CHECK_VAL and others.