Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) client-ip=2620:137:e000::3:4;
Content-Type: text/plain;
        charset=us-ascii
Mime-Version: 1.0
Subject: Re: [PATCH 2/7] mm: shrinker: Add a .to_text() method for shrinkers
From:   Muchun Song <muchun.song@linux.dev>
In-Reply-To: <20231125003009.tbaxuquny43uwei3@moria.home.lan>
Date:   Tue, 28 Nov 2023 11:27:11 +0800
Cc:     Qi Zheng <zhengqi.arch@bytedance.com>,
        Linux-MM <linux-mm@kvack.org>, linux-kernel@vger.kernel.org,
        Andrew Morton <akpm@linux-foundation.org>,
        Roman Gushchin <roman.gushchin@linux.dev>,
        Dave Chinner <david@fromorbit.com>
Content-Transfer-Encoding: quoted-printable
Message-Id: <76A1EE85-B62C-49B3-889C-80F9A2A88040@linux.dev>
References: <20231122232515.177833-1-kent.overstreet@linux.dev>
 <20231122232515.177833-3-kent.overstreet@linux.dev>
 <deed9bb1-02b9-4e89-895b-38a84e5a9408@gmail.com>
 <20231123212411.s6r5ekvkklvhwfra@moria.home.lan>
 <4caadff7-1df0-45cc-9d43-e616f9e4ddb3@bytedance.com>
 <20231125003009.tbaxuquny43uwei3@moria.home.lan>
To:     Kent Overstreet <kent.overstreet@linux.dev>
Precedence: bulk


> On Nov 25, 2023, at 08:30, Kent Overstreet <kent.overstreet@linux.dev> =
wrote:
>=20
> On Fri, Nov 24, 2023 at 11:08:11AM +0800, Qi Zheng wrote:
>> Hi Kent,
>>=20
>> On 2023/11/24 05:24, Kent Overstreet wrote:
>>> On Thu, Nov 23, 2023 at 11:32:59AM +0800, Qi Zheng wrote:
>>>>> + void (*to_text)(struct seq_buf *, struct shrinker *);
>>>>=20
>>>> The "to_text" looks a little strange, how about naming it
>>>> "stat_objects"?
>>>=20
>>> The convention I've been using heavily in bcachefs is
>>> typename_to_text(), or type.to_text(), for debug reports. The
>>=20
>> OK.
>>=20
>>> consistency is nice.
>>=20
>> However, this is inconsistent with the name style of other
>> shrinker callbacks. Please use the "objects" suffix. As for
>> bcachefs's own callback function, you can use typename_to_text()
>> to ensure consistency.
>=20
> That would be inconsistent with introducing a convention to the wider
> kernel.
>=20

I don not think .to_text is a good name. I really do not know what it =
means
when I first look at this name. I knew you want to report the objects of
shrinks, so why not use .report_objects or stat_objects proposed by Qi.
Although .to_text is only used by bcachefs now, shrinker is a general =
module
which is not only serving the bcachefs itself. I think it should be =
better
to use a more straightforward name.

Muchun,
Thanks.=