Re: lo_unlink documentation error

Good catch.  Patch attached and applied.

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

Warwick Hunter wrote:
> I noticed a small but misleading documentation error.
>
> /usr/share/doc/postgresql-7.2/html/lo-interfaces.html
> ======================================================
> 2.3.9. Removing a Large Object
>
> To remove a large object from the database, call
>
> Oid lo_unlink(PGconn *conn, Oid lobjId)
>
> The lobjId argument specifies the OID of the large object to remove.
> ======================================================
> The return value for lo_unlink is described in the documentation as Oid.
>
>
> In the header file /usr/include/libpq-fe.h
> ======================================================
>
> /* === in fe-lobj.c === */
>
> /* Large-object access routines */
> ...
> extern int    lo_unlink(PGconn *conn, Oid lobjId);
> ...
> ======================================================
> The return value for lo_unlink is defined as an int.
>
> Presumably the header file is correct. Perhaps the
> documentation should read like lo_close:
>
> "On success, lo_unlink returns zero. On error, the return value is
> negative."
>
> Warwick
> --
> Warwick Hunter                    Agile TV Corporation
> Voice: +61 7 5584 5912            Fax: +61 7 5575 9550
> mailto:whunter@oz.agile.tv        http://www.agile.tv
>
>
> ---------------------------(end of broadcast)---------------------------
> TIP 3: if posting/reading through Usenet, please send an appropriate
> subscribe-nomail command to majordomo@postgresql.org so that your
> message can get through to the mailing list cleanly
>

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
Index: doc/src/sgml/lobj.sgml
===================================================================
RCS file: /cvsroot/pgsql/doc/src/sgml/lobj.sgml,v
retrieving revision 1.26
diff -c -r1.26 lobj.sgml
*** doc/src/sgml/lobj.sgml    20 Jan 2002 22:19:56 -0000    1.26
--- doc/src/sgml/lobj.sgml    18 Apr 2002 14:24:03 -0000
***************
*** 267,276 ****
      <para>
       To remove a large object from the database, call
  <synopsis>
! Oid lo_unlink(PGconn *<replaceable class="parameter">conn</replaceable>, Oid lobjId)
  </synopsis>
       The <parameter>lobjId</parameter> argument specifies  the  OID  of  the  large
!      object  to  remove.
      </para>
     </sect2>

--- 267,276 ----
      <para>
       To remove a large object from the database, call
  <synopsis>
! int lo_unlink(PGconn *<replaceable class="parameter">conn</replaceable>, Oid lobjId)
  </synopsis>
       The <parameter>lobjId</parameter> argument specifies  the  OID  of  the  large
!      object  to  remove.  In the event of an error, the return value is negative.
      </para>
     </sect2>