From nobody@FreeBSD.org  Thu Nov 29 18:27:45 2007
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 2F37916A46E
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 29 Nov 2007 18:27:45 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id 0FAE313C442
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 29 Nov 2007 18:27:45 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.2/8.14.2) with ESMTP id lATIRYId030761
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 29 Nov 2007 18:27:34 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.2/8.14.1/Submit) id lATIRXCi030759;
	Thu, 29 Nov 2007 18:27:33 GMT
	(envelope-from nobody)
Message-Id: <200711291827.lATIRXCi030759@www.freebsd.org>
Date: Thu, 29 Nov 2007 18:27:33 GMT
From: Andrew Hammond <andrew.george.hammond@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: man page for top does not describe STATE column wait events
X-Send-Pr-Version: www-3.1
X-GNATS-Notify: keramida

>Number:         118332
>Category:       docs
>Synopsis:       man page for top(1) does not describe STATE column wait events
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    arundel
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Nov 29 18:30:02 UTC 2007
>Closed-Date:    
>Last-Modified:  Sat Aug 06 09:08:51 UTC 2011
>Originator:     Andrew Hammond
>Release:        6.2 amd64
>Organization:
Microsoft
>Environment:
FreeBSD ahammond.ecoffice.experclick.com 6.2-RELEASE FreeBSD 6.2-RELEASE #0: Fri Jan 12 08:32:24 UTC 2007     root@portnoy.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC  amd64

>Description:
The manual page for top does not describe or provide a pointer to descriptions of STATEs such as swread, nanslp, select, piperd, etc. 
>How-To-Repeat:

>Fix:


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->feedback 
State-Changed-By: keramida 
State-Changed-When: Sun Feb 10 19:51:33 UTC 2008 
State-Changed-Why:  
Set the state to `feedback', and add myself to the `notify' list. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=118332 

From: Giorgos Keramidas <keramida@freebsd.org>
To: Andrew Hammond <andrew.george.hammond@gmail.com>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/118332: man page for top does not describe STATE column
	wait events
Date: Sun, 10 Feb 2008 21:51:17 +0200

 On 2007-11-29 18:27, Andrew Hammond <andrew.george.hammond@gmail.com> wrote:
 > >Number:         118332
 > >Category:       docs
 > >Synopsis:       man page for top does not describe STATE column wait events
 
 > The manual page for top does not describe or provide a pointer to
 > descriptions of STATEs such as swread, nanslp, select, piperd, etc.
 
 The manpage describes `STATE' with the somewhat cryptic text:
 
     STATE is the current state (one of "START", "RUN" (shown as "CPUn"
     on SMP systems), "SLEEP", "STOP", "ZOMB", "WAIT", "LOCK" or the
     event on which the process waits),
 
 Any lowercase string is the name of a kernel-related event, and it would
 be a very daunting task to list them *all* in the manpage.  Do you think
 we can phrase this particular part of the manpage in a way that is more
 helpful?  If yes, we are open to suggestions.
 

From: "Andrew Hammond" <andrew.george.hammond@gmail.com>
To: "Giorgos Keramidas" <keramida@freebsd.org>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/118332: man page for top does not describe STATE column wait events
Date: Sun, 10 Feb 2008 12:38:02 -0800

 ------=_Part_1733_29124706.1202675882451
 Content-Type: text/plain; charset=ISO-8859-1
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline
 
 On Feb 10, 2008 11:51 AM, Giorgos Keramidas <keramida@freebsd.org> wrote:
 
 > On 2007-11-29 18:27, Andrew Hammond <andrew.george.hammond@gmail.com>
 > wrote:
 > > >Number:         118332
 > > >Category:       docs
 > > >Synopsis:       man page for top does not describe STATE column wait
 > events
 >
 > > The manual page for top does not describe or provide a pointer to
 > > descriptions of STATEs such as swread, nanslp, select, piperd, etc.
 >
 > The manpage describes `STATE' with the somewhat cryptic text:
 >
 >    STATE is the current state (one of "START", "RUN" (shown as "CPUn"
 >    on SMP systems), "SLEEP", "STOP", "ZOMB", "WAIT", "LOCK" or the
 >    event on which the process waits),
 >
 > Any lowercase string is the name of a kernel-related event, and it would
 > be a very daunting task to list them *all* in the manpage.  Do you think
 > we can phrase this particular part of the manpage in a way that is more
 > helpful?  If yes, we are open to suggestions.
 
 
 How about continuing on with something like the following.
 
 "Here are some common events which can cause a process to wait and what they
 mean."
 
 Then list the ones that a user is most likely to see while dealing with a
 performance problem along with brief descriptions and finally provide a
 reference to the canonical documentation.
 
 A
 
 ------=_Part_1733_29124706.1202675882451
 Content-Type: text/html; charset=ISO-8859-1
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline
 
 On Feb 10, 2008 11:51 AM, Giorgos Keramidas &lt;<a href="mailto:keramida@freebsd.org">keramida@freebsd.org</a>&gt; wrote:<br><div class="gmail_quote"><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
 On 2007-11-29 18:27, Andrew Hammond &lt;<a href="mailto:andrew.george.hammond@gmail.com">andrew.george.hammond@gmail.com</a>&gt; wrote:<br>&gt; &gt;Number: &nbsp; &nbsp; &nbsp; &nbsp; 118332<br>&gt; &gt;Category: &nbsp; &nbsp; &nbsp; docs<br><div class="Ih2E3d">
 &gt; &gt;Synopsis: &nbsp; &nbsp; &nbsp; man page for top does not describe STATE column wait events<br><br></div>&gt; The manual page for top does not describe or provide a pointer to<br>&gt; descriptions of STATEs such as swread, nanslp, select, piperd, etc.<br>
 <br>The manpage describes `STATE&#39; with the somewhat cryptic text:<br><br> &nbsp; &nbsp;STATE is the current state (one of &quot;START&quot;, &quot;RUN&quot; (shown as &quot;CPUn&quot;<br> &nbsp; &nbsp;on SMP systems), &quot;SLEEP&quot;, &quot;STOP&quot;, &quot;ZOMB&quot;, &quot;WAIT&quot;, &quot;LOCK&quot; or the<br>
  &nbsp; &nbsp;event on which the process waits),<br><br>Any lowercase string is the name of a kernel-related event, and it would<br>be a very daunting task to list them *all* in the manpage. &nbsp;Do you think<br>we can phrase this particular part of the manpage in a way that is more<br>
 helpful? &nbsp;If yes, we are open to suggestions.</blockquote><div>&nbsp;</div></div>How about continuing on with something like the following.<br><br>&quot;Here are some common events which can cause a process to wait and what they mean.&quot;<br>
 <br>Then list the ones that a user is most likely to see while dealing with a performance problem along with brief descriptions and finally provide a reference to the canonical documentation.<br><br>A<br>
 
 ------=_Part_1733_29124706.1202675882451--
State-Changed-From-To: feedback->open 
State-Changed-By: vwe 
State-Changed-When: Fri May 2 10:37:44 UTC 2008 
State-Changed-Why:  

Feedback has been provided. 
If I got this right, the states are listed but manpage does not describe them. 
Do we need to explain process states in detail? 

http://www.freebsd.org/cgi/query-pr.cgi?pr=118332 

From: "Andrew Hammond" <andrew.george.hammond@gmail.com>
To: bug-followup@FreeBSD.org, andrew.george.hammond@gmail.com
Cc:  
Subject: re: docs/118332: man page for top does not describe state column wait events
Date: Fri, 2 May 2008 10:08:50 -0700

 ------=_Part_14002_7359292.1209748130661
 Content-Type: text/plain; charset=ISO-8859-1
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline
 
 From an operations stance, when I'm trying to diagnose an issue, and I see
 from top that a process is in some state that I don't recognize or
 understand, I want to know what it means. I naturally go to the man page for
 top to find out. If it's not directly in there then I want a pointer of
 where I should look next. So, to clarify my prior email, it'd be nice if the
 man page listed some of the more common states and what they mean and then
 provided a pointer to the canonical documentation.
 
 Andrew
 
 ------=_Part_14002_7359292.1209748130661
 Content-Type: text/html; charset=ISO-8859-1
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline
 
 From an operations stance, when I&#39;m trying to diagnose an issue, and I see from top that a process is in some state that I don&#39;t recognize or understand, I want to know what it means. I naturally go to the man page for top to find out. If it&#39;s not directly in there then I want a pointer of where I should look next. So, to clarify my prior email, it&#39;d be nice if the man page listed some of the more common states and what they mean and then provided a pointer to the canonical documentation.<b r>
 <br>Andrew<br><br><br>
 
 ------=_Part_14002_7359292.1209748130661--

From: Chris St Denis <chris@ctgameinfo.com>
To: bug-followup@FreeBSD.org, andrew.george.hammond@gmail.com
Cc:  
Subject: Re: docs/118332: man page for top does not describe STATE column
 wait events
Date: Thu, 18 Jun 2009 22:51:33 -0700

 Not all states are listed. For example I have some processes spending a 
 lot of time in state "*vm ob" but I can't find any info on what exactly 
 this means.
 
 The man page should identify this, or point us somewhere that does.
 
 I suspect there is not currently anywhere that these states are 
 comprehensively documented. There should be.
Responsible-Changed-From-To: freebsd-doc->arundel 
Responsible-Changed-By: arundel 
Responsible-Changed-When: Sat Aug 6 09:08:14 UTC 2011 
Responsible-Changed-Why:  
Over to me, since I'm working on this issue atm. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=118332 
>Unformatted:
