code review 6657047: runtime: update docs for MemStats.PauseNs

runtime: update docs for MemStats.PauseNs
   PauseNs is a circular buffer of recent pause times, and the
most recent one is at [((NumGC-1)+256)%256].

   Also fix comments cross-linking the Go and C definition of
various structs.

[minux1, 2012-10-11 20:08:24]

Hello golang-dev@googlegroups.com (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go/

[rsc, 2012-10-12 15:07:05]

That's a pretty long line. How about just

// most recent pause times (circular buffer)

[minux1, 2012-10-12 15:14:27]

On 2012/10/12 15:07:05, rsc wrote:
> That's a pretty long line. How about just 
> // most recent pause times (circular buffer)
How about this?
   // circular buffer of recent GC pause times, the most recent one is
[NumGC%256]

I prefer we give explicit note about which entry is the most recent
(e.g. the offset of the circular buffer)

[bradfitz, 2012-10-12 15:19:20]

On Fri, Oct 12, 2012 at 8:14 AM, <minux.ma@gmail.com> wrote:

> On 2012/10/12 15:07:05, rsc wrote:
>
>> That's a pretty long line. How about just
>> // most recent pause times (circular buffer)
>>
> How about this?
>    // circular buffer of recent GC pause times, the most recent one is
> [NumGC%256]
>
>
// circular buffer of recent GC pause times; most recent at [NumGC%256]

?

[rsc, 2012-10-12 15:21:05]

> // circular buffer of recent GC pause times; most recent at [NumGC%256]

This is not true. The most recent is at [(NumGC-1+256)%256]

Russ

[bradfitz, 2012-10-12 15:23:37]

On Fri, Oct 12, 2012 at 8:21 AM, Russ Cox <rsc@golang.org> wrote:

> > // circular buffer of recent GC pause times; most recent at [NumGC%256]
>
> This is not true. The most recent is at [(NumGC-1+256)%256]


Right. I was trying to shorten the wording.

[minux1, 2012-10-12 15:31:00]

On Fri, Oct 12, 2012 at 11:21 PM, Russ Cox <rsc@golang.org> wrote:

> > // circular buffer of recent GC pause times; most recent at [NumGC%256]
>
> This is not true. The most recent is at [(NumGC-1+256)%256]
>
Oops, off by 1 error, my bad.

I've update the docs and CL description to use Brad's suggestion
with [(NumGC+255)%256].

[minux1, 2012-10-20 09:28:08]

gentle ping.

[bradfitz, 2012-10-20 16:53:45]

LGTM at least

On Sat, Oct 20, 2012 at 2:28 AM, <minux.ma@gmail.com> wrote:

> gentle ping.
>
>
https://codereview.appspot.**com/6657047/<https://codereview.appspot.com/6657...
>

[rsc, 2012-10-21 16:25:06]

LGTM

[minux1, 2012-10-21 17:08:25]

*** Submitted as http://code.google.com/p/go/source/detail?r=5ff25ab9358f ***

runtime: update docs for MemStats.PauseNs
   PauseNs is a circular buffer of recent pause times, and the
most recent one is at [((NumGC-1)+256)%256].

   Also fix comments cross-linking the Go and C definition of
various structs.

R=golang-dev, rsc, bradfitz
CC=golang-dev
http://codereview.appspot.com/6657047