doc: Add man page for ck_bitmap_bts.

ck_pring
David Joseph 10 years ago
parent 1d7057eb58
commit 1492590835

@ -48,6 +48,7 @@ OBJECTS=CK_ARRAY_FOREACH \
ck_bitmap_init \
ck_bitmap_reset \
ck_bitmap_set \
ck_bitmap_bts \
ck_bitmap_test \
ck_bitmap_base \
ck_bitmap_union \

@ -0,0 +1,61 @@
.\"
.\" Copyright 2014 David Joseph.
.\" All rights reserved.
.\"
.\" 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 REGENTS 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 REGENTS 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 August 22, 2014
.Dt CK_BITMAP_BTS 3
.Sh NAME
.Nm ck_bitmap_bts
.Nd set the bit at the specified index and fetch its original value
.Sh LIBRARY
Concurrency Kit (libck, \-lck)
.Sh SYNOPSIS
.In ck_bitmap.h
.Ft bool
.Fn ck_bitmap_bts "ck_bitmap_t *bitmap" "unsigned int n"
.Sh DESCRIPTION
.Fn ck_bitmap_bts
sets the bit at the offset specified by the argument
.Fa n
to
.Dv 1
and fetches its original value.
.Sh RETURN VALUES
This function returns the original value of the bit at offset
.Fa n
in
.Fa bitmap .
.Sh SEE ALSO
.Xr ck_bitmap_base 3 ,
.Xr ck_bitmap_size 3 ,
.Xr ck_bitmap_init 3 ,
.Xr ck_bitmap_reset 3 ,
.Xr ck_bitmap_clear 3 ,
.Xr ck_bitmap_set 3 ,
.Xr ck_bitmap_test 3 ,
.Xr ck_bitmap_bits 3 ,
.Xr ck_bitmap_buffer 3
.Pp
Additional information available at http://concurrencykit.org/
Loading…
Cancel
Save