David Steele <david@pgmasters.net> writes:
> On 1/18/22 15:41, Tom Lane wrote:
>> The only other nitpick I have is that I'd make the cross-references be
>> to the two file names, ie like "Note that similar checks are performed
>> in fe-secure-openssl.c ..." References to the specific functions seem
>> likely to bit-rot in the face of future code rearrangements.
>> I suppose filename references could become obsolete too, but it
>> seems less likely.
> It's true that functions are more likely to be renamed, but when I
> rename a function I then search for all the places where it is used so I
> can update them. If the function name appears in a comment that gets
> updated as well.
Harsh experience says that a lot of Postgres contributors have zero
interest in updating comments two lines away from what they're editing,
let alone in some distant branch of the source tree. But I'm not dead
set on it either way.
regards, tom lane