lkml.org 
[lkml]   [2003]   [Jun]   [7]   [last100]   RSS Feed
Views: [more markup]  [less markup]  [headers]  [forward] 
 
Messages in this thread
/
DateSat, 7 Jun 2003 10:02:26 +0200
FromSam Ravnborg <>
SubjectDocbook update
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

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

\
 
 \ /
  Last update: 2005-03-22 13:36    [from the cache]
©2003-2008