From owner-freebsd-doc@FreeBSD.ORG  Sun Jun 22 17:00:27 2003
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 14FF137B404
	for <freebsd-doc@hub.freebsd.org>;
	Sun, 22 Jun 2003 17:00:27 -0700 (PDT)
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 5FE3243FE3
	for <freebsd-doc@hub.freebsd.org>;
	Sun, 22 Jun 2003 17:00:25 -0700 (PDT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1])
	by freefall.freebsd.org (8.12.9/8.12.9) with ESMTP id h5N00PUp088102
	for <freebsd-doc@freefall.freebsd.org>;
	Sun, 22 Jun 2003 17:00:25 -0700 (PDT)
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.12.9/8.12.9/Submit) id h5N00P9I088101;
	Sun, 22 Jun 2003 17:00:25 -0700 (PDT)
Resent-Date: Sun, 22 Jun 2003 17:00:25 -0700 (PDT)
Resent-Message-Id: <200306230000.h5N00P9I088101@freefall.freebsd.org>
Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer)
Resent-To: freebsd-doc@FreeBSD.org
Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org,
	Faried Nawaz <fn@hungry.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id AF24037B401
	for <FreeBSD-gnats-submit@freebsd.org>;
	Sun, 22 Jun 2003 16:53:40 -0700 (PDT)
Received: from loops.nilpotent.org (loops.nilpotent.org [12.17.163.70])
	by mx1.FreeBSD.org (Postfix) with SMTP id CF42643FDF
	for <FreeBSD-gnats-submit@freebsd.org>;
	Sun, 22 Jun 2003 16:53:39 -0700 (PDT)	(envelope-from fn@hungry.org)
Received: (qmail 2148 invoked from network); 22 Jun 2003 23:53:38 -0000
Received: from unknown (203.215.182.84)
  by loops.nilpotent.org with QMTP; 22 Jun 2003 23:53:38 -0000
Received: (qmail 1033 invoked by uid 500); 22 Jun 2003 23:48:57 -0000
Message-Id: <20030622234857.1032.qmail@xpf.nilpotent.org>
Date: 22 Jun 2003 23:48:57 -0000
From: Faried Nawaz <fn@hungry.com>
To: FreeBSD-gnats-submit@FreeBSD.org
X-Send-Pr-Version: 3.113
Subject: docs/53621: devname(3)'s man page needs an example
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
Reply-To: Faried Nawaz <fn@hungry.com>
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 23 Jun 2003 00:00:27 -0000


>Number:         53621
>Category:       docs
>Synopsis:       devname(3)'s man page needs an example
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Jun 22 17:00:25 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     Faried Nawaz
>Release:        FreeBSD 5.1-CURRENT i386
>Organization:
Hungry Programmers, Inc
>Environment:
System: FreeBSD semuta.nilpotent.org 5.1-CURRENT FreeBSD 5.1-CURRENT #0: Mon Jun 23 00:16:32 PKST 2003 root@semuta.nilpotent.org:/usr/obj/usr/src/sys/semuta i386
>Description:
	devname(3)'s man page is hard to figure out.  Sure, it includes an
	xref to stat(2), but I think a little bit more info can help.
>How-To-Repeat:
	man 3 devname
>Fix:
	I suggest adding an example.  Something like

EXAMPLE

     int fd;
     struct stat buf;
     char *name;

     fd = open("/dev/tun", O_RDWR);
     fstat(fd, &buf)
     printf("devname is /dev/%s\n", devname(buf.st_rdev, S_IFCHR))

     prints out

     devname is /dev/tun5

>Release-Note:
>Audit-Trail:
>Unformatted: