From: Peter Eisentraut <peter@eisentraut.org>
Date: Fri, 20 May 2022 07:26:21 +0000 (+0200)
Subject: pg_waldump: Improve option parsing error messages
X-Git-Tag: REL_15_BETA2~119
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=25f915b31e41e5c86e1905d199c7d41cc66161ed;p=thirdparty%2Fpostgresql.git

pg_waldump: Improve option parsing error messages

I rephrased the error messages to be more in the style of
option_parse_int(), and also made use of the new "detail" message
facility.  I didn't actually use option_parse_int() (which could be
used for -n) because libpgfeutils wasn't used here yet and I wanted to
keep this just to string changes.  But it could be done in the future.
---

diff --git a/src/bin/pg_waldump/pg_waldump.c b/src/bin/pg_waldump/pg_waldump.c
index 3151cb5562b..5dc60109b12 100644
--- a/src/bin/pg_waldump/pg_waldump.c
+++ b/src/bin/pg_waldump/pg_waldump.c
@@ -794,7 +794,7 @@ main(int argc, char **argv)
 				if (sscanf(optarg, "%u", &config.filter_by_relation_block) != 1 ||
 					!BlockNumberIsValid(config.filter_by_relation_block))
 				{
-					pg_log_error("could not parse valid block number \"%s\"", optarg);
+					pg_log_error("invalid block number: \"%s\"", optarg);
 					goto bad_argument;
 				}
 				config.filter_by_relation_block_enabled = true;
@@ -803,7 +803,7 @@ main(int argc, char **argv)
 			case 'e':
 				if (sscanf(optarg, "%X/%X", &xlogid, &xrecoff) != 2)
 				{
-					pg_log_error("could not parse end WAL location \"%s\"",
+					pg_log_error("invalid WAL location: \"%s\"",
 								 optarg);
 					goto bad_argument;
 				}
@@ -816,7 +816,7 @@ main(int argc, char **argv)
 				config.filter_by_relation_forknum = forkname_to_number(optarg);
 				if (config.filter_by_relation_forknum == InvalidForkNumber)
 				{
-					pg_log_error("could not parse fork \"%s\"", optarg);
+					pg_log_error("invalid fork name: \"%s\"", optarg);
 					goto bad_argument;
 				}
 				config.filter_by_extended = true;
@@ -824,7 +824,7 @@ main(int argc, char **argv)
 			case 'n':
 				if (sscanf(optarg, "%d", &config.stop_after_records) != 1)
 				{
-					pg_log_error("could not parse limit \"%s\"", optarg);
+					pg_log_error("invalid value \"%s\" for option %s", optarg, "-n/--limit");
 					goto bad_argument;
 				}
 				break;
@@ -891,9 +891,8 @@ main(int argc, char **argv)
 					!OidIsValid(config.filter_by_relation.spcNode) ||
 					!OidIsValid(config.filter_by_relation.relNode))
 				{
-					pg_log_error("could not parse valid relation from \"%s\""
-								 " (expecting \"tablespace OID/database OID/"
-								 "relation filenode\")", optarg);
+					pg_log_error("invalid relation specification: \"%s\"", optarg);
+					pg_log_error_detail("Expecting \"tablespace OID/database OID/relation filenode\".");
 					goto bad_argument;
 				}
 				config.filter_by_relation_enabled = true;
@@ -902,7 +901,7 @@ main(int argc, char **argv)
 			case 's':
 				if (sscanf(optarg, "%X/%X", &xlogid, &xrecoff) != 2)
 				{
-					pg_log_error("could not parse start WAL location \"%s\"",
+					pg_log_error("invalid WAL location: \"%s\"",
 								 optarg);
 					goto bad_argument;
 				}
@@ -912,7 +911,7 @@ main(int argc, char **argv)
 			case 't':
 				if (sscanf(optarg, "%u", &private.timeline) != 1)
 				{
-					pg_log_error("could not parse timeline \"%s\"", optarg);
+					pg_log_error("invalid timeline specification: \"%s\"", optarg);
 					goto bad_argument;
 				}
 				break;
@@ -922,7 +921,7 @@ main(int argc, char **argv)
 			case 'x':
 				if (sscanf(optarg, "%u", &config.filter_by_xid) != 1)
 				{
-					pg_log_error("could not parse \"%s\" as a transaction ID",
+					pg_log_error("invalid transaction ID specification: \"%s\"",
 								 optarg);
 					goto bad_argument;
 				}
@@ -937,8 +936,8 @@ main(int argc, char **argv)
 						config.stats_per_record = true;
 					else if (strcmp(optarg, "rmgr") != 0)
 					{
-						pg_log_error("unrecognized argument to --stats: %s",
-									 optarg);
+						pg_log_error("unrecognized value for option %s: %s",
+									 "--stats", optarg);
 						goto bad_argument;
 					}
 				}
@@ -951,7 +950,8 @@ main(int argc, char **argv)
 	if (config.filter_by_relation_block_enabled &&
 		!config.filter_by_relation_enabled)
 	{
-		pg_log_error("--block option requires --relation option to be specified");
+		pg_log_error("option %s requires option %s to be specified",
+					 "-B/--block", "-R/--relation");
 		goto bad_argument;
 	}