mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-12-20 11:11:24 +00:00
Code Issues Releases Activity

Add manual pages for clock_getcpuclockid and pthread_getcpuclockid.

Browse Source
This commit is contained in:
David Xu 2012-08-21 09:18:28 +00:00
parent cdfe902650
commit 9653e55f6a
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=239486
4 changed files with 181 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/libc/gen/Makefile.inc
View File

@ -52,7 +52,7 @@ SYM_MAPS+=${.CURDIR}/gen/Symbol.map
.sinclude "${.CURDIR}/${LIBC_ARCH}/gen/Makefile.inc"
MAN+= alarm.3 arc4random.3 \
basename.3 check_utility_compat.3 clock.3 \
basename.3 check_utility_compat.3 clock.3 clock_getcpuclockid.3 \
confstr.3 ctermid.3 daemon.3 devname.3 directory.3 dirname.3 \
dl_iterate_phdr.3 dladdr.3 dlinfo.3 dllockinit.3 dlopen.3 \
err.3 exec.3 \

95
lib/libc/gen/clock_getcpuclockid.3 Normal file
View File

@ -0,0 +1,95 @@
.\" Copyright (c) 2012 David Xu <davidxu@FreeBSD.org>
.\" 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 AUTHOR 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 AUTHOR 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.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
.\" Portable Operating System Interface (POSIX), The Open Group Base
.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
.\" Electrical and Electronics Engineers, Inc and The Open Group. In the
.\" event of any discrepancy between this version and the original IEEE and
.\" The Open Group Standard, the original IEEE and The Open Group Standard is
.\" the referee document. The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" $FreeBSD$
.\"
.Dd August 21, 2012
.Dt CLOCK_GETCPUCLOCKID 3
.Os
.Sh NAME
.Nm clock_getcpuclockid
.Nd access a process CPU-time clock
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In time.h
.Ft int
.Fn clock_getcpuclockid "pid_t pid" "clockid_t *clock_id"
.Sh DESCRIPTION
The
.Fn clock_getcpuclockid
returns the clock ID of the CPU-time clock of the process specified by
.Fa pid .
If the process described by
.Fa pid
exists and the calling process has permission, the clock ID of this
clock will be returned in
.Fa clock_id .
.Pp
If
.Fa pid
is zero, the
.Fn clock_getcpuclockid
function returns the clock ID of the CPU-time clock of the process
making the call, in
.Fa clock_id .
.Sh RETURN VALUES
Upon successful completion,
.Fn clock_getcpuclockid
returns zero; otherwise, an error number is returned to indicate the
error.
.Sh ERRORS
The clock_getcpuclockid() function will fail if:
.Bl -tag -width Er
.It Bq Er EPERM
The requesting process does not have permission to access the CPU-time
clock for the process.
.It Bq Er ESRCH
No process can be found corresponding to the process specified by
.Fa pid .
.El
.Sh SEE ALSO
.Xr clock_gettime 2
.Sh STANDARDS
The
.Fn clock_getcpuclockid
function conform to
.St -p1003.1-2001 .
.Sh HISTORY
The
.Fn clock_getcpuclockid
function first appeared in
.Fx 10.0 .
.Sh AUTHORS
.An David Xu Aq davidxu@FreeBSD.org

1
share/man/man3/Makefile
View File

@ -206,6 +206,7 @@ PTHREAD_MAN= pthread.3 \
pthread_equal.3 \
pthread_exit.3 \
pthread_getconcurrency.3 \
pthread_getcpuclockid.3 \
pthread_getspecific.3 \
pthread_getthreadid_np.3 \
pthread_join.3 \

84
share/man/man3/pthread_getcpuclockid.3 Normal file
View File

@ -0,0 +1,84 @@
.\" Copyright (c) 2012 David Xu <davidxu@FreeBSD.org>
.\" 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 AUTHOR 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 AUTHOR 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.
.\"
.\" Portions of this text are reprinted and reproduced in electronic form
.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
.\" Portable Operating System Interface (POSIX), The Open Group Base
.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
.\" Electrical and Electronics Engineers, Inc and The Open Group. In the
.\" event of any discrepancy between this version and the original IEEE and
.\" The Open Group Standard, the original IEEE and The Open Group Standard is
.\" the referee document. The original Standard can be obtained online at
.\" http://www.opengroup.org/unix/online.html.
.\"
.\" $FreeBSD$
.\"
.Dd August 21, 2012
.Dt PTHREAD_GETCPUCLOCKID 3
.Os
.Sh NAME
.Nm pthread_getcpuclockid
.Nd access a thread CPU-time clock
.Sh LIBRARY
.Lb libpthread
.Sh SYNOPSIS
.In pthread.h
.In time.h
.Ft int
.Fn pthread_getcpuclockid "pthread_t thread_id" "clockid_t *clock_id"
.Sh DESCRIPTION
The
.Fn pthread_getcpuclockid
returns the clock ID of the CPU-time clock of the thread specified by
.Fa thread_id .
If the thread described by
.Fa thread_id
exists.
.Sh RETURN VALUES
Upon successful completion,
.Fn pthread_getcpuclockid
returns zero; otherwise, an error number is returned to indicate the
error.
.Sh ERRORS
The pthread_getcpuclockid() function will fail if:
.Bl -tag -width Er
.It Bq Er ESRCH
The value specified by
.Fa thread_id
does not refer to an existing thread.
.El
.Sh SEE ALSO
.Xr clock_gettime 2
.Sh STANDARDS
The
.Fn pthread_getcpuclockid
function conforms to
.St -p1003.1-2004 .
.Sh HISTORY
The
.Fn pthread_getcpuclockid
function first appeared in
.Fx 10.0 .
.Sh AUTHORS
.An David Xu Aq davidxu@FreeBSD.org