From: "Krzysztof Wilczyński" <kw@linux.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Ray Jui <rjui@broadcom.com>, Bjorn Helgaas <bhelgaas@google.com>,
Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
Rob Herring <robh@kernel.org>,
Scott Branden <sbranden@broadcom.com>,
bcm-kernel-feedback-list@broadcom.com, linux-pci@vger.kernel.org,
linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH v2] PCI: iproc: Fix a non-compliant kernel-doc
Date: Thu, 20 May 2021 00:49:08 +0200 [thread overview]
Message-ID: <20210519224908.GA616654@rocinante.localdomain> (raw)
In-Reply-To: <3623373c-b95c-344f-63c3-3eeeda623e90@infradead.org>
Hi,
> This is a really good cleanup, but there is still one kernel-doc
> warning remaining after this patch is applied. Please see below.
[...]
> > - * iProc PCIe inbound mapping type
> > + * enum iproc_pcie_ib_map_type - iProc PCIe inbound mapping type.
[...]
>
> The above gives me this:
>
> pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_MEM' not described in enum 'iproc_pcie_ib_map_type'
> pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_IO' not described in enum 'iproc_pcie_ib_map_type'
> pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_INVALID' not described in enum 'iproc_pcie_ib_map_type'
>
>
> If you could fix that, it would be Nice. :)
>
> Even if not, it's a good cleanup. Thanks.
Doh! Apologies! This is my bad - correcting the format of the
kernel-doc made the parser go and check for the fields to be properly
documented, thus this new warning. I need to also take care about this
too, a very good point!
Thank you for catching this! I will update everything accordingly.
Krzysztof
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2021-05-19 22:51 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-19 18:38 [PATCH v2] PCI: iproc: Fix a non-compliant kernel-doc Krzysztof Wilczyński
2021-05-19 22:28 ` Randy Dunlap
2021-05-19 22:49 ` Krzysztof Wilczyński [this message]
2021-07-02 20:42 ` Krzysztof Wilczyński
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=20210519224908.GA616654@rocinante.localdomain \
--to=kw@linux.com \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=bhelgaas@google.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=rdunlap@infradead.org \
--cc=rjui@broadcom.com \
--cc=robh@kernel.org \
--cc=sbranden@broadcom.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox