Re: Fix wrong reference in pg_overexplain's doc

From: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
To: Julien Tachoires <julien(at)tachoires(dot)me>
Cc: pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Fix wrong reference in pg_overexplain's doc
Date: 2025-12-22 09:24:48
Message-ID: CAHGQGwEyYUzz0LjBV_fMcdwU3wgmu0NCoT+JJiozPa8DG6eeog@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Dec 19, 2025 at 12:16 PM Fujii Masao <masao(dot)fujii(at)gmail(dot)com> wrote:
>
> On Thu, Dec 18, 2025 at 6:23 PM Julien Tachoires <julien(at)tachoires(dot)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

Attachment Content-Type Size
v1-0001-doc-Use-proper-tags-in-pg_overexplain-documentati.patch application/octet-stream 3.2 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Chao Li 2025-12-22 09:28:37 Re: [bug fix] prepared transaction might be lost when max_prepared_transactions is zero on the subscriber
Previous Message Chao Li 2025-12-22 09:06:41 Re: Remove MsgType type