Re: [PATCH] man page for pip_stress

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [RT Stable]     [Kernel Newbies]     [IDE]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux ATA RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]

  Powered by Linux