michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: enforce 8-char tabs and 80-column width in coding standards

Browse source 
This will ensure uniformity in the future, but will require what code is
currently aligned on 4-char tabs to be reformated (basically the kernel
and arch code, and some other) to fit in 80 columns with 8-char tabs.
However, it will be more natural to developers used to 8-char tabs,
i.e. people used to work on Linux and other open source projects, which
is our audience, and will lower the barrier of entry.

Change-Id: I626b20e62ba1a5dddd030a27185f51237e5e98b5
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
This commit is contained in:
Benjamin Walsh 2016-03-04 17:01:51 -05:00 • committed by Gerrit Code Review
commit 572e052379
1 changed files with 3 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/collaboration/code/coding_style.rst
View file

@ -12,11 +12,9 @@ exceptions:
* Add braces to every ``if`` and ``else`` body, even for single-line code * Add braces to every ``if`` and ``else`` body, even for single-line code
blocks. Use the :option:`--ignore BRACES` flag to make :program:`checkpatch` blocks. Use the :option:`--ignore BRACES` flag to make :program:`checkpatch`
stop complaining. stop complaining.
* Use hard tab stops. Set the tab width to either 4 or 8 spaces. Train * Use hard tab stops. Set the tab width 8 spaces. Break lines at 80 characters.
:program:`checkpatch` to only warn when lines are over 100 If you are trying to align comments after declarations, use spaces instead of
characters. In general, break lines at 80 characters where possible. tabs to align them.
If you are trying to align comments after declarations, use spaces
instead of tabs to align them.
* Use C89-style single line comments, :literal:`/* */`. The C99-style * Use C89-style single line comments, :literal:`/* */`. The C99-style
single line comment, //, is not allowed. single line comment, //, is not allowed.
* Use :literal:`/** */` for any comments that need to appear in the * Use :literal:`/** */` for any comments that need to appear in the