mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@xenotime.net>
To: Matt Mackall <mpm@selenic.com>
Cc: linux-kernel@vger.kernel.org, akpm@linux-foundation.org,
	Johannes Berg <johannes@sipsolutions.net>,
	sam@ravnborg.org
Subject: Re: [PATCH 0/6] kernel-doc: add DOC: sections support
Date: Thu, 25 Oct 2007 10:36:11 -0700	[thread overview]
Message-ID: <20071025103611.f2ae216f.rdunlap@xenotime.net> (raw)
In-Reply-To: <20071025172932.GN17536@waste.org>

On Thu, 25 Oct 2007 12:29:32 -0500 Matt Mackall wrote:

> On Wed, Oct 24, 2007 at 03:08:48PM -0700, Randy Dunlap wrote:
> > 
> > This patch series from Johannes Berg adds support for DOC: sections
> > that are embedded in source files.
> 
> What do these look like?

There are currently 2 files in the kernel tree that contain DOC:
sections.  These are not used in the docbooks, but you can see what
they look like here:

./drivers/net/3c501.c: * DOC: 3c501 Card Notes
./drivers/net/3c501.c: * DOC: Problems
./drivers/net/3c527.c: * DOC: Traps for the unwary
./drivers/net/3c527.c: * DOC: Theory Of Operation
./drivers/net/3c527.c: * DOC: Notes

Also, Johannes has patches to use DOC: in mac80211 files.


> Kerneldoc's documentation is sadly lacking..

point taken.

---
~Randy

  reply	other threads:[~2007-10-25 17:36 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-10-24 22:08 Randy Dunlap
2007-10-24 22:08 ` [PATCH 4/6] kernel-doc: process functions, not DOC: Randy Dunlap
2007-10-24 22:08 ` [PATCH 5/6] kernel-doc: use no-doc option Randy Dunlap
2007-10-24 22:08 ` [PATCH 2/6] kernel-doc: init kernel version Randy Dunlap
2007-10-24 22:08 ` [PATCH 3/6] kernel-doc: single DOC: selection Randy Dunlap
2007-10-24 22:08 ` [PATCH 1/6] kernel-doc: fix xml output mode Randy Dunlap
2007-10-24 22:08 ` [PATCH 6/6] kernel-doc: new P directive for DOC: sections Randy Dunlap
2007-10-25 17:29 ` [PATCH 0/6] kernel-doc: add DOC: sections support Matt Mackall
2007-10-25 17:36   ` Randy Dunlap [this message]
2007-10-25 19:21     ` Matt Mackall
2007-10-26 10:48       ` Johannes Berg
2007-10-26 14:46         ` Matt Mackall
2007-10-26 20:32           ` Johannes Berg
2007-10-26 20:18 ` Sam Ravnborg

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=20071025103611.f2ae216f.rdunlap@xenotime.net \
    --to=rdunlap@xenotime.net \
    --cc=akpm@linux-foundation.org \
    --cc=johannes@sipsolutions.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mpm@selenic.com \
    --cc=sam@ravnborg.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

all inboxes | Powered by JetHome®