Control: tags -1 patch
Dear mutextrace maintainer,
On Wed, Dec 02, 2009 at 04:04:27PM +0100, Helmut Grohne wrote:
The mutextrace package does not contain any documentation. According to
policy section 12.1. a bug should be reported for a missing manual page
which is the case. As there is no other documentation in the package it
degrades the usability and thus the bug is marked as important.
I wrote a manual page for the mutextrace utility. Please consider
including it under the very same license as the rest of the source.
You'll find it attached to this mail.
Helmut
.Dd Mar 11 2013
.Dt mutextrace 1
.Sh NAME
mutextrace - LD_PRELOAD wrapper for tracing pthread mutex acquisition
.Sh SYNOPSIS
.nf
\fBmutextrace\fP \fIprogram options\fP
.fi
.Sh DESCRIPTION
This tool allows you to wrap an existing program and wrap calls to
\fBpthread_create\fP and \fBpthread_mutex_*\fP to display what is happening.
Specifically creation, locking, unlocking and destruction of mutexes as well as
creation and termination of threads is displayed.
Note that it does replace \fBpthread_mutex_trylock\fP.
Objects are numbered sequentially numbered at creation and those numbers are
used to identify them later on.
When a lock is acquired in one thread which is currently held by another
thread, the ownership transfer is explained.
The \fBmutextrace\fP utility sets up the \fBLD_PRELOAD\fP environment variable
to load the library into a program to be debugged.
It takes no options on its own and assumes that the first parameter refers to a
program to be executed.
All further parameters are passed on to the wrapped program.
.Sh SEE ALSO
.Xr pthread_create 3
.Xr pthread_mutex_init 3
.Xr pthread_mutex_lock 3
.Xr pthread_mutex_unlock 3
.Xr pthread_mutex_destroy 3
.Sh AUTHOR
\fBmutextrace\fP was written by Simon Richter simon.rich...@hogyros.de.
This manual page was written by Helmut Grohne hel...@subdivi.de for the
Debian system (but may be used by others).
