public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <randy.dunlap@oracle.com>
To: Stephen Rothwell <sfr@canb.auug.org.au>, Yinghai Lu <yinghai@kernel.org>
Cc: linux-next@vger.kernel.org, LKML <linux-kernel@vger.kernel.org>,
	Ingo Molnar <mingo@elte.hu>
Subject: Re: linux-next: Tree for December 18 (irq.h documentation)
Date: Thu, 18 Dec 2008 15:57:09 -0800	[thread overview]
Message-ID: <20081218155709.bf435d8c.randy.dunlap@oracle.com> (raw)
In-Reply-To: <20081218230637.c879a046.sfr@canb.auug.org.au>

Hi YH,

Whenever you update a struct in a header file that uses kernel-doc,
like struct irq_desc in include/linux/irq.h, please also update the
corresponding kernel-doc notation for the new struct members, so
that kernel-doc warnings are not caused:

from linux-next-20081218:

Warning(linux-next-20081218//include/linux/irq.h:192): No description found for parameter 'timer_rand_state'
Warning(linux-next-20081218//include/linux/irq.h:192): No description found for parameter 'kstat_irqs'
Warning(linux-next-20081218//include/linux/irq.h:192): No description found for parameter 'irq_2_iommu'


Please add kernel-doc notation for those missing struct members.

Thanks,
---
~Randy

  parent reply	other threads:[~2008-12-18 23:57 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-12-18 12:06 linux-next: Tree for December 18 Stephen Rothwell
2008-12-18 17:21 ` linux-next: Tree for December 18 (slow-work) Randy Dunlap
2008-12-18 17:45   ` David Howells
2008-12-18 17:25 ` linux-next: Tree for December 18 (fscache) Randy Dunlap
2008-12-18 17:47   ` David Howells
2008-12-18 23:57 ` Randy Dunlap [this message]
2008-12-19  0:33   ` linux-next: Tree for December 18 (irq.h documentation) Yinghai Lu
2008-12-19  0:45     ` Randy Dunlap
2008-12-19  0:57     ` Yinghai Lu
2008-12-19  1:00       ` Randy Dunlap
2008-12-19  0:14 ` linux-next: Tree for December 18 (patch: kernel-doc notation) Randy Dunlap
2008-12-19 10:39   ` Dave Chinner
2008-12-22 22:49   ` Andrew Morton

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=20081218155709.bf435d8c.randy.dunlap@oracle.com \
    --to=randy.dunlap@oracle.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=mingo@elte.hu \
    --cc=sfr@canb.auug.org.au \
    --cc=yinghai@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox