fa88928470
The documentation and the code is generated automatically from a new file called wait_event_names.txt, formatted in sections dedicated to each wait event class (Timeout, Lock, IO, etc.) with three tab-separated fields: - C symbol in enums - Format in the system views - Description in the docs Using this approach has several advantages, as we have proved to be rather bad in maintaining this area of the tree across the years: - The order of each item in the documentation and the code, which should be alphabetical, has become incorrect multiple times, and the script generating the code and documentation has a few rules to enforce that, making the maintenance a no-brainer. - Some wait events were added to the code, but not documented, so this cannot be missed now. - The order of the tables for each wait event class is enforced in the documentation (the input .txt file does so as well for clarity, though this is not mandatory). - Less code, shaving 1.2k lines from the tree, with 1/3 of the savings coming from the code, the rest from the documentation. The wait event types "Lock" and "LWLock" still have their own code path for their code, hence only the documentation is created for them. These classes are listed with a special marker called WAIT_EVENT_DOCONLY in the input file. Adding a new wait event now requires only an update of wait_event_names.txt, with "Lock" and "LWLock" treated as exceptions. This commit has been tested with configure/Makefile, the CI and VPATH build. clean, distclean and maintainer-clean were working fine. Author: Bertrand Drouvot, Michael Paquier Discussion: https://postgr.es/m/77a86b3a-c4a8-5f5d-69b9-d70bbf2e9b98@gmail.com |
||
|---|---|---|
| .. | ||
| activity | ||
| adt | ||
| cache | ||
| error | ||
| fmgr | ||
| hash | ||
| init | ||
| mb | ||
| misc | ||
| mmgr | ||
| resowner | ||
| sort | ||
| time | ||
| .gitignore | ||
| Gen_dummy_probes.pl | ||
| Gen_dummy_probes.pl.prolog | ||
| Gen_dummy_probes.sed | ||
| Gen_fmgrtab.pl | ||
| Makefile | ||
| README.Gen_dummy_probes | ||
| errcodes.txt | ||
| generate-errcodes.pl | ||
| meson.build | ||
| postprocess_dtrace.sed | ||
| probes.d | ||
README.Gen_dummy_probes
# Generating dummy probes If Postgres isn't configured with dtrace enabled, we need to generate dummy probes for the entries in probes.d, that do nothing. This is accomplished in Unix via the sed script `Gen_dummy_probes.sed`. We used to use this in MSVC builds using the perl utility `psed`, which mimicked sed. However, that utility disappeared from Windows perl distributions and so we converted the sed script to a perl script to be used in MSVC builds. We still keep the sed script as the authoritative source for generating these dummy probes because except on Windows perl is not a hard requirement when building from a tarball. So, if you need to change the way dummy probes are generated, first change the sed script, and when it's working generate the perl script. This can be accomplished by using the perl utility s2p. s2p is no longer part of the perl core, so it might not be on your system, but it is available on CPAN and also in many package systems. e.g. on Fedora it can be installed using `cpan App::s2p` or `dnf install perl-App-s2p`. The Makefile contains a recipe for regenerating Gen_dummy_probes.pl, so all you need to do is once you have s2p installed is `make Gen_dummy_probes.pl` Note that in a VPATH build this will generate the file in the vpath tree, not the source tree.