Docs: make source file path references consistent - Mailing list pgsql-hackers

From Chao Li
Subject Docs: make source file path references consistent
Date
Msg-id CAEoWx2n=X2vvkJqsNDENgqkyw_adG=7wSHG-og-dLbyM4G_7SA@mail.gmail.com
Whole thread Raw
List 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.


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


Attachment

pgsql-hackers by date:

Previous
From: "Jelte Fennema-Nio"
Date:
Subject: Re: cleanup: Split long Makefile lists across lines and sort them
Next
From: "zengman"
Date:
Subject: Re: cleanup: Split long Makefile lists across lines and sort them