Re: Documentation for building with meson

From: Andres Freund <andres(at)anarazel(dot)de>
To: samay sharma <smilingsamay(at)gmail(dot)com>
Cc: Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>, Justin Pryzby <pryzby(at)telsasoft(dot)com>, Nazir Bilal Yavuz <byavuz81(at)gmail(dot)com>, John Naylor <john(dot)naylor(at)enterprisedb(dot)com>, pgsql-hackers(at)postgresql(dot)org
Subject: Re: Documentation for building with meson
Date: 2023-04-11 17:18:07
Message-ID: 20230411171807.ewyxv7hzcphuwcnc@awork3.anarazel.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

On 2023-03-28 12:27:26 -0700, samay sharma wrote:
> Subject: [PATCH v9 1/5] Make minor additions and corrections to meson docs
>
> This commit makes a few corrections to the meson docs
> and adds a few instructions and links for better clarity.
> ---
> doc/src/sgml/installation.sgml | 24 +++++++++++++++---------
> 1 file changed, 15 insertions(+), 9 deletions(-)
>
> diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml
> index 70ab5b77d8..e3b9b6c0d0 100644
> --- a/doc/src/sgml/installation.sgml
> +++ b/doc/src/sgml/installation.sgml
> @@ -2057,8 +2057,7 @@ meson setup build -Dssl=openssl
> <screen>
> meson configure -Dcassert=true
> </screen>
> - <command>meson configure</command>'s commonly used command-line options
> - are explained in <xref linkend="meson-options"/>.
> + Commonly used build options for <command>meson configure</command> (and <command>meson setup</command>) are explained in <xref linkend="meson-options"/>.
> </para>
> </step>
>
> @@ -2078,6 +2077,13 @@ ninja
> processes used with the command line argument <literal>-j</literal>.
> </para>
>
> + <para>
> + If you want to build the docs, you can type:
> +<screen>
> +ninja docs
> +</screen>
> + </para>

"type" sounds a bit too, IDK, process oriented. "To build the docs, use"?

> Subject: [PATCH v9 2/5] Add data layout options sub-section in installation
> docs
>
> This commit separates out blocksize, segsize and wal_blocksize
> options into a separate Data layout options sub-section in both
> the make and meson docs. They were earlier in a miscellaneous
> section which included several unrelated options. This change
> also helps reduce the repetition of the warnings that changing
> these parameters breaks on-disk compatibility.

Makes sense. I'm planning to apply this unless Peter or somebody else has
further feedback.

> From 11d82aa49efb3d1cbc08f14562a757f115053c8b Mon Sep 17 00:00:00 2001
> From: Samay Sharma <smilingsamay(at)gmail(dot)com>
> Date: Mon, 13 Feb 2023 16:23:52 -0800
> Subject: [PATCH v9 3/5] Remove Anti-Features section from Installation from
> source docs
>
> Currently, several meson setup options are listed in anti-features.
> However, they are similar to most other options in the postgres
> features list as they are 'auto' features themselves. Also, other
> options are likely better suited to the developer options section.
> This commit, therefore, moves the options listed in the anti-features
> section into other sections and removes that section.
>
> For consistency, this reorganization has been done on the make section
> of the docs as well.

Makes sense to me. "Anti-Features" is confusing as a name to start with.

Greetings,

Andres Freund

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2023-04-11 17:30:15 Re: When to drop src/tools/msvc support
Previous Message Jehan-Guillaume de Rorthais 2023-04-11 17:14:24 Re: Memory leak from ExecutorState context?