Re: Docs: make source file path references consistent

Поиск
Список
Период
Сортировка
От Chao Li
Тема Re: Docs: make source file path references consistent
Дата
Msg-id 64003689-A1F0-4B3A-9DBC-3D1B7B52C7E7@gmail.com
обсуждение исходный текст
Ответ на Docs: make source file path references consistent  (Chao Li <li.evan.chao@gmail.com>)
Ответы Re: Docs: make source file path references consistent
Список pgsql-hackers

> On Dec 25, 2025, at 17:07, Chao Li <li.evan.chao@gmail.com> wrote:
>
> Hi Hackers,
>
> This patch is derived from [1]. While reviewing that thread, I noticed that when the documentation refers to .h and
.cfilesin the PostgreSQL source tree, it uses a mix of full source-tree paths and short relative paths. This
inconsistencycan 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
sourcetree (for example, “in the file …”, "see the file ..."), it uses the full path. When the documentation refers to
aheader 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/







В списке pgsql-hackers по дате отправления: