From nobody@FreeBSD.org  Wed Aug  8 14:53:59 2001
Return-Path: <nobody@FreeBSD.org>
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 773A937B40B
	for <freebsd-gnats-submit@FreeBSD.org>; Wed,  8 Aug 2001 14:53:59 -0700 (PDT)
	(envelope-from nobody@FreeBSD.org)
Received: (from nobody@localhost)
	by freefall.freebsd.org (8.11.4/8.11.4) id f78Lrx969238;
	Wed, 8 Aug 2001 14:53:59 -0700 (PDT)
	(envelope-from nobody)
Message-Id: <200108082153.f78Lrx969238@freefall.freebsd.org>
Date: Wed, 8 Aug 2001 14:53:59 -0700 (PDT)
From: Evan Sarmiento <kaworu@sektor7.ath.cx>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [PATCH] No man page for pgfind()
X-Send-Pr-Version: www-1.0

>Number:         29552
>Category:       docs
>Synopsis:       [PATCH] No man page for pgfind()
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    ru
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Aug 08 15:00:02 PDT 2001
>Closed-Date:    Fri Aug 10 00:20:54 PDT 2001
>Last-Modified:  Fri Aug 10 00:23:41 PDT 2001
>Originator:     Evan Sarmiento
>Release:        5.0-CURRENT
>Organization:
>Environment:
FreeBSD armitage.sekt7.org 5.0-CURRENT FreeBSD 5.0-CURRENT #2: Sat Aug  4 15:43:02 EDT 2001     root@armitage.sekt7.org:/usr/src/sys/i386/compile/INSPIRON  i386


>Description:
I have written a manpage for pgfind(). Here it is below. This is just one in a series of man pages about functions from kern_proc.c I am suggesting. Thanks.

 
>How-To-Repeat:

>Fix:
.\" Copyright (c) 2001 Evan Sarmiento.
.\" 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: src/share/man/man9/pfind.9,v 1.1 2001/07/16 07:04:09 ru Exp $
.\"
.Dd August 8, 2001
.Os
.Dt PGFIND 9
.Sh NAME
.Nm pgfind 
.Nd locate a process group by pid 
.Sh SYNOPSIS
.In sys/proc.h
.Ft "struct pgrp *"
.Fn pgfind "pid_t pgid"
.Sh DESCRIPTION
.Fn pgfind 
takes a
.Fa pid
as its argument and returns a pointer to the
.Vt pgrp 
structure whose pgid is specified in the argument.
.Pp
.Sh RETURN VALUES
.Nm pgfind
returns NULL on failure or a pointer to a
.Vt pgrp 
structure on sucessful completion.
.Sh AUTHORS
This man page was written by
.An Evan Sarmiento Aq kaworu@sektor7.ath.cx .

>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: Evan Sarmiento <kaworu@sektor7.ath.cx>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/29552: [PATCH] No man page for pgfind() 
Date: Wed, 08 Aug 2001 16:27:06 -0700

 Evan Sarmiento <kaworu@sektor7.ath.cx> writes:
 > .\" $FreeBSD: src/share/man/man9/pfind.9,v 1.1 2001/07/16 07:04:09 ru Exp $
 
 This should just be "$FreeBSD$".
 
 ...
 > .Sh DESCRIPTION
 > .Fn pgfind 
 ...
 > .Sh RETURN VALUES
 > .Nm pgfind
 
 Why did you use .Nm here?  It should be .Fn like above.
 
 > returns NULL on failure or a pointer to a
 
 returns
 .Dv NULL
 on failure or a pointer to a
 
 > .Vt pgrp 
 > structure on sucessful completion.
 > .Sh AUTHORS
 > This man page was written by
 > .An Evan Sarmiento Aq kaworu@sektor7.ath.cx .
 
 Also, some of the lines have extra whitespace at the end.  It
 shouldn't be there.
 
 Thanks.
 

From: Ruslan Ermilov <ru@FreeBSD.ORG>
To: Evan Sarmiento <kaworu@sektor7.ath.cx>
Cc: freebsd-gnats-submit@FreeBSD.ORG
Subject: Re: docs/29552: [PATCH] No man page for pgfind()
Date: Thu, 9 Aug 2001 15:33:17 +0300

 On Wed, Aug 08, 2001 at 02:53:59PM -0700, Evan Sarmiento wrote:
 [...]
 > .Nm pgfind 
 > .Nd locate a process group by pid 
 > 
 `pid' and `pgid' are different things.  pgfind() locates a process
 group by number.  I would write this like "by ID", or "by number".
 
 > .Sh DESCRIPTION
 +The
 > .Fn pgfind 
 +function
 > takes a
 > .Fa pid
 s/pid/pgid
 
 > as its argument and returns a pointer to the
 > .Vt pgrp 
 > structure whose pgid is specified in the argument.
 
 s/pgid/.Va pg_id/
 
 > .Pp
 Gratuitous .Pp.
 
 > .Sh RETURN VALUES
 > .Nm pgfind
 The
 .Fn pgfind
 function
 > returns NULL on failure or a pointer to a
 .Dv NULL
 > .Vt pgrp 
 > structure on sucessful completion.
 > .Sh AUTHORS
 > This man page was written by
 > .An Evan Sarmiento Aq kaworu@sektor7.ath.cx .
 
 If you agree with these corrections, I can commit your manpage,
 and connect it to build in man9/Makefile.
 
 
 Cheers,
 -- 
 Ruslan Ermilov		Oracle Developer/DBA,
 ru@sunbay.com		Sunbay Software AG,
 ru@FreeBSD.org		FreeBSD committer,
 +380.652.512.251	Simferopol, Ukraine
 
 http://www.FreeBSD.org	The Power To Serve
 http://www.oracle.com	Enabling The Information Age

From: Evan Sarmiento <ems@open-root.org>
To: freebsd-gnats-submit@FreeBSD.org, ru@freebsd.org
Cc:  
Subject: Re: docs/29552: [PATCH] No man page for pgfind()
Date: Thu,  9 Aug 2001 16:55:47 -0400 (EDT)

 Yes,  I do accept the corrections. Commit away. Thanks a lot. :-)
 
 -- 
 -----------------------------------
 Evan Sarmiento | www.open-root.org 
 ems@sekt7.org  | www.sekt7.org/~ems/
 -----------------------------------
 
State-Changed-From-To: open->closed 
State-Changed-By: ru 
State-Changed-When: Fri Aug 10 00:20:54 PDT 2001 
State-Changed-Why:  
Committed, thanks! 


Responsible-Changed-From-To: freebsd-doc->ru 
Responsible-Changed-By: ru 
Responsible-Changed-When: Fri Aug 10 00:20:54 PDT 2001 
Responsible-Changed-Why:  

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=29552 
>Unformatted:
