[Doc] Tiny fix for regression tests example

Started by tanghy.fnst@fujitsu.comover 4 years ago4 messages
#1tanghy.fnst@fujitsu.com
tanghy.fnst@fujitsu.com
1 attachment(s)

Hi

When reading PG DOC, found some example code not correct as it said.

https://www.postgresql.org/docs/devel/regress-run.html

Here's a tiny fix in regress.sgml.

-make check PGOPTIONS="-c log_checkpoints=on -c work_mem=50MB"

+make check PGOPTIONS="-c geqo=off -c work_mem=50MB"

log_checkpoints couldn't be set in PGOPTIONS.

Replace log_checkpoints with geqo in the example code.

-make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"

+make check EXTRA_REGRESS_OPTS="--temp-config=$(pwd)/test_postgresql.conf"

User needs to specify $(pwd) to let the command execute as expected.

The above example code is added by Peter in PG14. So I think we need to apply this fix at PG14/master.

I proposed this fix at pgsql-docs@lists.postgresql.org<mailto:pgsql-docs@lists.postgresql.org> at [1]/messages/by-id/OS0PR01MB6113FA937648B8F7A372359BFB009@OS0PR01MB6113.jpnprd01.prod.outlook.com. But no reply except Craig. So I please allow me to post the patch at Hackers’ mail list again in case the fix is missed.

[1]: /messages/by-id/OS0PR01MB6113FA937648B8F7A372359BFB009@OS0PR01MB6113.jpnprd01.prod.outlook.com

Regards,

Tang

Attachments:

0001-minor-fix-for-regress-example.patchapplication/octet-stream; name=0001-minor-fix-for-regress-example.patchDownload
From e3c3b3422d66f48e2397af247ad831f6fc6cf373 Mon Sep 17 00:00:00 2001
From: tanghy <tanghy.fnst@fujitsu.com>
Date: Thu, 1 Jul 2021 15:40:06 +0900
Subject: [PATCH] minor fix for regress example


diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index cb401a45b3..5e8fa29f9e 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -359,14 +359,14 @@ make check LANG=C ENCODING=EUC_JP
     set in the <varname>PGOPTIONS</varname> environment variable (for settings
     that allow this):
 <screen>
-make check PGOPTIONS="-c log_checkpoints=on -c work_mem=50MB"
+make check PGOPTIONS="-c geqo=off -c work_mem=50MB"
 </screen>
     When running against a temporary installation, custom settings can also be
     set by supplying a pre-written <filename>postgresql.conf</filename>:
 <screen>
 echo 'log_checkpoints = on' > test_postgresql.conf
 echo 'work_mem = 50MB' >> test_postgresql.conf
-make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"
+make check EXTRA_REGRESS_OPTS="--temp-config=$(pwd)/test_postgresql.conf"
 </screen>
    </para>
 
-- 
2.31.1.windows.1

#2Michael Paquier
michael@paquier.xyz
In reply to: tanghy.fnst@fujitsu.com (#1)
Re: [Doc] Tiny fix for regression tests example

On Fri, Jul 23, 2021 at 06:12:02AM +0000, tanghy.fnst@fujitsu.com wrote:

Here's a tiny fix in regress.sgml.

-make check PGOPTIONS="-c log_checkpoints=on -c work_mem=50MB"
+make check PGOPTIONS="-c geqo=off -c work_mem=50MB"

log_checkpoints couldn't be set in PGOPTIONS.

Replace log_checkpoints with geqo in the example code.

Right, that won't work. What about using something more
developer-oriented here, say force_parallel_mode=regress?

-make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"
+make check EXTRA_REGRESS_OPTS="--temp-config=$(pwd)/test_postgresql.conf"

User needs to specify $(pwd) to let the command execute as expected.

This works as-is.
--
Michael

#3tanghy.fnst@fujitsu.com
tanghy.fnst@fujitsu.com
In reply to: Michael Paquier (#2)
1 attachment(s)
RE: [Doc] Tiny fix for regression tests example

On Monday, July 26, 2021 1:04 PM, Michael Paquier <michael@paquier.xyz> wrote:

-make check PGOPTIONS="-c log_checkpoints=on -c work_mem=50MB"
+make check PGOPTIONS="-c geqo=off -c work_mem=50MB"

log_checkpoints couldn't be set in PGOPTIONS.

Replace log_checkpoints with geqo in the example code

Right, that won't work. What about using something more
developer-oriented here, say force_parallel_mode=regress?

Thanks for your comment. Agree with your suggestion.
Modified it in the attachment patch.

Regards,
Tang

Attachments:

V2-0001-minor-fix-for-regress-example.patchapplication/octet-stream; name=V2-0001-minor-fix-for-regress-example.patchDownload
From 2afc4ba6e0e8795ec6a910d5c3743cf145286dd4 Mon Sep 17 00:00:00 2001
From: tanghy <tanghy.fnst@fujitsu.com>
Date: Mon, 26 Jul 2021 14:45:30 +0900
Subject: [PATCH] minor fix for regress example


diff --git a/doc/src/sgml/regress.sgml b/doc/src/sgml/regress.sgml
index acc7a50c2f..4b4efc5f26 100644
--- a/doc/src/sgml/regress.sgml
+++ b/doc/src/sgml/regress.sgml
@@ -359,14 +359,14 @@ make check LANG=C ENCODING=EUC_JP
     set in the <varname>PGOPTIONS</varname> environment variable (for settings
     that allow this):
 <screen>
-make check PGOPTIONS="-c log_checkpoints=on -c work_mem=50MB"
+make check PGOPTIONS="-c force_parallel_mode=regress -c work_mem=50MB"
 </screen>
     When running against a temporary installation, custom settings can also be
     set by supplying a pre-written <filename>postgresql.conf</filename>:
 <screen>
 echo 'log_checkpoints = on' > test_postgresql.conf
 echo 'work_mem = 50MB' >> test_postgresql.conf
-make check EXTRA_REGRESS_OPTS="--temp-config=test_postgresql.conf"
+make check EXTRA_REGRESS_OPTS="--temp-config=$(pwd)/test_postgresql.conf"
 </screen>
    </para>
 
-- 
2.31.1.windows.1

#4Michael Paquier
michael@paquier.xyz
In reply to: tanghy.fnst@fujitsu.com (#3)
Re: [Doc] Tiny fix for regression tests example

On Mon, Jul 26, 2021 at 05:50:28AM +0000, tanghy.fnst@fujitsu.com wrote:

Thanks for your comment. Agree with your suggestion.
Modified it in the attachment patch.

Okay, applied, but without the pwd part.
--
Michael