NetBSD Problem Report #42349

From bharder@methodlogic.net  Thu Nov 19 18:07:37 2009
Return-Path: <bharder@methodlogic.net>
Received: from mail.netbsd.org (mail.netbsd.org [204.152.190.11])
	by www.NetBSD.org (Postfix) with ESMTP id C8AA963B844
	for <gnats-bugs@gnats.netbsd.org>; Thu, 19 Nov 2009 18:07:37 +0000 (UTC)
Message-Id: <20091119180735.GA26519@methodlogic.net>
Date: Thu, 19 Nov 2009 10:07:35 -0800
From: bharder <bharder@methodlogic.net>
Reply-To:
To: gnats-bugs@gnats.NetBSD.org
Subject: libmagic/magic man page cross-ref. errors
X-Send-Pr-Version: 3.95

>Number:         42349
>Category:       misc
>Synopsis:       libmagic, file manpages have inconsistent ref. to magic(4|5).
>Confidential:   no
>Severity:       non-critical
>Priority:       high
>Responsible:    misc-bug-people
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Thu Nov 19 18:10:00 +0000 2009
>Closed-Date:    Sat Jan 30 20:16:22 +0000 2010
>Last-Modified:  Sat Jan 30 20:16:22 +0000 2010
>Originator:     bharder <bharder@methodlogic.net>
>Release:        NetBSD 5.0_STABLE
>Organization:
	Method Logic Digital (http://methodlogic.net)
>Environment:
System: NetBSD oxford 5.0_STABLE NetBSD 5.0_STABLE (oxford) #8: Sun Nov 15 12:35:12 PST 2009 root@oxford:/usr/obj/sys/arch/i386/compile/oxford i386
Architecture: i386
Machine: i386
>Description:
	libmagic and file manpages make reference to magic file as magic(4); magic man page is currently filed as magic(5). Further title shown in libmagic shows as "magic(3)", but "man 3 magic" has no entry.
>How-To-Repeat:
	Review manual pages.
>Fix:
	is magic file description of section 4 or 5? Fix header in libmagic man page, or make another entry to reflect header?

>Release-Note:

>Audit-Trail:
From: Thomas Klausner <wiz@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/42349: libmagic/magic man page cross-ref. errors
Date: Tue, 24 Nov 2009 15:09:57 +0100

 On Thu, Nov 19, 2009 at 06:10:00PM +0000, bharder wrote:
 > >Number:         42349
 > >Category:       misc
 > >Synopsis:       libmagic, file manpages have inconsistent ref. to magic(4|5).
 ...
 > >Description:
 > 	libmagic and file manpages make reference to magic file as magic(4); magic man page is currently filed as magic(5). Further title shown in libmagic shows as "magic(3)", but "man 3 magic" has no entry.
 > >How-To-Repeat:
 > 	Review manual pages.
 > >Fix:
 > 	is magic file description of section 4 or 5? Fix header in libmagic man page, or make another entry to reflect header?

 I've checked on current.
 The file format is described in magic(5), as it should be.
 I only found references to magic(5), not 4 or 3.
 I've changed the internally displayed name of the libmagic man page to
 match its file name, so it's now "libmagic(3)", which should avoid the
 confusion.

 I haven't looked at 5.0, since I don't have one running.
  Thomas

From: David Holland <dholland-bugs@netbsd.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: misc/42349: libmagic/magic man page cross-ref. errors
Date: Thu, 3 Dec 2009 04:57:22 +0000

 On Tue, Nov 24, 2009 at 02:10:05PM +0000, Thomas Klausner wrote:
  >>>Synopsis: libmagic, file manpages have inconsistent ref. to magic(4|5).
  >>[...]
  >  I haven't looked at 5.0, since I don't have one running.

 Candidate patch for netbsd-5:

 Index: file.1
 ===================================================================
 RCS file: /cvsroot/src/dist/file/doc/Attic/file.1,v
 retrieving revision 1.17
 diff -u -r1.17 file.1
 --- file.1	30 Aug 2008 12:16:51 -0000	1.17
 +++ file.1	3 Dec 2009 04:56:02 -0000
 @@ -339,7 +339,7 @@
  .Fl h
  options.
  .Sh SEE ALSO
 -.Xr magic 4 ,
 +.Xr magic 5 ,
  .Xr strings 1 ,
  .Xr od 1 ,
  .Xr hexdump 1,
 Index: libmagic.3
 ===================================================================
 RCS file: /cvsroot/src/dist/file/doc/Attic/libmagic.3,v
 retrieving revision 1.10
 diff -u -r1.10 libmagic.3
 --- libmagic.3	30 Aug 2008 12:16:51 -0000	1.10
 +++ libmagic.3	3 Dec 2009 04:56:02 -0000
 @@ -26,7 +26,7 @@
  .\" SUCH DAMAGE.
  .\"
  .Dd November 15, 2006
 -.Dt MAGIC 3
 +.Dt LIBMAGIC 3
  .Os
  .Sh NAME
  .Nm magic_open ,
 @@ -68,7 +68,7 @@
  operate on the magic database file
  which is described
  in
 -.Xr magic 4 .
 +.Xr magic 5 .
  .Pp
  The function
  .Fn magic_open
 @@ -132,7 +132,7 @@
  The
  .Fn magic_close
  function closes the
 -.Xr magic 4
 +.Xr magic 5
  database and deallocates any resources used.
  .Pp
  The
 @@ -249,7 +249,7 @@
  .El
  .Sh SEE ALSO
  .Xr file 1 ,
 -.Xr magic 4 
 +.Xr magic 5
  .Sh AUTHORS
  Måns Rullgård Initial libmagic implementation,
  and configuration.


 -- 
 David A. Holland
 dholland@netbsd.org

State-Changed-From-To: open->pending-pullups
State-Changed-By: dholland@NetBSD.org
State-Changed-When: Sat, 30 Jan 2010 19:10:47 +0000
State-Changed-Why:
I've submitted the patch as pullup-5 #1287.


State-Changed-From-To: pending-pullups->closed
State-Changed-By: snj@NetBSD.org
State-Changed-When: Sat, 30 Jan 2010 20:16:22 +0000
State-Changed-Why:
Patch committed to netbsd-5.


>Unformatted:

Home	PR Database Search