Thread: Minor addition to index documentation

Fix incomplete gist interface description.
Patch is attached.

--
Anastasia Lubennikova
Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company

Anastasia Lubennikova wrote:
> Fix incomplete gist interface description.

Hi, thanks for the patch.

I think this sentence is a bit confusing:

>    <para>
> -   GiST indexes require seven support functions, with an optional eighth, as
> +   GiST indexes require seven support functions, with two optional, as
>     shown in <xref linkend="xindex-gist-support-table">.

The new text seems to say that one of the seven support funcs is
optional, which is wrong if I correctly understand that the "fetch"
optional function was added.

Maybe "GiST indexes require nine support functions, two of which are
optional, as shown in XYZ".

This is to be backpatched as far back as commit d04c8ed9044ec, right?

--
Álvaro Herrera                http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

16.11.2015 21:59, Alvaro Herrera:
> Anastasia Lubennikova wrote:
>> Fix incomplete gist interface description.
> Hi, thanks for the patch.
>
> I think this sentence is a bit confusing:
>
>>     <para>
>> -   GiST indexes require seven support functions, with an optional eighth, as
>> +   GiST indexes require seven support functions, with two optional, as
>>      shown in <xref linkend="xindex-gist-support-table">.
> The new text seems to say that one of the seven support funcs is
> optional, which is wrong if I correctly understand that the "fetch"
> optional function was added.
>
> Maybe "GiST indexes require nine support functions, two of which are
> optional, as shown in XYZ".
Yes, thank you for advice. I think it'll be more clear.

> This is to be backpatched as far back as commit d04c8ed9044ec, right?
Yes.

--
Anastasia Lubennikova
Postgres Professional: http://www.postgrespro.com
The Russian Postgres Company

Alvaro Herrera <alvherre@2ndquadrant.com> writes:
> Maybe "GiST indexes require nine support functions, two of which are
> optional, as shown in XYZ".

That wording seems just as bizarre to me: a support function can hardly
be both "required" and "optional".  After a bit of thought I changed it
to
    GiST indexes have nine support functions, two of which are optional,

I noted that the corresponding wording for GIN indexes was a bit out
of date too :-(.  Pushed with those corrections.

            regards, tom lane