Doc: Rework contrib appendix -- informative titles, tweaked sentences

From: "Karl O(dot) Pinc" <kop(at)karlpinc(dot)com>
To: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Doc: Rework contrib appendix -- informative titles, tweaked sentences
Date: 2023-01-03 00:00:15
Message-ID: 20230102180015.372995a9@slate.karlpinc.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-www

Hi,

Attached is a patch: contrib_v1.patch

It modifies Appendix F, the contrib directory.

It adds brief text into the titles shown in the
table of contents so it's easier to tell what
each module does. It also suffixes [trusted] or [obsolete]
on the relevant titles.

I added the word "extension" into the appendix title
because I always have problems scanning through the
appendix and finding the one to do with extensions.

The sentences describing what the modules are and how
to build them have been reworked. Some split in 2,
some words removed or replaced, etc.

I introduced the word "component" because the appendix
has build instructions for command line programs as well
as extensions and libraries loaded with shared_preload_libraries().
This involved removing most occurrences of the word
"module", although it is left in the section title.

Regards,

Karl <kop(at)karlpinc(dot)com>
Free Software: "You don't pay back, you pay forward."
-- Robert A. Heinlein

Attachment Content-Type Size
contrib_v1.patch text/x-patch 27.0 KB

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Joseph Koshakow 2023-01-03 00:44:25 Re: Infinite Interval
Previous Message Andres Freund 2023-01-02 23:46:36 Re: perl 5.36, C99, -Wdeclaration-after-statement -Wshadow=compatible-local

Browse pgsql-www by date

  From Date Subject
Next Message N. Can KIRIK 2023-01-03 09:55:38 Wiki editor request
Previous Message Daniel Gustafsson 2023-01-02 14:48:00 Re: Formatting of <itemizedlist> vs role="catalog_table_entry"