mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Sam Ravnborg <sam@ravnborg.org>
To: Linus Torvalds <torvalds@transmeta.com>
Cc: linux-kernel@vger.kernel.org, Sam Ravnborg <sam@ravnborg.org>
Subject: Docbook update
Date: Sat, 7 Jun 2003 10:02:26 +0200	[thread overview]
Message-ID: <20030607080226.GA8943@mars.ravnborg.org> (raw)

bugzilla.kernel.org has long complained about make *docs (See entry 228).
This updates docbook and some sourcefile to make it compile with success.
When building sgmldocs a lot of warnings are now issued about
parameters with no description. A good sign that comments needs an update.

There is no functional changes in sis900.c and kmod.c - only docbook
related changes.

	Sam

Patches will follow as follow-up mails.

Linus please do a

	bk pull http://linux-sam.bkbits.net/docbook

This will update the following files:

 Documentation/DocBook/Makefile        |   48 ++++++++++++++--------
 Documentation/DocBook/kernel-api.tmpl |    3 -
 drivers/net/sis900.c                  |   72 +++++++++++++++++-----------------
 kernel/kmod.c                         |    2 
 scripts/docproc.c                     |    2 
 scripts/kernel-doc                    |   15 +++++--
 6 files changed, 83 insertions(+), 59 deletions(-)

through these ChangeSets:

<sam@mars.ravnborg.org> (03/06/07 1.1316.1.4)
   docbook: Move definition of MODULENAME_SIZE
   
   The location between the comment and the prototype confused kernel-doc.
   Kernel-doc requires the prototype to follow after the comment section.

<sam@mars.ravnborg.org> (03/06/07 1.1316.1.3)
   docbook: Warn about missing parameter definitions
   
   Previously kernel-doc silently ignored missing parameter descriptions
   but sometimes 'make sgmldocs' failed with exit code > 0.
   When kernel-doc encounter parameters where the description is missing
   it now prints a warning.
   docproc corrected so previously exit code are recorded.
   docbook makefile cleaned up a bit

<sam@mars.ravnborg.org> (03/06/07 1.1316.1.2)
   docbook: Recognize sis900 functions
   
   Adapted comments to follow what kernel-doc (docbook) understands

<sam@mars.ravnborg.org> (03/06/07 1.1316.1.1)
   docbook/kernel-api: include files updated
   
   Path to pci_hotplug_core corrected.
   Added !Eli/string.h to document strlcpy and friends


             reply	other threads:[~2003-06-07  7:48 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2003-06-07  8:02 Sam Ravnborg [this message]
2003-06-07  8:03 ` Sam Ravnborg
2003-06-07  8:04 ` Sam Ravnborg
2003-06-07  8:05 ` Sam Ravnborg
2003-06-07  8:05 ` 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=20030607080226.GA8943@mars.ravnborg.org \
    --to=sam@ravnborg.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=torvalds@transmeta.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®