Re: Docs: make source file path references consistent

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>
Cc: Postgres hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>, Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Subject: Re: Docs: make source file path references consistent
Date: 2026-01-08 06:44:55
Message-ID: 1909358.1767854695@sss.pgh.pa.us
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> writes:
> On Dec 25, 2025, at 17:07, Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> wrote:
>> This patch is derived from [1]. While reviewing that thread, I noticed that when the documentation refers to .h and .cfiles in the PostgreSQL source tree, it uses a mix of full source-tree paths and short relative paths. This inconsistency can be confusing for future documentation authors, who may be unsure which form to use.

> Added to CF for tracking: https://commitfest.postgresql.org/patch/6380/

Is this actually worth spending time on?

Sure, in an ideal world every last line of our source code and
documentation would be totally consistent and read like it had
flowed from a single pen. But the effort to get there seems
out of proportion to the value, and the effort to keep it there
over time would be even more so.

I'd be much happier to see us spending time on, say, improving
the many barely-intelligible comments in the code. That takes
serious thought and work though (ChatGPT is unlikely to help).

regards, tom lane

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message shveta malik 2026-01-08 06:59:47 Re: Proposal: Conflict log history table for Logical Replication
Previous Message Chao Li 2026-01-08 06:32:23 Re: Docs: make source file path references consistent