Re: [RFC] building postgres with meson - v11
samay sharma <smilingsamay@gmail.com>
Hi, On Wed, Aug 31, 2022 at 1:42 AM Peter Eisentraut < peter.eisentraut@enterprisedb.com> wrote: > On 24.08.22 17:30, Andres Freund wrote: > >> 0545eec895 meson: Add docs > >> > >> We should think more about how to arrange the documentation. We > >> probably don't want to copy-and-paste all the introductory and > >> requirements information. I think we can make this initially much > >> briefer, like the Windows installation chapter. For example, instead > >> of documenting each setup option again, just mention which ones exist > >> and then point (link) to the configure chapter for details. > > The current docs, including the windows ones, are already hard to > follow. I > > think we should take some care to not make the meson bits even more > > confusing. Cross referencing left and right seems problematic from that > angle. > > If you look at the current structure of the installation chapter > > 17.1. Short Version > 17.2. Requirements > 17.3. Getting the Source > 17.4. Installation Procedure > 17.5. Post-Installation Setup > 17.6. Supported Platforms > 17.7. Platform-Specific Notes > > only 17.1, small parts of 12.2, and 17.4 should differ between make and > meson. There is no conceivable reason why the meson installation > chapter should have a different "Getting the Source" section. And some > of the post-installation and platform-specific information doesn't > appear at all on the meson chapter. > > I think we can try to be a bit more ingenious in how we weave this > together in the best way. What I really wouldn't want is two separate > chapters that duplicate the entire process. I think we could do one > chapter, like > > - Short Version > - Requirements > - Getting the Source > - Installation Procedure > - Installation Procedure using Meson > - Post-Installation Setup > - Supported Platforms > - Platform-Specific Notes > I spent some more time thinking about the structure of the docs. The getting the source, supported platforms, post installation setup and platform specific notes sections are going to be mostly common. We do expect some differences in supported platforms and platform specific notes but I think they should be manageable without confusing readers. The others; short version, requirements, and installation procedure are pretty different and I feel combining them will end up confusing readers or require creating autoconf / make and meson versions of many things at many different places. Also, if we keep it separate, it'll be easier to remove make / autoconf specific sections if (when?) we want to do that. So, I was thinking of the following structure: - Supported Platforms - Getting the Source - Building with make and autoconf -- Short version -- Requirements -- Installation Procedure and it's subsections - Building with Meson -- Short version -- Requirements -- Installation Procedure and it's subsections - Post-installation Setup - Platform specific notes It has the disadvantage of short version moving to a bit later in the chapter but I think it's a good structure to reduce duplication and also keep sections which are different separate. Thoughts on this approach? If this looks good, I can submit a patch rearranging things this way. As a follow up patch, we could also try to fit the Windows part into this model. We could add a Building with visual C++ or Microsoft windows SDK section. It doesn't have a short version but follows the remaining template of requirements and installation procedure subsections (Building, Cleaning and Installing and Running Regression tests) well. Regards, Samay > > Alternatively, if people prefer two separate chapters, let's think about > some source-code level techniques to share the common contents. >
Commits
-
meson: Add 'running' test setup, as a replacement for installcheck
- 3f0e786ccbf5 16.0 landed
-
meson: Add support for building with precompiled headers
- e5555657ba86 16.0 landed
-
windows: Adjust FD_SETSIZE via commandline define
- 4289263cf263 16.0 landed
-
meson: docs: Add xml{lint,proc} wrapper to collect dependencies
- 29668e31865a 16.0 landed
-
meson: ecpg: Split definition of static and shared libraries
- a1261cd16f07 16.0 landed
-
windows: Set UMDF_USING_NTSTATUS globally, include ntstatus.h
- b8d8a4593a3a 16.0 landed
-
ci: Add hint about downloadable logs to README
- bed0927aeb0c 16.0 cited
-
meson: Set up absolute rpaths to libdir
- a1860071b3fc 16.0 landed
-
meson: Include CFLAGS/c_args in summary and pg_config output
- 1330dcdec0f2 16.0 landed
-
windows: remove date from version number in win32ver.rc
- 31d2c4716e6b 16.0 landed
-
meson: Add initial version of meson based build system
- e6927270cd18 16.0 landed
-
ci: windows: set error mode to not include SEM_NOGPFAULTERRORBOX
- 0c400445dbe3 15.0 landed
- 661ee7bfc661 16.0 landed
-
Refactor PG_TEST_EXTRA logic in autoconf build
- c3382a3c3ccd 16.0 landed
-
Split TESTDIR into TESTLOGDIR and TESTDATADIR
- c47885bd8b69 16.0 landed
-
Don't hardcode tmp_check/ as test directory for tap tests
- bb54bf22900f 16.0 landed
-
Extend gendef.pl in preparation for meson
- 70df2df1cc89 16.0 landed
-
Include c.h instead of postgres.h in src/port/*p{read,write}*.c
- 5aee41e28de9 12.13 landed
- f69b8f324af5 13.9 landed
- b4b4b817da5a 14.6 landed
- 940c1c7ed3d1 15.0 landed
- 43fcaa345d5a 16.0 landed
-
Remove DLLTOOL, DLLWRAP from configure / Makefile.global.in
- 8d513a6b71b7 16.0 landed
-
Run xmllint validation only once
- ab393528fa4b 16.0 landed
-
Bump minimum Perl version to 5.14
- 4c1532763a00 16.0 landed
-
Move gramparse.h to src/backend/parser
- ecaf7c5df54f 16.0 landed
-
Run perltidy over Catalog.pm
- b2e6e768230b 16.0 landed
-
Parse catalog .dat files as a whole when compiling the backend
- 69eb643b2582 16.0 landed
-
Build all Flex files standalone
- dac048f71ebb 16.0 landed
-
Move private declarations shared between guc.c and guc-file.l to new header
- 80e8450a744b 16.0 landed
-
Preparatory refactoring for compiling guc-file.c standalone
- 1b188ea7921a 16.0 landed
-
Move darwin sysroot determination into separate file
- 05519126a02e 16.0 landed
-
Fix MSVC warning in compat_informix/rnull.pgc
- 483ac6476198 16.0 landed
-
solaris: Use versioning scripts instead of -Bsymbolic
- 3fb0687d328b 16.0 landed
-
Change shared library installation naming on macOS
- 161355ee6d2c 16.0 landed
-
regress: allow to specify directory containing expected files, for ecpg
- c855872074b5 16.0 landed
-
Don't add HAVE_LDAP_H HAVE_WINLDAP_H to pg_config.h
- 4ab53b647abf 16.0 landed
-
Refactor dtrace postprocessing make rules
- eb6569fd0e24 16.0 landed
-
Add output directory option to gen_node_support.pl
- adba4b747106 16.0 landed
-
Add output directory argument to generate-unicode_norm_table.pl
- c8a9246e09cc 16.0 landed
-
Add output file argument to generate-errcodes.pl
- 2bf626b714b5 16.0 landed
-
Add output path arg in generate-lwlocknames.pl
- 4f20506fe040 16.0 landed
-
Move snowball_create.sql creation into perl file
- b3a0d8324cf1 16.0 landed
-
ecpg: Output dir, source dir, stamp file argument for preproc/*.pl
- db0a272d123b 16.0 landed
-
psql: Output dir and dependency generation for sql_help
- 7c3c2cb9aeda 16.0 landed
-
Deal with paths containing \ and spaces in basebackup_to_shell tests
- a91242b1bcb3 16.0 landed
- 1ab071983637 15.0 landed
-
Remove LLVM_CONFIG from Makefile.global.in
- 7775c748db12 16.0 landed
-
Make update-unicode target work in vpath builds
- c64fb698d076 15.0 landed
-
Refactor DLSUFFIX handling
- 23119d51a14c 15.0 landed
-
ldap tests: Add paths for openbsd.
- 45fb0de4dc65 15.0 landed
-
ldap tests: Don't run on unsupported operating systems.
- ee56c3b21629 15.0 landed
-
Remove check for accept() argument types
- ee3a1a5b636b 15.0 landed
-
Move our p{read,write}v replacements into their own files.
- 0d56acfbaa79 14.0 cited
-
Adjust yywrap macro for non-reentrant scanners for MSVC.
- 08a0c2dabc3b 9.1.0 cited
-
Remove any -arch switches given in ExtUtils::Embed's ldopts from our
- d69a419e682c 9.0.0 cited
-
Change PL/Perl and Pg interface build to use configured compiler and
- 7662419f1bc1 7.3.1 cited
-
Apparently, on some systems, ExtUtils::Embed and MakeMaker are slightly
- f5d0c6cad5bb 7.2.1 cited