Re: Add additional information to src/test/ssl/README

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Kevin Burke <kevin(at)burke(dot)dev>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Add additional information to src/test/ssl/README
Date: 2021-10-31 20:15:43
Message-ID: 5EAAA715-AE57-4C1C-BC0B-6FA495389027@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> On 31 Oct 2021, at 19:28, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>
> I wrote:
>> Daniel Gustafsson <daniel(at)yesql(dot)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.

That's pretty much just what I was thinking, definitely +1 on this patch.

> 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.

Sounds good.

--
Daniel Gustafsson https://vmware.com/

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Andres Freund 2021-10-31 20:16:33 Re: should we enable log_checkpoints out of the box?
Previous Message Thomas Munro 2021-10-31 20:00:49 Re: Time to drop plpython2?