Horton

Re: Fix wrong reference in pg_overexplain's doc

Shixin Wang <wang-shi-xin@outlook.com>

View thread
From: Shixin Wang <wang-shi-xin@outlook.com>
To: Fujii Masao <masao.fujii@gmail.com>
Cc: Julien Tachoires <julien@tachoires.me>, "pgsql-hackers@lists.postgresql.org" <pgsql-hackers@lists.postgresql.org>
Date: 2025-12-23T01:25:27Z
Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

  1. doc: Use proper tags in pg_overexplain documentation.

  2. doc: Fix incorrect reference in pg_overexplain documentation.

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.