Doc: Fixup misplaced filelist.sgml entities and add some commentary

Started by David G. Johnstonover 1 year ago4 messageshackers
Beta feature

Hackorum builds and tests every patch posted to the lists, not only commitfest submissions. This is Hackorum's own CI rather than the PostgreSQL project's, and it is still under testing - please report anything that looks wrong.

won't retrysuccessCI history

You can run a PostgreSQL built from this patch straight from Docker, with no checkout and no build:

docker run --rm -p 5432:5432 ghcr.io/hackorum-dev/postgres-patch:t51269
psql -h localhost -U postgres

Built from patchset v1 (message #1), July 27, 2026 at 09:56 AM.

Every patchset is also pushed to a branch of our PostgreSQL fork, so you can check out the same tree CI built. Without a PostgreSQL checkout:

git clone --branch t51269_1 https://github.com/hackorum-dev/postgres.git

In a checkout you already have, add the fork once:

git remote add hackorum https://github.com/hackorum-dev/postgres.git

then, for this patchset and every later one:

git fetch hackorum t51269_1 && git checkout t51269_1

Patchset v1 (message #1) is on t51269_1

Jump to latest
#1David G. Johnston
david.g.johnston@gmail.com

Hi.

Having been in filelist.sgml a bit recently I've noticed that the original
alphabetical ordering of the entities therein hasn't been adhered to.
Partly, I suspect, because there is no guidance about these files and how
they are organized. The attached puts things back into alphabetical order
(by section) and adds some commentary to this and related files, and the
manual.

I made the choice to move the special %allfiles; reference to the top since
placement doesn't matter and burying the one unique thing in the middle of
the file didn't seem helpful. Now both its immediate presence and the
comment point out the existence and purpose of ref/allfiles.sgml.

David J.

Attachments:

t51269_1
doc-reorder-entities-and-comment.difftext/x-patch; charset=US-ASCII; name=doc-reorder-entities-and-comment.diffDownload+109-50
#2Marcos Pegoraro
marcos@f10.com.br
In reply to: David G. Johnston (#1)
Re: Doc: Fixup misplaced filelist.sgml entities and add some commentary

Em qua., 19 de mar. de 2025 às 18:14, David G. Johnston <
david.g.johnston@gmail.com> escreveu:

Having been in filelist.sgml a bit recently I've noticed that the original
alphabetical ordering of the entities therein hasn't been adhered to.
Partly, I suspect, because there is no guidance about these files and how
they are organized. The attached puts things back into alphabetical order
(by section) and adds some commentary to this and related files, and the
manual.

Liked that.

Just one typo: chatpers should be chapters.

regards
Marcos

#3David G. Johnston
david.g.johnston@gmail.com
In reply to: Marcos Pegoraro (#2)
Re: Doc: Fixup misplaced filelist.sgml entities and add some commentary

On Wed, Mar 19, 2025 at 2:31 PM Marcos Pegoraro <marcos@f10.com.br> wrote:

Em qua., 19 de mar. de 2025 às 18:14, David G. Johnston <
david.g.johnston@gmail.com> escreveu:

Having been in filelist.sgml a bit recently I've noticed that the
original alphabetical ordering of the entities therein hasn't been adhered
to. Partly, I suspect, because there is no guidance about these files and
how they are organized. The attached puts things back into alphabetical
order (by section) and adds some commentary to this and related files, and
the manual.

Liked that.

Just one typo: chatpers should be chapters.

Thanks.

I've got some additional thoughts for the next version; though I figure
this, and the others like it out there right now, won't get much attention
until mid-April.

Be better to do larger refactorings like this after feature freeze anyway.
We've tended to not consider the documentation part of what is frozen so
looking at it post-deadline makes sense.

David J.

#4Steven Niu
niushiji@gmail.com
In reply to: David G. Johnston (#1)
Re: Doc: Fixup misplaced filelist.sgml entities and add some commentary

Hi, David,

In the file docguide.sgml, there is a typo.
"Within the book are parts, mostly defined within the same file, expect
for the", the "expect" here should be "except".

Thanks,
Steven

在 2025/3/20 5:13, David G. Johnston 写道:

Show quoted text

Hi.

Having been in filelist.sgml a bit recently I've noticed that the
original alphabetical ordering of the entities therein hasn't been
adhered to.  Partly, I suspect, because there is no guidance about these
files and how they are organized.  The attached puts things back into
alphabetical order (by section) and adds some commentary to this and
related files, and the manual.

I made the choice to move the special %allfiles; reference to the top
since placement doesn't matter and burying the one unique thing in the
middle of the file didn't seem helpful.  Now both its immediate presence
and the comment point out the existence and purpose of ref/allfiles.sgml.

David J.