Re: documentation structure

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Tatsuo Ishii <ishii(at)postgresql(dot)org>
Cc: tgl(at)sss(dot)pgh(dot)pa(dot)us, andrew(at)dunslane(dot)net, corey(dot)huinker(at)gmail(dot)com, jian(dot)universality(at)gmail(dot)com, robertmhaas(at)gmail(dot)com, pgsql-hackers(at)postgresql(dot)org
Subject: Re: documentation structure
Date: 2024-07-19 20:11:46
Message-ID: CAKFQuwZ1QEuiHkvkCECUXO3vYhxC=JjFHZ1iRQtCOG2omUrVZQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Jul 19, 2024 at 1:01 PM Tatsuo Ishii <ishii(at)postgresql(dot)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.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message David E. Wheeler 2024-07-19 20:15:28 Re: DSO Terms Galore
Previous Message Aleksander Alekseev 2024-07-19 20:09:34 Re: Build with LTO / -flto on macOS