Mac Developer Library Developer
Search

 

This manual page is for Mac OS X version 10.9

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.




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 under-stand understand
     stand 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 casting 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 generally applied
     though.

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

     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, namespace,
     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 module 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

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback