mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@xenotime.net>
To: "Arend van Spriel" <arend@broadcom.com>
Cc: "Andrew Morton" <akpm@linux-foundation.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"linux-wireless@vger.kernel.org" <linux-wireless@vger.kernel.org>,
	"John W. Linville" <linville@tuxdriver.com>,
	"Greg Kroah-Hartman" <gregkh@suse.de>,
	"Dan Carpenter" <error27@gmail.com>
Subject: Re: [RFC V1] lib: cordic: add library module for cordic angle calculation
Date: Thu, 26 May 2011 08:28:34 -0700	[thread overview]
Message-ID: <20110526082834.6ac25796.rdunlap@xenotime.net> (raw)
In-Reply-To: <4DDE0AB4.5020102@broadcom.com>

On Thu, 26 May 2011 10:09:24 +0200 Arend van Spriel wrote:

> On 05/25/2011 10:04 PM, Randy Dunlap wrote:
> > On Wed, 25 May 2011 21:40:26 +0200 Arend van Spriel wrote:
> >> +/**
> >> + * struct - i/q coordinate.
> >   * struct cordic_iq - i/q coordinate
> 
> The kernel-doc processing is pretty smart here. In the current form I 
> get the html as attached. From that perspective your proposed change is 
> not needed, but if your point is that it would be more clear to the mere 
> mortal reading through the source code I can change it.

Hm, I see.  scripts/kernel-doc gets the struct name from the source code
in this case.  too smart ;)

AFAIK, everywhere else we use

/**
 * struct structname - description

and that's what Documentation/kernel-doc-nano-HOWTO.txt calls for, and
yes, it would be more readable to us mortals also, so please change it.

thanks,
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

  parent reply	other threads:[~2011-05-26 15:28 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-05-25 19:40 Arend van Spriel
2011-05-25 20:04 ` Randy Dunlap
     [not found]   ` <4DDE0AB4.5020102@broadcom.com>
2011-05-26  8:59     ` Arend van Spriel
2011-05-26 15:28     ` Randy Dunlap [this message]
2011-05-25 20:35 ` Larry Finger
2011-05-26  9:30   ` Arend van Spriel

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=20110526082834.6ac25796.rdunlap@xenotime.net \
    --to=rdunlap@xenotime.net \
    --cc=akpm@linux-foundation.org \
    --cc=arend@broadcom.com \
    --cc=error27@gmail.com \
    --cc=gregkh@suse.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=linville@tuxdriver.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
all inboxes | Powered by JetHome®