On Fri, Jan 31, 2014 at 6:09 AM, Robert Haas <robertmh...@gmail.com> wrote:
> On Thu, Jan 30, 2014 at 3:32 AM, Christian Kruse
> <christ...@2ndquadrant.com> wrote:
>>> For the documentation patch, I propose the attached to avoid future
>>> confusions. Comments? It might make sense to back-patch as well.
>>
>> Compiles, didn't find any typos and I think it is comprehensible.
>
> I took a look at this with a view to committing it but on examination
> I'm not sure this is the best way to proceed. The proposed text
> documents that the tests should be run in a database called
> regression, but the larger documentation chapter of which this section
> is a part never explains how to run them anywhere else, so it feels a
> bit like telling a ten-year-old not to burn out the clutch.
>
> The bit about not changing enable_* probably belongs, if anywhere, in
> section 30.2, on test evaluation, rather than here.
And what about the attached? I have moved all the content to 30.2, and
added two paragraphs: one about the planner flags, the other about the
database used.
Regards,
--
Michael
*** a/doc/src/sgml/regress.sgml
--- b/doc/src/sgml/regress.sgml
***************
*** 471,476 **** diff results/random.out expected/random.out
--- 471,510 ----
not worry unless the random test fails repeatedly.
</para>
</sect2>
+
+ <sect2>
+ <title>Planner Configuration parameters</title>
+
+ <para>
+ Parameters able to change the planning of queries like enable/disable
+ flags described in <xref linkend="runtime-config-query-enable"> for
+ <command>EXPLAIN</> should use default values.
+ </para>
+ </sect2>
+
+ <sect2>
+ <title>Database Name</title>
+
+ <para>
+ Regression tests should be run on a database named <literal>regression</>
+ to prevent failures of tests using directly or indirectly the current
+ database name in output results. The tests that would fail in this case
+ include <literal>updatable_views</literal>, <literal>foreign_data</literal>,
+ <literal>xml_map</literal> and <literal>sequence</literal>.
+ </para>
+
+ <para>
+ <literal>regression</> is the default database name for tests of core,
+ and contrib modules use <literal>contrib_regression</> as default.
+ </para>
+
+ <para>
+ Running regression tests with <application>pg_regress</application>
+ causes the existed database to be dropped before running the tests,
+ so be sure that there is not already a database with the same name
+ existing on server before running it.
+ </para>
+ </sect2>
</sect1>
<!-- We might want to move the following section into the developer's guide. -->
--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers
