Skip to content

Commit 68c23cb

Browse files
tglsfdctglsfdc
committed
Improve consistency of comments in system catalog headers.
Use the term "system catalog" rather than "system relation" in assorted places where it's clearly referring to a table rather than, say, an index. Use more natural word order in the header boilerplate, improve some of the one-liner catalog descriptions, and fix assorted random deviations from the normal boilerplate. All purely neatnik-ism, but why not. John Naylor, some additional cleanup by me Discussion: https://postgr.es/m/CAJVSVGUeJmFB3h-NJ18P32NPa+kzC165nm7GSoGHfPaN80Wxcw@mail.gmail.com
1 parent e5d8399 commit 68c23cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+136
-97
lines changed

‎src/backend/catalog/genbki.pl

+3-3
Original file line numberDiff line numberDiff line change
@@ -535,8 +535,8 @@ sub gen_pg_attribute
535535
{
536536
my $table = $catalogs{$table_name};
537537

538-
# Currently, all bootstrapped relations also need schemapg.h
539-
# entries, so skip if the relation isn't to be in schemapg.h.
538+
# Currently, all bootstrap catalogs also need schemapg.h
539+
# entries, so skip if it isn't to be in schemapg.h.
540540
next if !$table->{schema_macro};
541541

542542
$schemapg_entries{$table_name} = [];
@@ -769,7 +769,7 @@ sub form_pg_type_symbol
769769
{
770770
my $typename = shift;
771771

772-
# Skip for rowtypes of bootstrap tables, since they have their
772+
# Skip for rowtypes of bootstrap catalogs, since they have their
773773
# own naming convention defined elsewhere.
774774
return
775775
if $typename eq 'pg_type'

‎src/include/catalog/pg_aggregate.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_aggregate.dat
4-
# Initial contents of the pg_aggregate system relation.
4+
# Initial contents of the pg_aggregate system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_aggregate.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_aggregate.h
4-
* definition of the system "aggregate" relation (pg_aggregate)
4+
* definition of the "aggregate" system catalog (pg_aggregate)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_am.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_am.dat
4-
# Initial contents of the pg_am system relation.
4+
# Initial contents of the pg_am system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_am.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_am.h
4-
* definition of the system "access method" relation (pg_am)
4+
* definition of the "access method" system catalog (pg_am)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_amop.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_amop.dat
4-
# Initial contents of the pg_amop system relation.
4+
# Initial contents of the pg_amop system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_amop.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_amop.h
4-
* definition of the system "amop" relation (pg_amop)
4+
* definition of the "access method operator" system catalog (pg_amop)
55
*
66
* The amop table identifies the operators associated with each index operator
77
* family and operator class (classes are subsets of families). An associated

‎src/include/catalog/pg_amproc.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_amproc.dat
4-
# Initial contents of the pg_amproc system relation.
4+
# Initial contents of the pg_amproc system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_amproc.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_amproc.h
4-
* definition of the system "amproc" relation (pg_amproc)
4+
* definition of the "access method procedure" system catalog (pg_amproc)
55
*
66
* The amproc table identifies support procedures associated with index
77
* operator families and classes. These procedures can't be listed in pg_amop

‎src/include/catalog/pg_attrdef.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_attrdef.h
4-
* definition of the system "attribute defaults" relation (pg_attrdef)
4+
* definition of the "attribute defaults" system catalog (pg_attrdef)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_attribute.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_attribute.h
4-
* definition of the system "attribute" relation (pg_attribute)
4+
* definition of the "attribute" system catalog (pg_attribute)
55
*
66
* The initial contents of pg_attribute are generated at compile time by
77
* genbki.pl, so there is no pg_attribute.dat file. Only "bootstrapped"

‎src/include/catalog/pg_auth_members.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_auth_members.h
4-
* definition of the system "authorization identifier members" relation
4+
* definition of the "authorization identifier members" system catalog
55
* (pg_auth_members).
66
*
77
*

‎src/include/catalog/pg_authid.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_authid.dat
4-
# Initial contents of the pg_authid system relation.
4+
# Initial contents of the pg_authid system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_authid.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_authid.h
4-
* definition of the system "authorization identifier" relation (pg_authid)
4+
* definition of the "authorization identifier" system catalog (pg_authid)
55
*
66
* pg_shadow and pg_group are now publicly accessible views on pg_authid.
77
*

‎src/include/catalog/pg_cast.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_cast.dat
4-
# Initial contents of the pg_cast system relation.
4+
# Initial contents of the pg_cast system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_cast.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_cast.h
4-
* definition of the system "type casts" relation (pg_cast)
4+
* definition of the "type casts" system catalog (pg_cast)
55
*
66
* As of Postgres 8.0, pg_cast describes not only type coercion functions
77
* but also length coercion functions.
88
*
9-
*
10-
* Copyright (c) 2002-2018, PostgreSQL Global Development Group
9+
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
10+
* Portions Copyright (c) 1994, Regents of the University of California
1111
*
1212
* src/include/catalog/pg_cast.h
1313
*

‎src/include/catalog/pg_class.dat

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_class.dat
4-
# Initial contents of the pg_class system relation.
4+
# Initial contents of the pg_class system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California
@@ -12,7 +12,7 @@
1212

1313
[
1414

15-
# Note: only "bootstrapped" relations, ie those marked BKI_BOOTSTRAP, need to
15+
# Note: only bootstrap catalogs, ie those marked BKI_BOOTSTRAP, need to
1616
# have entries here. Be sure that the OIDs listed here match those given in
1717
# their CATALOG and BKI_ROWTYPE_OID macros, and that the relnatts values are
1818
# correct.

‎src/include/catalog/pg_class.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_class.h
4-
* definition of the system "relation" relation (pg_class)
4+
* definition of the "relation" system catalog (pg_class)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_collation.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_collation.dat
4-
# Initial contents of the pg_collation system relation.
4+
# Initial contents of the pg_collation system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_collation.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_collation.h
4-
* definition of the system "collation" relation (pg_collation)
4+
* definition of the "collation" system catalog (pg_collation)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
88
* Portions Copyright (c) 1994, Regents of the University of California
99
*
10-
* IDENTIFICATION
11-
* src/include/catalog/pg_collation.h
10+
* src/include/catalog/pg_collation.h
1211
*
1312
* NOTES
1413
* The Catalog.pm module reads this file and derives schema

‎src/include/catalog/pg_constraint.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_constraint.h
4-
* definition of the system "constraint" relation (pg_constraint)
4+
* definition of the "constraint" system catalog (pg_constraint)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_conversion.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_conversion.h
4-
* definition of the system "conversion" relation (pg_conversion)
4+
* definition of the "conversion" system catalog (pg_conversion)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_database.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_database.dat
4-
# Initial contents of the pg_database system relation.
4+
# Initial contents of the pg_database system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_database.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_database.h
4-
* definition of the system "database" relation (pg_database)
4+
* definition of the "database" system catalog (pg_database)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_db_role_setting.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_db_role_setting.h
4-
* definition of per-database/per-user configuration settings relation
4+
* definition of the system catalog for per-database/per-user
5+
* configuration settings (pg_db_role_setting)
56
*
67
*
78
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_default_acl.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_default_acl.h
4-
* definition of default ACLs for new objects.
4+
* definition of the system catalog for default ACLs of new objects
5+
* (pg_default_acl)
56
*
67
*
78
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_depend.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_depend.h
4-
* definition of the system "dependency" relation (pg_depend)
4+
* definition of the "dependency" system catalog (pg_depend)
55
*
66
* pg_depend has no preloaded contents, so there is no pg_depend.dat
77
* file; system-defined dependencies are loaded into it during a late stage

‎src/include/catalog/pg_description.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_description.h
4-
* definition of the system "description" relation (pg_description)
4+
* definition of the "description" system catalog (pg_description)
55
*
66
* Because the contents of this table are taken from the *.dat files
77
* of other catalogs, there is no pg_description.dat file. The initial

‎src/include/catalog/pg_enum.h

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_enum.h
4-
* definition of the system "enum" relation (pg_enum)
4+
* definition of the "enum" system catalog (pg_enum)
55
*
66
*
7-
* Copyright (c) 2006-2018, PostgreSQL Global Development Group
7+
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
8+
* Portions Copyright (c) 1994, Regents of the University of California
89
*
910
* src/include/catalog/pg_enum.h
1011
*

‎src/include/catalog/pg_event_trigger.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_event_trigger.h
4-
* definition of the system "event trigger" relation (pg_event_trigger)
4+
* definition of the "event trigger" system catalog (pg_event_trigger)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_extension.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_extension.h
4-
* definition of the system "extension" relation (pg_extension)
4+
* definition of the "extension" system catalog (pg_extension)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_foreign_data_wrapper.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_foreign_data_wrapper.h
4-
* definition of the system "foreign-data wrapper" relation (pg_foreign_data_wrapper)
4+
* definition of the "foreign-data wrapper" system catalog (pg_foreign_data_wrapper)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_foreign_server.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_foreign_server.h
4-
* definition of the system "foreign server" relation (pg_foreign_server)
4+
* definition of the "foreign server" system catalog (pg_foreign_server)
55
*
66
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
* Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_foreign_table.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_foreign_table.h
4-
* definition of the system "foreign table" relation (pg_foreign_table)
4+
* definition of the "foreign table" system catalog (pg_foreign_table)
55
*
66
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
* Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_index.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_index.h
4-
* definition of the system "index" relation (pg_index)
4+
* definition of the "index" system catalog (pg_index)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_inherits.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_inherits.h
4-
* definition of the system "inherits" relation (pg_inherits)
4+
* definition of the "inherits" system catalog (pg_inherits)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

‎src/include/catalog/pg_init_privs.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_init_privs.h
4-
* definition of the system "initial privileges" relation (pg_init_privs)
4+
* definition of the "initial privileges" system catalog (pg_init_privs)
55
*
66
* NOTE: an object is identified by the OID of the row that primarily
77
* defines the object, plus the OID of the table that that row appears in.

‎src/include/catalog/pg_language.dat

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#----------------------------------------------------------------------
22
#
33
# pg_language.dat
4-
# Initial contents of the pg_language system relation.
4+
# Initial contents of the pg_language system catalog.
55
#
66
# Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
77
# Portions Copyright (c) 1994, Regents of the University of California

‎src/include/catalog/pg_language.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*-------------------------------------------------------------------------
22
*
33
* pg_language.h
4-
* definition of the system "language" relation (pg_language)
4+
* definition of the "language" system catalog (pg_language)
55
*
66
*
77
* Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group

0 commit comments

Comments
 (0)