public inbox for [email protected]
help / color / mirror / Atom feedindexterm of pg_notify
6+ messages / 4 participants
[nested] [flat]
* indexterm of pg_notify
@ 2010-05-17 12:49 Fujii Masao <[email protected]>
2010-05-17 15:33 ` Re: indexterm of pg_notify Robert Haas <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Fujii Masao @ 2010-05-17 12:49 UTC (permalink / raw)
To: pgsql-docs
Hi,
In the index of current document, "pg_notify" is tied to the
word "Notes". This is odd for me.
http://developer.postgresql.org/pgdocs/postgres/bookindex.html
How about the patch to tie "pg_notify" to "NOTIFY"?
Regards,
--
Fujii Masao
NIPPON TELEGRAPH AND TELEPHONE CORPORATION
NTT Open Source Software Center
Attachments:
[application/octet-stream] pg_notify_indexterm.patch (443B, 2-pg_notify_indexterm.patch)
download | inline diff:
*** a/doc/src/sgml/ref/notify.sgml
--- b/doc/src/sgml/ref/notify.sgml
***************
*** 152,158 **** NOTIFY <replaceable class="PARAMETER">channel</replaceable> [ , <replaceable cla
<refsect1>
<title>Notes</title>
! <indexterm>
<primary>pg_notify</primary>
</indexterm>
--- 152,158 ----
<refsect1>
<title>Notes</title>
! <indexterm zone="sql-notify">
<primary>pg_notify</primary>
</indexterm>
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: indexterm of pg_notify
2010-05-17 12:49 indexterm of pg_notify Fujii Masao <[email protected]>
@ 2010-05-17 15:33 ` Robert Haas <[email protected]>
2010-05-17 15:38 ` Re: indexterm of pg_notify Tom Lane <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Robert Haas @ 2010-05-17 15:33 UTC (permalink / raw)
To: Fujii Masao <[email protected]>; +Cc: pgsql-docs
On Mon, May 17, 2010 at 8:49 AM, Fujii Masao <[email protected]> wrote:
> Hi,
>
> In the index of current document, "pg_notify" is tied to the
> word "Notes". This is odd for me.
> http://developer.postgresql.org/pgdocs/postgres/bookindex.html
>
> How about the patch to tie "pg_notify" to "NOTIFY"?
I think that's because the "Notes" section of that page is the only
place in the documentation that pg_notify() is mentioned... I agree
it looks a little weird, but it's nice that it jumps to the specific
section of the page that is relevant.
--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise Postgres Company
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: indexterm of pg_notify
2010-05-17 12:49 indexterm of pg_notify Fujii Masao <[email protected]>
2010-05-17 15:33 ` Re: indexterm of pg_notify Robert Haas <[email protected]>
@ 2010-05-17 15:38 ` Tom Lane <[email protected]>
2010-05-17 19:39 ` Re: indexterm of pg_notify Alvaro Herrera <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Tom Lane @ 2010-05-17 15:38 UTC (permalink / raw)
To: Robert Haas <[email protected]>; +Cc: Fujii Masao <[email protected]>; pgsql-docs
Robert Haas <[email protected]> writes:
> On Mon, May 17, 2010 at 8:49 AM, Fujii Masao <[email protected]> wrote:
>> In the index of current document, "pg_notify" is tied to the
>> word "Notes". This is odd for me.
> I think that's because the "Notes" section of that page is the only
> place in the documentation that pg_notify() is mentioned... I agree
> it looks a little weird, but it's nice that it jumps to the specific
> section of the page that is relevant.
Yeah, the link would be less useful if it just pointed to the whole
page. It would be nice though if the index entry said something more
specific than "Notes", perhaps "NOTIFY Notes". Is there a way to
control the label used for an index link?
regards, tom lane
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: indexterm of pg_notify
2010-05-17 12:49 indexterm of pg_notify Fujii Masao <[email protected]>
2010-05-17 15:33 ` Re: indexterm of pg_notify Robert Haas <[email protected]>
2010-05-17 15:38 ` Re: indexterm of pg_notify Tom Lane <[email protected]>
@ 2010-05-17 19:39 ` Alvaro Herrera <[email protected]>
2010-05-18 02:15 ` Re: indexterm of pg_notify Fujii Masao <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Alvaro Herrera @ 2010-05-17 19:39 UTC (permalink / raw)
To: Tom Lane <[email protected]>; +Cc: Robert Haas <[email protected]>; Fujii Masao <[email protected]>; pgsql-docs
Excerpts from Tom Lane's message of lun may 17 11:38:29 -0400 2010:
> Yeah, the link would be less useful if it just pointed to the whole
> page. It would be nice though if the index entry said something more
> specific than "Notes", perhaps "NOTIFY Notes". Is there a way to
> control the label used for an index link?
Doesn't look like there is :-(
--
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: indexterm of pg_notify
2010-05-17 12:49 indexterm of pg_notify Fujii Masao <[email protected]>
2010-05-17 15:33 ` Re: indexterm of pg_notify Robert Haas <[email protected]>
2010-05-17 15:38 ` Re: indexterm of pg_notify Tom Lane <[email protected]>
2010-05-17 19:39 ` Re: indexterm of pg_notify Alvaro Herrera <[email protected]>
@ 2010-05-18 02:15 ` Fujii Masao <[email protected]>
2010-05-18 02:29 ` Re: indexterm of pg_notify Robert Haas <[email protected]>
0 siblings, 1 reply; 6+ messages in thread
From: Fujii Masao @ 2010-05-18 02:15 UTC (permalink / raw)
To: Alvaro Herrera <[email protected]>; +Cc: Tom Lane <[email protected]>; Robert Haas <[email protected]>; pgsql-docs
On Tue, May 18, 2010 at 4:39 AM, Alvaro Herrera <[email protected]> wrote:
> Excerpts from Tom Lane's message of lun may 17 11:38:29 -0400 2010:
>
>> Yeah, the link would be less useful if it just pointed to the whole
>> page. It would be nice though if the index entry said something more
>> specific than "Notes", perhaps "NOTIFY Notes". Is there a way to
>> control the label used for an index link?
>
> Doesn't look like there is :-(
How about creating new subsection "pg_notify" under "Notes" and placing
the description about pg_notify in it? Here is the patch.
Regards,
--
Fujii Masao
NIPPON TELEGRAPH AND TELEPHONE CORPORATION
NTT Open Source Software Center
Attachments:
[application/octet-stream] pg_notify_indexterm_v2.patch (1.7K, 2-pg_notify_indexterm_v2.patch)
download | inline diff:
*** a/doc/src/sgml/ref/notify.sgml
--- b/doc/src/sgml/ref/notify.sgml
***************
*** 152,169 **** NOTIFY <replaceable class="PARAMETER">channel</replaceable> [ , <replaceable cla
<refsect1>
<title>Notes</title>
- <indexterm>
- <primary>pg_notify</primary>
- </indexterm>
-
- <para>
- To send a notification you can also use the function
- <literal><function>pg_notify</function>(<type>text</type>,
- <type>text</type>)</literal>. The function takes the channel name as the
- first argument and the payload as the second. The function is much easier
- to use than the <command>NOTIFY</command> command if you need to work with
- non-constant channel names and payloads.
- </para>
<para>
There is a queue that holds notifications that have been sent but not
yet processed by all listening sessions. If this queue becomes full,
--- 152,157 ----
***************
*** 180,185 **** NOTIFY <replaceable class="PARAMETER">channel</replaceable> [ , <replaceable cla
--- 168,190 ----
A transaction that has executed <command>NOTIFY</command> cannot be
prepared for two-phase commit.
</para>
+
+ <refsect2>
+ <title>pg_notify</title>
+
+ <indexterm>
+ <primary>pg_notify</primary>
+ </indexterm>
+
+ <para>
+ To send a notification you can also use the function
+ <literal><function>pg_notify</function>(<type>text</type>,
+ <type>text</type>)</literal>. The function takes the channel name as the
+ first argument and the payload as the second. The function is much easier
+ to use than the <command>NOTIFY</command> command if you need to work with
+ non-constant channel names and payloads.
+ </para>
+ </refsect2>
</refsect1>
<refsect1>
^ permalink raw reply [nested|flat] 6+ messages in thread
* Re: indexterm of pg_notify
2010-05-17 12:49 indexterm of pg_notify Fujii Masao <[email protected]>
2010-05-17 15:33 ` Re: indexterm of pg_notify Robert Haas <[email protected]>
2010-05-17 15:38 ` Re: indexterm of pg_notify Tom Lane <[email protected]>
2010-05-17 19:39 ` Re: indexterm of pg_notify Alvaro Herrera <[email protected]>
2010-05-18 02:15 ` Re: indexterm of pg_notify Fujii Masao <[email protected]>
@ 2010-05-18 02:29 ` Robert Haas <[email protected]>
0 siblings, 0 replies; 6+ messages in thread
From: Robert Haas @ 2010-05-18 02:29 UTC (permalink / raw)
To: Fujii Masao <[email protected]>; +Cc: Alvaro Herrera <[email protected]>; Tom Lane <[email protected]>; pgsql-docs
On Mon, May 17, 2010 at 10:15 PM, Fujii Masao <[email protected]> wrote:
> On Tue, May 18, 2010 at 4:39 AM, Alvaro Herrera <[email protected]> wrote:
>> Excerpts from Tom Lane's message of lun may 17 11:38:29 -0400 2010:
>>
>>> Yeah, the link would be less useful if it just pointed to the whole
>>> page. It would be nice though if the index entry said something more
>>> specific than "Notes", perhaps "NOTIFY Notes". Is there a way to
>>> control the label used for an index link?
>>
>> Doesn't look like there is :-(
>
> How about creating new subsection "pg_notify" under "Notes" and placing
> the description about pg_notify in it? Here is the patch.
Looks good to me. Committed.
--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise Postgres Company
^ permalink raw reply [nested|flat] 6+ messages in thread
end of thread, other threads:[~2010-05-18 02:29 UTC | newest]
Thread overview: 6+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2010-05-17 12:49 indexterm of pg_notify Fujii Masao <[email protected]>
2010-05-17 15:33 ` Robert Haas <[email protected]>
2010-05-17 15:38 ` Tom Lane <[email protected]>
2010-05-17 19:39 ` Alvaro Herrera <[email protected]>
2010-05-18 02:15 ` Fujii Masao <[email protected]>
2010-05-18 02:29 ` Robert Haas <[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