BUG #4894: [patch] documentation bug on 'include' directive - Mailing list pgsql-bugs

From Peter Schuller
Subject BUG #4894: [patch] documentation bug on 'include' directive
Date
Msg-id 200906291547.n5TFlXsY057633@wwwmaster.postgresql.org
Whole thread Raw
Responses Re: BUG #4894: [patch] documentation bug on 'include' directive
List pgsql-bugs
The following bug has been logged online:

Bug reference:      4894
Logged by:          Peter Schuller
Email address:      peter.schuller@infidyne.com
PostgreSQL version: CVS
Operating system:   N/A
Description:        [patch] documentation bug on 'include' directive
Details:

The documentation says to use:

  include 'filename'

Which fails with a generic error. Correct syntax is:

  include = 'filename'

Suggested fix:

Since the form is likely to munch whitespace, the authoritative patch is
here:

   http://distfiles.scode.org/mlref/pg-include-doc.patch

For convenience here's a cut'n'paste (which is likely broken):

Index: doc/src/sgml/config.sgml
===================================================================
RCS file: /projects/cvsroot/pgsql/doc/src/sgml/config.sgml,v
retrieving revision 1.220
diff -u -r1.220 config.sgml
--- doc/src/sgml/config.sgml    17 Jun 2009 21:58:48 -0000    1.220
+++ doc/src/sgml/config.sgml    29 Jun 2009 15:44:57 -0000
@@ -82,11 +82,12 @@
     another file to read and process as if it were inserted into the
     configuration file at this point.  Include directives simply look
like:
 <programlisting>
-include 'filename'
+include = 'filename'
 </programlisting>
     If the file name is not an absolute path, it is taken as relative to
     the directory containing the referencing configuration file.
-    Inclusions can be nested.
+    Inclusions can be nested. Contrary to what is implied by the syntax,
+    it is not an assignment and multiple include directives can be used.
    </para>

    <para>

pgsql-bugs by date:

Previous
From: "Kevin Grittner"
Date:
Subject: Re: BUG #4870: don't start service
Next
From: Tom Lane
Date:
Subject: Re: BUG #4894: [patch] documentation bug on 'include' directive