[src/trunk]: src/share/man/man3 Document __arraycount.

[jruoho <jruoho%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/8bf051165949
branches:  trunk
changeset: 752571:8bf051165949
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Mon Mar 01 16:02:34 2010 +0000

description:
Document __arraycount.

diffstat:

 share/man/man3/Makefile       |   4 +-
 share/man/man3/__arraycount.3 |  60 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 2 deletions(-)

diffs (78 lines):

diff -r 709709e5e113 -r 8bf051165949 share/man/man3/Makefile
--- a/share/man/man3/Makefile   Mon Mar 01 15:41:15 2010 +0000
+++ b/share/man/man3/Makefile   Mon Mar 01 16:02:34 2010 +0000
@@ -1,8 +1,8 @@
-#      $NetBSD: Makefile,v 1.37 2010/03/01 13:44:09 jruoho Exp $
+#      $NetBSD: Makefile,v 1.38 2010/03/01 16:02:34 jruoho Exp $
 #      @(#)Makefile    8.2 (Berkeley) 12/13/93
 
 MAN=   _DIAGASSERT.3 __UNCONST.3 CMSG_DATA.3 \
-       assert.3 bits.3 bitstring.3 dlfcn.3 end.3 \
+       __arraycount.3 assert.3 bits.3 bitstring.3 dlfcn.3 end.3 \
        gcq.3 intro.3 offsetof.3 queue.3 stdarg.3 sysexits.3 \
        timeradd.3 tree.3 varargs.3
 
diff -r 709709e5e113 -r 8bf051165949 share/man/man3/__arraycount.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man3/__arraycount.3     Mon Mar 01 16:02:34 2010 +0000
@@ -0,0 +1,60 @@
+.\" $NetBSD: __arraycount.3,v 1.1 2010/03/01 16:02:34 jruoho Exp $
+.\"
+.\" Copyright (c) 2010 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Jukka Ruohonen.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd March 1, 2010
+.Os
+.Dt __arraycount 3
+.Sh NAME
+.Nm __arraycount
+.Nd macro for statically allocated arrays
+.Sh SYNOPSIS
+.In sys/cdefs.h
+.Ft size_t
+.Fn __arraycount x
+.Sh DESCRIPTION
+The
+.Fn __arraycount
+macro returns the number of elements in a statically allocated buffer.
+.Sh EXAMPLES
+The following example demonstrates a possible usage of
+.Fn __arraycount :
+.Bd -literal -offset indent
+uint8_t *buf[BUFSIZE];
+size_t i;
+
+\&...
+
+for (i = 0; i < __arraycount(buf); i++)
+       \&...
+.Ed
+.Sh HISTORY
+The
+.Fn __arraycount
+macro first appeared in
+.Nx 4.0 .