Re: Fix wrong reference in pg_overexplain's doc

From: Shixin Wang <wang-shi-xin(at)outlook(dot)com>
To: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Cc: Julien Tachoires <julien(at)tachoires(dot)me>, "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Fix wrong reference in pg_overexplain's doc
Date: 2025-12-23 01:25:27
Message-ID: CEFFDD03-BDB8-4BAB-814A-1CB44E7767F3@outlook.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi Fujii-san

> It would be more appropriate to use
> <filename>, <structname>, and <command> instead.

```
- following fields. See <literal>PlannedStmt</literal> in
- <literal>nodes/plannodes.h</literal> for additional detail.
+ following fields. See <structname>PlannedStmt</structname> in
+ <filename>nodes/plannodes.h</filename> for additional detail.
```

Switching to <filename> here makes sense. While looking through the SGML files,
I noticed that the way header file paths are written is a bit inconsistent across the documentation.

In many places we use full paths including src/include, for example in fdw_handler.sgml and create_type.sgml:

```
in <filename>src/include/nodes/plannodes.h</filename>, and the comments for
<type>ExecRowMark</type> in <filename>src/include/nodes/execnodes.h</filename> for
```

But in a few files, such as pgoverexplain.sgml (this patch), spi.sgml,
and xfunc.sgml, the paths are written without the src/include/ prefix.

I’m fine with the change as-is; just wanted to ask whether you’d like to use
this patch to address that inconsistency, or keep the existing style in this file.

Regards,
Shixin Wang.

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Yugo Nagata 2025-12-23 01:37:49 Re: psql: Fix tab completion for VACUUM option values
Previous Message Melanie Plageman 2025-12-23 01:18:05 Re: eliminate xl_heap_visible to reduce WAL (and eventually set VM on-access)