Fix typos and grammar in code comments and docs

michaelpq · michaelpq · commit 4236825197e8 · 2024-09-03T14:49:04.000+09:00
Author: Alexander Lakhin Discussion: https://postgr.es/m/f7e514cf-2446-21f1-a5d2-8c089a6e2168@gmail.com
diff --git a/contrib/test_decoding/specs/skip_snapshot_restore.spec b/contrib/test_decoding/specs/skip_snapshot_restore.spec
@@ -39,7 +39,7 @@ step "s2_get_changes_slot0" { SELECT data FROM pg_logical_slot_get_changes('slot
 # serializes consistent snapshots to the disk at LSNs where are before
 # s0-transaction's commit. After s0-transaction commits, "s1_init" resumes but
 # must not restore any serialized snapshots and will reach the consistent state
-# when decoding a RUNNING_XACT record generated after s0-transaction's commit.
+# when decoding a RUNNING_XACTS record generated after s0-transaction's commit.
 # We check if the get_changes on 'slot1' will not return any s0-transaction's
 # changes as its confirmed_flush_lsn will be after the s0-transaction's commit
 # record.
diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml
@@ -3891,8 +3891,8 @@ static const PgStat_KindInfo custom_stats = {
      it with <literal>pgstat_register_kind</literal> and a unique ID used to
      store the entries related to this type of statistics:
 <programlisting>
-extern PgStat_Kind pgstat_add_kind(PgStat_Kind kind,
-                                   const PgStat_KindInfo *kind_info);
+extern PgStat_Kind pgstat_register_kind(PgStat_Kind kind,
+                                        const PgStat_KindInfo *kind_info);
 </programlisting>
      While developing a new extension, use
      <literal>PGSTAT_KIND_EXPERIMENTAL</literal> for
diff --git a/src/backend/access/transam/multixact.c b/src/backend/access/transam/multixact.c
@@ -2017,7 +2017,7 @@ check_multixact_offset_buffers(int *newval, void **extra, GucSource source)
 }
 
 /*
- * GUC check_hook for multixact_member_buffer
+ * GUC check_hook for multixact_member_buffers
  */
 bool
 check_multixact_member_buffers(int *newval, void **extra, GucSource source)
diff --git a/src/backend/commands/matview.c b/src/backend/commands/matview.c
@@ -382,7 +382,7 @@ RefreshMatViewByOid(Oid matviewOid, bool is_create, bool skipData,
 	 * command tag is left false in cmdtaglist.h. Otherwise, the change of
 	 * completion tag output might break applications using it.
 	 *
-	 * When called from CREATE MATERIALIZED VIEW comand, the rowcount is
+	 * When called from CREATE MATERIALIZED VIEW command, the rowcount is
 	 * displayed with the command tag CMDTAG_SELECT.
 	 */
 	if (qc)
diff --git a/src/backend/commands/waitlsn.c b/src/backend/commands/waitlsn.c
@@ -369,7 +369,7 @@ pg_wal_replay_wait(PG_FUNCTION_ARGS)
 	 */
 	InvalidateCatalogSnapshot();
 
-	/* Give up if there is still an active or registered sanpshot. */
+	/* Give up if there is still an active or registered snapshot. */
 	if (GetOldestSnapshot())
 		ereport(ERROR,
 				(errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
diff --git a/src/backend/executor/execExprInterp.c b/src/backend/executor/execExprInterp.c
@@ -1101,7 +1101,7 @@ ExecInterpExpr(ExprState *state, ExprContext *econtext, bool *isnull)
 
 		EEO_CASE(EEOP_PARAM_SET)
 		{
-			/* out of line, unlikely to matter performancewise */
+			/* out of line, unlikely to matter performance-wise */
 			ExecEvalParamSet(state, op, econtext);
 			EEO_NEXT();
 		}
@@ -4762,7 +4762,7 @@ ExecEvalJsonCoercionFinish(ExprState *state, ExprEvalStep *op)
 	if (SOFT_ERROR_OCCURRED(&jsestate->escontext))
 	{
 		/*
-		 * jsestate->error or jsetate->empty being set means that the error
+		 * jsestate->error or jsestate->empty being set means that the error
 		 * occurred when coercing the JsonBehavior value.  Throw the error in
 		 * that case with the actual coercion error message shown in the
 		 * DETAIL part.
diff --git a/src/backend/postmaster/postmaster.c b/src/backend/postmaster/postmaster.c
@@ -2628,7 +2628,8 @@ CleanupBackend(Backend *bp,
 		BackgroundWorkerStopNotifications(bp->pid);
 
 	/*
-	 * If it was a background worker, also update its RegisteredWorker entry.
+	 * If it was a background worker, also update its RegisteredBgWorker
+	 * entry.
 	 */
 	if (bp->bkend_type == BACKEND_TYPE_BGWORKER)
 	{
diff --git a/src/backend/replication/logical/slotsync.c b/src/backend/replication/logical/slotsync.c
@@ -83,7 +83,7 @@
  * this flag is set. Note that we don't need to reset this variable as after
  * promotion the slot sync worker won't be restarted because the pmState
  * changes to PM_RUN from PM_HOT_STANDBY and we don't support demoting
- * primary without restarting the server. See MaybeStartSlotSyncWorker.
+ * primary without restarting the server. See LaunchMissingBackgroundProcesses.
  *
  * The 'syncing' flag is needed to prevent concurrent slot syncs to avoid slot
  * overwrites.
diff --git a/src/backend/storage/aio/read_stream.c b/src/backend/storage/aio/read_stream.c
@@ -449,7 +449,7 @@ read_stream_begin_impl(int flags,
 	queue_size = max_pinned_buffers + 1;
 
 	/*
-	 * Allocate the object, the buffers, the ios and per_data_data space in
+	 * Allocate the object, the buffers, the ios and per_buffer_data space in
 	 * one big chunk.  Though we have queue_size buffers, we want to be able
 	 * to assume that all the buffers for a single read are contiguous (i.e.
 	 * don't wrap around halfway through), so we allow temporary overflows of
diff --git a/src/backend/storage/lmgr/lock.c b/src/backend/storage/lmgr/lock.c
@@ -396,7 +396,7 @@ LockManagerShmemInit(void)
 
 	/*
 	 * Compute init/max size to request for lock hashtables.  Note these
-	 * calculations must agree with LockShmemSize!
+	 * calculations must agree with LockManagerShmemSize!
 	 */
 	max_table_size = NLOCKENTS();
 	init_table_size = max_table_size / 2;
diff --git a/src/backend/utils/cache/typcache.c b/src/backend/utils/cache/typcache.c
@@ -367,9 +367,9 @@ lookup_type_cache(Oid type_id, int flags)
 		ctl.entrysize = sizeof(TypeCacheEntry);
 
 		/*
-		 * TypeEntry takes hash value from the system cache. For TypeCacheHash
-		 * we use the same hash in order to speedup search by hash value. This
-		 * is used by hash_seq_init_with_hash_value().
+		 * TypeCacheEntry takes hash value from the system cache. For
+		 * TypeCacheHash we use the same hash in order to speedup search by
+		 * hash value. This is used by hash_seq_init_with_hash_value().
 		 */
 		ctl.hash = type_cache_syshash;
 
diff --git a/src/bin/pg_combinebackup/t/008_promote.pl b/src/bin/pg_combinebackup/t/008_promote.pl
@@ -54,7 +54,7 @@
 EOM
 $node2->start();
 
-# Wait until recoveery pauses, then promote.
+# Wait until recovery pauses, then promote.
 $node2->poll_query_until('postgres', "SELECT pg_get_wal_replay_pause_state() = 'paused';");
 $node2->safe_psql('postgres', "SELECT pg_promote()");
 
@@ -65,7 +65,7 @@
 EOM
 
 # Now take an incremental backup. If WAL summarization didn't follow the
-# timeline cange correctly, something should break at this point.
+# timeline change correctly, something should break at this point.
 my $backup2path = $node1->backup_dir . '/backup2';
 $node2->command_ok(
 	[ 'pg_basebackup', '-D', $backup2path, '--no-sync', '-cfast',
diff --git a/src/bin/psql/common.c b/src/bin/psql/common.c
@@ -1715,7 +1715,7 @@ ExecQueryAndProcessResults(const char *query,
 			{
 				/*
 				 * Display the current chunk of results, unless the output
-				 * stream stopped working or we got cancelled.  We skip use of
+				 * stream stopped working or we got canceled.  We skip use of
 				 * PrintQueryResult and go directly to printQuery, so that we
 				 * can pass the correct is_pager value and because we don't
 				 * want PrintQueryStatus to happen yet.  Above, we rejected
diff --git a/src/fe_utils/astreamer_gzip.c b/src/fe_utils/astreamer_gzip.c
@@ -13,7 +13,7 @@
  * taken here is less flexible, because a writer can only write to a file,
  * while a compressor can write to a subsequent astreamer which is free
  * to do whatever it likes. The reason it's like this is because this
- * code was adapated from old, less-modular pg_basebackup code that used
+ * code was adapted from old, less-modular pg_basebackup code that used
  * the same APIs that astreamer_gzip_writer now uses, and it didn't seem
  * necessary to change anything at the time.
  *
diff --git a/src/include/storage/read_stream.h b/src/include/storage/read_stream.h
@@ -66,7 +66,6 @@ extern ReadStream *read_stream_begin_smgr_relation(int flags,
 												   ReadStreamBlockNumberCB callback,
 												   void *callback_private_data,
 												   size_t per_buffer_data_size);
-extern Buffer read_stream_next_buffer(ReadStream *stream, void **per_buffer_private);
 extern void read_stream_reset(ReadStream *stream);
 extern void read_stream_end(ReadStream *stream);
 
diff --git a/src/include/utils/injection_point.h b/src/include/utils/injection_point.h
@@ -12,7 +12,7 @@
 #define INJECTION_POINT_H
 
 /*
- * Injections points require --enable-injection-points.
+ * Injection points require --enable-injection-points.
  */
 #ifdef USE_INJECTION_POINTS
 #define INJECTION_POINT_LOAD(name) InjectionPointLoad(name)
diff --git a/src/interfaces/libpq/fe-connect.c b/src/interfaces/libpq/fe-connect.c
@@ -948,7 +948,7 @@ fillPGconn(PGconn *conn, PQconninfoOption *connOptions)
  * Copy over option values from srcConn to dstConn
  *
  * Don't put anything cute here --- intelligence should be in
- * connectOptions2 ...
+ * pqConnectOptions2 ...
  *
  * Returns true on success. On failure, returns false and sets error message of
  * dstConn.
diff --git a/src/test/modules/test_misc/t/006_signal_autovacuum.pl b/src/test/modules/test_misc/t/006_signal_autovacuum.pl
@@ -67,7 +67,7 @@
 
 my $offset = -s $node->logfile;
 
-# Role with pg_signal_autovacuum can terminate autovacuum worker.
+# Role with pg_signal_autovacuum_worker can terminate autovacuum worker.
 my $terminate_with_pg_signal_av = $node->psql(
 	'postgres', qq(
     SET ROLE regress_worker_role;
diff --git a/src/test/subscription/t/021_twophase.pl b/src/test/subscription/t/021_twophase.pl
@@ -76,7 +76,7 @@
 	INSERT INTO tab_full VALUES (11);
 	PREPARE TRANSACTION 'test_prepared_tab_full';");
 
-# Confirm the ERROR is reported becasue max_prepared_transactions is zero
+# Confirm the ERROR is reported because max_prepared_transactions is zero
 $node_subscriber->wait_for_log(
 	qr/ERROR: ( [A-Z0-9]+:)? prepared transactions are disabled/);
 

Original file line number	Diff line number	Diff line change
`@@ -2017,7 +2017,7 @@ check_multixact_offset_buffers(int newval, void *extra, GucSource source)`
`2017`	`2017`	`}`
`2018`	`2018`
`2019`	`2019`	`/*`
`2020`		`- * GUC check_hook for multixact_member_buffer`
	`2020`	`+ * GUC check_hook for multixact_member_buffers`
`2021`	`2021`	`*/`
`2022`	`2022`	`bool`
`2023`	`2023`	`check_multixact_member_buffers(int newval, void *extra, GucSource source)`
Original file line number	Diff line number	Diff line change
`@@ -382,7 +382,7 @@ RefreshMatViewByOid(Oid matviewOid, bool is_create, bool skipData,`
`382`	`382`	`* command tag is left false in cmdtaglist.h. Otherwise, the change of`
`383`	`383`	`* completion tag output might break applications using it.`
`384`	`384`	`*`
`385`		`- * When called from CREATE MATERIALIZED VIEW comand, the rowcount is`
	`385`	`+ * When called from CREATE MATERIALIZED VIEW command, the rowcount is`
`386`	`386`	`* displayed with the command tag CMDTAG_SELECT.`
`387`	`387`	`*/`
`388`	`388`	`if (qc)`
Original file line number	Diff line number	Diff line change
`@@ -1101,7 +1101,7 @@ ExecInterpExpr(ExprState state, ExprContext econtext, bool *isnull)`
`1101`	`1101`
`1102`	`1102`	`EEO_CASE(EEOP_PARAM_SET)`
`1103`	`1103`	`{`
`1104`		`- /* out of line, unlikely to matter performancewise */`
	`1104`	`+ /* out of line, unlikely to matter performance-wise */`
`1105`	`1105`	`ExecEvalParamSet(state, op, econtext);`
`1106`	`1106`	`EEO_NEXT();`
`1107`	`1107`	`}`
`@@ -4762,7 +4762,7 @@ ExecEvalJsonCoercionFinish(ExprState state, ExprEvalStep op)`
`4762`	`4762`	`if (SOFT_ERROR_OCCURRED(&jsestate->escontext))`
`4763`	`4763`	`{`
`4764`	`4764`	`/*`
`4765`		`- * jsestate->error or jsetate->empty being set means that the error`
	`4765`	`+ * jsestate->error or jsestate->empty being set means that the error`
`4766`	`4766`	`* occurred when coercing the JsonBehavior value. Throw the error in`
`4767`	`4767`	`* that case with the actual coercion error message shown in the`
`4768`	`4768`	`* DETAIL part.`
Original file line number	Diff line number	Diff line change
`@@ -2628,7 +2628,8 @@ CleanupBackend(Backend *bp,`
`2628`	`2628`	`BackgroundWorkerStopNotifications(bp->pid);`
`2629`	`2629`
`2630`	`2630`	`/*`
`2631`		`- * If it was a background worker, also update its RegisteredWorker entry.`
	`2631`	`+ * If it was a background worker, also update its RegisteredBgWorker`
	`2632`	`+ * entry.`
`2632`	`2633`	`*/`
`2633`	`2634`	`if (bp->bkend_type == BACKEND_TYPE_BGWORKER)`
`2634`	`2635`	`{`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@`
`83`	`83`	`* this flag is set. Note that we don't need to reset this variable as after`
`84`	`84`	`* promotion the slot sync worker won't be restarted because the pmState`
`85`	`85`	`* changes to PM_RUN from PM_HOT_STANDBY and we don't support demoting`
`86`		`- * primary without restarting the server. See MaybeStartSlotSyncWorker.`
	`86`	`+ * primary without restarting the server. See LaunchMissingBackgroundProcesses.`
`87`	`87`	`*`
`88`	`88`	`* The 'syncing' flag is needed to prevent concurrent slot syncs to avoid slot`
`89`	`89`	`* overwrites.`
Original file line number	Diff line number	Diff line change
`@@ -1715,7 +1715,7 @@ ExecQueryAndProcessResults(const char *query,`
`1715`	`1715`	`{`
`1716`	`1716`	`/*`
`1717`	`1717`	`* Display the current chunk of results, unless the output`
`1718`		`- * stream stopped working or we got cancelled. We skip use of`
	`1718`	`+ * stream stopped working or we got canceled. We skip use of`
`1719`	`1719`	`* PrintQueryResult and go directly to printQuery, so that we`
`1720`	`1720`	`* can pass the correct is_pager value and because we don't`
`1721`	`1721`	`* want PrintQueryStatus to happen yet. Above, we rejected`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`* taken here is less flexible, because a writer can only write to a file,`
`14`	`14`	`* while a compressor can write to a subsequent astreamer which is free`
`15`	`15`	`* to do whatever it likes. The reason it's like this is because this`
`16`		`- * code was adapated from old, less-modular pg_basebackup code that used`
	`16`	`+ * code was adapted from old, less-modular pg_basebackup code that used`
`17`	`17`	`* the same APIs that astreamer_gzip_writer now uses, and it didn't seem`
`18`	`18`	`* necessary to change anything at the time.`
`19`	`19`	`*`
Original file line number	Diff line number	Diff line change
`@@ -948,7 +948,7 @@ fillPGconn(PGconn conn, PQconninfoOption connOptions)`
`948`	`948`	`* Copy over option values from srcConn to dstConn`
`949`	`949`	`*`
`950`	`950`	`* Don't put anything cute here --- intelligence should be in`
`951`		`- * connectOptions2 ...`
	`951`	`+ * pqConnectOptions2 ...`
`952`	`952`	`*`
`953`	`953`	`* Returns true on success. On failure, returns false and sets error message of`
`954`	`954`	`* dstConn.`