lkml.org 
[lkml]   [2022]   [Nov]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [patch 23/39] PCI/MSI: Move pci_alloc_irq_vectors_affinity() to api.c
    On Wed, Nov 16, 2022 at 10:23:22AM -0600, Bjorn Helgaas wrote:
    > On Fri, Nov 11, 2022 at 02:54:51PM +0100, Thomas Gleixner wrote:
    ...
    > > +
    > > +/**
    > > + * pci_alloc_irq_vectors_affinity() - Allocate multiple device interrupt
    > > + * vectors with affinity requirements
    > > + * @dev: the PCI device to operate on
    > > + * @min_vecs: minimum required number of vectors (must be >= 1)
    > > + * @max_vecs: maximum desired number of vectors
    > > + * @flags: allocation flags, as in pci_alloc_irq_vectors()
    > > + * @affd: affinity requirements (can be %NULL).
    > > + *
    > > + * Same as pci_alloc_irq_vectors(), but with the extra @affd parameter.
    > > + * Check that function docs, and &struct irq_affinity, for more details.
    >
    > Is "&struct irq_affinity" some kernel-doc syntax, or is the "&"
    > superfluous?
    >

    Hmmm, I stole it from Documentation/doc-guide/kernel-doc.rst. htmldoc
    parses it and generates a link to the referenced structure's kernel-doc.

    But, yeah, this was literally the first usage of such a doc pattern in
    the entire kernel's C code :)

    Thanks,

    --
    Ahmed S. Darwish
    Linutronix GmbH

    \
     
     \ /
      Last update: 2022-11-18 13:35    [W:2.537 / U:0.052 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site