Source code details – Comtrol eCos User Manual

Page 324

Advertising
background image

Chapter 11. Porting Guide

Assertions

The code should contain assertions to validate argument values, state information and any assumptions the
code may be making. Assertions are not enabled in production builds, so liberally sprinkling assertions
throughout the code is good.

Testing

The ability to test your code is very important. In general, do not add new code to the eCos runtime unless
you also add a new test to exercise that code. The test also serves as an example of how to use the new code.

Source code details

Line length

Keep line length below 78 columns whenever possible.

Comments

Whenever possible, use // comments instead of /**/.

Indentation

Use spaces instead of TABs. Indentation level is 4. Braces start on the same line as the expression. See below
for emacs mode details.

;;=================================================================

;; eCos C/C++ mode Setup.

;;

;; bsd mode: indent = 4

;; tail comments are at col 40.

;; uses spaces not tabs in C

(defun ecos-c-mode ()

"C mode with adjusted defaults for use with the eCos sources."

(interactive)

(c++-mode)

(c-set-style "bsd")

(setq comment-column 40)

(setq indent-tabs-mode nil)

(show-paren-mode 1)

(setq c-basic-offset 4)

(set-variable ’add-log-full-name "Your Name")

(set-variable ’add-log-mailing-address "Your email address"))

(defun ecos-asm-mode ()

"ASM mode with adjusted defaults for use with the eCos sources."

(interactive)

(setq comment-column 40)

(setq indent-tabs-mode nil)

(asm-mode)

(setq c-basic-offset 4)

220

Advertising