Re: CVS commit: src/share/man/man9

[Masao Uebayashi <uebayasi%tombi.co.jp@localhost>]

How about ABI?  KASSERT(9) should preserve ABI IMO.

On Tue, Jan 25, 2011 at 11:46:48PM +0000, YAMAMOTO Takashi wrote:
> Module Name:  src
> Committed By: yamt
> Date:         Tue Jan 25 23:46:48 UTC 2011
> 
> Modified Files:
>       src/share/man/man9: KASSERT.9
> 
> Log Message:
> - add some random notes
> 
>      Basically, KASSERT() should be used for light-weight checks and
>      KDASSERT() should be used for heavier ones.
> 
>      Callers should not rely on the side effects of expression because,
>      depending on the kernel compile options mentioned above, expression might
>      not be evaluated at all.
> 
> - Xr options(4)
> - bump date
> 
> 
> To generate a diff of this commit:
> cvs rdiff -u -r1.9 -r1.10 src/share/man/man9/KASSERT.9
> 
> Please note that diffs are not public domain; they are subject to the
> copyright notices on the relevant files.
> 

> Modified files:
> 
> Index: src/share/man/man9/KASSERT.9
> diff -u src/share/man/man9/KASSERT.9:1.9 src/share/man/man9/KASSERT.9:1.10
> --- src/share/man/man9/KASSERT.9:1.9  Fri Oct 29 09:34:03 2010
> +++ src/share/man/man9/KASSERT.9      Tue Jan 25 23:46:48 2011
> @@ -1,4 +1,4 @@
> -.\"     $NetBSD: KASSERT.9,v 1.9 2010/10/29 09:34:03 wiz Exp $
> +.\"     $NetBSD: KASSERT.9,v 1.10 2011/01/25 23:46:48 yamt Exp $
>  .\"
>  .\" Copyright (c) 2006 Igor Sobrado
>  .\" All rights reserved.
> @@ -24,7 +24,7 @@
>  .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
> THE
>  .\" POSSIBILITY OF SUCH DAMAGE.
>  .\"
> -.Dd October 28, 2010
> +.Dd Janurary 26, 2011
>  .Dt KASSERT 9
>  .Os
>  .Sh NAME
> @@ -63,11 +63,24 @@
>  vs
>  .Dv DIAGNOSTIC ) .
>  .Pp
> +Basically,
> +.Fn KASSERT
> +should be used for light-weight checks and
> +.Fn KDASSERT
> +should be used for heavier ones.
> +.Pp
> +Callers should not rely on the side effects of
> +.Ar expression
> +because, depending on the kernel compile options mentioned above,
> +.Ar expression
> +might not be evaluated at all.
> +.Pp
>  The panic message will display the style of assertion (debugging
>  vs. diagnostic), the expression that failed and the filename, and line
>  number the failure happened on.
>  .Sh SEE ALSO
>  .Xr config 1 ,
> +.Xr options 4 ,
>  .Xr CTASSERT 9 ,
>  .Xr panic 9 ,
>  .Xr printf 9
> 

-- 
Masao Uebayashi / Tombi Inc. / Tel: +81-90-9141-4635