PGDOCS - "System Catalogs" table-of-contents page structure

Started by Peter Smithover 3 years ago3 messages
#1Peter Smith
smithpb2250@gmail.com

Hi hackers,

(Resending because my previous post was missing the subject - sorry for noise)

Recently when looking at the "System Catalogs" Tables of Contents [1]https://www.postgresql.org/docs/15/catalogs.html,
I was wondering why are those headings "Overview" and "System Views"
at the same section level as the catalogs/views within them.

~~~

e.g.1. Current:

Chapter 53. "System Catalogs"
======
53.1. Overview
53.2. pg_aggregate
53.3. pg_am
53.4. pg_amop
53.5. pg_amproc
...
53.66. System Views
53.67. pg_available_extensions
53.68. pg_available_extension_versions
53.69. pg_backend_memory_contexts
53.70. pg_config
...
======

e.g.2 What I thought it should look like:

Chapter 53. "System Catalogs and Views" <-- chapter name change
======
53.1. System Catalogs <-- heading name change
53.1.1. pg_aggregate
53.1.2. pg_am
53.1.3. pg_amop
53.1.4. pg_amproc
...
53.2. System Views
53.2.1. pg_available_extensions
53.2.2. pg_available_extension_versions
53.2.3. pg_backend_memory_contexts
53.2.4. pg_config
...
======

~~~

OTOH it looks like this table of contents page has been this way
forever (20+ years?). It is hard to believe nobody else suggested
modifying it in all that time, so perhaps there is some reason for it
being like it is?

Thoughts?

------
[1]: https://www.postgresql.org/docs/15/catalogs.html

Kind Regards,
Peter Smith.
Fujitsu Australia

#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Smith (#1)
Re: PGDOCS - "System Catalogs" table-of-contents page structure

Peter Smith <smithpb2250@gmail.com> writes:

e.g.2 What I thought it should look like:

Chapter 53. "System Catalogs and Views" <-- chapter name change
======
53.1. System Catalogs <-- heading name change
53.1.1. pg_aggregate
53.1.2. pg_am
53.1.3. pg_amop
53.1.4. pg_amproc

Then the catalog descriptions would not be on separate pages.

OTOH it looks like this table of contents page has been this way
forever (20+ years?). It is hard to believe nobody else suggested
modifying it in all that time, so perhaps there is some reason for it
being like it is?

Perhaps that it's just fine as-is.

regards, tom lane

#3Peter Smith
smithpb2250@gmail.com
In reply to: Tom Lane (#2)
Re: PGDOCS - "System Catalogs" table-of-contents page structure

On Thu, Jun 9, 2022 at 10:00 AM Tom Lane <tgl@sss.pgh.pa.us> wrote:

Peter Smith <smithpb2250@gmail.com> writes:

e.g.2 What I thought it should look like:

Chapter 53. "System Catalogs and Views" <-- chapter name change
======
53.1. System Catalogs <-- heading name change
53.1.1. pg_aggregate
53.1.2. pg_am
53.1.3. pg_amop
53.1.4. pg_amproc

Then the catalog descriptions would not be on separate pages.

Oh, right. Thanks for the explanation.

------
Kind Regards,
Peter Smith.
Fujitsu Australia.