Re: Docs: make source file path references consistent

From: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>
To: Postgres hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Cc: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Subject: Re: Docs: make source file path references consistent
Date: 2026-01-08 06:32:23
Message-ID: 64003689-A1F0-4B3A-9DBC-3D1B7B52C7E7@gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> On Dec 25, 2025, at 17:07, Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> wrote:
>
> Hi Hackers,
>
> 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.
>
> This patch aims to make the usage consistent. When the documentation explicitly refers to a file’s location in the source tree (for example, “in the file …”, "see the file ..."), it uses the full path. When the documentation refers to a header in the context of inclusion, it uses the short relative path, matching the form used in #include <header> directives.
>
> [1] https://postgr.es/m/CAHGQGwEyYUzz0LjBV_fMcdwU3wgmu0NCoT+JJiozPa8DG6eeog@mail.gmail.com
>
> Best regards,
> --
> Chao Li (Evan)
> HighGo Software Co., Ltd.
> https://www.highgo.com/
>
>
> <v1-0001-Docs-make-documentation-source-file-references-co.patch>

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

Best regards,
--
Chao Li (Evan)
HighGo Software Co., Ltd.
https://www.highgo.com/

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2026-01-08 06:44:55 Re: Docs: make source file path references consistent
Previous Message Soumya S Murali 2026-01-08 06:28:43 Re: [PATCH] Expose checkpoint reason to completion log messages.