Fix obsoleted comments for function prototypes

Lists: pgsql-hackers
From: Richard Guo <guofenglinux(at)gmail(dot)com>
To: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Fix obsoleted comments for function prototypes
Date: 2022-08-02 09:06:44
Message-ID: CAMbWs4__RdcSNXPa7L62Ozvo_Q4LvT60o3Bnp8yrQ_m9y5CKvg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

While doing the search in [1], I spotted several places where the
comments for the function prototypes are obsoleted. For instance,
btree_desc() and btree_identify() are now located in nbtdesc.c but the
comment in nbtxlog.h is still claiming they are in nbtxlog.c.

Fix these places with the attached. With high possibility there are
other places with this kind of obsoleted comments, but I don't know how
to find them all :-(.

Thanks
Richard

[1]
https://www.postgresql.org/message-id/CAMbWs489%2Bu6P_9qMjABsse0dNNBr36MA1SX5Ss7yZ7TD86mfKQ%40mail.gmail.com

Attachment Content-Type Size
v1-0001-Resolve-obsoleted-comments-for-function-prototype.patch application/octet-stream 3.4 KB
From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Richard Guo <guofenglinux(at)gmail(dot)com>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Fix obsoleted comments for function prototypes
Date: 2022-08-02 10:25:49
Message-ID: [email protected]
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

On Tue, Aug 02, 2022 at 05:06:44PM +0800, Richard Guo wrote:
> While doing the search in [1], I spotted several places where the
> comments for the function prototypes are obsoleted. For instance,
> btree_desc() and btree_identify() are now located in nbtdesc.c but the
> comment in nbtxlog.h is still claiming they are in nbtxlog.c.
>
> Fix these places with the attached. With high possibility there are
> other places with this kind of obsoleted comments, but I don't know how
> to find them all :-(.

These declarations are linked to comments with their file paths, so
making that automated looks rather complicated to me. I have looked
at the surroundings without noticing anything obvious, so what you
have caught here sounds fine to me, good catches :)
--
Michael

From: Michael Paquier <michael(at)paquier(dot)xyz>
To: Richard Guo <guofenglinux(at)gmail(dot)com>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Fix obsoleted comments for function prototypes
Date: 2022-08-04 08:38:00
Message-ID: [email protected]
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

On Tue, Aug 02, 2022 at 07:25:49PM +0900, Michael Paquier wrote:
> These declarations are linked to comments with their file paths, so
> making that automated looks rather complicated to me. I have looked
> at the surroundings without noticing anything obvious, so what you
> have caught here sounds fine to me, good catches :)

Done as of 245e14e.
--
Michael

From: Richard Guo <guofenglinux(at)gmail(dot)com>
To: Michael Paquier <michael(at)paquier(dot)xyz>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Fix obsoleted comments for function prototypes
Date: 2022-08-04 11:02:13
Message-ID: CAMbWs4-=Zf-ehuF=ZOz7XfC-+-ZdEj-cwx0duyAqKfDXDjEOmg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

On Thu, Aug 4, 2022 at 4:38 PM Michael Paquier <michael(at)paquier(dot)xyz> wrote:

> On Tue, Aug 02, 2022 at 07:25:49PM +0900, Michael Paquier wrote:
> > These declarations are linked to comments with their file paths, so
> > making that automated looks rather complicated to me. I have looked
> > at the surroundings without noticing anything obvious, so what you
> > have caught here sounds fine to me, good catches :)
>
> Done as of 245e14e.

Thank you Michael!

Thanks
Richard