Re: Fix wrong reference in pg_overexplain's doc

Fujii Masao <masao.fujii@gmail.com>

From: Fujii Masao <masao.fujii@gmail.com>

To: Julien Tachoires <julien@tachoires.me>

Cc: pgsql-hackers@lists.postgresql.org

Date: 2025-12-22T09:24:48Z

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 →

doc: Use proper tags in pg_overexplain documentation.
- 02a0f385fa98 18.2 landed
- 008beba005c9 19 (unreleased) landed
doc: Fix incorrect reference in pg_overexplain documentation.
- 283e25a37187 18.2 landed
- c5d162435ab7 19 (unreleased) landed

Attachments

v1-0001-doc-Use-proper-tags-in-pg_overexplain-documentati.patch (application/octet-stream) patch v1-0001

On Fri, Dec 19, 2025 at 12:16 PM Fujii Masao <masao.fujii@gmail.com> wrote:
>
> On Thu, Dec 18, 2025 at 6:23 PM Julien Tachoires <julien@tachoires.me> wrote:
> >
> > Hi,
> >
> > pg_overexplain's documentation mentions that the definition of
> > RangeTblEntry is in nodes/plannodes.h, which seems to be wrong as it
> > is defined in nodes/parsenodes.h. Please find a small patch fixing this.
>
> Thanks for the patch! It looks good to me.
>
> Barring any objections, I'll commit it and backpatch to v18,
> where pg_overexplain was introduced.

I've pushed the patch. Thanks!

After that, I noticed that the pg_overexplain docs uses the <literal> tag for
file names, struct names, and commands. It would be more appropriate to use
<filename>, <structname>, and <command> instead. I've attached a patch that
updates the documentation accordingly. Thoughts?

Regards,

-- 
Fujii Masao