On Wed, 22 Jan 2025 23:03:24 -0800
Boqun Feng [off-list ref] wrote:

On Wed, Jan 22, 2025 at 07:44:05PM +0900, FUJITA Tomonori wrote:

quoted

On Wed, 22 Jan 2025 09:23:33 +0100
Alice Ryhl [off-list ref] wrote:

quoted

quoted

quoted

I would also say "the C side [`fsleep()`] or similar"; in other words,
both are "kernel's" at this point.

Agreed that "the C side" is better and updated the comment. I copied
that expression from the existing code; there are many "kernel's" in
rust/kernel/. "good first issues" for them?

You prefer "[`fsleep()`]" rather than "[`fsleep`]"? I can't find any
precedent for the C side functions.

I think that's a matter of taste. In the Rust ecosystem, fsleep is
more common, in the kernel ecosystem, fsleep() is more common. I've
seen both in Rust code at this point.

Understood, I'll go with [`fsleep`].

I would suggest using [`fsleep()`], in the same spirit of this paragraph
in Documentation/process/maintainer-tip.rst:

"""
When a function is mentioned in the changelog, either the text body or the
subject line, please use the format 'function_name()'. Omitting the
brackets after the function name can be ambiguous::

  Subject: subsys/component: Make reservation_count static

  reservation_count is only used in reservation_stats. Make it static.

The variant with brackets is more precise::

  Subject: subsys/component: Make reservation_count() static

  reservation_count() is only called from reservation_stats(). Make it
  static.
"""

, since fsleep() falls into the areas of tip tree.

Thanks, I overlooked this. I had better to go with [`fsleep()`] then.

I think that using two styles under rust/kernel isn't ideal. Should we
make the [`function_name()`] style the preference under rust/kernel?

Unless there's a subsystem that prefers the [`function_name`] style,
that would be a different story.