From: | Alvaro Herrera <alvherre(at)2ndquadrant(dot)com> |
---|---|
To: | Justin Pryzby <pryzby(at)telsasoft(dot)com>, Jürgen Purtz <juergen(at)purtz(dot)de> |
Cc: | Erik Rijkers <er(at)xs4all(dot)nl>, Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>, Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>, Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>, Corey Huinker <corey(dot)huinker(at)gmail(dot)com>, Roger Harkavy <rogerharkavy(at)gmail(dot)com>, pgsql-hackers(at)postgresql(dot)org, Michael Paquier <michael(at)paquier(dot)xyz>, Pg Docs <pgsql-docs(at)lists(dot)postgresql(dot)org> |
Subject: | Re: Add A Glossary |
Date: | 2020-06-18 23:51:13 |
Message-ID: | 20200618235113.GA1137@alvherre.pgsql |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-docs pgsql-hackers |
On 2020-Jun-16, Justin Pryzby wrote:
> On Tue, Jun 16, 2020 at 08:09:26PM -0400, Alvaro Herrera wrote:
Thanks for the review. I merged all your suggestions. This one:
> > Most local objects belong to a specific
> > + <glossterm linkend="glossary-schema">schema</glossterm> in their
> > + containing database, such as
> > + <glossterm linkend="glossary-relation">all types of relations</glossterm>,
> > + <glossterm linkend="glossary-function">all types of functions</glossterm>,
>
> Maybe say: >Relations< (all types), and >Functions< (all types)
led me down not one but two rabbit holes; first I realized that
"functions" is an insufficient term since procedures should also be
included but weren't, so I had to add the more generic term "routine"
and then modify the definitions of all routine types to mix in well. I
think overall the quality of these definitions is improved as a result.
I also felt the need to revise the definition of "relations", so I did
that too; this made me change the definition of resultset too.
On 2020-Jun-17, Jürgen Purtz wrote:
> +1, with two formal changes:
>
> - Rearrangement of term "Data page" to meet alphabetical order.
To forestall these ordering issues (look, another rabbit hole), I
grepped the file for all glossterms and sorted that under en_US rules,
then reordered the terms to match that. Turns out there were several
other ordering mistakes.
git grep '<glossterm>' | sed -e 's/<[^>]*>\([^<]*\)<[^>]*>/\1/' > orig
LC_COLLATE=en_US.UTF-8 sort orig > sorted
(Eliminating the tags is important, otherwise the sort uses the tags
themselves to disambiguate)
> One last question: The definition of "Data directory" reads "... A cluster's
> storage space comprises the data directory plus ..." and 'cluster' links to
> '"glossary-instance". Shouldn't it link to "glossary-db-cluster"?
Yes, an oversight, thanks.
I also added TPS, because I had already written it.
--
Álvaro Herrera https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
Attachment | Content-Type | Size |
---|---|---|
glossary-2.patch | text/x-diff | 25.6 KB |
From | Date | Subject | |
---|---|---|---|
Next Message | Erik Rijkers | 2020-06-19 15:45:35 | Re: Add A Glossary |
Previous Message | Fujii Masao | 2020-06-17 14:47:28 | The description for pg_replication_slots.restart_lsn |
From | Date | Subject | |
---|---|---|---|
Next Message | Melanie Plageman | 2020-06-19 00:46:09 | Re: Extracting only the columns needed for a query |
Previous Message | David Rowley | 2020-06-18 23:34:15 | Re: Parallel Seq Scan vs kernel read ahead |