Re: Add A Glossary

From: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
To: Jürgen Purtz <juergen(at)purtz(dot)de>
Cc: Corey Huinker <corey(dot)huinker(at)gmail(dot)com>, Justin Pryzby <pryzby(at)telsasoft(dot)com>, Roger Harkavy <rogerharkavy(at)gmail(dot)com>, pgsql-hackers(at)postgresql(dot)org, Fabien COELHO <coelho(at)cri(dot)ensmp(dot)fr>, Michael Paquier <michael(at)paquier(dot)xyz>
Subject: Re: Add A Glossary
Date: 2020-04-02 00:09:25
Message-ID: 20200402000925.GA7329@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-docs pgsql-hackers

On 2020-Apr-01, Jürgen Purtz wrote:

> On 31.03.20 19:58, Justin Pryzby wrote:
> > On Tue, Mar 31, 2020 at 04:13:00PM +0200, Jürgen Purtz wrote:
> > > Please find some minor suggestions in the attachment. They are based on
> > > Corey's last patch 0001-glossary-v4.patch.
> > > @@ -220,7 +220,7 @@
> > > Record</glossterm>s to the file system and creates a special
> > > checkpoint record. This process is initiated when predefined
> > > conditions are met, such as a specified amount of time has passed, or
> > > - a certain volume of records have been collected.
> > > + a certain volume of records has been collected.
> > I think you're correct in that "volume" is singular. But I think "collected"
> > is the wrong world. I suggested "written".
> >
> "collected" is not optimal. I suggest "created". Please avoid "written", the
> WAL records will be written when the Checkpointer is running, not before.

Actually, you're mistaken; the checkpointer hardly writes any WAL
records. In fact, it only writes *one* wal record, which is the
checkpoint record itself. All the other wal records are written either
by the backends that produce it, or by the wal writer process. By the
time the checkpoint runs, the wal records are long expected to be written.

Anyway I changed a lot of terms again, as well as changing the way the
terms are marked up -- for two reasons:

1. I didn't like the way the WAL-related entries were structured. I
created a new entry called "Write-Ahead Log", which explains what WAL
is; this replaces the term "WAL Log", which is redundant (since the L in
WAL stands for "log" already). I kept the id as glossary-wal, though,
because it's shorter and *shrug*. The definition uses the terms "wal
record" and "wal file", which I also rewrote.

2. I found out that "see xyz" and "see also" have bespoke markup in
Docbook -- <glosssee> and <glossseealso>. I changed some glossentries
to use those, removing some glossdefs and changing a couple of paras to
glossseealsos. I also removed all "id" properties from glossentries
that are just <glosssee>, because I think it's a mistake to have
references to entries that will make the reader look up a different
term; for me as a reader that's annoying, and I don't like to annoy

While at it, I again came across "analytic", which is a term we don't
use much, so I made it a glosssee for "window function"; and while at it
I realized we didn't clearly explain what a window was. So I added
"window frame" for that. I considered adding the term "partition" which
is used in this context, but decided it wasn't necessary.

I also added "(process)" to terms that define processes. So
now we have "checkpointer (process)" and so on.

I rewrote the definition for "atomic" once again. Made it two
glossdefs, because I can. If you don't like this, I can undo.

I added "recycling".

I still have to go through some other defs.

Álvaro Herrera
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

Attachment Content-Type Size
0001-glossary-v5.patch text/x-diff 51.1 KB

In response to


Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2020-04-02 00:27:59 Re: terminology in example
Previous Message Jürgen Purtz 2020-04-01 07:34:56 Re: Add A Glossary

Browse pgsql-hackers by date

  From Date Subject
Next Message Andres Freund 2020-04-02 00:17:21 Re: snapshot too old issues, first around wraparound and then more.
Previous Message Andres Freund 2020-04-01 23:59:51 Re: snapshot too old issues, first around wraparound and then more.