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: Docs: make source file path references consistent
Date: 2025-12-25 09:07:53
Message-ID: CAEoWx2n=X2vvkJqsNDENgqkyw_adG=7wSHG-og-dLbyM4G_7SA@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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/

Attachment Content-Type Size
v1-0001-Docs-make-documentation-source-file-references-co.patch application/octet-stream 18.3 KB

Browse pgsql-hackers by date

  From Date Subject
Next Message zengman 2025-12-25 09:26:24 Re: cleanup: Split long Makefile lists across lines and sort them
Previous Message Jelte Fennema-Nio 2025-12-25 09:07:40 Re: cleanup: Split long Makefile lists across lines and sort them