Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages

OpenDarwin 7.2.1 - man page for intro (opendarwin section 9)

INTRO(9)			  BSD Kernel Developer's Manual 			 INTRO(9)

NAME
     intro -- introduction to system kernel interfaces

DESCRIPTION
     This section contains information about the interfaces and subroutines in the kernel.

PROTOTYPES ANSI-C AND ALL THAT
     Yes please.

     We would like all code to be fully prototyped.

     If your code compiles cleanly with cc -Wall we would feel happy about it.	It is important
     to understand that this isn't a question of just shutting up cc, it is a question about
     avoiding the things it complains about.  To put it bluntly, don't hide the problem by cast-
     ing and other obfuscating practices, solve the problem.

INDENTATION AND STYLE
     Believe it or not, there actually exists a guide for indentation and style.  It isn't gener-
     ally applied though.

     We would appreciate if people would pay attention to it, and at least not violate it bla-
     tantly.

     We don't mind it too badly if you have your own style, but please make sure we can read it
     too.

     Please take time to read style(9) for more information.

NAMING THINGS
     Some general rules exist:

     1.   If a function is meant as a debugging aid in DDB, it should be enclosed in

		#ifdef DDB

		#endif /* DDB */

	  And the name of the procedure should start with the prefix DDB_ to clearly identify the
	  procedure as a debugger routine.

SCOPE OF SYMBOLS
     It is important to carefully consider the scope of symbols in the kernel.	The default is to
     make everything static, unless some reason requires the opposite.

     There are several reasons for this policy, the main one is that the kernel is one monolithic
     name-space, and pollution is not a good idea here either.

     For device drivers and other modules that don't add new internal interfaces to the kernel,
     the entire source should be in one file if possible.  That way all symbols can be made
     static.

     If for some reason a module is split over multiple source files, then try to split the mod-
     ule along some major fault-line and consider using the number of global symbols as your
     guide.  The fewer the better.

SEE ALSO
     style(9)

HISTORY
     The intro section manual page appeared in FreeBSD 2.2.

BSD					December 13, 1995				      BSD


All times are GMT -4. The time now is 01:26 AM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
UNIX.COM Login
Username:
Password:  
Show Password