Re: New Defects reported by Coverity Scan for PostgreSQL

From: Tomas Vondra <tomas(dot)vondra(at)2ndquadrant(dot)com>
To: emre(at)hasegeli(dot)com, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Ning Yu <nyu(at)pivotal(dot)io>, Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, Pg Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: New Defects reported by Coverity Scan for PostgreSQL
Date: 2018-08-01 13:33:47
Message-ID: 5fece6c5-6a80-9694-1a24-3ae245ae2cba@2ndquadrant.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-hackers

On 08/01/2018 11:55 AM, Emre Hasegeli wrote:
>> Or perhaps I have it backwards and "l1" and "l2" need to be swapped in
>> that description. But the mere fact that there is any question about
>> that means that the function is poorly documented and perhaps poorly
>> named as well. For that matter, is there a good reason why l1/l2
>> have those roles and not the reverse?
>
> Consistency. I organized all xxx_closept_yyy(Point *result, xxx *l1,
> yyy *l2) functions in a way that they find the find the point on "l1".
>

IMHO the main issue here is that the rule is not obvious / documented
anywhere. I think the best way to do that is by making it clear in a
comment for each such such function.

regards

--
Tomas Vondra http://www.2ndQuadrant.com
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

In response to

Responses

Browse pgsql-committers by date

  From Date Subject
Next Message Tom Lane 2018-08-01 13:57:04 Re: New Defects reported by Coverity Scan for PostgreSQL
Previous Message Robert Haas 2018-08-01 12:15:27 pgsql: Update parallel.sgml for Parallel Append

Browse pgsql-hackers by date

  From Date Subject
Next Message PG Bug reporting form 2018-08-01 13:35:13 BUG #15307: Low numerical precision of (Co-) Variance
Previous Message Robert Haas 2018-08-01 13:21:25 Re: partition tree inspection functions