public inbox for [email protected]  
help / color / mirror / Atom feed
Documentation of pg_badkend_pid and stats functions
10+ messages / 4 participants
[nested] [flat]

* Documentation of pg_badkend_pid and stats functions
@ 2007-04-12 12:54  Jim Nasby <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Nasby @ 2007-04-12 12:54 UTC (permalink / raw)
  To: pgsql-docs

Two questions: Why is pg_backend_pid documented with the stats  
functions (9.19 System Information Functions) seems more logical.

Also, I can see mentioning the stats functions in the monitoring  
section, but shouldn't they actually be documented in with the rest  
of the functions?
--
Jim Nasby                                            [email protected]
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-06 15:12  Jim Nasby <[email protected]>
  parent: Jim Nasby <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Nasby @ 2007-05-06 15:12 UTC (permalink / raw)
  To: Jim Nasby <[email protected]>; +Cc: pgsql-docs

On Apr 12, 2007, at 7:54 AM, Jim Nasby wrote:
> Two questions: Why is pg_backend_pid documented with the stats  
> functions (9.19 System Information Functions) seems more logical.
>
> Also, I can see mentioning the stats functions in the monitoring  
> section, but shouldn't they actually be documented in with the rest  
> of the functions?

No comments? Does that mean if I write up a patch it'll be accepted?
--
Jim Nasby                                            [email protected]
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-06 16:44  Bruce Momjian <[email protected]>
  parent: Jim Nasby <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Bruce Momjian @ 2007-05-06 16:44 UTC (permalink / raw)
  To: Jim Nasby <[email protected]>; +Cc: pgsql-docs

Jim Nasby wrote:
> On Apr 12, 2007, at 7:54 AM, Jim Nasby wrote:
> > Two questions: Why is pg_backend_pid documented with the stats  
> > functions (9.19 System Information Functions) seems more logical.
> >
> > Also, I can see mentioning the stats functions in the monitoring  
> > section, but shouldn't they actually be documented in with the rest  
> > of the functions?
> 
> No comments? Does that mean if I write up a patch it'll be accepted?

Yea, I was wondering about that.  I think the best idea would be to
reference the backend functions from the main functions page, rather
than move them.

-- 
  Bruce Momjian  <[email protected]>          http://momjian.us
  EnterpriseDB                               http://www.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +



^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-07 16:03  Jim Nasby <[email protected]>
  parent: Bruce Momjian <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Nasby @ 2007-05-07 16:03 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: pgsql-docs

On May 6, 2007, at 11:44 AM, Bruce Momjian wrote:
> Jim Nasby wrote:
>> On Apr 12, 2007, at 7:54 AM, Jim Nasby wrote:
>>> Two questions: Why is pg_backend_pid documented with the stats
>>> functions (9.19 System Information Functions) seems more logical.
>>>
>>> Also, I can see mentioning the stats functions in the monitoring
>>> section, but shouldn't they actually be documented in with the rest
>>> of the functions?
>>
>> No comments? Does that mean if I write up a patch it'll be accepted?
>
> Yea, I was wondering about that.  I think the best idea would be to
> reference the backend functions from the main functions page, rather
> than move them.

Well, pg_backend_pid makes no sense being in with the stats  
functions, so I'll move it. I'll just include references to the other  
stuff.
--
Jim Nasby                                            [email protected]
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-13 20:55  Jim Nasby <[email protected]>
  parent: Jim Nasby <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Nasby @ 2007-05-13 20:55 UTC (permalink / raw)
  To: Jim Nasby <[email protected]>; +Cc: Bruce Momjian <[email protected]>; pgsql-docs

On May 7, 2007, at 11:03 AM, Jim Nasby wrote:
> On May 6, 2007, at 11:44 AM, Bruce Momjian wrote:
>> Jim Nasby wrote:
>>> On Apr 12, 2007, at 7:54 AM, Jim Nasby wrote:
>>>> Two questions: Why is pg_backend_pid documented with the stats
>>>> functions (9.19 System Information Functions) seems more logical.
>>>>
>>>> Also, I can see mentioning the stats functions in the monitoring
>>>> section, but shouldn't they actually be documented in with the rest
>>>> of the functions?
>>>
>>> No comments? Does that mean if I write up a patch it'll be accepted?
>>
>> Yea, I was wondering about that.  I think the best idea would be to
>> reference the backend functions from the main functions page, rather
>> than move them.
>
> Well, pg_backend_pid makes no sense being in with the stats  
> functions, so I'll move it. I'll just include references to the  
> other stuff.

Turns out it didn't really make much more sense to move  
pg_backend_pid either, so I went with Bruce's original idea.

--
Jim Nasby                                            [email protected]
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)




Attachments:

  [application/octet-stream] monfunc.patch (847B, 2-monfunc.patch)
  download | inline diff:
Index: doc/src/sgml/func.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/func.sgml,v
retrieving revision 1.379
diff -c -r1.379 func.sgml
*** doc/src/sgml/func.sgml	7 May 2007 07:53:26 -0000	1.379
--- doc/src/sgml/func.sgml	13 May 2007 20:52:02 -0000
***************
*** 10196,10201 ****
--- 10196,10208 ----
    <title>System Information Functions</title>
  
    <para>
+    In addition to the functions listed in this section, there are a number of
+    functions related to the statistics system that also provide system
+    information. See <xref linkend="monitoring-stats-views"> for more
+    information.
+   </para>
+ 
+   <para>
     <xref linkend="functions-info-session-table"> shows several
     functions that extract session and system information.
    </para>


^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-13 22:48  Tom Lane <[email protected]>
  parent: Jim Nasby <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Tom Lane @ 2007-05-13 22:48 UTC (permalink / raw)
  To: Jim Nasby <[email protected]>; +Cc: Bruce Momjian <[email protected]>; pgsql-docs

Jim Nasby <[email protected]> writes:
>     <title>System Information Functions</title>
  
>     <para>
> +    In addition to the functions listed in this section, there are a number of
> +    functions related to the statistics system that also provide system
> +    information. See <xref linkend="monitoring-stats-views"> for more
> +    information.
> +   </para>

Surely a section should not *begin* with a cross-reference to someplace
else.

			regards, tom lane



^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-13 22:59  Jim C. Nasby <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim C. Nasby @ 2007-05-13 22:59 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: Bruce Momjian <[email protected]>; pgsql-docs

On Sun, May 13, 2007 at 06:48:01PM -0400, Tom Lane wrote:
> Jim Nasby <[email protected]> writes:
>>     <title>System Information Functions</title>
>
>>     <para>
>> +    In addition to the functions listed in this section, there  
>> are a number of
>> +    functions related to the statistics system that also provide  
>> system
>> +    information. See <xref linkend="monitoring-stats-views"> for  
>> more
>> +    information.
>> +   </para>
>
> Surely a section should not *begin* with a cross-reference to  
> someplace
> else.

My concern is that folks will see the table right below it, not find
what they're looking for there, and move on... what about immediately
after the table?
-- 
Jim Nasby                                      [email protected]
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)


Attachments:

  [application/octet-stream] monfunc2.patch (787B, 1-monfunc2.patch)
  download | inline diff:
Index: doc/src/sgml/func.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/func.sgml,v
retrieving revision 1.379
diff -c -r1.379 func.sgml
*** doc/src/sgml/func.sgml	7 May 2007 07:53:26 -0000	1.379
--- doc/src/sgml/func.sgml	13 May 2007 22:59:02 -0000
***************
*** 10295,10300 ****
--- 10295,10307 ----
      </tgroup>
     </table>
  
+   <para>
+    In addition to the functions listed in this section, there are a number of
+    functions related to the statistics system that also provide system
+    information. See <xref linkend="monitoring-stats-views"> for more
+    information.
+   </para>
+ 
     <indexterm zone="functions-info">
      <primary>user</primary>
      <secondary>current</secondary>


^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-13 23:45  Tom Lane <[email protected]>
  parent: Jim C. Nasby <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Tom Lane @ 2007-05-13 23:45 UTC (permalink / raw)
  To: Jim C. Nasby <[email protected]>; +Cc: Bruce Momjian <[email protected]>; pgsql-docs

"Jim C. Nasby" <[email protected]> writes:
> On Sun, May 13, 2007 at 06:48:01PM -0400, Tom Lane wrote:
>> Surely a section should not *begin* with a cross-reference to  
>> someplace else.

> My concern is that folks will see the table right below it, not find
> what they're looking for there, and move on... what about immediately
> after the table?

Immediately after is fine with me.  For that matter, you could probably
get away with putting it between the introductory para and the table
proper.  I'm just allergic to sections that don't begin with a topic
sentence telling you what they are about.

			regards, tom lane



^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-14 18:47  Jim Nasby <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Nasby @ 2007-05-14 18:47 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: Bruce Momjian <[email protected]>; pgsql-docs

On May 13, 2007, at 6:45 PM, Tom Lane wrote:
> "Jim C. Nasby" <[email protected]> writes:
>> On Sun, May 13, 2007 at 06:48:01PM -0400, Tom Lane wrote:
>>> Surely a section should not *begin* with a cross-reference to
>>> someplace else.
>
>> My concern is that folks will see the table right below it, not find
>> what they're looking for there, and move on... what about immediately
>> after the table?
>
> Immediately after is fine with me.  For that matter, you could  
> probably
> get away with putting it between the introductory para and the table
> proper.  I'm just allergic to sections that don't begin with a topic
> sentence telling you what they are about.

See attached. I wanted to not put it between the paragraph  
referencing the table and the table itself, but couldn't think of a  
better intro paragraph for the section...

--
Jim Nasby                                            [email protected]
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)




Attachments:

  [application/octet-stream] monfunc3.patch (845B, 2-monfunc3.patch)
  download | inline diff:
Index: doc/src/sgml/func.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/func.sgml,v
retrieving revision 1.379
diff -c -r1.379 func.sgml
*** doc/src/sgml/func.sgml	7 May 2007 07:53:26 -0000	1.379
--- doc/src/sgml/func.sgml	14 May 2007 18:45:29 -0000
***************
*** 10200,10205 ****
--- 10200,10212 ----
     functions that extract session and system information.
    </para>
  
+   <para>
+    In addition to the functions listed in this section, there are a number of
+    functions related to the statistics system that also provide system
+    information. See <xref linkend="monitoring-stats-views"> for more
+    information.
+   </para>
+ 
     <table id="functions-info-session-table">
      <title>Session Information Functions</title>
      <tgroup cols="3">


^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: Documentation of pg_badkend_pid and stats functions
@ 2007-05-30 18:13  Bruce Momjian <[email protected]>
  parent: Jim Nasby <[email protected]>
  0 siblings, 0 replies; 10+ messages in thread

From: Bruce Momjian @ 2007-05-30 18:13 UTC (permalink / raw)
  To: Jim Nasby <[email protected]>; +Cc: Tom Lane <[email protected]>; pgsql-docs


Patch applied.  Thanks.

---------------------------------------------------------------------------


Jim Nasby wrote:
> On May 13, 2007, at 6:45 PM, Tom Lane wrote:
> > "Jim C. Nasby" <[email protected]> writes:
> >> On Sun, May 13, 2007 at 06:48:01PM -0400, Tom Lane wrote:
> >>> Surely a section should not *begin* with a cross-reference to
> >>> someplace else.
> >
> >> My concern is that folks will see the table right below it, not find
> >> what they're looking for there, and move on... what about immediately
> >> after the table?
> >
> > Immediately after is fine with me.  For that matter, you could  
> > probably
> > get away with putting it between the introductory para and the table
> > proper.  I'm just allergic to sections that don't begin with a topic
> > sentence telling you what they are about.
> 
> See attached. I wanted to not put it between the paragraph  
> referencing the table and the table itself, but couldn't think of a  
> better intro paragraph for the section...
[ Attachment, skipping... ]

> 
> --
> Jim Nasby                                            [email protected]
> EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)
> 
> 
> 
> ---------------------------(end of broadcast)---------------------------
> TIP 9: In versions below 8.0, the planner will ignore your desire to
>        choose an index scan if your joining column's datatypes do not
>        match

-- 
  Bruce Momjian  <[email protected]>          http://momjian.us
  EnterpriseDB                               http://www.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +




^ permalink  raw  reply  [nested|flat] 10+ messages in thread


end of thread, other threads:[~2007-05-30 18:13 UTC | newest]

Thread overview: 10+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2007-04-12 12:54 Documentation of pg_badkend_pid and stats functions Jim Nasby <[email protected]>
2007-05-06 15:12 ` Jim Nasby <[email protected]>
2007-05-06 16:44   ` Bruce Momjian <[email protected]>
2007-05-07 16:03     ` Jim Nasby <[email protected]>
2007-05-13 20:55       ` Jim Nasby <[email protected]>
2007-05-13 22:48         ` Tom Lane <[email protected]>
2007-05-13 22:59           ` Jim C. Nasby <[email protected]>
2007-05-13 23:45             ` Tom Lane <[email protected]>
2007-05-14 18:47               ` Jim Nasby <[email protected]>
2007-05-30 18:13                 ` Bruce Momjian <[email protected]>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox