1
0
mirror of https://github.com/postgres/postgres.git synced 2025-05-28 05:21:27 +03:00
Tom Lane ae67e81edb Fix documentation for libpq's PQfn().
The SGML docs claimed that 1-byte integers could be sent or received with
the "isint" options, but no such behavior has ever been implemented in
pqGetInt() or pqPutInt().  The in-code documentation header for PQfn() was
even less in tune with reality, and the code itself used parameter names
matching neither the SGML docs nor its libpq-fe.h declaration.  Do a bit
of additional wordsmithing on the SGML docs while at it.

Since the business about 1-byte integers is a clear documentation bug,
back-patch to all supported branches.
2015-03-08 13:35:44 -04:00
..
2010-09-20 22:08:53 +02:00
2013-10-21 06:23:06 -04:00
2010-09-20 22:08:53 +02:00
2015-02-11 11:14:14 +01:00
2012-12-22 15:01:45 -05:00
2010-09-20 22:08:53 +02:00
2010-09-20 22:08:53 +02:00
2012-10-17 09:19:24 +01:00
2010-09-20 22:08:53 +02:00
2015-01-06 11:43:46 -05:00
2014-08-30 11:04:12 -05:00
2012-12-08 07:38:02 -05:00
2014-08-30 11:04:12 -05:00
2012-04-24 21:16:07 +03:00
2014-11-01 11:33:48 -04:00
2014-08-30 11:04:12 -05:00
2014-08-30 11:04:12 -05:00
2012-04-12 10:43:39 -04:00
2014-08-30 11:04:12 -05:00
2014-08-30 11:04:12 -05:00

<!-- doc/src/sgml/README.links -->

Linking within SGML documents can be confusing, so here is a summary:


Intra-document Linking
----------------------

<xref>
	use to get chapter/section # from the title of the target
	link, or xreflabel if defined at the target; has no close tag
	http://www.oasis-open.org/docbook/documentation/reference/html/xref.html

<link>
	use to supply text for the link, requires </link>
	http://www.oasis-open.org/docbook/documentation/reference/html/link.html

linkend=
	controls the target of the link/xref, required

endterm=
	for <xref>, allows the text of the link/xref to be taken from a
	different link target title


External Linking
----------------

<ulink>
	like <link>, but uses a URL (not a document target);  requires
	</ulink>; if no text is specified, the URL appears as the link
	text
	http://www.oasis-open.org/docbook/documentation/reference/html/ulink.html

url=
	used by <ulink> to specify the URL, required


Guidelines
----------

o  If you want to supply text, use <link>, else <xref>
o  Do not use text with <ulink> so the URL appears in printed output
o  Specific nouns like GUC variables, SQL commands, and contrib modules
   usually have xreflabels