Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 1 Jul 1999 21:08:58 +0100
From:      Nik Clayton <nik@nothing-going-on.demon.co.uk>
To:        Jesus Monroy <jesus.monroy@usa.net>
Cc:        Nik Clayton <nik@nothing-going-on.demon.co.uk>, doc@freebsd.org
Subject:   Re: [Re: pstat -k; pstat -n]
Message-ID:  <19990701210858.B53704@catkin.nothing-going-on.org>
In-Reply-To: <19990701100518.26102.qmail@nwcst277.netaddress.usa.net>; from Jesus Monroy on Thu, Jul 01, 1999 at 03:05:18AM -0700
References:  <19990701100518.26102.qmail@nwcst277.netaddress.usa.net>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Jul 01, 1999 at 03:05:18AM -0700, Jesus Monroy wrote:
>     Perhaps, but I note that this is not documented well in
>     the man pages. That is, when a flags such as these
>     are needed it is note that the flags work ONLY with
>     others. 

From pstat(1)

     -n      Print devices out by major/minor instead of name.

     -k      Print sizes in kilobytes, regardless of the setting of the BLOCK-
             SIZE environment variable.

I'm a native English speaker, and both of those imply to me that some
other option is going to be specifying that I want devices and/or sizes
printed in a different format.

If you find that confusing, could you suggest an alternative wording that
isn't confusing?

> > Yes they are, by and large.  Sometimes they forget, and we try and > remind
> > them.  Reading the cvs-all mailing list for any length of time should 
> > show this.
>  
>     No, don't have time for cvs-anything. Am taxed as it is.
>     But why would I look in the CVS anyway?
>     This is about documentation, not version control.

Your question was "Who was responsible?".  If you read the CVS mailing
lists you'll frequently see people committing changes to both the code and
the man pages, and you'll less frequently see people committing changes to
the code, and forgetting the man pages.  Normally someone else gently 
reminds them to update the man page as well.

Not everyone has the time to read the cvs-all mailing list, and I'm not
surprised, as most of the time it is deathly boring.

I think your question comes under the "No one's ever asked it before"
category, as it's always been assumed that if you change the code, you
change the accompanying documentation.

> > >   If not, who is responsible for these changes? 
> > 
> > People that notice problems.  Either by sending a PR, or, if they're a 
> > committer themselves, taking it up with the last person to change that
> > utility, confirming that it was an oversight, and fixing the problem.
> > 
>     Yes, that is what I had surmised.
>     Can I quote you on this?

Certainly.

N
-- 
 [intentional self-reference] can be easily accommodated using a blessed,
 non-self-referential dummy head-node whose own object destructor severs
 the links.
    -- Tom Christiansen in <375143b5@cs.colorado.edu>


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990701210858.B53704>