All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
To: Andy Shevchenko <andriy.shevchenko@intel.com>
Cc: linux-pci@vger.kernel.org, "Bjorn Helgaas" <bhelgaas@google.com>,
	"Lorenzo Pieralisi" <lorenzo.pieralisi@arm.com>,
	"Rob Herring" <robh@kernel.org>,
	"Krzysztof Wilczyński" <kw@linux.com>,
	"Igor Mammedov" <imammedo@redhat.com>,
	"Lukas Wunner" <lukas@wunner.de>,
	"Mika Westerberg" <mika.westerberg@linux.intel.com>,
	"Rafael J . Wysocki" <rafael@kernel.org>,
	LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 4/7] resource: Use typedef for alignf callback
Date: Wed, 27 Dec 2023 17:54:50 +0200 (EET)	[thread overview]
Message-ID: <8161e59d-2122-562c-dcc7-f772ddbcbdf@linux.intel.com> (raw)
In-Reply-To: <ZYWPaGc4rjymcm75@smile.fi.intel.com>

On Fri, 22 Dec 2023, Andy Shevchenko wrote:

> > +/**
> > + * resource_alignf - Resource alignment callback
> > + * @data:	Private data used by the callback
> > + * @res:	Resource candidate range (an empty resource slot)
> > + * @size:	The minimum size of the empty slot
> > + * @align:	Alignment from the constraints
> > + *
> > + * Callback allows calculating resource placement and alignment beyond min,
> > + * max, and align fields in the struct resource_constraint.
> > + *
> > + * Return: Start address for the resource.
> > + */
> > +typedef resource_size_t (*resource_alignf)(void *data,
> > +					   const struct resource *res,
> > +					   resource_size_t size,
> > +					   resource_size_t align);
> 
> Never saw typedef kernel-doc before, so hopefully this will be rendered
> just fine.

This was a good point. It seems that one has to prefix the name with 
typedef like this:

/**
 * typedef resource_alignf - Resource alignment callback

...otherwise scripts/kernel-doc attempts to parse it as a function 
kerneldoc.

-- 
 i.


  reply	other threads:[~2023-12-27 15:54 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-22 12:28 [PATCH 0/7] PCI: Solve two bridge window sizing issues Ilpo Järvinen
2023-12-22 12:28 ` [PATCH 1/7] PCI: Fix resource double counting on remove & rescan Ilpo Järvinen
2023-12-22 12:28 ` [PATCH 2/7] resource: Rename find_resource() to find_empty_resource_slot() Ilpo Järvinen
2023-12-22 13:26   ` Andy Shevchenko
2023-12-22 12:28 ` [PATCH 3/7] resource: Document find_empty_resource_slot() and resource_constraint Ilpo Järvinen
2023-12-22 13:28   ` Andy Shevchenko
2023-12-22 12:28 ` [PATCH 4/7] resource: Use typedef for alignf callback Ilpo Järvinen
2023-12-22 13:30   ` Andy Shevchenko
2023-12-27 15:54     ` Ilpo Järvinen [this message]
2023-12-27 21:21       ` Randy Dunlap
2023-12-22 12:28 ` [PATCH 5/7] resource: Handle simple alignment inside __find_empty_resource_slot() Ilpo Järvinen
2023-12-22 13:34   ` Andy Shevchenko
2023-12-22 12:29 ` [PATCH 6/7] resource: Export find_empty_resource_slot() Ilpo Järvinen
2023-12-22 13:35   ` Andy Shevchenko
2023-12-22 12:29 ` [PATCH 7/7] PCI: Relax bridge window tail sizing rules Ilpo Järvinen
2023-12-22 13:48   ` Andy Shevchenko
2023-12-27 14:44     ` Ilpo Järvinen
2024-03-05 15:37 ` [PATCH 0/7] PCI: Solve two bridge window sizing issues Ilpo Järvinen
2024-03-05 16:25   ` Bjorn Helgaas

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8161e59d-2122-562c-dcc7-f772ddbcbdf@linux.intel.com \
    --to=ilpo.jarvinen@linux.intel.com \
    --cc=andriy.shevchenko@intel.com \
    --cc=bhelgaas@google.com \
    --cc=imammedo@redhat.com \
    --cc=kw@linux.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=lorenzo.pieralisi@arm.com \
    --cc=lukas@wunner.de \
    --cc=mika.westerberg@linux.intel.com \
    --cc=rafael@kernel.org \
    --cc=robh@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.