1
0
mirror of https://github.com/postgres/postgres.git synced 2025-08-28 18:48:04 +03:00
Files
postgres/doc/src/sgml
Tom Lane cbc8d65639 Code + docs review for escaping of option values (commit 11a020eb6).
Avoid memory leak from incorrect choice of how to free a StringInfo
(resetStringInfo doesn't do it).  Now that pg_split_opts doesn't scribble
on the optstr, mark that as "const" for clarity.  Attach the commentary in
protocol.sgml to the right place, and add documentation about the
user-visible effects of this change on postgres' -o option and libpq's
PGOPTIONS option.
2015-06-29 12:42:52 -04:00
..
2014-05-06 21:28:58 -04:00
2015-06-08 15:37:42 -03:00
2015-06-20 12:26:36 -03:00
2015-05-16 13:28:26 -04:00
2015-05-28 13:02:09 -04:00
2014-02-23 21:31:08 -05:00
2015-04-24 12:00:49 -04:00
2015-02-10 12:04:10 +01:00
2015-06-11 00:09:32 -04:00
2015-06-29 00:01:26 +03:00
2015-04-26 10:33:14 -04:00
2015-04-26 10:33:14 -04:00
2015-01-06 11:43:47 -05:00
2015-01-06 11:43:47 -05:00
2015-05-17 14:58:04 +02:00
2015-04-12 19:07:46 +02:00
2014-07-08 23:29:25 -04:00
2014-05-06 21:28:58 -04:00
2014-11-01 11:31:35 -04:00
2014-08-30 10:52:36 -05:00
2015-05-15 15:40:52 -04:00
2015-04-26 10:33:14 -04:00
2015-06-11 00:09:32 -04:00
2014-05-06 21:28:58 -04:00
2014-07-16 22:48:11 -04:00
2014-05-06 21:28:58 -04:00
2015-06-03 20:19:47 -04:00
2014-07-16 22:48:11 -04:00
2014-08-30 10:52:36 -05:00
2014-08-30 10:52:36 -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 number from the title of the target
	link, or xreflabel if defined at the target, or refentrytitle if target
        is a refentry;  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