Re: Optimizer docs typos

Etsuro Fujita <etsuro.fujita@gmail.com>

From: Etsuro Fujita <etsuro.fujita@gmail.com>
To: Richard Guo <guofenglinux@gmail.com>
Cc: Magnus Hagander <magnus@hagander.net>, Daniel Gustafsson <daniel@yesql.se>, PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2020-05-20T10:17:48Z
Lists: pgsql-hackers

Attachments

On Tue, May 19, 2020 at 7:35 PM Etsuro Fujita <etsuro.fujita@gmail.com> wrote:
> On Mon, May 18, 2020 at 7:45 PM Richard Guo <guofenglinux@gmail.com> wrote:
> > In this same README doc, another suspicious typo to me, which happens in
> > section "Optimizer Functions", is in the prefix to query_planner(),
> > we should have three dashes, rather than two, since query_planner() is
> > called within grouping_planner().
> >
> > diff --git a/src/backend/optimizer/README b/src/backend/optimizer/README
> > index 7dcab9a..bace081 100644
> > --- a/src/backend/optimizer/README
> > +++ b/src/backend/optimizer/README
> > @@ -315,7 +315,7 @@ set up for recursive handling of subqueries
> >    preprocess target list for non-SELECT queries
> >    handle UNION/INTERSECT/EXCEPT, GROUP BY, HAVING, aggregates,
> >         ORDER BY, DISTINCT, LIMIT
> > ---query_planner()
> > +---query_planner()
> >     make list of base relations used in query
> >     split up the qual into restrictions (a=1) and joins (b=c)
> >     find qual clauses that enable merge and hash joins
>
> Yeah, you are right.  Another one would be in the prefix to
> standard_join_search(); I think it might be better to have six dashes,
> rather than five, because standard_join_search() is called within
> make_rel_from_joinlist().

Here is a patch including the change I proposed.  (Yet another thing I
noticed is the indent spaces for join_search_one_level(): that
function is called within standard_join_search(), so it would be
better to have one extra space, for consistency with others (eg,
set_base_rel_pathlists() called from make_one_rel()), but that would
be too nitpicking.)  This is more like an improvement, so I'll apply
the patch to HEAD only, if no objestions.

Best regards,
Etsuro Fujita

Commits

  1. Adjust indentation in src/backend/optimizer/README.