Re: Fix wrong reference in pg_overexplain's doc - Mailing list pgsql-hackers

From Fujii Masao
Subject Re: Fix wrong reference in pg_overexplain's doc
Date
Msg-id CAHGQGwEyYUzz0LjBV_fMcdwU3wgmu0NCoT+JJiozPa8DG6eeog@mail.gmail.com
Whole thread Raw
In response to Re: Fix wrong reference in pg_overexplain's doc  (Fujii Masao <masao.fujii@gmail.com>)
List pgsql-hackers
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

Attachment

pgsql-hackers by date:

Previous
From: Chao Li
Date:
Subject: Re: Remove MsgType type
Next
From: Chao Li
Date:
Subject: Re: [bug fix] prepared transaction might be lost when max_prepared_transactions is zero on the subscriber