Subject: Re: New Defects reported by Coverity Scan for PostgreSQL
To: emre@hasegeli.com, Tom Lane <tgl@sss.pgh.pa.us>
Cc: Ning Yu <nyu@pivotal.io>, Alvaro Herrera <alvherre@2ndquadrant.com>,
 Pg Hackers <pgsql-hackers@postgresql.org>
References: <E1fjZo1-00019i-GG@gemulon.postgresql.org>
 <20180731172149.kdjl3xdjjtwxaj4s@alvherre.pgsql>
 <CAKmaiL2o6584gLFP=6YX-MUqmvOiT==uny+LA8z3=uAnriuzXA@mail.gmail.com>
 <26769.1533090136@sss.pgh.pa.us>
 <CAE2gYzw6iD1YTZ+67hA=s3AG5sbLCsGkHRYQ_Z1Kd+vhiM7ecA@mail.gmail.com>
From: Tomas Vondra <tomas.vondra@2ndquadrant.com>
Message-ID: <5fece6c5-6a80-9694-1a24-3ae245ae2cba@2ndquadrant.com>
Date: Wed, 1 Aug 2018 15:33:47 +0200
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101
 Thunderbird/52.5.2
MIME-Version: 1.0
In-Reply-To: 
 <CAE2gYzw6iD1YTZ+67hA=s3AG5sbLCsGkHRYQ_Z1Kd+vhiM7ecA@mail.gmail.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk


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