Re: Documentation of underlying functions for statistics views

From: Josh Kupershmidt <schmiddy(at)gmail(dot)com>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: pgsql-docs(at)postgresql(dot)org
Subject: Re: Documentation of underlying functions for statistics views
Date: 2012-04-29 21:33:29
Message-ID: CAK3UJREojaUn4tqwRbp8RzZOSVztc400raMZVekNz_NOv_AT9A@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Sun, Apr 29, 2012 at 2:06 PM, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
> Josh Kupershmidt <schmiddy(at)gmail(dot)com> writes:
>> Yeah, that sounds fine. The paragraph I think you're talking about
>> claims "These functions are listed in Table 27-13", but Table 27-13
>> only has a few functions (e.g. pg_stat_get_db_block_time_read() is
>> missing). Maybe that paragraph could  clarify that it's talking
>> generally about all the views/functions on that page.
>
> It seemed to me that the only view-underlying function that needs
> explicit documentation is pg_stat_get_activity(), because the fact
> that you can pass it a PID isn't obvious from the view's usage.
> So that's the only one I left in table 27-13.  However, I realized
> that the stats functions that we used in pg_stat_activity before 8.4
> are not documented at all with this approach, so I made another table
> 27-14 to cover them.  I'm not sure if we should mark them deprecated
> or not; thoughts?
>
> Anyway, this is committed and up on the devel docs website, if
> you want to take a look.

I think you left an extra

<entry>
</entry>

in the description for pg_stat_get_backend_start(integer), around line
1712 of monitoring.sgml. Other than that, I liked the changes.

Josh

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Tom Lane 2012-04-29 21:57:21 Re: Documentation of underlying functions for statistics views
Previous Message Tom Lane 2012-04-29 21:06:09 Re: Documentation of underlying functions for statistics views