Rework help interface of vcregress.pl

Started by Michael Paquierover 9 years ago5 messages
#1Michael Paquier
michael.paquier@gmail.com
1 attachment(s)

Hi all,
(Windows-only be careful)

Horiguchi-san has mentioned yesterday
(/messages/by-id/20160414.172539.34325458.horiguchi.kyotaro@lab.ntt.co.jp)
that we are missing a couple of modes in vcregress.pl in its help
message: modulescheck, bincheck, recoverycheck.

The help message given to users is ugly and unreadable:
$ perl vcregress.pl
Usage: vcregress.pl
<check|installcheck|plcheck|contribcheck|isolationcheck|ecpgcheck|upgradecheck>
[schedule]
So I would like to suggest the attached patch that makes things easier
to understand:
$ perl vcregress.pl
Usage: vcregress.pl <mode> [ <schedule> ]

Options for <mode>:
bincheck run tests of utilities in src/bin/
check deploy instance and run regression tests on it
contribcheck run tests of modules in contrib/
ecpgcheck run regression tests of ECPG driver
installcheck run regression tests on existing instance
isolationcheck run isolation tests
modulescheck run tests of modules in src/test/modules
plcheck run tests of PL languages
recoverycheck run recovery test suite
upgradecheck run tests of pg_upgrade

Options for <schedule>:
serial serial mode
parallel parallel mode

Regards,
--
Michael

Attachments:

msvc-vcregress-help.patchtext/x-patch; charset=US-ASCII; name=msvc-vcregress-help.patchDownload
diff --git a/src/tools/msvc/vcregress.pl b/src/tools/msvc/vcregress.pl
index 3d14544..3348b9f 100644
--- a/src/tools/msvc/vcregress.pl
+++ b/src/tools/msvc/vcregress.pl
@@ -547,7 +547,20 @@ sub InstallTemp
 sub usage
 {
 	print STDERR
-	  "Usage: vcregress.pl ",
-"<check|installcheck|plcheck|contribcheck|isolationcheck|ecpgcheck|upgradecheck> [schedule]\n";
+		"Usage: vcregress.pl <mode> [ <schedule> ]\n\n",
+		"Options for <mode>:\n",
+		"  bincheck       run tests of utilities in src/bin/\n",
+		"  check          deploy instance and run regression tests on it\n",
+		"  contribcheck   run tests of modules in contrib/\n",
+		"  ecpgcheck      run regression tests of ECPG driver\n",
+		"  installcheck   run regression tests on existing instance\n",
+		"  isolationcheck run isolation tests\n",
+		"  modulescheck   run tests of modules in src/test/modules\n",
+		"  plcheck        run tests of PL languages\n",
+		"  recoverycheck  run recovery test suite\n",
+		"  upgradecheck   run tests of pg_upgrade\n",
+		"\nOptions for <schedule>:\n",
+		"  serial         serial mode\n",
+		"  parallel       parallel mode\n";
 	exit(1);
 }
#2Kyotaro HORIGUCHI
horiguchi.kyotaro@lab.ntt.co.jp
In reply to: Michael Paquier (#1)
Re: Rework help interface of vcregress.pl

At Fri, 15 Apr 2016 14:45:33 +0900, Michael Paquier <michael.paquier@gmail.com> wrote in <CAB7nPqQ_8xYDBv0R+k28E+79WY=TCuFG+DGy_GqcyprE5d6Kow@mail.gmail.com>

Hi all,
(Windows-only be careful)

Horiguchi-san has mentioned yesterday
(/messages/by-id/20160414.172539.34325458.horiguchi.kyotaro@lab.ntt.co.jp)
that we are missing a couple of modes in vcregress.pl in its help
message: modulescheck, bincheck, recoverycheck.

The help message given to users is ugly and unreadable:
$ perl vcregress.pl
Usage: vcregress.pl
<check|installcheck|plcheck|contribcheck|isolationcheck|ecpgcheck|upgradecheck>
[schedule]

This seems to be accumultion of gradually edting for every check
modes.

So I would like to suggest the attached patch that makes things easier
to understand:
$ perl vcregress.pl
Usage: vcregress.pl <mode> [ <schedule> ]

It is an issue of this patch, but the command line is not
vcregress.pl, but vcregress[.bat]. However nobody would care
about the difference.

Options for <mode>:
bincheck run tests of utilities in src/bin/
check deploy instance and run regression tests on it
contribcheck run tests of modules in contrib/
ecpgcheck run regression tests of ECPG driver
installcheck run regression tests on existing instance
isolationcheck run isolation tests
modulescheck run tests of modules in src/test/modules
plcheck run tests of PL languages
recoverycheck run recovery test suite
upgradecheck run tests of pg_upgrade

Options for <schedule>:
serial serial mode
parallel parallel mode

This looks good to me but since <schedule> is optional, some
description about default behavior would be needed.

regards,

--
Kyotaro Horiguchi
NTT Open Source Software Center

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers

#3Magnus Hagander
magnus@hagander.net
In reply to: Michael Paquier (#1)
Re: Rework help interface of vcregress.pl

On Fri, Apr 15, 2016 at 7:45 AM, Michael Paquier <michael.paquier@gmail.com>
wrote:

Hi all,
(Windows-only be careful)

Horiguchi-san has mentioned yesterday
(
/messages/by-id/20160414.172539.34325458.horiguchi.kyotaro@lab.ntt.co.jp
)
that we are missing a couple of modes in vcregress.pl in its help
message: modulescheck, bincheck, recoverycheck.

The help message given to users is ugly and unreadable:
$ perl vcregress.pl
Usage: vcregress.pl

<check|installcheck|plcheck|contribcheck|isolationcheck|ecpgcheck|upgradecheck>
[schedule]
So I would like to suggest the attached patch that makes things easier
to understand:
$ perl vcregress.pl
Usage: vcregress.pl <mode> [ <schedule> ]

Options for <mode>:
bincheck run tests of utilities in src/bin/
check deploy instance and run regression tests on it
contribcheck run tests of modules in contrib/
ecpgcheck run regression tests of ECPG driver
installcheck run regression tests on existing instance
isolationcheck run isolation tests
modulescheck run tests of modules in src/test/modules
plcheck run tests of PL languages
recoverycheck run recovery test suite
upgradecheck run tests of pg_upgrade

Options for <schedule>:
serial serial mode
parallel parallel mode

Applied with only very small changes - you had trailing slashes on src/bin
and contrib, but not on src/test/modules. I added it to modules, to make it
consistent. And I removed the "driver" from ECPG, because I'm pretty sure
that's not a driver... And I marked serial mode as the default schedule.

--
Magnus Hagander
Me: http://www.hagander.net/
Work: http://www.redpill-linpro.com/

#4Magnus Hagander
magnus@hagander.net
In reply to: Kyotaro HORIGUCHI (#2)
Re: Rework help interface of vcregress.pl

On Fri, Apr 15, 2016 at 10:03 AM, Kyotaro HORIGUCHI <
horiguchi.kyotaro@lab.ntt.co.jp> wrote:

At Fri, 15 Apr 2016 14:45:33 +0900, Michael Paquier <
michael.paquier@gmail.com> wrote in <CAB7nPqQ_8xYDBv0R+k28E+79WY=
TCuFG+DGy_GqcyprE5d6Kow@mail.gmail.com>

Hi all,
(Windows-only be careful)

Horiguchi-san has mentioned yesterday
(

/messages/by-id/20160414.172539.34325458.horiguchi.kyotaro@lab.ntt.co.jp
)

that we are missing a couple of modes in vcregress.pl in its help
message: modulescheck, bincheck, recoverycheck.

The help message given to users is ugly and unreadable:
$ perl vcregress.pl
Usage: vcregress.pl

<check|installcheck|plcheck|contribcheck|isolationcheck|ecpgcheck|upgradecheck>

[schedule]

This seems to be accumultion of gradually edting for every check
modes.

Yeah. (I noticed you sent this just as I pushed the fix)

So I would like to suggest the attached patch that makes things easier
to understand:
$ perl vcregress.pl
Usage: vcregress.pl <mode> [ <schedule> ]

It is an issue of this patch, but the command line is not
vcregress.pl, but vcregress[.bat]. However nobody would care
about the difference.

The actual usage is for vcregress.pl. vcregress.bat happens to be calling
that one. It's a fine line :)

Options for <mode>:
bincheck run tests of utilities in src/bin/
check deploy instance and run regression tests on it
contribcheck run tests of modules in contrib/
ecpgcheck run regression tests of ECPG driver
installcheck run regression tests on existing instance
isolationcheck run isolation tests
modulescheck run tests of modules in src/test/modules
plcheck run tests of PL languages
recoverycheck run recovery test suite
upgradecheck run tests of pg_upgrade

Options for <schedule>:
serial serial mode
parallel parallel mode

This looks good to me but since <schedule> is optional, some
description about default behavior would be needed.

I had already added that one independently.

Thanks!

//Magnus

#5Michael Paquier
michael.paquier@gmail.com
In reply to: Magnus Hagander (#3)
Re: Rework help interface of vcregress.pl

On Fri, Apr 15, 2016 at 5:07 PM, Magnus Hagander <magnus@hagander.net> wrote:

Applied with only very small changes - you had trailing slashes on src/bin
and contrib, but not on src/test/modules. I added it to modules, to make it
consistent. And I removed the "driver" from ECPG, because I'm pretty sure
that's not a driver... And I marked serial mode as the default schedule.

Thanks for the final push.
--
Michael

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers