From: "Uwe Kleine-König" <u.kleine-koenig@pengutronix.de>
To: John Kacur <jkacur@redhat.com>
Cc: linux-rt-users@vger.kernel.org, Clark Williams <williams@redhat.com>
Subject: Re: [PATCH] man page for pip_stress
Date: Wed, 13 Jul 2011 20:37:48 +0200 [thread overview]
Message-ID: <20110713183748.GC21450@pengutronix.de> (raw)
In-Reply-To: <985116783.390457.1309180305814.JavaMail.root@zmail07.collab.prod.int.phx2.redhat.com>
Hi John,
On Mon, Jun 27, 2011 at 09:11:45AM -0400, John Kacur wrote:
> ----- Original Message -----
> > The Debian package checker lintian criticizes that pip_stress doesn't
> > have a
> > man page. So put a short version of the description from the source
> > file
> > into a man page to make lintian happy.
> >
>
> Why not just steal the text in the comments at the top of the file and
> put that into man page form?
I reread the description in pip_stress.c and I think it is too verbose
for a manpage. A few examples that are IMHO not suitable for a man page:
Pay particular attention to how this [mmap to back the
pthread_mutex_t] is intialized to support processes.
The state structure keeps track of the progress.
In either case this program demonstrates how to use priority
inheritance mutexes with processes.
If you are having difficulty triggering an inversion, merely
increase the time that the low priority process sleeps while
holding the lock.
These are good as comments in the source file but are not helpful for a
user who just wants to use pip_stress.
Best regards
Uwe
--
Pengutronix e.K. | Uwe Kleine-König |
Industrial Linux Solutions | http://www.pengutronix.de/ |
--
To unsubscribe from this list: send the line "unsubscribe linux-rt-users" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
prev parent reply other threads:[~2011-07-13 18:37 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-06-27 12:41 [PATCH] man page for pip_stress Uwe Kleine-König
2011-06-27 13:11 ` John Kacur
2011-07-13 18:37 ` Uwe Kleine-König [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20110713183748.GC21450@pengutronix.de \
--to=u.kleine-koenig@pengutronix.de \
--cc=jkacur@redhat.com \
--cc=linux-rt-users@vger.kernel.org \
--cc=williams@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).