System, diagnose thyself: auto-documentation for crashes

[Igor Mozolevsky]

2008/8/29 Kirk Strauser <kirk at strauser.com>:
>
> For instance, suppose the comments in sys/vm/uma_core.c looked like:
>
> /*
>  * Frees an item to an INTERNAL zone or allocates a free bucket
>  *
>  * Arguments:
>  *      zone   The zone to free to
>  *      item   The item we're freeing
>  *      udata  User supplied data for the dtor
>  *      skip   Skip dtors and finis
>  *
>  * Failure:
>  *      Failures in this function are commonly due to defective RAM.
>  */

'Crash' would probably be a more meaningful word instead of 'failure'

;-)

--
igor