Document cru2x().

This commit is contained in:
Dima Dorfman 2002-03-03 03:27:28 +00:00
parent 00805a5267
commit 0db0f1925a
2 changed files with 26 additions and 2 deletions

View File

@ -250,6 +250,7 @@ MLINKS+=BUS_SETUP_INTR.9 bus_teardown_intr.9
MLINKS+=bus_generic_read_ivar.9 bus_generic_write_ivar.9
MLINKS+=ucred.9 crget.9 ucred.9 crhold.9 ucred.9 crfree.9
MLINKS+=ucred.9 crshared.9 ucred.9 crcopy.9 ucred.9 crdup.9
MLINKS+=ucred.9 cru2x.9
MLINKS+= lock.9 lockinit.9 lock.9 lockdestroy.9
MLINKS+= lock.9 lockcount.9 lock.9 lockmgr.9

View File

@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd July 9, 2001
.Dd March 3, 2002
.Dt UCRED 9
.Os
.Sh NAME
@ -36,7 +36,8 @@
.Nm crfree ,
.Nm crshared ,
.Nm crcopy ,
.Nm crdup
.Nm crdup ,
.Nm cru2x
.Nd "functions related to user credentials"
.Sh SYNOPSIS
.In sys/param.h
@ -53,6 +54,8 @@
.Fn crcopy "struct ucred *dest" "struct ucred *src"
.Ft "struct ucred *"
.Fn crdup "struct ucred *cr"
.Ft void
.Fn cru2x "struct ucred *cr" "struct xucred *xcr"
.Sh DESCRIPTION
The
.Nm
@ -99,6 +102,26 @@ contents of
into it.
The actual copying is performed by
.Fn crcopy .
.Pp
The
.Fn cru2x
function converts a
.Vt ucred
structure to an
.Vt xucred
structure.
That is,
it copies data from
.Fa cr
to
.Fa xcr ;
it ignores fields in the former that are not present in the latter
(e.g.,
.Va cr_uidinfo ) ,
and appropriately sets fields in the latter that are not present in
the former
(e.g.,
.Va cr_version ) .
.Sh RETURN VALUES
The functions that return values all return a pointer to a
.Vt ucred