[PATCH] pthread_mutexattr_*{kind_np,type} in man pages

[PATCH] pthread_mutexattr_*{kind_np,type} in man pages

[Jakub Jelinek]

Hi!

As pthread_mutexattr_?etkind_np are deprecated, it should be said
in the man pages.

2002-04-05  Jakub Jelinek  <jakub@redhat.com>

	* man/pthread_mutexattr_init.man (pthread_mutexattr_settype): Document
	instead of pthread_mutexattr_setkind_np.
	(pthread_mutexattr_gettype): Similarly.
	* man/pthread_mutexattr_setkind_np.man: New.
	* man/Makefile (SOURCES): Add pthread_mutexattr_setkind_np.man.

--- libc/linuxthreads/man/pthread_mutexattr_init.man.jj	Wed Mar 11 13:42:23 1998
+++ libc/linuxthreads/man/pthread_mutexattr_init.man	Fri Apr  5 23:24:24 2002
@@ -1,11 +1,11 @@
 .TH PTHREAD_MUTEXATTR 3 LinuxThreads
 
 .XREF pthread_mutexattr_destroy
-.XREF pthread_mutexattr_setkind_np
-.XREF pthread_mutexattr_getkind_np
+.XREF pthread_mutexattr_settype
+.XREF pthread_mutexattr_gettype
 
 .SH NAME
-pthread_mutexattr_init, pthread_mutexattr_destroy, pthread_mutexattr_setkind_np, pthread_mutexattr_getkind_np \- mutex creation attributes
+pthread_mutexattr_init, pthread_mutexattr_destroy, pthread_mutexattr_settype, pthread_mutexattr_gettype \- mutex creation attributes
 
 .SH SYNOPSIS
 #include <pthread.h>
@@ -14,9 +14,9 @@ int pthread_mutexattr_init(pthread_mutex
 
 int pthread_mutexattr_destroy(pthread_mutexattr_t *attr);
 
-int pthread_mutexattr_setkind_np(pthread_mutexattr_t *attr, int kind);
+int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int kind);
 
-int pthread_mutexattr_getkind_np(const pthread_mutexattr_t *attr, int *kind);
+int pthread_mutexattr_gettype(const pthread_mutexattr_t *attr, int *kind);
 
 .SH DESCRIPTION
 
@@ -53,23 +53,23 @@ returns to the unlocked state.
 
 The default mutex kind is ``fast'', that is, !PTHREAD_MUTEX_FAST_NP!.
 
-!pthread_mutexattr_setkind_np! sets the mutex kind attribute in |attr|
+!pthread_mutexattr_settype! sets the mutex kind attribute in |attr|
 to the value specified by |kind|.
 
-!pthread_mutexattr_getkind_np! retrieves the current value of the
+!pthread_mutexattr_gettype! retrieves the current value of the
 mutex kind attribute in |attr| and stores it in the location pointed
 to by |kind|.
 
 .SH "RETURN VALUE"
 !pthread_mutexattr_init!, !pthread_mutexattr_destroy! and
-!pthread_mutexattr_getkind_np! always return 0.
+!pthread_mutexattr_gettype! always return 0.
 
-!pthread_mutexattr_setkind_np! returns 0 on success and a non-zero
+!pthread_mutexattr_settype! returns 0 on success and a non-zero
 error code on error.
 
 .SH ERRORS
 
-On error, !pthread_mutexattr_setkind_np! returns the following error code:
+On error, !pthread_mutexattr_settype! returns the following error code:
 .TP
 !EINVAL!
 |kind| is neither !PTHREAD_MUTEX_FAST_NP! nor !PTHREAD_MUTEX_RECURSIVE_NP!
--- libc/linuxthreads/man/pthread_mutexattr_setkind_np.man.jj	Fri Apr  5 23:24:42 2002
+++ libc/linuxthreads/man/pthread_mutexattr_setkind_np.man	Fri Apr  5 23:27:56 2002
@@ -0,0 +1,39 @@
+.TH PTHREAD_MUTEXATTR_SETKIND_NP 3 LinuxThreads
+
+.XREF pthread_mutexattr_getkind_np
+
+.SH NAME
+pthread_mutexattr_setkind_np, pthread_mutexattr_getkind_np \- deprecated mutex creation attributes
+
+.SH SYNOPSIS
+#include <pthread.h>
+
+int pthread_mutexattr_setkind_np(pthread_mutexattr_t *attr, int kind);
+
+int pthread_mutexattr_getkind_np(const pthread_mutexattr_t *attr, int *kind);
+
+.SH DESCRIPTION
+
+These functions are deprecated, use !pthread_mutexattr_settype!(3)
+and !pthread_mutexattr_gettype!(3) instead.
+
+.SH "RETURN VALUE"
+!pthread_mutexattr_getkind_np! always returns 0.
+
+!pthread_mutexattr_setkind_np! returns 0 on success and a non-zero
+error code on error.
+
+.SH ERRORS
+
+On error, !pthread_mutexattr_setkind_np! returns the following error code:
+.TP
+!EINVAL!
+|kind| is neither !PTHREAD_MUTEX_FAST_NP! nor !PTHREAD_MUTEX_RECURSIVE_NP!
+nor !PTHREAD_MUTEX_ERRORCHECK_NP!
+
+.SH AUTHOR
+Xavier Leroy <Xavier.Leroy@inria.fr>
+
+.SH "SEE ALSO"
+!pthread_mutexattr_settype!(3),
+!pthread_mutexattr_gettype!(3).
--- libc/linuxthreads/man/Makefile.jj	Wed Mar 11 13:42:23 1998
+++ libc/linuxthreads/man/Makefile	Fri Apr  5 23:28:47 2002
@@ -5,7 +5,7 @@ SOURCES=pthread_atfork.man pthread_attr_
   pthread_key_create.man pthread_mutex_init.man \
   pthread_mutexattr_init.man pthread_once.man pthread_self.man \
   pthread_setschedparam.man pthread_sigmask.man sem_init.man \
-  pthread_kill_other_threads_np.man
+  pthread_kill_other_threads_np.man pthread_mutexattr_setkind_np.man
 
 MANPAGES=$(SOURCES:.man=.3thr)
 

	Jakub

Re: [PATCH] pthread_mutexattr_*{kind_np,type} in man pages

[Ulrich Drepper]

[-- Attachment #1: Type: text/plain, Size: 405 bytes --]

On Fri, 2002-04-05 at 13:26, Jakub Jelinek wrote:

> As pthread_mutexattr_?etkind_np are deprecated, it should be said
> in the man pages.

I've applied the patch.  Thanks,

-- 
---------------.                          ,-.   1325 Chesapeake Terrace
Ulrich Drepper  \    ,-------------------'   \  Sunnyvale, CA 94089 USA
Red Hat          `--' drepper at redhat.com   `------------------------

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 232 bytes --]