Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1olLWk-0003uL-1O for pgsql-hackers@arkaria.postgresql.org; Thu, 20 Oct 2022 02:43:22 +0000 Received: from localhost ([127.0.0.1] helo=malur.postgresql.org) by malur.postgresql.org with esmtp (Exim 4.92) (envelope-from ) id 1olLWi-000574-F5 for pgsql-hackers@arkaria.postgresql.org; Thu, 20 Oct 2022 02:43:20 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1olLWi-00056v-2O for pgsql-hackers@lists.postgresql.org; Thu, 20 Oct 2022 02:43:20 +0000 Received: from mail-il1-x133.google.com ([2607:f8b0:4864:20::133]) by magus.postgresql.org with esmtps (TLS1.3:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.92) (envelope-from ) id 1olLWe-0005Q7-Sa for pgsql-hackers@postgresql.org; Thu, 20 Oct 2022 02:43:19 +0000 Received: by mail-il1-x133.google.com with SMTP id g13so10227640ile.0 for ; Wed, 19 Oct 2022 19:43:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telsasoft-com.20210112.gappssmtp.com; s=20210112; h=user-agent:in-reply-to:content-disposition:mime-version:references :message-id:subject:cc:to:from:date:from:to:cc:subject:date :message-id:reply-to; bh=vKp9td249ZL/xE75s7/Vx2RAXWN1hX1TwTpfRkcyXhI=; b=d5SxGNaaW3ll6+kiiVjLl2430Ypg1+1/Zmub9jqlgr5qlFDNabd1Cut4fZQHUe0u4I WU7NRd6FL+ImKa7s89BLz/QGDhsAIFgw60dwNduh+bsxRTCUqviVlSCneHc5c0sCkQl4 HM/DtSRSW4D/PkBId4qCPMQ1qsdTSGMbSiFXOka2U6BPIB4WZsHX6ZiIwV33S/80//Z+ Ej2RyWjuzam18KLKHPvOP5kR+U6xhAlDur9n7svnZlliaq2haEBiZF93LB0GltnIwbYt PM800Clb3ibF27cH5dJRF85p/q3rQx6bbYvog82xWC5FmkmDqce0xCEt1aPpTryYlxMQ xnPg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=user-agent:in-reply-to:content-disposition:mime-version:references :message-id:subject:cc:to:from:date:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=vKp9td249ZL/xE75s7/Vx2RAXWN1hX1TwTpfRkcyXhI=; b=CMj5Z36rzy47K4W0L5pe5xtszGJEq8HDs6PW4a4a8GlBADKoVlyqgYEO588qCaFyt3 lcSQoTxXL+Y9j8JVHB+uuqGVNiWe19KHMFyN+tTLGbvTjaw5nQNpnOdcU86MW11ZgLcB wFDLMk3dQG6QPAfVaXtsZJ5Zhoqq2jjR0IRa1zzcbD2MVeAzlxh1DHqCtmYQIYMqhthn IHRhTO/Dy1xVWGm0ZdTDiYf06WOd/3P5DTvE3Ds1nwRgMvYmZmJRb4DxB8z9H42Cti90 ADaQsljSBoYXETBpm7HTjHODvPyPhg+HOsDqvoFHaE68KpOJFm5Dt7ws1ac2prV61QSz z75Q== X-Gm-Message-State: ACrzQf1cmpTRUMhWh1YYTB9LBx6ULR985XYY4n7cVR09MqC1uOOWVm13 414gOqYfENhnzS1IoILXRHXvoQ== X-Google-Smtp-Source: AMsMyM62OK8afTXWRQLLjdr7cdvM+gAgjW8+ZqfyzMt/rYJV3QVRXzEpLnBe0IpgMHEWZFZKIFXg/A== X-Received: by 2002:a05:6e02:1a89:b0:2fd:4b9c:3390 with SMTP id k9-20020a056e021a8900b002fd4b9c3390mr8715182ilv.179.1666233794710; Wed, 19 Oct 2022 19:43:14 -0700 (PDT) Received: from pryzbyj.telsasoft (charmander.telsasoft.com. [50.244.222.1]) by smtp.gmail.com with ESMTPSA id g34-20020a022722000000b003634aa4a55asm2778131jaa.82.2022.10.19.19.43.13 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 19 Oct 2022 19:43:14 -0700 (PDT) Received: by pryzbyj.telsasoft (Postfix, from userid 1000) id 041F68007CC; Wed, 19 Oct 2022 21:43:12 -0500 (CDT) Date: Wed, 19 Oct 2022 21:43:12 -0500 From: Justin Pryzby To: samay sharma Cc: pgsql-hackers@postgresql.org, Peter Eisentraut , Andres Freund Subject: Re: Documentation for building with meson Message-ID: <20221020024312.GH16921@telsasoft.com> References: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.9.4 (2018-02-28) List-Id: List-Help: List-Subscribe: List-Post: List-Owner: List-Archive: Archived-At: Precedence: bulk On Wed, Oct 19, 2022 at 11:35:10AM -0700, samay sharma wrote: > Creating a new thread focussed on adding docs for building Postgres with > meson. This is a spinoff from the original thread [1] and I've attempted to > address all the feedback provided there in the attached patch. > > Please let me know your thoughts. It's easier to review rendered documentation. I made a rendered copy available here: https://api.cirrus-ci.com/v1/artifact/task/6084297781149696/html_docs/html_docs/install-meson.html + Flex and Bison + are needed to build PostgreSQL using + meson. Be sure to get + Flex 2.5.31 or later and + Bison 1.875 or later from your package manager. + Other lex and yacc + programs cannot be used. These versions need to be updated, see also: 57bab3330: - b086a47a270 "Bump minimum version of Bison to 2.3" - 8b878bffa8d "Bump minimum version of Flex to 2.5.35" + will be enabled automatically if the required packages are found. should refer to files/libraries/headers/dependencies rather than "packages" ? + default is false that is to use Readline. "that is to use" should be parenthesized or separate with commas, like | default is false, that is to use Readline. zlib is mentioned twice, the first being "strongly recommended". Is that intended? Also, basebackup can use zlib, too. + If you have the binaries for certain by programs required to build remove "by" ? + Postgres (with or without optional flags) stored at non-standard + paths, you could specify them manually to meson configure. The complete + list of programs for whom this is supported can be found by running for *which Actually, I suggest to say: |If a program required to build Postgres (with or without optional flags) |is stored in a non-standard path, ... + a build with a different value of these options. .. with different values .. + the server, it is recommended to use atleast the at least + and it's options in the meson documentation. its Maybe other things should have ? Git Libxml2 libxslt visual studio DTrace ninja + Flex and Bison Maybe these should use ? + be installed with pip. Should be ? This part is redundant with prior text: " To use this option, you will need an implementation of the Gettext API. " + Enabls use of the Zlib library typo: Enabls + This option is set to true by default and setting it to false will change "and" to ";" for spinlocks and atomics? + Debug info is generated but the result is not optimized. Maybe say the "code" is not optimized ? + the tests can slow down the server significantly remove "can" + You can override the amount of parallel processes used with s/amount/number/ + If you'd like to build with a backend other that ninja other *than + the GNU C library then you will additionally library comma + argument. If no srcdir is given Meson will deduce the given comma + It should be noted that after the initial configure step step comma + After the installation you can free disk space by removing the built installation comma + To learn more about running the tests and how to interpret the results + you can refer to the documentation for interpreting test results. interpret the results comma "for interpreting test results" seems redundant. + ninja install should work for most cases but if you'd like to use more options cases comma Starting with "Developer Options", this intermixes postgres project-specific options like cassert and tap-tests with meson's stuff like buildtype and werror. IMO there's too much detail about meson's options, which I think is better left to that project's own documentation, and postgres docs should include only a brief mention and a reference to their docs. + Ninja will automatically detect the number of CPUs in your computer and + parallelize itself accordingly. You can override the amount of parallel + processes used with the command line argument -j. too much detail for my taste.. -- Justin