Horton

Re: Probable documentation errors or improvements

Heikki Linnakangas <hlinnaka@iki.fi>

View thread View on postgr.es
From: Heikki Linnakangas <hlinnaka@iki.fi>
To: Justin Pryzby <pryzby@telsasoft.com>, Yaroslav <ladayaroslav@yandex.ru>
Cc: pgsql-hackers@postgresql.org, David G Johnston <david.g.johnston@gmail.com>, Teodor Sigaev <teodor@sigaev.ru>, Oleg Bartunov <obartunov@postgrespro.ru>, Dmitry Ivanov <d.ivanov@postgrespro.ru>, Alexander Korotkov <a.korotkov@postgrespro.ru>, Arthur Zakirov <a.zakirov@postgrespro.ru>
Date: 2020-10-19T16:36:29Z
Lists: pgsql-hackers 
On 05/10/2020 22:19, Justin Pryzby wrote:
> On Fri, Sep 25, 2020 at 09:30:00AM -0500, Justin Pryzby wrote:
>> Split one patch about text search, added another one (sequences), added some
>> info to commit messages, and added here.
>> https://commitfest.postgresql.org/30/2744/
> 
> Added an additional patch regarding spaces between function arguments.

Pushed most of these.

I left out these changes in sepgsql docs:

> --- a/doc/src/sgml/sepgsql.sgml
> +++ b/doc/src/sgml/sepgsql.sgml
> @@ -88,7 +88,7 @@ Policy from config file:        targeted
>    <para>
>     To build this module, include the option <literal>--with-selinux</literal> in
>     your PostgreSQL <literal>configure</literal> command.  Be sure that the
> -   <filename>libselinux-devel</filename> RPM is installed at build time.
> +   <filename>libselinux-devel</filename> package is installed at build time.
>    </para>

It's true that the sentence is unusually distro-specific, but I think 
second instance of this becomes ambiguous if we just change RPM to package:

>   <para>
>    Second, build and install the policy package for the regression test.
>    The <filename>sepgsql-regtest</filename> policy is a special purpose policy package
>    which provides a set of rules to be allowed during the regression tests.
>    It should be built from the policy source file
>    <filename>sepgsql-regtest.te</filename>, which is done using
>    <command>make</command> with a Makefile supplied by SELinux.
>    You will need to locate the appropriate
>    Makefile on your system; the path shown below is only an example.
>    (This Makefile is usually supplied by the
>    <filename>selinux-policy-devel</filename> or
>    <filename>selinux-policy</filename> RPM.)
>    Once built, install this policy package using the
>    <command>semodule</command> command, which loads supplied policy packages
>    into the kernel.  If the package is correctly installed,
>    <literal><command>semodule</command> -l</literal> should list <literal>sepgsql-regtest</literal> as an
>    available policy package:
>   </para>

The paragraph talks about "policy package", so using just "package" to 
refer to a .rpm/.deb file would be confusing. Suggestions are welcome.

- Heikki

Commits

  1. doc: Remove more notes about compatibilities with past versions

  2. Misc documentation fixes.

  3. Fix TRUNCATE doc: ALTER SEQUENCE RESTART is now transactional.

  4. Fix output of tsquery example in docs.

  5. Fix doc for full text search distance operator.

  6. Phrase full text search.