NetBSD Problem Report #36962

From martin@duskware.de  Mon Sep 10 07:49:23 2007
Return-Path: <martin@duskware.de>
Received: from mail.netbsd.org (mail.netbsd.org [204.152.190.11])
	by narn.NetBSD.org (Postfix) with ESMTP id 0695963B8E9
	for <gnats-bugs@gnats.netbsd.org>; Mon, 10 Sep 2007 07:49:23 +0000 (UTC)
Message-Id: <20070910033841.7674163B8A2@narn.NetBSD.org>
Date: Mon, 10 Sep 2007 03:38:41 +0000 (UTC)
From: jjhartley@gmail.com
Reply-To: jjhartley@gmail.com
To: netbsd-bugs-owner@NetBSD.org
Subject: Misleading use of "path" in swapctl(8)'s discussion of -a option.
X-Send-Pr-Version: www-1.0

>Number:         36962
>Category:       port-i386
>Synopsis:       Misleading use of "path" in swapctl(8)'s discussion of -a option.
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    port-i386-maintainer
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Mon Sep 10 07:50:01 +0000 2007
>Closed-Date:    Mon Sep 10 20:23:47 +0000 2007
>Last-Modified:  Mon Sep 10 21:25:01 +0000 2007
>Originator:     James Hartley
>Release:        4.0_RC1
>Organization:
>Environment:
NetBSD lederman 4.0_RC1 NetBSD 4.0_RC1 (GENERIC) #0: Sat Sep  1 15:24:09 PDT 2007  builds@wb42:/home/builds/ab/netbsd-4-0-RC1/i386/200709011431Z-obj/home/builds/ab/netbsd-4-0-RC1/src/sys/arch/i386/compile/GENERIC i386
>Description:
The manpage for swapctl(8) discusses requirement of a path when using the -a option.  This path is actually a "node" as described in the manpage for mount(8).  Use of the word "path" is misleading.

Likewise, it should be mentioned that use of swapctl(8)'s -a option does not require a corresponding entry in /etc/fstab.
>How-To-Repeat:
Not applicable.
>Fix:

>Release-Note:

>Audit-Trail:

State-Changed-From-To: open->closed
State-Changed-By: mrg@netbsd.org
State-Changed-When: Mon, 10 Sep 2007 20:23:47 +0000
State-Changed-Why:
not a bug.


From: matthew green <mrg@eterna.com.au>
To: gnats-bugs@NetBSD.org
Cc: port-i386-maintainer@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org
Subject: re: port-i386/36962: Misleading use of "path" in swapctl(8)'s discussion of -a option. 
Date: Tue, 11 Sep 2007 06:23:23 +1000

    The manpage for swapctl(8) discusses requirement of a path when
    using the -a option. This path is actually a "node" as described
    in the manpage for mount(8). Use of the word "path" is misleading.

 i do not agree.

 in mount(8) a "node" is the place mounted upon.  it's a local
 directory.  in mount(8) a "special" is the device or remote
 name to use (eg, /dev/sd0a or host:/path.)

 in swapctl(8) the "path" is more akin to mount(8)'s "special",
 in that it is normally a device or file.  it certainly is not
 "node" as described in mount(8).  why a description in mount(8)
 is relevant to swapctl, i'm not sure.

    Likewise, it should be mentioned that use of swapctl(8)'s -a option
    does not require a corresponding entry in /etc/fstab.

 the manual already states in the 2nd paragraph of the
 DESCRIPTION: 

 	If either special or node are not provided, the
 	appropriate information is taken from the fstab(5) file

 i see no reason to change swapctl(8).


 .mrg.

From: "James Hartley" <jjhartley@gmail.com>
To: gnats-bugs@netbsd.org
Cc: port-i386-maintainer@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org
Subject: Re: port-i386/36962: Misleading use of "path" in swapctl(8)'s discussion of -a option.
Date: Mon, 10 Sep 2007 13:43:13 -0700

 On 9/10/07, matthew green <mrg@eterna.com.au> wrote:
 > The following reply was made to PR port-i386/36962; it has been noted by GNATS.
 >  the manual already states in the 2nd paragraph of the
 >  DESCRIPTION:
 >
 >         If either special or node are not provided, the
 >         appropriate information is taken from the fstab(5) file
 >
 >  i see no reason to change swapctl(8).

 Searching for the word "special" on swapctl(8)'s manpage yields no
 results.  Again, I am looking at 4.0_RC1/i386.  It would be good if
 the above text actually was in the discussion found on the manpage.

 Jim

From: matthew green <mrg@eterna.com.au>
To: "James Hartley" <jjhartley@gmail.com>
Cc: port-i386-maintainer@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org, gnats-bugs@netbsd.org
Subject: re: port-i386/36962: Misleading use of "path" in swapctl(8)'s discussion of -a option. 
Date: Tue, 11 Sep 2007 07:03:03 +1000

    On 9/10/07, matthew green <mrg@eterna.com.au> wrote:
    > The following reply was made to PR port-i386/36962; it has been noted by GNATS.
    >  the manual already states in the 2nd paragraph of the
    >  DESCRIPTION:
    >
    >         If either special or node are not provided, the
    >         appropriate information is taken from the fstab(5) file
    >
    >  i see no reason to change swapctl(8).

    Searching for the word "special" on swapctl(8)'s manpage yields no
    results.  Again, I am looking at 4.0_RC1/i386.  It would be good if
    the above text actually was in the discussion found on the manpage.


 sorry, i was quoting mount(8) not swapctl(8).

 in any case, i don't see why -a should meantion not looking
 in /etc/fstab.  nothing elsewhere implies that this is the
 case and the only options that do look in fstab say so.


 .mrg.

From: "James Hartley" <jjhartley@gmail.com>
To: "matthew green" <mrg@eterna.com.au>
Cc: port-i386-maintainer@netbsd.org, gnats-admin@netbsd.org,
	netbsd-bugs@netbsd.org, gnats-bugs@netbsd.org
Subject: Re: port-i386/36962: Misleading use of "path" in swapctl(8)'s discussion of -a option.
Date: Mon, 10 Sep 2007 14:24:20 -0700

 On 9/10/07, matthew green <mrg@eterna.com.au> wrote:
 > ...i don't see why -a should meantion not looking
 > in /etc/fstab.  nothing elsewhere implies that this is the
 > case and the only options that do look in fstab say so.

 Technically this may be correct, but I would think that clarity is a
 bigger goal.

 Likewise, I still believe that mentioning "special" in the discussion
 of "path" would help clarify as well.

 Jim

>Unformatted:

Home	PR Database Search