Re: [PATCH v8 2/6] PCI: Deprecate pcim_iounmap_regions()
From: Andy Shevchenko
Date: Fri Oct 18 2024 - 08:37:01 EST
On Fri, Oct 18, 2024 at 12:52:15PM +0200, Philipp Stanner wrote:
> On Wed, 2024-10-16 at 13:38 +0300, Andy Shevchenko wrote:
> > On Wed, Oct 16, 2024 at 11:49:05AM +0200, Philipp Stanner wrote:
...
> > > + * This function is DEPRECATED. Do not use it in new code.
> >
> > Interestingly that the syntax of the DEPRECATED is not documented
> > (yet?),
> > however the sphinx parser hints us about **DEPRECATED** format — see
> > Documentation/sphinx/parse-headers.pl:251. In any case the above
> > seems
> > like second used (in a form of the full sentence) and will be updated
> > in accordance with the above mentioned script.
>
> Can't completely follow – so one should always write "**DEPRECATED**",
> correct?
I can't answer to this, because there may be "rendered" form and in this case
it should not be surrounded by double asterisks, otherwise it's better to have
at the start.
> Is that a blocker for you?
Nope, I mentioned this in the last sentence in my previous reply.
> All the docstrings in pci/pci.c and pci/devres.c so far just use
> "DEPRECATED".
Yeah, this, if ever needed, has to be changed at once.
--
With Best Regards,
Andy Shevchenko