Re: documentation structure - Mailing list pgsql-hackers

From David G. Johnston
Subject Re: documentation structure
Date
Msg-id CAKFQuwZ1QEuiHkvkCECUXO3vYhxC=JjFHZ1iRQtCOG2omUrVZQ@mail.gmail.com
Whole thread Raw
In response to Re: documentation structure  (Tatsuo Ishii <ishii@postgresql.org>)
Responses Re: documentation structure
List pgsql-hackers
On Fri, Jul 19, 2024 at 1:01 PM Tatsuo Ishii <ishii@postgresql.org> wrote:
> Do we want to use a "func-" prefix on the file names?  I could
> imagine dispensing with that as unnecessary;

If we don't use the prefix and we generate new file names from sect1
tag, we could have file name collision: for example, json.sgml because
there's sect1 tag "functions-json".

> or another idea
> could be to make a new subdirectory func/ for these.

+1. Looks better than adding +30 files right under sgml directory.


+many for placing these under a subdirectory.

IMO the file name should match the ID of the sect1 element with the leading "functions-" removed, naming the directory "functions".  Thus when viewing the web page the corresponding sgml file is determinable.

David J.


pgsql-hackers by date:

Previous
From: Aleksander Alekseev
Date:
Subject: Re: Build with LTO / -flto on macOS
Next
From: "David E. Wheeler"
Date:
Subject: Re: DSO Terms Galore