1
0
mirror of https://github.com/postgres/postgres.git synced 2025-10-24 01:29:19 +03:00

Convert documentation to DocBook XML

Since some preparation work had already been done, the only source
changes left were changing empty-element tags like <xref linkend="foo">
to <xref linkend="foo"/>, and changing the DOCTYPE.

The source files are still named *.sgml, but they are actually XML files
now.  Renaming could be considered later.

In the build system, the intermediate step to convert from SGML to XML
is removed.  Everything is build straight from the source files again.
The OpenSP (or the old SP) package is no longer needed.

The documentation toolchain instructions are updated and are much
simpler now.

Peter Eisentraut, Alexander Lakhin, Jürgen Purtz
This commit is contained in:
Peter Eisentraut
2017-11-23 09:39:47 -05:00
parent 2f8d6369e6
commit 3c49c6facb
346 changed files with 4260 additions and 4588 deletions

View File

@@ -29,7 +29,7 @@
special pseudo-type identifies the function as a call handler and
prevents it from being called directly in SQL commands.
For more details on C language calling conventions and dynamic loading,
see <xref linkend="xfunc-c">.
see <xref linkend="xfunc-c"/>.
</para>
<para>
@@ -144,7 +144,7 @@ plsample_call_handler(PG_FUNCTION_ARGS)
<para>
After having compiled the handler function into a loadable module
(see <xref linkend="dfunc">), the following commands then
(see <xref linkend="dfunc"/>), the following commands then
register the sample procedural language:
<programlisting>
CREATE FUNCTION plsample_call_handler() RETURNS language_handler
@@ -162,9 +162,9 @@ CREATE LANGUAGE plsample
are a <firstterm>validator</firstterm> and an
<firstterm>inline handler</firstterm>. A validator can be provided
to allow language-specific checking to be done during
<xref linkend="sql-createfunction">.
<xref linkend="sql-createfunction"/>.
An inline handler can be provided to allow the language to support
anonymous code blocks executed via the <xref linkend="sql-do"> command.
anonymous code blocks executed via the <xref linkend="sql-do"/> command.
</para>
<para>
@@ -191,7 +191,7 @@ CREATE LANGUAGE plsample
<para>
Validator functions should typically honor the <xref
linkend="guc-check-function-bodies"> parameter: if it is turned off then
linkend="guc-check-function-bodies"/> parameter: if it is turned off then
any expensive or context-sensitive checking should be skipped. If the
language provides for code execution at compilation time, the validator
must suppress checks that would induce such execution. In particular,
@@ -230,7 +230,7 @@ CREATE LANGUAGE plsample
as well as the <command>CREATE LANGUAGE</command> command itself, into
an <firstterm>extension</firstterm> so that a simple <command>CREATE EXTENSION</command>
command is sufficient to install the language. See
<xref linkend="extend-extensions"> for information about writing
<xref linkend="extend-extensions"/> for information about writing
extensions.
</para>
@@ -238,7 +238,7 @@ CREATE LANGUAGE plsample
The procedural languages included in the standard distribution
are good references when trying to write your own language handler.
Look into the <filename>src/pl</filename> subdirectory of the source tree.
The <xref linkend="sql-createlanguage">
The <xref linkend="sql-createlanguage"/>
reference page also has some useful details.
</para>