Re: Add additional information to src/test/ssl/README
Tom Lane <tgl@sss.pgh.pa.us>
From: Tom Lane <tgl@sss.pgh.pa.us>
To: Daniel Gustafsson <daniel@yesql.se>
Cc: Kevin Burke <kevin@burke.dev>,
PostgreSQL Hackers <pgsql-hackers@lists.postgresql.org>
Date: 2021-10-31T18:28:35Z
Lists: pgsql-hackers
Attachments
- readme-improvements-wip.patch (text/x-diff) patch
I wrote: > Daniel Gustafsson <daniel@yesql.se> writes: >> Wouldn't it make more sense to start collecting troubleshooting advice in >> src/test/perl/README and instead refer to that in the boilerplate? I notice >> that we don't document for example PG_TEST_NOCLEAN anywhere (which admittedly >> is my fault), a trubleshooting section in that file would be a good fit. > Yeah, we could try to move all the repetitive stuff to there. I was a bit > allergic to the idea of having README files refer to webpages, because you > might be offline --- but referencing a different README doesn't have that > issue. Here's a quick stab at rearranging src/test/perl/README so that the initial section is all how-to-run-the-tests info, and advice about writing new tests starts after that. Your point about PG_TEST_NOCLEAN could be added into the initial section. I'd envision adding something like "See src/test/perl/README for more info about running these tests." to the boilerplate "Running the tests" section in src/test/ssl/README and its cohorts, but I didn't bother with that yet. regards, tom lane
Commits
-
Document PG_TEST_NOCLEAN in TAP test README
- 05d8785af2a1 15.0 landed
-
Doc: improve README files associated with TAP tests.
- b21415595cac 15.0 landed