d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
01012c6442
freebsd-dev/share/man/man3/pthread_set_name_np.3

78 lines
2.4 KiB
Groff
Raw Normal View History

Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.\" Copyright (c) 2003 Alexey Zelkin <phantom@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.
.\"
.\" $FreeBSD$
.\"
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.Dd August 12, 2018
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Dt PTHREAD_SET_NAME_NP 3
.Os
.Sh NAME
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.Nm pthread_get_name_np ,
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Nm pthread_set_name_np
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.Nd set and retrieve the thread name
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Sh LIBRARY
Have a single set of POSIX threads man pages. The LIBRARY section of each manpage lists libraries that have corresponding interfaces implemented. Prodded by: threads Reviewed by: deischen
2004-01-14 21:44:26 +00:00
.Lb libpthread
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Sh SYNOPSIS
.In pthread_np.h
.Ft void
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.Fn pthread_get_name_np "pthread_t thread" "char *name" "size_t len"
.Ft void
thr_set_name(): silently truncate the given name as needed Instead of failing with ENAMETOOLONG, which is swallowed by pthread_set_name_np() anyway, truncate the given name to MAXCOMLEN+1 bytes. This is more likely what the user wants, and saves the caller from truncating it before the call (which was the only recourse). Polish pthread_set_name_np(3) and add a .Xr to thr_set_name(2) so the user might find the documentation for this behavior. Reviewed by: jilles MFC after: 3 days Sponsored by: Dell EMC
2016-12-03 01:14:21 +00:00
.Fn pthread_set_name_np "pthread_t thread" "const char *name"
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Sh DESCRIPTION
The
.Fn pthread_set_name_np
thr_set_name(): silently truncate the given name as needed Instead of failing with ENAMETOOLONG, which is swallowed by pthread_set_name_np() anyway, truncate the given name to MAXCOMLEN+1 bytes. This is more likely what the user wants, and saves the caller from truncating it before the call (which was the only recourse). Polish pthread_set_name_np(3) and add a .Xr to thr_set_name(2) so the user might find the documentation for this behavior. Reviewed by: jilles MFC after: 3 days Sponsored by: Dell EMC
2016-12-03 01:14:21 +00:00
function applies a copy of the given
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Fa name
thr_set_name(): silently truncate the given name as needed Instead of failing with ENAMETOOLONG, which is swallowed by pthread_set_name_np() anyway, truncate the given name to MAXCOMLEN+1 bytes. This is more likely what the user wants, and saves the caller from truncating it before the call (which was the only recourse). Polish pthread_set_name_np(3) and add a .Xr to thr_set_name(2) so the user might find the documentation for this behavior. Reviewed by: jilles MFC after: 3 days Sponsored by: Dell EMC
2016-12-03 01:14:21 +00:00
to the given
.Fa thread .
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.Pp
The
.Fn pthread_get_name_np
function retrieves the
.Fa name
associated with
.Fa thread .
If
.Fn pthread_set_name_np
was not previously called for
.Fa thread ,
the buffer pointed to by
.Fa name
will be empty.
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Sh ERRORS
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
Because of the debugging nature of these functions, all errors that may
mdoc(7) police: Scheduled sweep.
2003-02-24 22:53:26 +00:00
appear inside are silently ignored.
thr_set_name(): silently truncate the given name as needed Instead of failing with ENAMETOOLONG, which is swallowed by pthread_set_name_np() anyway, truncate the given name to MAXCOMLEN+1 bytes. This is more likely what the user wants, and saves the caller from truncating it before the call (which was the only recourse). Polish pthread_set_name_np(3) and add a .Xr to thr_set_name(2) so the user might find the documentation for this behavior. Reviewed by: jilles MFC after: 3 days Sponsored by: Dell EMC
2016-12-03 01:14:21 +00:00
.Sh SEE ALSO
.Xr thr_set_name 2
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.Sh STANDARDS
.Fn pthread_set_name_np
and
.Fn pthread_get_name_np
are non-standard extensions.
Finally! Document all undocumented functions in libc_r. Add manual pages for following functions: . pthread_attr_setcreatesuspend_np(3) . pthread_main_np(3) . pthread_multi_np(3) . pthread_single_np(3) . pthread_mutexattr_getkind_np(3) . pthread_mutexattr_setkind_np(3) . pthread_resume_all_np(3) . pthread_resume_np(3) . pthread_set_name_np(3) . pthread_suspend_all_np(3) . pthread_suspend_np(3) . pthread_switch_add_np(3) . pthread_switch_delete_np(3) MFC after: 3 days
2003-02-13 22:10:10 +00:00
.Sh AUTHORS
mdoc(7) police: Scheduled sweep.
2003-02-24 22:53:26 +00:00
This manual page was written by
Add pthread_get_name_np(3). The function retrieves the thread name previously set by pthread_set_name_np(3). The name is cached in the process memory. Requested by: Willem Jan Withagen <wjw@digiware.nl> Man page update: Yuri Pankov <yuripv@yuripv.net> Reviewed by: ian (previous version) Discussed with: arichardson, bjk (man page) Sponsored by: The FreeBSD Foundation MFC after: 2 weeks Differential revision: https://reviews.freebsd.org/D16702
2018-08-17 18:34:07 +00:00
.An Alexey Zelkin Aq Mt phantom@FreeBSD.org
and
An Yuri Pankov Aq Mt yuripv@yuripv.net .
Reference in New Issue Copy Permalink