Re: Doc reference of contrib modules

Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > Tom Lane wrote:
> >> That's not just awkward, but flat wrong, because the link points to
> >> documentation of the module not the function.
>
> > The tag for the dblink module is:
>
> >     <sect1 id="dblink">
>
> > the function's tag is:
>
> >      <refentry id="CONTRIB-DBLINK">
>
> > so I believe the text in the patch is correct.  (Yes, I realize those
> > are confusing tags.)
>
> Oh.  Please change the function's tag to something a bit saner while
> you're messing around with this, FUNCTION-DBLINK perhaps?

OK, done in attached patch.  (Git does allow easier incremental patch
generation.)

> I still think that a link to the contrib module's page would be a good
> thing to provide here.

Yep, but how to do it in a clear way?

--
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + It's impossible for everything to be true. +
commit 82f2051a17355ec1bc00b969052967f7d6a59817
Author: Bruce Momjian <bruce@momjian.us>
Date:   Tue Jan 25 10:52:26 2011 -0500

    Raname doc link for dblink() to "CONTRIB-DBLINK-FUNCTION", for clarity.

diff --git a/doc/src/sgml/dblink.sgml b/doc/src/sgml/dblink.sgml
index 0e9cd22..295544e 100644
*** /tmp/QezWFa_dblink.sgml    Tue Jan 25 10:53:18 2011
--- /tmp/4vCDsa_dblink.sgml    Tue Jan 25 10:53:18 2011
*************** SELECT dblink_disconnect('myconn');
*** 303,309 ****
    </refsect1>
   </refentry>

!  <refentry id="CONTRIB-DBLINK">
    <refmeta>
     <refentrytitle>dblink</refentrytitle>
     <manvolnum>3</manvolnum>
--- 303,309 ----
    </refsect1>
   </refentry>

!  <refentry id="CONTRIB-DBLINK-FUNCTION">
    <refmeta>
     <refentrytitle>dblink</refentrytitle>
     <manvolnum>3</manvolnum>
diff --git a/doc/src/sgml/queries.sgml b/doc/src/sgml/queries.sgml
index 3227b09..b995ff1 100644
*** /tmp/ogNVLa_queries.sgml    Tue Jan 25 10:53:18 2011
--- /tmp/sUYrkb_queries.sgml    Tue Jan 25 10:53:18 2011
*************** SELECT *
*** 686,692 ****
        AS t1(proname name, prosrc text)
      WHERE proname LIKE 'bytea%';
  </programlisting>
!      The <link linkend="CONTRIB-DBLINK">dblink</> function executes
       a remote query.  It is declared to return
       <type>record</> since it might be used for any kind of query.
       The actual column set must be specified in the calling query so
--- 686,692 ----
        AS t1(proname name, prosrc text)
      WHERE proname LIKE 'bytea%';
  </programlisting>
!      The <link linkend="CONTRIB-DBLINK-FUNCTION">dblink</> function executes
       a remote query.  It is declared to return
       <type>record</> since it might be used for any kind of query.
       The actual column set must be specified in the calling query so