Horton

Re: documentation structure

Tom Lane <tgl@sss.pgh.pa.us>

View thread
From: Tom Lane <tgl@sss.pgh.pa.us>
To: "David G. Johnston" <david.g.johnston@gmail.com>
Cc: Tatsuo Ishii <ishii@postgresql.org>, andrew@dunslane.net, corey.huinker@gmail.com, jian.universality@gmail.com, robertmhaas@gmail.com, pgsql-hackers@postgresql.org
Date: 2024-07-19T16:22:14Z
Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

  1. docs: Consistently use <optional> to indicate optional parameters

  2. docs: Consolidate into new "WAL for Extensions" chapter.

  3. freespace: Don't return blocks past the end of the main fork.

  4. docs: Merge separate chapters on built-in index AMs into one.

  5. docs: Demote "Monitoring Disk Usage" from chapter to section.

  6. doc: move system views section to its own chapter

"David G. Johnston" <david.g.johnston@gmail.com> writes:
> On Thu, Jul 18, 2024 at 8:06 PM Tatsuo Ishii <ishii@postgresql.org> wrote:
>>> I'm opposed to having a separate file for every function. I think
>>> breaking up func.sgml into one piece per sect1 is about right.

>> That will create at least 30 func-xx.sgml files.
>> I am afraid that's too many?

> The premise and the resultant number of files both seem reasonable to me.

I agree.  The hundreds that would result from file-per-function, or
anything close to that, would be too many.  But I can deal with
file-per-sect1.  For context, I count currently 167 sgml/*.sgml files
plus 219 ref/*.sgml, so adding 30 more would be an 8% increase.

Do we want to use a "func-" prefix on the file names?  I could
imagine dispensing with that as unnecessary; or another idea
could be to make a new subdirectory func/ for these.

			regards, tom lane