NFS EINVAL with O_TRUNC
hoi :) I bisected the kernel to find out why cfs stopped working. (open with O_TRUNC returning EINVAL when file already exists on an cfs file system.) First I tried to debug cfs itself, and after reading Gianlucas thread on lkml I then looked at the kernel itself. 1c710c896eb461895d3c399e15bb5f20b39c9073 is first bad commit commit 1c710c896eb461895d3c399e15bb5f20b39c9073 Author: Ulrich Drepper <[EMAIL PROTECTED]> Date: Tue May 8 00:33:25 2007 -0700 utimensat implementation Implement utimensat(2) which is an extension to futimesat(2) in that it a) supports nano-second resolution for the timestamps b) allows to selectively ignore the atime/mtime value c) allows to selectively use the current time for either atime or mtime d) supports changing the atime/mtime of a symlink itself along the lines of the BSD lutimes(3) functions [...] I don't have any clue how this commit can break cfs, but it definitely does. At least it uncovers some bug either in the Linux NFS client or in the cvs server code. So, and now I will happily go to sleep... Thanks to everybody who can figure out why above commit breaks stuff... -- Martin signature.asc Description: Digital signature
NFS EINVAL with O_TRUNC
hoi :) I bisected the kernel to find out why cfs stopped working. (open with O_TRUNC returning EINVAL when file already exists on an cfs file system.) First I tried to debug cfs itself, and after reading Gianlucas thread on lkml I then looked at the kernel itself. 1c710c896eb461895d3c399e15bb5f20b39c9073 is first bad commit commit 1c710c896eb461895d3c399e15bb5f20b39c9073 Author: Ulrich Drepper [EMAIL PROTECTED] Date: Tue May 8 00:33:25 2007 -0700 utimensat implementation Implement utimensat(2) which is an extension to futimesat(2) in that it a) supports nano-second resolution for the timestamps b) allows to selectively ignore the atime/mtime value c) allows to selectively use the current time for either atime or mtime d) supports changing the atime/mtime of a symlink itself along the lines of the BSD lutimes(3) functions [...] I don't have any clue how this commit can break cfs, but it definitely does. At least it uncovers some bug either in the Linux NFS client or in the cvs server code. So, and now I will happily go to sleep... Thanks to everybody who can figure out why above commit breaks stuff... -- Martin signature.asc Description: Digital signature
[PATCH] kernel-doc: remove myself from MAINTAINERS
I don't have the time to work on Linux Documentation, so I really should document that in MAINTAINERS. With Randy, kernel-doc is in good hands anyway. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> --- diff --git a/MAINTAINERS b/MAINTAINERS index 3e926e7..ba586b4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -943,11 +943,8 @@ L: linux-kernel@vger.kernel.org S: Maintained DOCBOOK FOR DOCUMENTATION -P: Martin Waitz -M: [EMAIL PROTECTED] P: Randy Dunlap M: [EMAIL PROTECTED] -T: git http://tali.admingilde.org/git/linux-docbook.git S: Maintained DOCKING STATION DRIVER -- Martin Waitz - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH] kernel-doc: remove myself from MAINTAINERS
I don't have the time to work on Linux Documentation, so I really should document that in MAINTAINERS. With Randy, kernel-doc is in good hands anyway. Signed-off-by: Martin Waitz [EMAIL PROTECTED] --- diff --git a/MAINTAINERS b/MAINTAINERS index 3e926e7..ba586b4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -943,11 +943,8 @@ L: linux-kernel@vger.kernel.org S: Maintained DOCBOOK FOR DOCUMENTATION -P: Martin Waitz -M: [EMAIL PROTECTED] P: Randy Dunlap M: [EMAIL PROTECTED] -T: git http://tali.admingilde.org/git/linux-docbook.git S: Maintained DOCKING STATION DRIVER -- Martin Waitz - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH] DocBook: fix kernel-api documentation generation
DocBook: fix kernel-api documentation generation This patch changes a macro definition so that kernel-doc can understand it. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> --- include/sound/pcm.h |5 ++--- 1 files changed, 2 insertions(+), 3 deletions(-) Index: linux-docbook/include/sound/pcm.h === --- linux-docbook.orig/include/sound/pcm.h 2005-07-29 12:46:13.0 +0200 +++ linux-docbook/include/sound/pcm.h 2005-08-12 11:10:20.0 +0200 @@ -911,11 +911,10 @@ int snd_pcm_format_big_endian(snd_pcm_fo * Returns 1 if the given PCM format is CPU-endian, 0 if * opposite, or a negative error code if endian not specified. */ -/* int snd_pcm_format_cpu_endian(snd_pcm_format_t format); */ #ifdef SNDRV_LITTLE_ENDIAN -#define snd_pcm_format_cpu_endian snd_pcm_format_little_endian +#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format) #else -#define snd_pcm_format_cpu_endian snd_pcm_format_big_endian +#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format) #endif int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */ int snd_pcm_format_physical_width(snd_pcm_format_t format);/* in bits */ - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH] DocBook: fix kernel-api documentation generation
DocBook: fix kernel-api documentation generation This patch changes a macro definition so that kernel-doc can understand it. Signed-off-by: Martin Waitz [EMAIL PROTECTED] --- include/sound/pcm.h |5 ++--- 1 files changed, 2 insertions(+), 3 deletions(-) Index: linux-docbook/include/sound/pcm.h === --- linux-docbook.orig/include/sound/pcm.h 2005-07-29 12:46:13.0 +0200 +++ linux-docbook/include/sound/pcm.h 2005-08-12 11:10:20.0 +0200 @@ -911,11 +911,10 @@ int snd_pcm_format_big_endian(snd_pcm_fo * Returns 1 if the given PCM format is CPU-endian, 0 if * opposite, or a negative error code if endian not specified. */ -/* int snd_pcm_format_cpu_endian(snd_pcm_format_t format); */ #ifdef SNDRV_LITTLE_ENDIAN -#define snd_pcm_format_cpu_endian snd_pcm_format_little_endian +#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format) #else -#define snd_pcm_format_cpu_endian snd_pcm_format_big_endian +#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format) #endif int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */ int snd_pcm_format_physical_width(snd_pcm_format_t format);/* in bits */ - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: [Documentation] Use doxygen or another tool to generate a documentation ?
hoi :) On Sun, Aug 21, 2005 at 08:32:42PM +0200, Stephane Wirtel wrote: > Martin, your patch works for the htmldocs target, but not for the > pdfdocs, I think there is a bug in a latex package. I don't know which > one, but it's the same error. yes, some pdfdocs are broken and I haven't found the cause yet. I guess we have to ditch xmlto, at least for PDF/PS. -- Martin Waitz signature.asc Description: Digital signature
Re: [Documentation] Use doxygen or another tool to generate a documentation ?
hoi :) On Sun, Aug 21, 2005 at 08:32:42PM +0200, Stephane Wirtel wrote: Martin, your patch works for the htmldocs target, but not for the pdfdocs, I think there is a bug in a latex package. I don't know which one, but it's the same error. yes, some pdfdocs are broken and I haven't found the cause yet. I guess we have to ditch xmlto, at least for PDF/PS. -- Martin Waitz signature.asc Description: Digital signature
Re: [Documentation] Use doxygen or another tool to generate a documentation ?
hoi :) On Sat, Aug 20, 2005 at 07:37:06PM +0200, Sam Ravnborg wrote: > > In make_docs.log.tar.bz2, you can find log files from make htmldocs, > > make psdocs and make pdfdocs. > > From your log-files I could not see what went wrong. It seems to be > error in the generated files. kerneldoc could not understand a macro definition. please try http://tali.admingilde.org/patches/linux-docbook/docbook-fixes.patch -- Martin Waitz signature.asc Description: Digital signature
Re: [Documentation] Use doxygen or another tool to generate a documentation ?
hoi :) On Sat, Aug 20, 2005 at 07:37:06PM +0200, Sam Ravnborg wrote: In make_docs.log.tar.bz2, you can find log files from make htmldocs, make psdocs and make pdfdocs. From your log-files I could not see what went wrong. It seems to be error in the generated files. kerneldoc could not understand a macro definition. please try http://tali.admingilde.org/patches/linux-docbook/docbook-fixes.patch -- Martin Waitz signature.asc Description: Digital signature
Re: reiser4 plugins
hoi :) On Tue, Jul 05, 2005 at 04:32:00PM -0600, Jonathan Briggs wrote: > You could do filesystems in userspace too and just use the kernel's > block layer. but you can't do that in an library, you have to use a filesystem server in order to get access control. But you can build a library that handles uniform access to files and directories. Don't get me wrong, I'm all for a uniform interface for files and metadata, but I don't think that it has to be in the kernel. Gnome and KDE already have their own userspace VFS, something like that should be used. One has to distinguish between the low-level filesystem and the storage system which is presented to the user. -- Martin Waitz signature.asc Description: Digital signature
Re: reiser4 plugins
hoi :) On Tue, Jul 05, 2005 at 04:32:00PM -0600, Jonathan Briggs wrote: You could do filesystems in userspace too and just use the kernel's block layer. but you can't do that in an library, you have to use a filesystem server in order to get access control. But you can build a library that handles uniform access to files and directories. Don't get me wrong, I'm all for a uniform interface for files and metadata, but I don't think that it has to be in the kernel. Gnome and KDE already have their own userspace VFS, something like that should be used. One has to distinguish between the low-level filesystem and the storage system which is presented to the user. -- Martin Waitz signature.asc Description: Digital signature
Re: reiser4 plugins
hoi :) On Wed, Jun 29, 2005 at 08:04:58PM -0700, Hans Reiser wrote: > >How is directories as files logically any different than putting all > >data into .data files and making all files directories (yes you would > >need some sort of special handling for files that were really called > >.data). > > > Add to this that you make .data the default if the file within the > directory is not specified, and define a stanadard set of names for > metafiles, and you've got the essential idea, and any differences are > details. sure, that would work more or less, but what would it give you? You haven't introduced anything new that userspace couldn't do before. Just write a library which mangles pathnames and treats files and directories the same. You don't need the kernel to do that. Filesystems are there to store files. Everything else can be done in userspace. -- Martin Waitz signature.asc Description: Digital signature
Re: reiser4 plugins
hoi :) On Wed, Jun 29, 2005 at 08:04:58PM -0700, Hans Reiser wrote: How is directories as files logically any different than putting all data into .data files and making all files directories (yes you would need some sort of special handling for files that were really called .data). Add to this that you make .data the default if the file within the directory is not specified, and define a stanadard set of names for metafiles, and you've got the essential idea, and any differences are details. sure, that would work more or less, but what would it give you? You haven't introduced anything new that userspace couldn't do before. Just write a library which mangles pathnames and treats files and directories the same. You don't need the kernel to do that. Filesystems are there to store files. Everything else can be done in userspace. -- Martin Waitz signature.asc Description: Digital signature
[patch 1/2] Docbook: use custom stylesheet
Docbook: use custom stylesheet With the custom stylesheet, functions are rendered using ANSI-C syntax and xmlto is a bit quieter. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> --- Documentation/DocBook/Makefile |3 ++- Documentation/DocBook/stylesheet.xsl |5 + 2 files changed, 7 insertions(+), 1 deletion(-) Index: linux-docbook/Documentation/DocBook/Makefile === --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-06 15:46:05.0 +0200 +++ linux-docbook/Documentation/DocBook/Makefile2005-04-10 12:57:53.678951360 +0200 @@ -49,7 +49,8 @@ installmandocs: mandocs KERNELDOC = scripts/kernel-doc DOCPROC = scripts/basic/docproc -#XMLTOFLAGS = --skip-validation +XMLTOFLAGS = -m Documentation/DocBook/stylesheet.xsl +#XMLTOFLAGS += --skip-validation ### # DOCPROC is used for two purposes: Index: linux-docbook/Documentation/DocBook/stylesheet.xsl === --- /dev/null 1970-01-01 00:00:00.0 + +++ linux-docbook/Documentation/DocBook/stylesheet.xsl 2005-04-09 13:59:56.0 +0200 @@ -0,0 +1,5 @@ + +http://www.w3.org/1999/XSL/Transform; version="1.0"> +1 +ansi + -- Martin Waitz - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 0/2] DocBook xmlto fixes
hoi :) the following two patches fix some problems noticed by Alexey. I still have to look harder at the stylesheets to get nicely linked function lists in the toc. @Andrew: lets test the xmlto converter in -mm a little bit longer. Should I keep sending relative patches or replacement patches? I guess we want to collapse patches before sending to Linus. (The patches before the xmlto one should be non-problematic and could be commited once Linus starts accepting patches again.) -- Martin Waitz - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 2/2] DocBook: fix html link
DocBook: fix html link The start page for each book has changed from book1.html to index.html. Update our generated links acocrdingly. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> --- Documentation/DocBook/Makefile |2 +- 1 files changed, 1 insertion(+), 1 deletion(-) Index: linux-docbook/Documentation/DocBook/Makefile === --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-09 13:27:12.0 +0200 +++ linux-docbook/Documentation/DocBook/Makefile2005-04-09 14:35:55.0 +0200 @@ -115,7 +115,7 @@ quiet_cmd_db2pdf = XMLTO $@ quiet_cmd_db2html = XMLTO $@ cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ - echo ' \ + echo ' \ Goto $(patsubst %.html,%,$(notdir $@))' > $@ %.html: %.xml -- Martin Waitz - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 2/2] DocBook: fix html link
DocBook: fix html link The start page for each book has changed from book1.html to index.html. Update our generated links acocrdingly. Signed-off-by: Martin Waitz [EMAIL PROTECTED] --- Documentation/DocBook/Makefile |2 +- 1 files changed, 1 insertion(+), 1 deletion(-) Index: linux-docbook/Documentation/DocBook/Makefile === --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-09 13:27:12.0 +0200 +++ linux-docbook/Documentation/DocBook/Makefile2005-04-09 14:35:55.0 +0200 @@ -115,7 +115,7 @@ quiet_cmd_db2pdf = XMLTO $@ quiet_cmd_db2html = XMLTO $@ cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $ \ - echo 'a HREF=$(patsubst %.html,%,$(notdir $@))/book1.html \ + echo 'a HREF=$(patsubst %.html,%,$(notdir $@))/index.html \ Goto $(patsubst %.html,%,$(notdir $@))/ap' $@ %.html:%.xml -- Martin Waitz - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 0/2] DocBook xmlto fixes
hoi :) the following two patches fix some problems noticed by Alexey. I still have to look harder at the stylesheets to get nicely linked function lists in the toc. @Andrew: lets test the xmlto converter in -mm a little bit longer. Should I keep sending relative patches or replacement patches? I guess we want to collapse patches before sending to Linus. (The patches before the xmlto one should be non-problematic and could be commited once Linus starts accepting patches again.) -- Martin Waitz - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 1/2] Docbook: use custom stylesheet
Docbook: use custom stylesheet With the custom stylesheet, functions are rendered using ANSI-C syntax and xmlto is a bit quieter. Signed-off-by: Martin Waitz [EMAIL PROTECTED] --- Documentation/DocBook/Makefile |3 ++- Documentation/DocBook/stylesheet.xsl |5 + 2 files changed, 7 insertions(+), 1 deletion(-) Index: linux-docbook/Documentation/DocBook/Makefile === --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-06 15:46:05.0 +0200 +++ linux-docbook/Documentation/DocBook/Makefile2005-04-10 12:57:53.678951360 +0200 @@ -49,7 +49,8 @@ installmandocs: mandocs KERNELDOC = scripts/kernel-doc DOCPROC = scripts/basic/docproc -#XMLTOFLAGS = --skip-validation +XMLTOFLAGS = -m Documentation/DocBook/stylesheet.xsl +#XMLTOFLAGS += --skip-validation ### # DOCPROC is used for two purposes: Index: linux-docbook/Documentation/DocBook/stylesheet.xsl === --- /dev/null 1970-01-01 00:00:00.0 + +++ linux-docbook/Documentation/DocBook/stylesheet.xsl 2005-04-09 13:59:56.0 +0200 @@ -0,0 +1,5 @@ +?xml version=1.0 encoding=UTF-8? +stylesheet xmlns=http://www.w3.org/1999/XSL/Transform; version=1.0 +param name=chunk.quietly1/param +param name=funcsynopsis.styleansi/param +/stylesheet -- Martin Waitz - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
Re: 2.6.12-rc2-mm2
hoi :) On Fri, Apr 08, 2005 at 05:28:25PM +, Alexey Dobriyan wrote: > htmldocs (haven't look at pdf, etc...) became K'ish. > Also, Documentation/Docbook/*.html uses book1.html, but there are only > Documentation/Docbook/*/index.html > Functions are not hyperlinked from index.html. IIRC, they were in jadetex > days. I'll take a look at the stylesheetes -- Martin Waitz signature.asc Description: Digital signature
Re: 2.6.12-rc2-mm2
hoi :) On Fri, Apr 08, 2005 at 05:28:25PM +, Alexey Dobriyan wrote: htmldocs (haven't look at pdf, etc...) became KR'ish. Also, Documentation/Docbook/*.html uses book1.html, but there are only Documentation/Docbook/*/index.html Functions are not hyperlinked from index.html. IIRC, they were in jadetex days. I'll take a look at the stylesheetes -- Martin Waitz signature.asc Description: Digital signature
Re: [RFC 1/6]SEP initialization rework
hoi :) On Mon, Apr 04, 2005 at 10:05:56AM +0800, Li Shaohua wrote: > - on_each_cpu(enable_sep_cpu, NULL, 1, 1); with this on_each_cpu call gone, you should also be able to remove the useless info pointer in enable_sep_cpu. -- Martin Waitz signature.asc Description: Digital signature
[patch 6/6] DocBook: Use xmlto to process the DocBook files.
DocBook: Use xmlto to process the DocBook files. xmlto uses standared XSLT templates to generate manpages, (x)html pages, and XML FO files which can be processed with passivetex. This is much faster than using jadetex for everything. This patch also reduces the number of kernel-specific scripts that are needed to generate documentation. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> scripts/makeman| 185 - scripts/split-man | 112 Documentation/Changes |8 - Documentation/DocBook/Makefile | 42 - scripts/kernel-doc | 32 ++- 5 files changed, 53 insertions(+), 326 deletions(-) Index: linux-docbook/Documentation/Changes === --- linux-docbook.orig/Documentation/Changes2005-04-06 12:12:34.750567521 +0200 +++ linux-docbook/Documentation/Changes 2005-04-06 12:25:20.551727922 +0200 @@ -357,14 +357,14 @@ Quota-tools -- o <http://sourceforge.net/projects/linuxquota/> -Jade - -o <ftp://ftp.jclark.com/pub/jade/jade-1.2.1.tar.gz> - DocBook Stylesheets --- o <http://nwalsh.com/docbook/dsssl/> +XMLTO XSLT Frontend +--- +o <http://cyberelk.net/tim/xmlto/> + Intel P6 microcode -- o <http://www.urbanmyth.org/microcode/> Index: linux-docbook/Documentation/DocBook/Makefile === --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-06 12:25:19.150939983 +0200 +++ linux-docbook/Documentation/DocBook/Makefile2005-04-06 12:25:20.552727770 +0200 @@ -41,14 +41,15 @@ MAN := $(patsubst %.xml, %.9, $(BOOKS)) mandocs: $(MAN) installmandocs: mandocs - $(MAKEMAN) install Documentation/DocBook/man + mkdir -p /usr/local/man/man9/ + install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/ ### #External programs used KERNELDOC = scripts/kernel-doc DOCPROC = scripts/basic/docproc -SPLITMAN = $(PERL) $(srctree)/scripts/split-man -MAKEMAN = $(PERL) $(srctree)/scripts/makeman + +#XMLTOFLAGS = --skip-validation ### # DOCPROC is used for two purposes: @@ -95,29 +96,29 @@ $(obj)/procfs-guide.xml: $(C-procfs-exam # Rules to generate postscript, PDF and HTML # db2html creates a directory. Generate a html file used for timestamp -quiet_cmd_db2ps = DB2PS $@ - cmd_db2ps = db2ps -o $(dir $@) $< +quiet_cmd_db2ps = XMLTO$@ + cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $< %.ps : %.xml - @(which db2ps > /dev/null 2>&1) || \ + @(which xmlto > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) $(call cmd,db2ps) -quiet_cmd_db2pdf = DB2PDF $@ - cmd_db2pdf = db2pdf -o $(dir $@) $< +quiet_cmd_db2pdf = XMLTO $@ + cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $< %.pdf : %.xml - @(which db2pdf > /dev/null 2>&1) || \ + @(which xmlto > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) $(call cmd,db2pdf) -quiet_cmd_db2html = DB2HTML $@ - cmd_db2html = db2html -o $(patsubst %.html,%,$@) $< && \ +quiet_cmd_db2html = XMLTO $@ + cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ echo ' \ Goto $(patsubst %.html,%,$(notdir $@))' > $@ %.html:%.xml - @(which db2html > /dev/null 2>&1) || \ + @(which xmlto > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) @rm -rf $@ $(patsubst %.html,%,$@) @@ -125,15 +126,14 @@ quiet_cmd_db2html = DB2HTML $@ @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi -### -# Rule to generate man files - output is placed in the man subdirectory - -%.9: %.xml -ifneq ($(KBUILD_SRC),) - $(Q)mkdir -p $(objtree)/Documentation/DocBook/man -endif - $(SPLITMAN) $< $(objtree)/Documentation/DocBook/man "$(VERSION).$(PATCHLEVEL).$(SUBLEVEL)" - $(MAKEMAN) convert $(objtree)/Documentation/DocBook/man $< +quiet_cmd_db2man = XMLTO $@ + cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi +%.9 : %.xml + @(which xmlto > /dev/null 2>&1) || \ +(echo "*** You need to install DocBook stylesheets ***"; \ + exit 1) + $(call cmd,db2man) + @touch $@ ### # Rules to generate postscripts and PNG imgages from .fig format files Index: linux-docbook/scripts/kernel-doc ===
[patch 1/6] DocBook: changes and extensions to the kernel documentation
DocBook: changes and extensions to the kernel documentation From: Pavel Pisa <[EMAIL PROTECTED]> I have recompiled Linux kernel 2.6.11.5 documentation for me and our university students again. The documentation could be extended for more sources which are equipped by structured comments for recent 2.6 kernels. I have tried to proceed with that task. I have done that more times from 2.6.0 time and it gets boring to do same changes again and again. Linux kernel compiles after changes for i386 and ARM targets. I have added references to some more files into kernel-api book, I have added some section names as well. So please, check that changes do not break something and that categories are not too much skewed. I have changed kernel-doc to accept "fastcall" and "asmlinkage" words reserved by kernel convention. Most of the other changes are modifications in the comments to make kernel-doc happy, accept some parameters description and do not bail out on errors. Changed to @pid in the description, moved some #ifdef before comments to correct function to comments bindings, etc. You can see result of the modified documentation build at http://cmp.felk.cvut.cz/~pisa/linux/lkdb-2.6.11.tar.gz Some more sources are ready to be included into kernel-doc generated documentation. Sources has been added into kernel-api for now. Some more section names added and probably some more chaos introduced as result of quick cleanup work. Signed-off-by: Pavel Pisa <[EMAIL PROTECTED]> Signed-off-by: Andrew Morton <[EMAIL PROTECTED]> Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> Documentation/DocBook/kernel-api.tmpl | 186 -- drivers/video/fbmem.c |5 fs/proc/base.c| 10 - include/linux/fs.h| 12 +- include/linux/net.h | 38 +++--- include/linux/skbuff.h|2 include/net/sock.h| 134 kernel/exit.c |2 kernel/power/swsusp.c |2 mm/page_alloc.c |3 mm/vmalloc.c |8 - net/core/datagram.c | 28 ++--- net/core/sock.c | 12 +- net/core/stream.c | 12 +- net/sunrpc/xdr.c | 12 +- scripts/kernel-doc|2 16 files changed, 320 insertions(+), 148 deletions(-) Index: linux-docbook/Documentation/DocBook/kernel-api.tmpl === --- linux-docbook.orig/Documentation/DocBook/kernel-api.tmpl2005-04-06 12:13:12.673832313 +0200 +++ linux-docbook/Documentation/DocBook/kernel-api.tmpl 2005-04-06 12:24:11.943114418 +0200 @@ -49,13 +49,33 @@ !Iinclude/asm-i386/unaligned.h - + + Kernel objects manipulation + +!Elib/kobject.c + + + Kernel utility functions +!Iinclude/linux/kernel.h + +!Ekernel/panic.c +!Ekernel/sys.c +!Ekernel/rcupdate.c + + @@ -81,7 +101,9 @@ KAO --> !Elib/vsprintf.c String Manipulation -!Ilib/string.c + !Elib/string.c Bit Operations @@ -98,6 +120,25 @@ KAO --> !Iinclude/asm-i386/uaccess.h !Iarch/i386/lib/usercopy.c + More Memory Management Functions +!Iinclude/linux/rmap.h +!Emm/readahead.c +!Emm/filemap.c +!Emm/memory.c +!Emm/vmalloc.c +!Emm/mempool.c +!Emm/page-writeback.c +!Emm/truncate.c + + + + + + Kernel IPC facilities + + IPC utilities +!Iipc/util.c + @@ -114,6 +155,10 @@ KAO --> sysctl interface !Ekernel/sysctl.c + + proc filesystem interface +!Ifs/proc/base.c + @@ -127,6 +172,10 @@ KAO --> The Linux VFS + The Filesystem types +!Iinclude/linux/fs.h +!Einclude/linux/fs.h + The Directory Cache !Efs/dcache.c !Iinclude/linux/dcache.h @@ -142,13 +191,31 @@ KAO --> !Efs/locks.c !Ifs/locks.c + Other Functions +!Efs/mpage.c +!Efs/namei.c +!Efs/buffer.c +!Efs/bio.c +!Efs/seq_file.c +!Efs/filesystems.c +!Efs/fs-writeback.c +!Efs/block_dev.c + Linux Networking + Networking Base Types +!Iinclude/linux/net.h + Socket Buffer Functions !Iinclude/linux/skbuff.h +!Iinclude/net/sock.h +!Enet/socket.c !Enet/core/skbuff.c +!Enet/core/sock.c +!Enet/core/datagram.c +!Enet/core/stream.c Socket Filter !Enet/core/filter.c @@ -158,6 +225,14 @@ KAO --> !Enet/core/gen_stats.c !Enet/core/gen_estimator.c + SUN RPC subsystem + +!Enet/sunrpc/xdr.c +!Enet/sunrpc/svcsock.c +!Enet/sunrpc/sched.c + @@ -194,11 +269,26 @@ X!Ekernel/module.c !Iarch/i386/kernel/irq.c + Resources Management +!Ekernel/resource.c + + MTRR Handling !Earch/i386/kernel/cpu/mtrr/main.c PCI Support Library !Edrivers/pci/pci.c +!Edrivers/pci/
[patch 3/6] DocBook: fix some descriptions
DocBook: fix some descriptions
Some KernelDoc descriptions are updated to match the current code.
No code changes.
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
drivers/acpi/scan.c |4 -
drivers/base/platform.c |4 -
drivers/pci/hotplug.c |4 +
drivers/pci/rom.c | 14 +++---
drivers/pnp/manager.c |2
fs/bio.c|2
fs/buffer.c | 11 ++---
fs/fs-writeback.c |4 +
fs/mpage.c | 92 ++--
fs/proc/base.c |2
fs/seq_file.c |9 +++-
fs/sysfs/file.c |4 -
include/linux/fs.h | 100
include/linux/skbuff.h |5 +-
include/net/sock.h |1
kernel/sched.c |3 -
kernel/sysctl.c |2
lib/kobject.c |3 -
mm/filemap.c| 17
mm/page-writeback.c |6 +-
mm/truncate.c |4 -
net/core/datagram.c |4 -
22 files changed, 160 insertions(+), 137 deletions(-)
Index: linux-docbook/kernel/sysctl.c
===
--- linux-docbook.orig/kernel/sysctl.c 2005-04-06 12:12:50.869129883 +0200
+++ linux-docbook/kernel/sysctl.c 2005-04-06 12:25:15.526488679 +0200
@@ -1969,6 +1969,7 @@ int proc_dointvec_jiffies(ctl_table *tab
* @filp: the file structure
* @buffer: the user buffer
* @lenp: the size of the user buffer
+ * @ppos: file position
*
* Reads/writes up to table->maxlen/sizeof(unsigned int) integer
* values from/to the user buffer, treated as an ASCII string.
@@ -1991,6 +1992,7 @@ int proc_dointvec_userhz_jiffies(ctl_tab
* @filp: the file structure
* @buffer: the user buffer
* @lenp: the size of the user buffer
+ * @ppos: the current position in the file
*
* Reads/writes up to table->maxlen/sizeof(unsigned int) integer
* values from/to the user buffer, treated as an ASCII string.
Index: linux-docbook/lib/kobject.c
===
--- linux-docbook.orig/lib/kobject.c2005-04-06 12:12:50.870129732 +0200
+++ linux-docbook/lib/kobject.c 2005-04-06 12:25:15.527488527 +0200
@@ -217,13 +217,12 @@ int kobject_register(struct kobject * ko
/**
* kobject_set_name - Set the name of an object
* @kobj: object.
- * @name: name.
+ * @fmt: format string used to build the name
*
* If strlen(name) >= KOBJ_NAME_LEN, then use a dynamically allocated
* string that @kobj->k_name points to. Otherwise, use the static
* @kobj->name array.
*/
-
int kobject_set_name(struct kobject * kobj, const char * fmt, ...)
{
int error = 0;
Index: linux-docbook/kernel/sched.c
===
--- linux-docbook.orig/kernel/sched.c 2005-04-06 12:12:50.870129732 +0200
+++ linux-docbook/kernel/sched.c2005-04-06 12:25:15.532487770 +0200
@@ -2906,6 +2906,7 @@ static void __wake_up_common(wait_queue_
* @q: the waitqueue
* @mode: which threads
* @nr_exclusive: how many wake-one or wake-many threads to wake up
+ * @key: is directly passed to the wakeup function
*/
void fastcall __wake_up(wait_queue_head_t *q, unsigned int mode,
int nr_exclusive, void *key)
@@ -2928,7 +2929,7 @@ void fastcall __wake_up_locked(wait_queu
}
/**
- * __wake_up - sync- wake up threads blocked on a waitqueue.
+ * __wake_up_sync - wake up threads blocked on a waitqueue.
* @q: the waitqueue
* @mode: which threads
* @nr_exclusive: how many wake-one or wake-many threads to wake up
Index: linux-docbook/fs/buffer.c
===
--- linux-docbook.orig/fs/buffer.c 2005-04-06 12:12:50.875128976 +0200
+++ linux-docbook/fs/buffer.c 2005-04-06 12:25:15.536487165 +0200
@@ -774,15 +774,14 @@ repeat:
/**
* sync_mapping_buffers - write out and wait upon a mapping's "associated"
*buffers
- * @buffer_mapping - the mapping which backs the buffers' data
- * @mapping - the mapping which wants those buffers written
+ * @mapping: the mapping which wants those buffers written
*
* Starts I/O against the buffers at mapping->private_list, and waits upon
* that I/O.
*
- * Basically, this is a convenience function for fsync(). @buffer_mapping is
- * the blockdev which "owns" the buffers and @mapping is a file or directory
- * which needs those buffers to be written for a successful fsync().
+ * Basically, this is a convenience function for fsync().
+ * @mapping is a file or directory which needs those buffers to be written for
+ * a successful fsync().
*/
int sync_mapping_buffers(struct address_space *mapping)
{
@@ -1263,6 +1262,7 @@ __getblk_slow(struct block_device *bdev,
/**
* mark_buffer_dirty - mark a buffer_head as needing wri
[patch 0/6] DocBook updates
hoi :) The following mails contain all my current DocBook patches. Many KernelDoc comments are fixed, XML generation is fixed and jadetex+custom scripts are replaced by the standard xmlto tool. Thanks go to everybody who contributed! -- Martin Waitz - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 4/6] DocBook: use for examples
DocBook: use for examples
From: Rich Walker <[EMAIL PROTECTED]>
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
scripts/kernel-doc | 13 +
1 files changed, 9 insertions(+), 4 deletions(-)
Index: linux-docbook/scripts/kernel-doc
===
--- linux-docbook.orig/scripts/kernel-doc 2005-04-06 12:25:14.115702254
+0200
+++ linux-docbook/scripts/kernel-doc2005-04-06 12:25:17.867134335 +0200
@@ -553,15 +553,20 @@ sub output_section_xml(%) {
# print out each section
$lineprefix=" ";
foreach $section (@{$args{'sectionlist'}}) {
- print "\n $section\n \n";
+ print "\n";
+ print "$section\n";
if ($section =~ m/EXAMPLE/i) {
- print "\n";
+ print "\n";
+ } else {
+ print "\n";
}
output_highlight($args{'sections'}{$section});
if ($section =~ m/EXAMPLE/i) {
- print "\n";
+ print "\n";
+ } else {
+ print "\n";
}
- print " \n\n";
+ print "\n";
}
}
--
Martin Waitz
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[patch 2/6] DocBook: fix xml tag
DocBook: fix xml tag
This fix is needed to create valid XML.
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
scripts/kernel-doc |2 +-
1 files changed, 1 insertion(+), 1 deletion(-)
Index: linux-docbook/scripts/kernel-doc
===
--- linux-docbook.orig/scripts/kernel-doc 2005-04-06 12:24:11.970110331
+0200
+++ linux-docbook/scripts/kernel-doc2005-04-06 12:25:14.115702254 +0200
@@ -607,7 +607,7 @@ sub output_function_xml(%) {
}
}
} else {
- print " \n";
+ print " \n";
}
print " \n";
print "\n";
--
Martin Waitz
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[patch 4/6] DocBook: use informalexample for examples
DocBook: use informalexample for examples
From: Rich Walker [EMAIL PROTECTED]
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
scripts/kernel-doc | 13 +
1 files changed, 9 insertions(+), 4 deletions(-)
Index: linux-docbook/scripts/kernel-doc
===
--- linux-docbook.orig/scripts/kernel-doc 2005-04-06 12:25:14.115702254
+0200
+++ linux-docbook/scripts/kernel-doc2005-04-06 12:25:17.867134335 +0200
@@ -553,15 +553,20 @@ sub output_section_xml(%) {
# print out each section
$lineprefix= ;
foreach $section (@{$args{'sectionlist'}}) {
- print refsect1\n title$section/title\n para\n;
+ print refsect1\n;
+ print title$section/title\n;
if ($section =~ m/EXAMPLE/i) {
- print examplepara\n;
+ print informalexampleprogramlisting\n;
+ } else {
+ print para\n;
}
output_highlight($args{'sections'}{$section});
if ($section =~ m/EXAMPLE/i) {
- print /para/example\n;
+ print /programlisting/example\n;
+ } else {
+ print /para\n;
}
- print /para\n/refsect1\n;
+ print /refsect1\n;
}
}
--
Martin Waitz
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[patch 2/6] DocBook: fix void/ xml tag
DocBook: fix void/ xml tag
This fix is needed to create valid XML.
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
scripts/kernel-doc |2 +-
1 files changed, 1 insertion(+), 1 deletion(-)
Index: linux-docbook/scripts/kernel-doc
===
--- linux-docbook.orig/scripts/kernel-doc 2005-04-06 12:24:11.970110331
+0200
+++ linux-docbook/scripts/kernel-doc2005-04-06 12:25:14.115702254 +0200
@@ -607,7 +607,7 @@ sub output_function_xml(%) {
}
}
} else {
- print void\n;
+ print void/\n;
}
print /funcprototype/funcsynopsis\n;
print /refsynopsisdiv\n;
--
Martin Waitz
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[patch 0/6] DocBook updates
hoi :) The following mails contain all my current DocBook patches. Many KernelDoc comments are fixed, XML generation is fixed and jadetex+custom scripts are replaced by the standard xmlto tool. Thanks go to everybody who contributed! -- Martin Waitz - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[patch 3/6] DocBook: fix some descriptions
DocBook: fix some descriptions
Some KernelDoc descriptions are updated to match the current code.
No code changes.
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
drivers/acpi/scan.c |4 -
drivers/base/platform.c |4 -
drivers/pci/hotplug.c |4 +
drivers/pci/rom.c | 14 +++---
drivers/pnp/manager.c |2
fs/bio.c|2
fs/buffer.c | 11 ++---
fs/fs-writeback.c |4 +
fs/mpage.c | 92 ++--
fs/proc/base.c |2
fs/seq_file.c |9 +++-
fs/sysfs/file.c |4 -
include/linux/fs.h | 100
include/linux/skbuff.h |5 +-
include/net/sock.h |1
kernel/sched.c |3 -
kernel/sysctl.c |2
lib/kobject.c |3 -
mm/filemap.c| 17
mm/page-writeback.c |6 +-
mm/truncate.c |4 -
net/core/datagram.c |4 -
22 files changed, 160 insertions(+), 137 deletions(-)
Index: linux-docbook/kernel/sysctl.c
===
--- linux-docbook.orig/kernel/sysctl.c 2005-04-06 12:12:50.869129883 +0200
+++ linux-docbook/kernel/sysctl.c 2005-04-06 12:25:15.526488679 +0200
@@ -1969,6 +1969,7 @@ int proc_dointvec_jiffies(ctl_table *tab
* @filp: the file structure
* @buffer: the user buffer
* @lenp: the size of the user buffer
+ * @ppos: file position
*
* Reads/writes up to table-maxlen/sizeof(unsigned int) integer
* values from/to the user buffer, treated as an ASCII string.
@@ -1991,6 +1992,7 @@ int proc_dointvec_userhz_jiffies(ctl_tab
* @filp: the file structure
* @buffer: the user buffer
* @lenp: the size of the user buffer
+ * @ppos: the current position in the file
*
* Reads/writes up to table-maxlen/sizeof(unsigned int) integer
* values from/to the user buffer, treated as an ASCII string.
Index: linux-docbook/lib/kobject.c
===
--- linux-docbook.orig/lib/kobject.c2005-04-06 12:12:50.870129732 +0200
+++ linux-docbook/lib/kobject.c 2005-04-06 12:25:15.527488527 +0200
@@ -217,13 +217,12 @@ int kobject_register(struct kobject * ko
/**
* kobject_set_name - Set the name of an object
* @kobj: object.
- * @name: name.
+ * @fmt: format string used to build the name
*
* If strlen(name) = KOBJ_NAME_LEN, then use a dynamically allocated
* string that @kobj-k_name points to. Otherwise, use the static
* @kobj-name array.
*/
-
int kobject_set_name(struct kobject * kobj, const char * fmt, ...)
{
int error = 0;
Index: linux-docbook/kernel/sched.c
===
--- linux-docbook.orig/kernel/sched.c 2005-04-06 12:12:50.870129732 +0200
+++ linux-docbook/kernel/sched.c2005-04-06 12:25:15.532487770 +0200
@@ -2906,6 +2906,7 @@ static void __wake_up_common(wait_queue_
* @q: the waitqueue
* @mode: which threads
* @nr_exclusive: how many wake-one or wake-many threads to wake up
+ * @key: is directly passed to the wakeup function
*/
void fastcall __wake_up(wait_queue_head_t *q, unsigned int mode,
int nr_exclusive, void *key)
@@ -2928,7 +2929,7 @@ void fastcall __wake_up_locked(wait_queu
}
/**
- * __wake_up - sync- wake up threads blocked on a waitqueue.
+ * __wake_up_sync - wake up threads blocked on a waitqueue.
* @q: the waitqueue
* @mode: which threads
* @nr_exclusive: how many wake-one or wake-many threads to wake up
Index: linux-docbook/fs/buffer.c
===
--- linux-docbook.orig/fs/buffer.c 2005-04-06 12:12:50.875128976 +0200
+++ linux-docbook/fs/buffer.c 2005-04-06 12:25:15.536487165 +0200
@@ -774,15 +774,14 @@ repeat:
/**
* sync_mapping_buffers - write out and wait upon a mapping's associated
*buffers
- * @buffer_mapping - the mapping which backs the buffers' data
- * @mapping - the mapping which wants those buffers written
+ * @mapping: the mapping which wants those buffers written
*
* Starts I/O against the buffers at mapping-private_list, and waits upon
* that I/O.
*
- * Basically, this is a convenience function for fsync(). @buffer_mapping is
- * the blockdev which owns the buffers and @mapping is a file or directory
- * which needs those buffers to be written for a successful fsync().
+ * Basically, this is a convenience function for fsync().
+ * @mapping is a file or directory which needs those buffers to be written for
+ * a successful fsync().
*/
int sync_mapping_buffers(struct address_space *mapping)
{
@@ -1263,6 +1262,7 @@ __getblk_slow(struct block_device *bdev,
/**
* mark_buffer_dirty - mark a buffer_head as needing writeout
+ * @bh: the buffer_head to mark dirty
*
* mark_buffer_dirty
[patch 1/6] DocBook: changes and extensions to the kernel documentation
DocBook: changes and extensions to the kernel documentation From: Pavel Pisa [EMAIL PROTECTED] I have recompiled Linux kernel 2.6.11.5 documentation for me and our university students again. The documentation could be extended for more sources which are equipped by structured comments for recent 2.6 kernels. I have tried to proceed with that task. I have done that more times from 2.6.0 time and it gets boring to do same changes again and again. Linux kernel compiles after changes for i386 and ARM targets. I have added references to some more files into kernel-api book, I have added some section names as well. So please, check that changes do not break something and that categories are not too much skewed. I have changed kernel-doc to accept fastcall and asmlinkage words reserved by kernel convention. Most of the other changes are modifications in the comments to make kernel-doc happy, accept some parameters description and do not bail out on errors. Changed pid to @pid in the description, moved some #ifdef before comments to correct function to comments bindings, etc. You can see result of the modified documentation build at http://cmp.felk.cvut.cz/~pisa/linux/lkdb-2.6.11.tar.gz Some more sources are ready to be included into kernel-doc generated documentation. Sources has been added into kernel-api for now. Some more section names added and probably some more chaos introduced as result of quick cleanup work. Signed-off-by: Pavel Pisa [EMAIL PROTECTED] Signed-off-by: Andrew Morton [EMAIL PROTECTED] Signed-off-by: Martin Waitz [EMAIL PROTECTED] Documentation/DocBook/kernel-api.tmpl | 186 -- drivers/video/fbmem.c |5 fs/proc/base.c| 10 - include/linux/fs.h| 12 +- include/linux/net.h | 38 +++--- include/linux/skbuff.h|2 include/net/sock.h| 134 kernel/exit.c |2 kernel/power/swsusp.c |2 mm/page_alloc.c |3 mm/vmalloc.c |8 - net/core/datagram.c | 28 ++--- net/core/sock.c | 12 +- net/core/stream.c | 12 +- net/sunrpc/xdr.c | 12 +- scripts/kernel-doc|2 16 files changed, 320 insertions(+), 148 deletions(-) Index: linux-docbook/Documentation/DocBook/kernel-api.tmpl === --- linux-docbook.orig/Documentation/DocBook/kernel-api.tmpl2005-04-06 12:13:12.673832313 +0200 +++ linux-docbook/Documentation/DocBook/kernel-api.tmpl 2005-04-06 12:24:11.943114418 +0200 @@ -49,13 +49,33 @@ !Iinclude/asm-i386/unaligned.h /sect1 -!-- FIXME: - kernel/sched.c has no docs, which stuffs up the sgml. Comment - out until somebody adds docs. KAO sect1titleDelaying, scheduling, and timer routines/title -X!Ekernel/sched.c +!Iinclude/linux/sched.h +!Ekernel/sched.c +!Ekernel/timer.c + /sect1 + sect1titleInternal Functions/title +!Ikernel/exit.c +!Ikernel/signal.c /sect1 -KAO -- + + sect1titleKernel objects manipulation/title +!-- +X!Iinclude/linux/kobject.h +-- +!Elib/kobject.c + /sect1 + + sect1titleKernel utility functions/title +!Iinclude/linux/kernel.h +!-- This needs to clean up to make kernel-doc happy +X!Ekernel/printk.c + -- +!Ekernel/panic.c +!Ekernel/sys.c +!Ekernel/rcupdate.c + /sect1 + /chapter chapter id=adt @@ -81,7 +101,9 @@ KAO -- !Elib/vsprintf.c /sect1 sect1titleString Manipulation/title -!Ilib/string.c +!-- All functions are exported at now +X!Ilib/string.c + -- !Elib/string.c /sect1 sect1titleBit Operations/title @@ -98,6 +120,25 @@ KAO -- !Iinclude/asm-i386/uaccess.h !Iarch/i386/lib/usercopy.c /sect1 + sect1titleMore Memory Management Functions/title +!Iinclude/linux/rmap.h +!Emm/readahead.c +!Emm/filemap.c +!Emm/memory.c +!Emm/vmalloc.c +!Emm/mempool.c +!Emm/page-writeback.c +!Emm/truncate.c + /sect1 + /chapter + + + chapter id=ipc + titleKernel IPC facilities/title + + sect1titleIPC utilities/title +!Iipc/util.c + /sect1 /chapter chapter id=kfifo @@ -114,6 +155,10 @@ KAO -- sect1titlesysctl interface/title !Ekernel/sysctl.c /sect1 + + sect1titleproc filesystem interface/title +!Ifs/proc/base.c + /sect1 /chapter chapter id=debugfs @@ -127,6 +172,10 @@ KAO -- chapter id=vfs titleThe Linux VFS/title + sect1titleThe Filesystem types/title +!Iinclude/linux/fs.h +!Einclude/linux/fs.h + /sect1 sect1titleThe Directory Cache/title !Efs/dcache.c !Iinclude/linux/dcache.h @@ -142,13 +191,31 @@ KAO -- !Efs/locks.c !Ifs/locks.c /sect1 + sect1titleOther Functions/title +!Efs/mpage.c +!Efs/namei.c +!Efs/buffer.c +!Efs/bio.c +!Efs/seq_file.c +!Efs
[patch 6/6] DocBook: Use xmlto to process the DocBook files.
DocBook: Use xmlto to process the DocBook files. xmlto uses standared XSLT templates to generate manpages, (x)html pages, and XML FO files which can be processed with passivetex. This is much faster than using jadetex for everything. This patch also reduces the number of kernel-specific scripts that are needed to generate documentation. Signed-off-by: Martin Waitz [EMAIL PROTECTED] scripts/makeman| 185 - scripts/split-man | 112 Documentation/Changes |8 - Documentation/DocBook/Makefile | 42 - scripts/kernel-doc | 32 ++- 5 files changed, 53 insertions(+), 326 deletions(-) Index: linux-docbook/Documentation/Changes === --- linux-docbook.orig/Documentation/Changes2005-04-06 12:12:34.750567521 +0200 +++ linux-docbook/Documentation/Changes 2005-04-06 12:25:20.551727922 +0200 @@ -357,14 +357,14 @@ Quota-tools -- o http://sourceforge.net/projects/linuxquota/ -Jade - -o ftp://ftp.jclark.com/pub/jade/jade-1.2.1.tar.gz - DocBook Stylesheets --- o http://nwalsh.com/docbook/dsssl/ +XMLTO XSLT Frontend +--- +o http://cyberelk.net/tim/xmlto/ + Intel P6 microcode -- o http://www.urbanmyth.org/microcode/ Index: linux-docbook/Documentation/DocBook/Makefile === --- linux-docbook.orig/Documentation/DocBook/Makefile 2005-04-06 12:25:19.150939983 +0200 +++ linux-docbook/Documentation/DocBook/Makefile2005-04-06 12:25:20.552727770 +0200 @@ -41,14 +41,15 @@ MAN := $(patsubst %.xml, %.9, $(BOOKS)) mandocs: $(MAN) installmandocs: mandocs - $(MAKEMAN) install Documentation/DocBook/man + mkdir -p /usr/local/man/man9/ + install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/ ### #External programs used KERNELDOC = scripts/kernel-doc DOCPROC = scripts/basic/docproc -SPLITMAN = $(PERL) $(srctree)/scripts/split-man -MAKEMAN = $(PERL) $(srctree)/scripts/makeman + +#XMLTOFLAGS = --skip-validation ### # DOCPROC is used for two purposes: @@ -95,29 +96,29 @@ $(obj)/procfs-guide.xml: $(C-procfs-exam # Rules to generate postscript, PDF and HTML # db2html creates a directory. Generate a html file used for timestamp -quiet_cmd_db2ps = DB2PS $@ - cmd_db2ps = db2ps -o $(dir $@) $ +quiet_cmd_db2ps = XMLTO$@ + cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $ %.ps : %.xml - @(which db2ps /dev/null 21) || \ + @(which xmlto /dev/null 21) || \ (echo *** You need to install DocBook stylesheets ***; \ exit 1) $(call cmd,db2ps) -quiet_cmd_db2pdf = DB2PDF $@ - cmd_db2pdf = db2pdf -o $(dir $@) $ +quiet_cmd_db2pdf = XMLTO $@ + cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $ %.pdf : %.xml - @(which db2pdf /dev/null 21) || \ + @(which xmlto /dev/null 21) || \ (echo *** You need to install DocBook stylesheets ***; \ exit 1) $(call cmd,db2pdf) -quiet_cmd_db2html = DB2HTML $@ - cmd_db2html = db2html -o $(patsubst %.html,%,$@) $ \ +quiet_cmd_db2html = XMLTO $@ + cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $ \ echo 'a HREF=$(patsubst %.html,%,$(notdir $@))/book1.html \ Goto $(patsubst %.html,%,$(notdir $@))/ap' $@ %.html:%.xml - @(which db2html /dev/null 21) || \ + @(which xmlto /dev/null 21) || \ (echo *** You need to install DocBook stylesheets ***; \ exit 1) @rm -rf $@ $(patsubst %.html,%,$@) @@ -125,15 +126,14 @@ quiet_cmd_db2html = DB2HTML $@ @if [ ! -z $(PNG-$(basename $(notdir $@))) ]; then \ cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi -### -# Rule to generate man files - output is placed in the man subdirectory - -%.9: %.xml -ifneq ($(KBUILD_SRC),) - $(Q)mkdir -p $(objtree)/Documentation/DocBook/man -endif - $(SPLITMAN) $ $(objtree)/Documentation/DocBook/man $(VERSION).$(PATCHLEVEL).$(SUBLEVEL) - $(MAKEMAN) convert $(objtree)/Documentation/DocBook/man $ +quiet_cmd_db2man = XMLTO $@ + cmd_db2man = if grep -q refentry $; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $ ; gzip -f $(obj)/man/*.9; fi +%.9 : %.xml + @(which xmlto /dev/null 21) || \ +(echo *** You need to install DocBook stylesheets ***; \ + exit 1) + $(call cmd,db2man) + @touch $@ ### # Rules to generate postscripts and PNG imgages from .fig format files Index: linux-docbook/scripts/kernel-doc === --- linux-docbook.orig/scripts/kernel-doc 2005-04-06 12:25:17.867134335 +0200 +++ linux-docbook/scripts/kernel-doc2005-04-06 12:25:20.555727316 +0200 @@ -581,8 +581,14
Re: [RFC 1/6]SEP initialization rework
hoi :) On Mon, Apr 04, 2005 at 10:05:56AM +0800, Li Shaohua wrote: - on_each_cpu(enable_sep_cpu, NULL, 1, 1); with this on_each_cpu call gone, you should also be able to remove the useless info pointer in enable_sep_cpu. -- Martin Waitz signature.asc Description: Digital signature
[PATCH RFC] DocBook: use xmlto to process the DocBook files.
\n";
- }
- elsif(//i){
- $front = "$front.\\\" This documentation comes with the following
legal notice:\n.\\\" \n";
- $mode = 2;
- }
-
- elsif(//i){
- $front = "$front.\\\" Documentation by: ";
- }
- elsif(/(.*)<\/firstname>/i){
- $front = "$front$1 ";
- }
- elsif(/(.*)<\/surname>/i){
- $front = "$front$1 ";
- }
- elsif(/(.*)<\/email>/i){
- $front = "$front($1)";
- }
- elsif(/\/author>/i){
- $front = "$front\n";
- }
-
- elsif(//i){
- $front = "$front.\\\" Documentation copyright: ";
- }
- elsif(/(.*)<\/holder>/i){
- $front = "$front$1 ";
- }
- elsif(/(.*)<\/year>/i){
- $front = "$front$1 ";
- }
- elsif(/\/copyright>/i){
- $front = "$front\n";
- }
-
- elsif(/^[ \t]*$/
- || //i
- || /<\/affiliation>/i
- || //i
- || /<\/address>/i
- || //i
- || /<\/authorgroup>/i
- || /<\/legalnotice>/i
- || //i
- || /<\/date>/i
- || //i
- || /<\/edition>/i
- || //i
- || /<\/pubdate>/i){
- }
- else{
- print "Unknown tag in manpage conversion: $_";
- }
- }
-
- if($mode == 0){
- if(//i){
- $mode = 1;
- }
- }
-
- if($mode == 4){
- if(/<\/bookinfo>/i){
- $mode = 3;
- }
- }
-}
-close INPUT;
-
-system("cd $ARGV[1]; docbook2man $filename.sgml; mv $filename.9
$tmpdir/$$.9\n");
-open GENERATED, "< $tmpdir/$$.9";
-open OUTPUT, "> $ARGV[1]/$filename.9";
-
-print OUTPUT "$front";
-print OUTPUT ".\\\" For comments on the formatting of this manpage, please
contact Michael Still <[EMAIL PROTECTED]>\n\n";
-while(){
- print OUTPUT "$_";
-}
-close OUTPUT;
-close GENERATED;
-
-system("gzip -f $ARGV[1]/$filename.9\n");
-unlink("$tmpdir/$$.9");
- }
-}
-elsif($ARGV[0] eq "install"){
- system("mkdir -p /usr/local/man/man9/; install $ARGV[1]/*.9.gz
/usr/local/man/man9/");
-}
-else{
- die "Usage: makeman [convert | install] \n";
-}
-
-print "Done\n";
diff -Nru a/scripts/split-man b/scripts/split-man
--- a/scripts/split-man 2005-03-18 11:51:17 +01:00
+++ /dev/null Wed Dec 31 16:00:00 196900
@@ -1,112 +0,0 @@
-#!/usr/bin/perl
-
-use strict;
-
-## Copyright (C) Michael Still ([EMAIL PROTECTED])
-## Released under the terms of the GNU GPL
-##
-## Hoon through the specified DocBook SGML file, and split out the
-## man pages. These can then be processed into groff format, and
-## installed if desired...
-##
-## Arguements: $1 -- the name of the sgml file
-## $2 -- the directory to put the generated SGML files in
-## $3 -- kernel version
-
-my($SGML, $REF, $front, $refdata, $mode, $filename);
-
-if(($ARGV[0] eq "") || ($ARGV[1] eq "") || ($ARGV[2] eq "")){
- die "Usage: split-man \n";
-}
-
-open SGML, "< $ARGV[0]" or die "Could not open input file \"$ARGV[0]\"\n";
-if( ! -d "$ARGV[1]" ){
- die "Output directory \"$ARGV[1]\" does not exist\n";
-}
-
-# Possible modes:
-# 0: Looking for input I care about
-# 1: Inside book front matter
-# 2: Inside a refentry
-# 3: Inside a refentry, and we know the filename
-
-$mode = 0;
-$refdata = "";
-$front = "";
-while(){
- # Starting modes
- if(// || //){
-$mode = 1;
- }
- elsif(//){
-$mode = 2;
- }
- elsif(/]*>([^<]*)<.*$/){
-$mode = 3;
-$filename = $1;
-
-$filename =~ s/struct //;
-$filename =~ s/typedef //;
-
-print "Found manpage for $filename\n";
-open REF, "> $ARGV[1]/$filename.sgml" or
- die "Couldn't open output file \"$ARGV[1]/$filename.sgml\": $!\n";
-print REF <
-
-
-$front
-
-
-$refdata
-EOF
-$refdata = "";
- }
-
- # Extraction
- if($mode == 1){
-chomp $_;
-$front = "$front\n";
- }
- elsif($mode == 2){
-$refdata = "$refdata$_";
- }
- elsif($mode == 3){
-# There are some fixups which need to be applied
-if(/<\/refmeta>/){
- print REF "9\n";
-}
-if(/<\/refentry>/){
- print REF <About this document
-
-This documentation was generated with kernel version $ARGV[2].
-
-
-EOF
-}
-
-# For some reason, we title the synopsis twice in the main DocBook
-if(! /Synopsis<\/title>/){
- if(//){
- s/struct //;
- s/typedef //;
- }
-
- print REF "$_";
-}
- }
-
- # Ending modes
- if(/<\/bookinfo>/ || /<\/docinfo>/){
-$mode = 0;
- }
- elsif(/<\/refentry>/){
-$mode = 0;
-close REF;
- }
-}
-
-# And make sure we don't process this unnessesarily
-$ARGV[0] =~ s/\.sgml/.9/;
-`touch $ARGV[0]`;
--
Martin Waitz
signature.asc
Description: Digital signature
[PATCH RFC] DocBook: use xmlto to process the DocBook files.
; - } -} - -# And make sure we don't process this unnessesarily -$ARGV[0] =~ s/\.sgml/.9/; -`touch $ARGV[0]`; -- Martin Waitz signature.asc Description: Digital signature
Re: Redirecting output
hoi :) On Wed, Mar 23, 2005 at 12:12:02PM +0530, shafa.hidee wrote: > I have created a dummy module for learning device driver in linux. I > want to redirect the standard output of printk to my xterm. But by default > it is redirected to tty. The kernel does not have 'standard output', so you can't redirect it. Please consult the manual for dmesg and syslog. And please have a look at a good Linux kernel book. This will help you understand the kernel and will answer most of your questions. -- Martin Waitz signature.asc Description: Digital signature
Re: Redirecting output
hoi :) On Wed, Mar 23, 2005 at 12:12:02PM +0530, shafa.hidee wrote: I have created a dummy module for learning device driver in linux. I want to redirect the standard output of printk to my xterm. But by default it is redirected to tty. The kernel does not have 'standard output', so you can't redirect it. Please consult the manual for dmesg and syslog. And please have a look at a good Linux kernel book. This will help you understand the kernel and will answer most of your questions. -- Martin Waitz signature.asc Description: Digital signature
[PATCH] docbook: fix escaping of kernel-doc
hoi :)
the following patch fixes a bug I introduced with the last patches
of the DocBook generation.
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
---
Please apply.
... and I really have to redo my bitkeeper repository as it
is full of merge artifacts as BK did not note the fact that
the patches were applied using normal patches.
I guess I have to use one complete tree per patch and recreate
the public repo as a combination of the individual ones.
Alternatives?
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-doc2005-03-18 11:51:17 +01:00
+++ b/scripts/kernel-doc2005-03-18 11:51:17 +01:00
@@ -1626,11 +1655,11 @@
# replace <, >, and &
sub xml_escape($) {
- shift;
- s/\&/\\amp;/g;
- s/\/\\gt;/g;
- return $_;
+ my $text = shift;
+ $text =~ s/\&/\\amp;/g;
+ $text =~ s/\/\\gt;/g;
+ return $text;
}
sub process_file($) {
--
Martin Waitz
signature.asc
Description: Digital signature
[PATCH] docbook: fix escaping of kernel-doc
hoi :)
the following patch fixes a bug I introduced with the last patches
of the DocBook generation.
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
---
Please apply.
... and I really have to redo my bitkeeper repository as it
is full of merge artifacts as BK did not note the fact that
the patches were applied using normal patches.
I guess I have to use one complete tree per patch and recreate
the public repo as a combination of the individual ones.
Alternatives?
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-doc2005-03-18 11:51:17 +01:00
+++ b/scripts/kernel-doc2005-03-18 11:51:17 +01:00
@@ -1626,11 +1655,11 @@
# replace , , and
sub xml_escape($) {
- shift;
- s/\/\\amp;/g;
- s/\/\\lt;/g;
- s/\/\\gt;/g;
- return $_;
+ my $text = shift;
+ $text =~ s/\/\\amp;/g;
+ $text =~ s/\/\\lt;/g;
+ $text =~ s/\/\\gt;/g;
+ return $text;
}
sub process_file($) {
--
Martin Waitz
signature.asc
Description: Digital signature
Re: [PATCH 15/16] [DocBook] factor out escaping of XML special characters
hoi :)
well, this patch is broken :(
On Thu, Mar 03, 2005 at 11:43:17AM +0100, Martin Waitz wrote:
> --- a/scripts/kernel-doc Thu Mar 3 11:43:21 2005
> +++ b/scripts/kernel-doc Thu Mar 3 11:43:21 2005
> @@ -1624,6 +1624,15 @@
> }
> }
>
> +# replace <, >, and &
> +sub xml_escape($) {
> + shift;
this must be: $_ = shift;
> + s/\&/\\amp;/g;
> + s/\ + s/\>/\\gt;/g;
> + return $_;
> +}
> +
> sub process_file($) {
> my ($file) = "$ENV{'SRCTREE'[EMAIL PROTECTED]";
> my $identifier;
this is also fixed in my BK repository.
(I'll send mail with other updates to lkml later)
--
Martin Waitz
signature.asc
Description: Digital signature
Re: [PATCH 15/16] [DocBook] factor out escaping of XML special characters
hoi :)
well, this patch is broken :(
On Thu, Mar 03, 2005 at 11:43:17AM +0100, Martin Waitz wrote:
--- a/scripts/kernel-doc Thu Mar 3 11:43:21 2005
+++ b/scripts/kernel-doc Thu Mar 3 11:43:21 2005
@@ -1624,6 +1624,15 @@
}
}
+# replace , , and
+sub xml_escape($) {
+ shift;
this must be: $_ = shift;
+ s/\/\\amp;/g;
+ s/\/\\lt;/g;
+ s/\/\\gt;/g;
+ return $_;
+}
+
sub process_file($) {
my ($file) = $ENV{'SRCTREE'[EMAIL PROTECTED];
my $identifier;
this is also fixed in my BK repository.
(I'll send mail with other updates to lkml later)
--
Martin Waitz
signature.asc
Description: Digital signature
[PATCH 5/16] DocBook: update function parameter description in USB code
DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2029 -> 1.2030 # drivers/usb/core/hub.c 1.160 -> 1.161 # drivers/usb/core/hcd.c 1.115 -> 1.116 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2030 # DocBook: update function parameter description in USB code # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/drivers/usb/core/hcd.c b/drivers/usb/core/hcd.c --- a/drivers/usb/core/hcd.cThu Mar 3 11:41:51 2005 +++ b/drivers/usb/core/hcd.cThu Mar 3 11:41:51 2005 @@ -1394,7 +1394,7 @@ /** * usb_bus_start_enum - start immediate enumeration (for OTG) * @bus: the bus (must use hcd framework) - * @port: 1-based number of port; usually bus->otg_port + * @port_num: 1-based number of port; usually bus->otg_port * Context: in_interrupt() * * Starts enumeration, with an immediate reset followed later by diff -Nru a/drivers/usb/core/hub.c b/drivers/usb/core/hub.c --- a/drivers/usb/core/hub.cThu Mar 3 11:41:51 2005 +++ b/drivers/usb/core/hub.cThu Mar 3 11:41:51 2005 @@ -383,7 +383,7 @@ /** * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub - * @dev: the device whose split transaction failed + * @udev: the device whose split transaction failed * @pipe: identifies the endpoint of the failed transaction * * High speed HCDs use this to tell the hub driver that some split control or - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 6/16] DocBook: fix function parameter descriptin in fbmem
DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2030 -> 1.2031 # drivers/video/fbmem.c 1.150 -> 1.151 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2031 # DocBook: fix function parameter descriptin in fbmem # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/drivers/video/fbmem.c b/drivers/video/fbmem.c --- a/drivers/video/fbmem.c Thu Mar 3 11:42:00 2005 +++ b/drivers/video/fbmem.c Thu Mar 3 11:42:00 2005 @@ -1211,9 +1211,10 @@ /** * fb_get_options - get kernel boot parameters - * @name - framebuffer name as it would appear in - * the boot parameter line - * (video=:) + * @name: framebuffer name as it would appear in + * the boot parameter line + * (video=:) + * @option: the option will be stored here * * NOTE: Needed to maintain backwards compatibility */ - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 7/16] DocBook: new kernel-doc comments for might_sleep & wait_event_*
DocBook: new kernel-doc comments for might_sleep & wait_event_*
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2031 -> 1.2032
# include/linux/kernel.h 1.60-> 1.61
# include/linux/wait.h1.28-> 1.29
#
# The following is the BitKeeper ChangeSet Log
#
# 05/01/26 [EMAIL PROTECTED] 1.2032
# DocBook: new kernel-doc comments for might_sleep & wait_event_*
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/include/linux/kernel.h b/include/linux/kernel.h
--- a/include/linux/kernel.hThu Mar 3 11:42:09 2005
+++ b/include/linux/kernel.hThu Mar 3 11:42:09 2005
@@ -48,10 +48,20 @@
struct completion;
+/**
+ * might_sleep - annotation for functions that can sleep
+ *
+ * this macro will print a stack trace if it is executed in an atomic
+ * context (spinlock, irq-handler, ...).
+ *
+ * This is a useful debugging help to be able to catch problems early and not
+ * be biten later when the calling function happens to sleep when it is not
+ * supposed to.
+ */
#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
-void __might_sleep(char *file, int line);
#define might_sleep() __might_sleep(__FILE__, __LINE__)
#define might_sleep_if(cond) do { if (unlikely(cond)) might_sleep(); } while
(0)
+void __might_sleep(char *file, int line);
#else
#define might_sleep() do {} while(0)
#define might_sleep_if(cond) do {} while (0)
diff -Nru a/include/linux/wait.h b/include/linux/wait.h
--- a/include/linux/wait.h Thu Mar 3 11:42:09 2005
+++ b/include/linux/wait.h Thu Mar 3 11:42:09 2005
@@ -169,6 +169,18 @@
finish_wait(, &__wait); \
} while (0)
+/**
+ * wait_event - sleep until a condition gets true
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ *
+ * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
+ * @condition evaluates to true. The @condition is checked each time
+ * the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ */
#define wait_event(wq, condition) \
do { \
if (condition) \
@@ -191,6 +203,22 @@
finish_wait(, &__wait); \
} while (0)
+/**
+ * wait_event_timeout - sleep until a condition gets true or a timeout elapses
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ * @timeout: timeout, in jiffies
+ *
+ * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
+ * @condition evaluates to true. The @condition is checked each time
+ * the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function returns 0 if the @timeout elapsed, and the remaining
+ * jiffies if the condition evaluated to true before the timeout elapsed.
+ */
#define wait_event_timeout(wq, condition, timeout) \
({ \
long __ret = timeout; \
@@ -217,6 +245,21 @@
finish_wait(, &__wait); \
} while (0)
+/**
+ * wait_event_interruptible - sleep until a condition gets true
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ *
+ * The process is put to sleep (TASK_INTERRUPTIBLE) until the
+ * @condition evaluates to true or a signal is received.
+ * The @condition is checked each time the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function will return -ERESTARTSYS if it was interrupted by a
+ * signal and 0 if @condition evaluated to true.
+ */
#define wait_event_interruptible(wq, condition)
\
({ \
int __ret = 0; \
@@ -245,6 +288,23 @@
finish_wait(, &__wait); \
} while (0)
+/**
+ * wait_event_interruptible_timeout - sleep until a condition gets true or a
timeout elapses
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ * @timeout: timeout, in jiffies
+ *
+ * The proce
[PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c
DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2025 -> 1.2026 # Documentation/DocBook/kernel-api.tmpl 1.32-> 1.33 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2026 # DocBook: remove reference to drivers/net/net_init.c # # This file has been removed and is breaking documentation generation. # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl --- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:41:17 2005 +++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:41:17 2005 @@ -152,7 +152,6 @@ Network device support Driver Support -!Edrivers/net/net_init.c !Enet/core/dev.c 8390 Based Network Cards - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 4/16] DocBook: update function parameter description in block/fs code
DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2028 -> 1.2029 # drivers/block/ll_rw_blk.c 1.282 -> 1.283 #kernel/sysctl.c1.96-> 1.97 # fs/jbd/journal.c1.79-> 1.81 # fs/jbd/transaction.c1.91-> 1.92 # fs/super.c1.129 -> 1.130 #include/linux/jbd.h1.48-> 1.49 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2029 # DocBook: update function parameter description in block/fs code # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/drivers/block/ll_rw_blk.c b/drivers/block/ll_rw_blk.c --- a/drivers/block/ll_rw_blk.c Thu Mar 3 11:41:42 2005 +++ b/drivers/block/ll_rw_blk.c Thu Mar 3 11:41:42 2005 @@ -618,6 +618,7 @@ * blk_queue_init_tags - initialize the queue tag info * @q: the request queue for the device * @depth: the maximum queue depth supported + * @tags: the tag to use **/ int blk_queue_init_tags(request_queue_t *q, int depth, struct blk_queue_tag *tags) @@ -1963,7 +1964,7 @@ /** * blk_rq_unmap_user - unmap a request with user data * @rq:request to be unmapped - * @ubuf: user buffer + * @bio: bio for the request * @ulen: length of user buffer * * Description: diff -Nru a/fs/jbd/journal.c b/fs/jbd/journal.c --- a/fs/jbd/journal.c Thu Mar 3 11:41:42 2005 +++ b/fs/jbd/journal.c Thu Mar 3 11:41:42 2005 @@ -1147,6 +1147,10 @@ /** *int journal_check_used_features () - Check if features specified are used. + * @journal: Journal to check. + * @compat: bitmask of compatible features + * @ro: bitmask of features that force read-only mount + * @incompat: bitmask of incompatible features * * Check whether the journal uses all of a given set of * features. Return true (non-zero) if it does. @@ -1174,6 +1178,10 @@ /** * int journal_check_available_features() - Check feature set in journalling layer + * @journal: Journal to check. + * @compat: bitmask of compatible features + * @ro: bitmask of features that force read-only mount + * @incompat: bitmask of incompatible features * * Check whether the journaling code supports the use of * all of a given set of features on this journal. Return true @@ -1206,6 +1214,10 @@ /** * int journal_set_features () - Mark a given journal feature in the superblock + * @journal: Journal to act on. + * @compat: bitmask of compatible features + * @ro: bitmask of features that force read-only mount + * @incompat: bitmask of incompatible features * * Mark a given journal feature as present on the * superblock. Returns true if the requested features could be set. @@ -1238,6 +1250,7 @@ /** * int journal_update_format () - Update on-disk journal structure. + * @journal: Journal to act on. * * Given an initialised but unloaded journal struct, poke about in the * on-disk structure to update it to the most recent supported version. @@ -1538,6 +1551,7 @@ /** * int journal_clear_err () - clears the journal's error state + * @journal: journal to act on. * * An error must be cleared or Acked to take a FS out of readonly * mode. @@ -1557,6 +1571,7 @@ /** * void journal_ack_err() - Ack journal err. + * @journal: journal to act on. * * An error must be cleared or Acked to take a FS out of readonly * mode. @@ -1574,10 +1589,6 @@ return 1 << (PAGE_CACHE_SHIFT - inode->i_sb->s_blocksize_bits); } -/* - * Simple support for retying memory allocations. Introduced to help to - * debug different VM deadlock avoidance strategies. - */ /* * Simple support for retying memory allocations. Introduced to help to * debug different VM deadlock avoidance strategies. diff -Nru a/fs/jbd/transaction.c b/fs/jbd/transaction.c --- a/fs/jbd/transaction.c Thu Mar 3 11:41:43 2005 +++ b/fs/jbd/transaction.c Thu Mar 3 11:41:43 2005 @@ -742,6 +742,7 @@ * int journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update. * @handle: transaction to add buffer modifications to * @bh: bh to be used for metadata writes + * @credits: variable that will receive credits for the buffer * * Returns an error code or 0 on success. * @@ -1578,7 +1579,7 @@ * int journal_try_to_free_buffers() - try to free page buffers. * @journal: journal for operation * @page: to try and free - * @gfp_mask: 'IO' mode for try_to_free_buffers() + * @unused_gfp_mask: unused * * * For all the b
script to send changesets per mail
hoi :)
I just tested my little script that can send changesets per mail.
okok, it still had a bug when I first tested it but that should be
fixed now.
If anyone is interested (perhaps for Documentation/BK-usage), here it
is:
#!/usr/bin/perl -w
# after sending an announcement (created by Documentation/BK-usage/bk-make-sum)
# just pipe your mail through this script.
# It will create one new mail per Changeset, properly threaded.
# Copyright © 2005 Martin Waitz <[EMAIL PROTECTED]>
use strict;
my $from;
my $to;
my $cc;
my $references;
# all local repositories are in ~/src/.
# you have to adjust this function if you keep them elsewhere.
sub local_repository($) {
my $repo;
$repo= shift;
$repo =~ s,.*/,"$ENV{HOME}/src/",e;
return $repo;
}
# this checks if we are allowed to send mails with this sender
# please modify the regexp to check for your adress!
sub check_from($) {
my $from = shift;
exit 1 unless $from =~ /insert-your-email-here/; #FIXME
}
# send one changeset.
# Parameters: the cset number, description prefix and the actual description.
sub send_cset() {
my ($cset, $serial, $desc, $longdesc) = @_;
open (MAIL, "| /usr/sbin/sendmail -t") or die "fork sendmail: $!";
print MAIL "From: $from\n";
print MAIL "To: $to\n";
print MAIL "Cc: $cc\n" if $cc;
print MAIL "References: $references\n" if $references;
print MAIL "Subject: [PATCH $serial] $desc\n";
print MAIL "\n";
print MAIL "$desc\n";
print MAIL "$longdesc\n";
print MAIL "\n";
print MAIL `bk export -tpatch -du -r $cset`;
close (MAIL) or die "could not send mail: error code $?";
}
# Parse header
while (<>) {
chomp;
last if /^$/;
if (/^From:\s+(.+)$/i) {
$from = $1;
} elsif (/^To:\s+(.+)$/i) {
$to = $1;
} elsif (/^Cc:\s+(.+)$/i) {
$cc = $1;
} elsif (/^Message-Id:\s+(.+)$/i) {
$references = $1;
}
}
my @cset;
my @desc;
my @longdesc;
# Parse body
my $cset;
while (<>) {
chomp;
if (/^\s+bk pull (\S+)$/) {
chdir local_repository($1) ||
die "could not find local repository for $1\n";
} elsif (/^<\S+> \(\S+ ([\d.]+)\)$/) {
# start of new ChangeSet
$cset = $1;
} elsif (/^ (.*)$/ && $cset) {
# first line of a description
unshift @cset, $cset;
unshift @desc, $1;
unshift @longdesc, "";
$cset = "";
} elsif (/^ (.*)$/) {
# next lines of description
$longdesc[0] .= "$1\n";
}
}
check_from($from);
my $i;
my $count;
$count = scalar @cset;
foreach $i (1 .. $count) {
print "$desc[$i-1]\n";
send_cset($cset[$i-1], "$i/$count", $desc[$i-1], $longdesc[$i-1]);
# let sendmail process the mail...
sleep 3;
}
exit(0);
--
Martin Waitz
signature.asc
Description: Digital signature
[PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function
DocBook: allow preprocessor directives between kernel-doc and function
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2026 -> 1.2027
# scripts/kernel-doc1.24-> 1.25
#
# The following is the BitKeeper ChangeSet Log
#
# 05/01/26 [EMAIL PROTECTED] 1.2027
# DocBook: allow preprocessor directives between kernel-doc and function
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:41:25 2005
+++ b/scripts/kernel-docThu Mar 3 11:41:25 2005
@@ -1578,13 +1578,13 @@
my $x = shift;
my $file = shift;
-if ($x =~ m#\s*/\*\s+MACDOC\s*#io) {
+if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ && $x !~ /^#define/)) {
# do nothing
}
elsif ($x =~ /([^\{]*)/) {
$prototype .= $1;
}
-if (($x =~ /\{/) || ($x =~ /\#/) || ($x =~ /;/)) {
+if (($x =~ /\{/) || ($x =~ /\#define/) || ($x =~ /;/)) {
$prototype =~ s@/\*.*?\*/@@gos;# strip comments.
$prototype =~ [EMAIL PROTECTED]@ @gos; # strip newlines/cr's.
$prototype =~ [EMAIL PROTECTED]@@gos; # strip leading spaces
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 3/16] DocBook: update function parameter description in network code
DocBook: update function parameter description in network code
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2027 -> 1.2028
# drivers/net/8390.c1.27-> 1.28
# net/core/skbuff.c1.41-> 1.42
# include/linux/skbuff.h 1.59-> 1.60
#
# The following is the BitKeeper ChangeSet Log
#
# 05/01/26 [EMAIL PROTECTED] 1.2028
# DocBook: update function parameter description in network code
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/drivers/net/8390.c b/drivers/net/8390.c
--- a/drivers/net/8390.cThu Mar 3 11:41:34 2005
+++ b/drivers/net/8390.cThu Mar 3 11:41:34 2005
@@ -999,6 +999,7 @@
/**
* alloc_ei_netdev - alloc_etherdev counterpart for 8390
+ * @size: extra bytes to allocate
*
* Allocate 8390-specific net_device.
*/
diff -Nru a/include/linux/skbuff.h b/include/linux/skbuff.h
--- a/include/linux/skbuff.hThu Mar 3 11:41:34 2005
+++ b/include/linux/skbuff.hThu Mar 3 11:41:34 2005
@@ -187,6 +187,8 @@
* @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
* @private: Data which is private to the HIPPI implementation
* @tc_index: Traffic control index
+ * @tc_verd: traffic control verdict
+ * @tc_classid: traffic control classid
*/
struct sk_buff {
diff -Nru a/net/core/skbuff.c b/net/core/skbuff.c
--- a/net/core/skbuff.c Thu Mar 3 11:41:34 2005
+++ b/net/core/skbuff.c Thu Mar 3 11:41:34 2005
@@ -1444,7 +1444,7 @@
if (pos < len) {
/* Split frag.
-* We have to variants in this case:
+* We have two variants in this case:
* 1. Move all the frag to the second
*part, if it is possible. F.e.
*this approach is mandatory for TUX,
@@ -1467,6 +1467,9 @@
/**
* skb_split - Split fragmented skb to two parts at length len.
+ * @skb: the buffer to split
+ * @skb1: the buffer to receive the second part
+ * @len: new length for skb
*/
void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len)
{
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 15/16] [DocBook] factor out escaping of XML special characters
[DocBook] factor out escaping of XML special characters
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2039 -> 1.2040
# scripts/kernel-doc1.26-> 1.27
#
# The following is the BitKeeper ChangeSet Log
#
# 05/03/03 [EMAIL PROTECTED] 1.2040
# [DocBook] factor out escaping of XML special characters
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:43:21 2005
+++ b/scripts/kernel-docThu Mar 3 11:43:21 2005
@@ -1624,6 +1624,15 @@
}
}
+# replace <, >, and &
+sub xml_escape($) {
+ shift;
+ s/\&/\\amp;/g;
+ s/\/\\gt;/g;
+ return $_;
+}
+
sub process_file($) {
my ($file) = "$ENV{'SRCTREE'[EMAIL PROTECTED]";
my $identifier;
@@ -1695,10 +1704,7 @@
$newcontents = $2;
if ($contents ne "") {
- $contents =~ s/\&/\\amp;/g;
- $contents =~ s/\/\\gt;/g;
- dump_section($section, $contents);
+ dump_section($section, xml_escape($contents));
$section = $section_default;
}
@@ -1710,10 +1716,7 @@
} elsif (/$doc_end/) {
if ($contents ne "") {
- $contents =~ s/\&/\\amp;/g;
- $contents =~ s/\/\\gt;/g;
- dump_section($section, $contents);
+ dump_section($section, xml_escape($contents));
$section = $section_default;
$contents = "";
}
@@ -1727,10 +1730,7 @@
# @parameter line to signify start of description
if ($1 eq "" &&
($section =~ m/^@/ || $section eq $section_context)) {
- $contents =~ s/\&/\\amp;/g;
- $contents =~ s/\/\\gt;/g;
- dump_section($section, $contents);
+ dump_section($section, xml_escape($contents));
$section = $section_default;
$contents = "";
} else {
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function
DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 11/16] DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile
DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2035 -> 1.2036 # Documentation/DocBook/Makefile 1.50-> 1.51 # # The following is the BitKeeper ChangeSet Log # # 05/02/08 [EMAIL PROTECTED] 1.2036 # DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile --- a/Documentation/DocBook/MakefileThu Mar 3 11:42:47 2005 +++ b/Documentation/DocBook/MakefileThu Mar 3 11:42:47 2005 @@ -6,38 +6,39 @@ # To add a new book the only step required is to add the book to the # list of DOCBOOKS. -DOCBOOKS := wanbook.sgml z8530book.sgml mcabook.sgml videobook.sgml \ - kernel-hacking.sgml kernel-locking.sgml via-audio.sgml \ - deviceiobook.sgml procfs-guide.sgml tulip-user.sgml \ - writing_usb_driver.sgml scsidrivers.sgml sis900.sgml \ - kernel-api.sgml journal-api.sgml lsm.sgml usb.sgml \ - gadget.sgml libata.sgml mtdnand.sgml librs.sgml +DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ + kernel-hacking.xml kernel-locking.xml via-audio.xml \ + deviceiobook.xml procfs-guide.xml tulip-user.xml \ + writing_usb_driver.xml scsidrivers.xml sis900.xml \ + kernel-api.xml journal-api.xml lsm.xml usb.xml \ + gadget.xml libata.xml mtdnand.xml librs.xml ### # The build process is as follows (targets): -# (sgmldocs) -# file.tmpl --> file.sgml +--> file.ps (psdocs) -# +--> file.pdf (pdfdocs) -# +--> DIR=file (htmldocs) -# +--> man/ (mandocs) +# (xmldocs) +# file.tmpl --> file.xml +--> file.ps (psdocs) +#+--> file.pdf (pdfdocs) +#+--> DIR=file (htmldocs) +#+--> man/ (mandocs) ### # The targets that may be used. -.PHONY:sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs +.PHONY:xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) -sgmldocs: $(BOOKS) +xmldocs: $(BOOKS) +sgmldocs: xmldocs -PS := $(patsubst %.sgml, %.ps, $(BOOKS)) +PS := $(patsubst %.xml, %.ps, $(BOOKS)) psdocs: $(PS) -PDF := $(patsubst %.sgml, %.pdf, $(BOOKS)) +PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) pdfdocs: $(PDF) -HTML := $(patsubst %.sgml, %.html, $(BOOKS)) +HTML := $(patsubst %.xml, %.html, $(BOOKS)) htmldocs: $(HTML) -MAN := $(patsubst %.sgml, %.9, $(BOOKS)) +MAN := $(patsubst %.xml, %.9, $(BOOKS)) mandocs: $(MAN) installmandocs: mandocs @@ -55,7 +56,7 @@ # 1) To generate a dependency list for a .tmpl file # 2) To preprocess a .tmpl file and call kernel-doc with # appropriate parameters. -# The following rules are used to generate the .sgml documentation +# The following rules are used to generate the .xml documentation # required to generate the final targets. (ps, pdf, html). quiet_cmd_docproc = DOCPROC $@ cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ @@ -69,7 +70,7 @@ ) > $(dir $@).$(notdir $@).cmd endef -%.sgml: %.tmpl FORCE +%.xml: %.tmpl FORCE $(call if_changed_rule,docproc) ### @@ -87,9 +88,9 @@ ### # procfs guide uses a .c file as example code. # This requires an explicit dependency -C-procfs-example = procfs_example.sgml +C-procfs-example = procfs_example.xml C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) -$(obj)/procfs-guide.sgml: $(C-procfs-example2) +$(obj)/procfs-guide.xml: $(C-procfs-example2) ### # Rules to generate postscript, PDF and HTML @@ -97,7 +98,7 @@ quiet_cmd_db2ps = DB2PS $@ cmd_db2ps = db2ps -o $(dir $@) $< -%.ps : %.sgml +%.ps : %.xml @(which db2ps > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) @@ -105,7 +106,7 @@ quiet_cmd_db2pdf = DB2PDF $@ cmd_db2pdf = db2pdf -o $(dir $@) $< -%.pdf : %.sgml +%.pdf : %.xml @(which db2pdf > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"; \ exit 1) @@ -116,7 +117,7 @@ echo ' \ Goto $(patsubst %.html,%,$(notdir $@))' > $@ -%.html:%.sgml +%.html:%.xml @(which db2html > /dev/null 2>&1) || \ (echo "*** You need to install DocBook stylesheets ***"
[PATCH 13/16] [DocBook] kernel-docify comments
[DocBook] kernel-docify comments Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2037 -> 1.2038 # kernel/kfifo.c1.2 -> 1.3 # include/linux/kfifo.h 1.1 -> 1.2 # # The following is the BitKeeper ChangeSet Log # # 05/03/02 [EMAIL PROTECTED] 1.2038 # [DocBook] kernel-docify comments # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/include/linux/kfifo.h b/include/linux/kfifo.h --- a/include/linux/kfifo.h Thu Mar 3 11:43:04 2005 +++ b/include/linux/kfifo.h Thu Mar 3 11:43:04 2005 @@ -44,7 +44,7 @@ extern unsigned int __kfifo_get(struct kfifo *fifo, unsigned char *buffer, unsigned int len); -/* +/** * __kfifo_reset - removes the entire FIFO contents, no locking version * @fifo: the fifo to be emptied. */ @@ -53,7 +53,7 @@ fifo->in = fifo->out = 0; } -/* +/** * kfifo_reset - removes the entire FIFO contents * @fifo: the fifo to be emptied. */ @@ -68,7 +68,7 @@ spin_unlock_irqrestore(fifo->lock, flags); } -/* +/** * kfifo_put - puts some data into the FIFO * @fifo: the fifo to be used. * @buffer: the data to be added. @@ -93,7 +93,7 @@ return ret; } -/* +/** * kfifo_get - gets some data from the FIFO * @fifo: the fifo to be used. * @buffer: where the data must be copied. @@ -124,7 +124,7 @@ return ret; } -/* +/** * __kfifo_len - returns the number of bytes available in the FIFO, no locking version * @fifo: the fifo to be used. */ @@ -133,7 +133,7 @@ return fifo->in - fifo->out; } -/* +/** * kfifo_len - returns the number of bytes available in the FIFO * @fifo: the fifo to be used. */ diff -Nru a/kernel/kfifo.c b/kernel/kfifo.c --- a/kernel/kfifo.cThu Mar 3 11:43:04 2005 +++ b/kernel/kfifo.cThu Mar 3 11:43:04 2005 @@ -25,7 +25,7 @@ #include #include -/* +/** * kfifo_init - allocates a new FIFO using a preallocated buffer * @buffer: the preallocated buffer to be used. * @size: the size of the internal buffer, this have to be a power of 2. @@ -56,7 +56,7 @@ } EXPORT_SYMBOL(kfifo_init); -/* +/** * kfifo_alloc - allocates a new FIFO and its internal buffer * @size: the size of the internal buffer to be allocated. * @gfp_mask: get_free_pages mask, passed to kmalloc() @@ -91,7 +91,7 @@ } EXPORT_SYMBOL(kfifo_alloc); -/* +/** * kfifo_free - frees the FIFO * @fifo: the fifo to be freed. */ @@ -102,7 +102,7 @@ } EXPORT_SYMBOL(kfifo_free); -/* +/** * __kfifo_put - puts some data into the FIFO, no locking version * @fifo: the fifo to be used. * @buffer: the data to be added. @@ -135,7 +135,7 @@ } EXPORT_SYMBOL(__kfifo_put); -/* +/** * __kfifo_get - gets some data from the FIFO, no locking version * @fifo: the fifo to be used. * @buffer: where the data must be copied. - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 14/16] [DocBook] add kfifo to kernel-api docs
[DocBook] add kfifo to kernel-api docs Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2038 -> 1.2039 # Documentation/DocBook/kernel-api.tmpl 1.34-> 1.35 # # The following is the BitKeeper ChangeSet Log # # 05/03/02 [EMAIL PROTECTED] 1.2039 # [DocBook] add kfifo to kernel-api docs # # Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> # # diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl --- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:43:12 2005 +++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:43:12 2005 @@ -100,6 +100,14 @@ + + FIFO Buffer + kfifo interface +!Iinclude/linux/kfifo.h +!Ekernel/kfifo.c + + + The proc filesystem - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 9/16] DocBook: s/sgml/xml/ in scripts/kernel-doc
DocBook: s/sgml/xml/ in scripts/kernel-doc
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2033 -> 1.2034
# scripts/kernel-doc1.25-> 1.26
#
# The following is the BitKeeper ChangeSet Log
#
# 05/02/08 [EMAIL PROTECTED] 1.2034
# DocBook: s/sgml/xml/ in scripts/kernel-doc
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:42:30 2005
+++ b/scripts/kernel-docThu Mar 3 11:42:30 2005
@@ -170,14 +170,14 @@
$type_param, "\$1" );
my $blankline_html = "";
-# sgml, docbook format
-my %highlights_sgml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1\$2",
+# XML, docbook format
+my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1\$2",
$type_constant, "\$1",
$type_func, "\$1",
$type_struct, "\$1",
$type_env, "\$1",
$type_param, "\$1" );
-my $blankline_sgml = "\n";
+my $blankline_xml = "\n";
# gnome, docbook format
my %highlights_gnome = ( $type_constant, "\$1",
@@ -297,14 +297,14 @@
%highlights = %highlights_text;
$blankline = $blankline_text;
} elsif ($cmd eq "-docbook") {
- $output_mode = "sgml";
- %highlights = %highlights_sgml;
- $blankline = $blankline_sgml;
+ $output_mode = "xml";
+ %highlights = %highlights_xml;
+ $blankline = $blankline_xml;
} elsif ($cmd eq "-gnome") {
$output_mode = "gnome";
%highlights = %highlights_gnome;
$blankline = $blankline_gnome;
-} elsif ($cmd eq "-module") { # not needed for sgml, inherits from calling
document
+} elsif ($cmd eq "-module") { # not needed for XML, inherits from calling
document
$modulename = shift @ARGV;
} elsif ($cmd eq "-function") { # to only output specific functions
$function_only = 1;
@@ -547,7 +547,7 @@
print "\n";
}
-sub output_section_sgml(%) {
+sub output_section_xml(%) {
my %args = %{$_[0]};
my $section;
# print out each section
@@ -565,8 +565,8 @@
}
}
-# output function in sgml DocBook
-sub output_function_sgml(%) {
+# output function in XML DocBook
+sub output_function_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $count;
@@ -632,12 +632,12 @@
}
print "\n";
-output_section_sgml(@_);
+output_section_xml(@_);
print "\n\n";
}
-# output struct in sgml DocBook
-sub output_struct_sgml(%) {
+# output struct in XML DocBook
+sub output_struct_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $id;
@@ -708,13 +708,13 @@
print " \n";
print " \n";
-output_section_sgml(@_);
+output_section_xml(@_);
print "\n\n";
}
-# output enum in sgml DocBook
-sub output_enum_sgml(%) {
+# output enum in XML DocBook
+sub output_enum_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $count;
@@ -769,13 +769,13 @@
print " \n";
print "\n";
-output_section_sgml(@_);
+output_section_xml(@_);
print "\n\n";
}
-# output typedef in sgml DocBook
-sub output_typedef_sgml(%) {
+# output typedef in XML DocBook
+sub output_typedef_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $id;
@@ -800,13 +800,13 @@
print " typedef ".$args{'typedef'}.";\n";
print "\n";
-output_section_sgml(@_);
+output_section_xml(@_);
print "\n\n";
}
-# output in sgml DocBook
-sub output_intro_sgml(%) {
+# output in XML DocBook
+sub output_intro_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $count;
@@ -831,7 +831,7 @@
print "\n\n";
}
-# output in sgml DocBook
+# output in XML DocBook
sub output_function_gnome {
my %args = %{$_[0]};
my ($parameter, $section);
@@ -1799,7 +1799,7 @@
}
if ($initial_section_counter == $section_counter) {
print STDERR "Warning(${file}): no structured comments found\n";
- if ($output_mode eq "sgml") {
+ if ($output_mode eq "xml") {
# The template wants at least one RefEntry here; make one.
print "\n";
print " \n";
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 12/16] DocBook: fix XML in templates
DocBook: fix XML in templates
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2036 -> 1.2037
# Documentation/DocBook/sis900.tmpl 1.6 -> 1.7
# Documentation/DocBook/mtdnand.tmpl 1.2 -> 1.3
# Documentation/DocBook/procfs-guide.tmpl 1.6 -> 1.7
# Documentation/DocBook/librs.tmpl1.3 -> 1.4
# Documentation/DocBook/videobook.tmpl1.8 -> 1.9
# Documentation/DocBook/via-audio.tmpl1.8 -> 1.9
#
# The following is the BitKeeper ChangeSet Log
#
# 05/02/09 [EMAIL PROTECTED] 1.2037
# DocBook: fix XML in templates
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/Documentation/DocBook/librs.tmpl b/Documentation/DocBook/librs.tmpl
--- a/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:55 2005
@@ -225,7 +225,7 @@
.
/* Decode 512 byte in data8.*/
numerr = decode_rs8 (rs_decoder, NULL, NULL, 512, syn, 0, errpos, 0, corr);
-for (i = 0; i < numerr; i++) {
+for (i = 0; i numerr; i++) {
do_error_correction_in_your_buffer(errpos[i], corr[i]);
}
diff -Nru a/Documentation/DocBook/mtdnand.tmpl
b/Documentation/DocBook/mtdnand.tmpl
--- a/Documentation/DocBook/mtdnand.tmplThu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/mtdnand.tmplThu Mar 3 11:42:55 2005
@@ -240,9 +240,9 @@
struct nand_chip *this = (struct nand_chip *) mtd->priv;
switch(cmd){
case NAND_CTL_SETCLE: this->IO_ADDR_W |= CLE_ADRR_BIT; break;
- case NAND_CTL_CLRCLE: this->IO_ADDR_W &= ~CLE_ADRR_BIT; break;
+ case NAND_CTL_CLRCLE: this->IO_ADDR_W = ~CLE_ADRR_BIT;
break;
case NAND_CTL_SETALE: this->IO_ADDR_W |= ALE_ADRR_BIT; break;
- case NAND_CTL_CLRALE: this->IO_ADDR_W &= ~ALE_ADRR_BIT; break;
+ case NAND_CTL_CLRALE: this->IO_ADDR_W = ~ALE_ADRR_BIT;
break;
}
}
@@ -393,7 +393,7 @@
/* Deselect all chips, set all nCE pins high */
GPIO(BOARD_NAND_NCE) |= 0xff;
if (chip >= 0)
- GPIO(BOARD_NAND_NCE) &= ~ (1 << chip);
+ GPIO(BOARD_NAND_NCE) = ~ (1 chip);
}
@@ -407,8 +407,8 @@
struct nand_chip *this = (struct nand_chip *) mtd->priv;
/* Deselect all chips */
- this->IO_ADDR_R &= ~BOARD_NAND_ADDR_MASK;
- this->IO_ADDR_W &= ~BOARD_NAND_ADDR_MASK;
+ this->IO_ADDR_R = ~BOARD_NAND_ADDR_MASK;
+ this->IO_ADDR_W = ~BOARD_NAND_ADDR_MASK;
switch (chip) {
case 0:
this->IO_ADDR_R |= BOARD_NAND_ADDR_CHIP0;
diff -Nru a/Documentation/DocBook/procfs-guide.tmpl
b/Documentation/DocBook/procfs-guide.tmpl
--- a/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:55 2005
@@ -1,7 +1,7 @@
http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd; [
-
+
]>
diff -Nru a/Documentation/DocBook/sis900.tmpl
b/Documentation/DocBook/sis900.tmpl
--- a/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:55 2005
@@ -20,7 +20,7 @@
-Document Revision: 0.3 for SiS900 driver v1.06 & v1.07
+Document Revision: 0.3 for SiS900 driver v1.06 v1.07
November 16, 2000
diff -Nru a/Documentation/DocBook/via-audio.tmpl
b/Documentation/DocBook/via-audio.tmpl
--- a/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:55 2005
@@ -264,7 +264,7 @@
-Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read &
+Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read
write mode (Rui Sousa)
diff -Nru a/Documentation/DocBook/videobook.tmpl
b/Documentation/DocBook/videobook.tmpl
--- a/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:55 2005
@@ -523,7 +523,7 @@
if(copy_from_user(arg, freq,
sizeof(unsigned long))!=0)
return -EFAULT;
-if(hardware_set_freq(freq)<0)
+if(hardware_set_freq(freq)0)
return -EINVAL;
curren
[PATCH 10/16] DocBook: move kernel-doc comment next to function
DocBook: move kernel-doc comment next to function
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2034 -> 1.2035
# drivers/video/fbmem.c 1.151 -> 1.152
#
# The following is the BitKeeper ChangeSet Log
#
# 05/02/08 [EMAIL PROTECTED] 1.2035
# DocBook: move kernel-doc comment next to function
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/drivers/video/fbmem.c b/drivers/video/fbmem.c
--- a/drivers/video/fbmem.c Thu Mar 3 11:42:38 2005
+++ b/drivers/video/fbmem.c Thu Mar 3 11:42:38 2005
@@ -1249,6 +1249,9 @@
return retval;
}
+
+extern const char *global_mode_option;
+
/**
* video_setup - process command line options
* @options: string of options
@@ -1262,9 +1265,6 @@
* Returns zero.
*
*/
-
-extern const char *global_mode_option;
-
int __init video_setup(char *options)
{
int i, global = 0;
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c
DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 16/16] [DocBook] escape declaration_purpose
[DocBook] escape declaration_purpose
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2040 -> 1.2041
# scripts/kernel-doc1.27-> 1.28
#
# The following is the BitKeeper ChangeSet Log
#
# 05/03/03 [EMAIL PROTECTED] 1.2041
# [DocBook] escape declaration_purpose
#
# Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:43:30 2005
+++ b/scripts/kernel-docThu Mar 3 11:43:30 2005
@@ -1673,7 +1673,7 @@
$state = 2;
if (/-(.*)/) {
- $declaration_purpose = $1;
+ $declaration_purpose = xml_escape($1);
} else {
$declaration_purpose = "";
}
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Documentation update
Hoi :) I'm still working on fixing and updating the Linux DocBook Documentation. My tree currently consists of several fixes to the Documentation generation, some additional kernel-doc entries and a move from SGML to valid XML. Please have a look at it and consider merging. Please do a bk pull bk://tali.bkbits.net/linux-doc This will update the following files: Documentation/DocBook/Makefile| 77 +-- Documentation/DocBook/deviceiobook.tmpl |4 Documentation/DocBook/gadget.tmpl |5 Documentation/DocBook/journal-api.tmpl|5 Documentation/DocBook/kernel-api.tmpl | 14 Documentation/DocBook/kernel-hacking.tmpl |4 Documentation/DocBook/kernel-locking.tmpl | 240 +-- Documentation/DocBook/libata.tmpl |4 Documentation/DocBook/librs.tmpl |6 Documentation/DocBook/lsm.tmpl| 11 Documentation/DocBook/mcabook.tmpl|4 Documentation/DocBook/mtdnand.tmpl| 14 Documentation/DocBook/procfs-guide.tmpl | 27 - Documentation/DocBook/scsidrivers.tmpl|5 Documentation/DocBook/sis900.tmpl | 556 +- Documentation/DocBook/tulip-user.tmpl |8 Documentation/DocBook/usb.tmpl|5 Documentation/DocBook/via-audio.tmpl |6 Documentation/DocBook/videobook.tmpl | 206 - Documentation/DocBook/wanbook.tmpl|4 Documentation/DocBook/writing_usb_driver.tmpl |4 Documentation/DocBook/z8530book.tmpl |4 drivers/block/ll_rw_blk.c |3 drivers/net/8390.c|1 drivers/usb/core/hcd.c|2 drivers/usb/core/hub.c|2 drivers/video/fbmem.c | 13 fs/jbd/journal.c | 19 fs/jbd/transaction.c |3 fs/super.c|2 include/linux/jbd.h |5 include/linux/kernel.h| 12 include/linux/kfifo.h | 12 include/linux/skbuff.h|2 include/linux/wait.h | 60 ++ kernel/kfifo.c| 10 kernel/sysctl.c |7 net/core/skbuff.c |5 scripts/kernel-doc| 78 +-- 39 files changed, 802 insertions(+), 647 deletions(-) through these ChangeSets: <[EMAIL PROTECTED]> (05/03/03 1.2041) [DocBook] escape declaration_purpose Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/03/03 1.2040) [DocBook] factor out escaping of XML special characters Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/03/02 1.2039) [DocBook] add kfifo to kernel-api docs Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/03/02 1.2038) [DocBook] kernel-docify comments Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/09 1.2037) DocBook: fix XML in templates Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2036) DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2035) DocBook: move kernel-doc comment next to function Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2034) DocBook: s/sgml/xml/ in scripts/kernel-doc Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2033) DocBook: convert template files to XML Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2032) DocBook: new kernel-doc comments for might_sleep & wait_event_* Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2031) DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2030) DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2029) DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2028) DocBook: update function parameter description in network code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2027) DocBook: allow preprocessor directives between kernel-doc and function
Documentation update
Hoi :) I'm still working on fixing and updating the Linux DocBook Documentation. My tree currently consists of several fixes to the Documentation generation, some additional kernel-doc entries and a move from SGML to valid XML. Please have a look at it and consider merging. Please do a bk pull bk://tali.bkbits.net/linux-doc This will update the following files: Documentation/DocBook/Makefile| 77 +-- Documentation/DocBook/deviceiobook.tmpl |4 Documentation/DocBook/gadget.tmpl |5 Documentation/DocBook/journal-api.tmpl|5 Documentation/DocBook/kernel-api.tmpl | 14 Documentation/DocBook/kernel-hacking.tmpl |4 Documentation/DocBook/kernel-locking.tmpl | 240 +-- Documentation/DocBook/libata.tmpl |4 Documentation/DocBook/librs.tmpl |6 Documentation/DocBook/lsm.tmpl| 11 Documentation/DocBook/mcabook.tmpl|4 Documentation/DocBook/mtdnand.tmpl| 14 Documentation/DocBook/procfs-guide.tmpl | 27 - Documentation/DocBook/scsidrivers.tmpl|5 Documentation/DocBook/sis900.tmpl | 556 +- Documentation/DocBook/tulip-user.tmpl |8 Documentation/DocBook/usb.tmpl|5 Documentation/DocBook/via-audio.tmpl |6 Documentation/DocBook/videobook.tmpl | 206 - Documentation/DocBook/wanbook.tmpl|4 Documentation/DocBook/writing_usb_driver.tmpl |4 Documentation/DocBook/z8530book.tmpl |4 drivers/block/ll_rw_blk.c |3 drivers/net/8390.c|1 drivers/usb/core/hcd.c|2 drivers/usb/core/hub.c|2 drivers/video/fbmem.c | 13 fs/jbd/journal.c | 19 fs/jbd/transaction.c |3 fs/super.c|2 include/linux/jbd.h |5 include/linux/kernel.h| 12 include/linux/kfifo.h | 12 include/linux/skbuff.h|2 include/linux/wait.h | 60 ++ kernel/kfifo.c| 10 kernel/sysctl.c |7 net/core/skbuff.c |5 scripts/kernel-doc| 78 +-- 39 files changed, 802 insertions(+), 647 deletions(-) through these ChangeSets: [EMAIL PROTECTED] (05/03/03 1.2041) [DocBook] escape declaration_purpose Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/03/03 1.2040) [DocBook] factor out escaping of XML special characters Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/03/02 1.2039) [DocBook] add kfifo to kernel-api docs Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/03/02 1.2038) [DocBook] kernel-docify comments Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/09 1.2037) DocBook: fix XML in templates Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2036) DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2035) DocBook: move kernel-doc comment next to function Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2034) DocBook: s/sgml/xml/ in scripts/kernel-doc Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2033) DocBook: convert template files to XML Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2032) DocBook: new kernel-doc comments for might_sleep wait_event_* Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2031) DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2030) DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2029) DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2028) DocBook: update function parameter description in network code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2027) DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2026) DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off
[PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c
DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz [EMAIL PROTECTED] - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 16/16] [DocBook] escape declaration_purpose
[DocBook] escape declaration_purpose
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2040 - 1.2041
# scripts/kernel-doc1.27- 1.28
#
# The following is the BitKeeper ChangeSet Log
#
# 05/03/03 [EMAIL PROTECTED] 1.2041
# [DocBook] escape declaration_purpose
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:43:30 2005
+++ b/scripts/kernel-docThu Mar 3 11:43:30 2005
@@ -1673,7 +1673,7 @@
$state = 2;
if (/-(.*)/) {
- $declaration_purpose = $1;
+ $declaration_purpose = xml_escape($1);
} else {
$declaration_purpose = ;
}
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 10/16] DocBook: move kernel-doc comment next to function
DocBook: move kernel-doc comment next to function
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2034 - 1.2035
# drivers/video/fbmem.c 1.151 - 1.152
#
# The following is the BitKeeper ChangeSet Log
#
# 05/02/08 [EMAIL PROTECTED] 1.2035
# DocBook: move kernel-doc comment next to function
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/drivers/video/fbmem.c b/drivers/video/fbmem.c
--- a/drivers/video/fbmem.c Thu Mar 3 11:42:38 2005
+++ b/drivers/video/fbmem.c Thu Mar 3 11:42:38 2005
@@ -1249,6 +1249,9 @@
return retval;
}
+
+extern const char *global_mode_option;
+
/**
* video_setup - process command line options
* @options: string of options
@@ -1262,9 +1265,6 @@
* Returns zero.
*
*/
-
-extern const char *global_mode_option;
-
int __init video_setup(char *options)
{
int i, global = 0;
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 12/16] DocBook: fix XML in templates
DocBook: fix XML in templates
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2036 - 1.2037
# Documentation/DocBook/sis900.tmpl 1.6 - 1.7
# Documentation/DocBook/mtdnand.tmpl 1.2 - 1.3
# Documentation/DocBook/procfs-guide.tmpl 1.6 - 1.7
# Documentation/DocBook/librs.tmpl1.3 - 1.4
# Documentation/DocBook/videobook.tmpl1.8 - 1.9
# Documentation/DocBook/via-audio.tmpl1.8 - 1.9
#
# The following is the BitKeeper ChangeSet Log
#
# 05/02/09 [EMAIL PROTECTED] 1.2037
# DocBook: fix XML in templates
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/Documentation/DocBook/librs.tmpl b/Documentation/DocBook/librs.tmpl
--- a/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/librs.tmpl Thu Mar 3 11:42:55 2005
@@ -225,7 +225,7 @@
.
/* Decode 512 byte in data8.*/
numerr = decode_rs8 (rs_decoder, NULL, NULL, 512, syn, 0, errpos, 0, corr);
-for (i = 0; i numerr; i++) {
+for (i = 0; i lt; numerr; i++) {
do_error_correction_in_your_buffer(errpos[i], corr[i]);
}
/programlisting
diff -Nru a/Documentation/DocBook/mtdnand.tmpl
b/Documentation/DocBook/mtdnand.tmpl
--- a/Documentation/DocBook/mtdnand.tmplThu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/mtdnand.tmplThu Mar 3 11:42:55 2005
@@ -240,9 +240,9 @@
struct nand_chip *this = (struct nand_chip *) mtd-priv;
switch(cmd){
case NAND_CTL_SETCLE: this-IO_ADDR_W |= CLE_ADRR_BIT; break;
- case NAND_CTL_CLRCLE: this-IO_ADDR_W = ~CLE_ADRR_BIT; break;
+ case NAND_CTL_CLRCLE: this-IO_ADDR_W amp;= ~CLE_ADRR_BIT;
break;
case NAND_CTL_SETALE: this-IO_ADDR_W |= ALE_ADRR_BIT; break;
- case NAND_CTL_CLRALE: this-IO_ADDR_W = ~ALE_ADRR_BIT; break;
+ case NAND_CTL_CLRALE: this-IO_ADDR_W amp;= ~ALE_ADRR_BIT;
break;
}
}
/programlisting
@@ -393,7 +393,7 @@
/* Deselect all chips, set all nCE pins high */
GPIO(BOARD_NAND_NCE) |= 0xff;
if (chip = 0)
- GPIO(BOARD_NAND_NCE) = ~ (1 chip);
+ GPIO(BOARD_NAND_NCE) amp;= ~ (1 lt;lt; chip);
}
/programlisting
para
@@ -407,8 +407,8 @@
struct nand_chip *this = (struct nand_chip *) mtd-priv;
/* Deselect all chips */
- this-IO_ADDR_R = ~BOARD_NAND_ADDR_MASK;
- this-IO_ADDR_W = ~BOARD_NAND_ADDR_MASK;
+ this-IO_ADDR_R amp;= ~BOARD_NAND_ADDR_MASK;
+ this-IO_ADDR_W amp;= ~BOARD_NAND_ADDR_MASK;
switch (chip) {
case 0:
this-IO_ADDR_R |= BOARD_NAND_ADDR_CHIP0;
diff -Nru a/Documentation/DocBook/procfs-guide.tmpl
b/Documentation/DocBook/procfs-guide.tmpl
--- a/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/procfs-guide.tmpl Thu Mar 3 11:42:55 2005
@@ -1,7 +1,7 @@
?xml version=1.0 encoding=UTF-8?
!DOCTYPE book PUBLIC -//OASIS//DTD DocBook XML V4.1.2//EN
http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd; [
-!ENTITY procfsexample SYSTEM procfs_example.sgml
+!ENTITY procfsexample SYSTEM procfs_example.xml
]
book id=LKProcfsGuide
diff -Nru a/Documentation/DocBook/sis900.tmpl
b/Documentation/DocBook/sis900.tmpl
--- a/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/sis900.tmpl Thu Mar 3 11:42:55 2005
@@ -20,7 +20,7 @@
/author
/authorgroup
-editionDocument Revision: 0.3 for SiS900 driver v1.06 v1.07/edition
+editionDocument Revision: 0.3 for SiS900 driver v1.06 amp; v1.07/edition
pubdateNovember 16, 2000/pubdate
copyright
diff -Nru a/Documentation/DocBook/via-audio.tmpl
b/Documentation/DocBook/via-audio.tmpl
--- a/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/via-audio.tmpl Thu Mar 3 11:42:55 2005
@@ -264,7 +264,7 @@
listitem
para
-Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read
+Fixes for the SPEED, STEREO, CHANNELS, FMT ioctls when in read amp;
write mode (Rui Sousa)
/para
/listitem
diff -Nru a/Documentation/DocBook/videobook.tmpl
b/Documentation/DocBook/videobook.tmpl
--- a/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:55 2005
+++ b/Documentation/DocBook/videobook.tmpl Thu Mar 3 11:42:55 2005
@@ -523,7 +523,7 @@
if(copy_from_user(arg, amp;freq,
sizeof(unsigned long))!=0
[PATCH 9/16] DocBook: s/sgml/xml/ in scripts/kernel-doc
DocBook: s/sgml/xml/ in scripts/kernel-doc
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2033 - 1.2034
# scripts/kernel-doc1.25- 1.26
#
# The following is the BitKeeper ChangeSet Log
#
# 05/02/08 [EMAIL PROTECTED] 1.2034
# DocBook: s/sgml/xml/ in scripts/kernel-doc
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:42:30 2005
+++ b/scripts/kernel-docThu Mar 3 11:42:30 2005
@@ -170,14 +170,14 @@
$type_param, ttb\$1/b/tt );
my $blankline_html = p;
-# sgml, docbook format
-my %highlights_sgml = ( ([^=])\\\([^\\\]+)\\\, \$1quote\$2/quote,
+# XML, docbook format
+my %highlights_xml = ( ([^=])\\\([^\\\]+)\\\, \$1quote\$2/quote,
$type_constant, constant\$1/constant,
$type_func, function\$1/function,
$type_struct, structname\$1/structname,
$type_env, envar\$1/envar,
$type_param, parameter\$1/parameter );
-my $blankline_sgml = /parapara\n;
+my $blankline_xml = /parapara\n;
# gnome, docbook format
my %highlights_gnome = ( $type_constant, replaceable
class=\option\\$1/replaceable,
@@ -297,14 +297,14 @@
%highlights = %highlights_text;
$blankline = $blankline_text;
} elsif ($cmd eq -docbook) {
- $output_mode = sgml;
- %highlights = %highlights_sgml;
- $blankline = $blankline_sgml;
+ $output_mode = xml;
+ %highlights = %highlights_xml;
+ $blankline = $blankline_xml;
} elsif ($cmd eq -gnome) {
$output_mode = gnome;
%highlights = %highlights_gnome;
$blankline = $blankline_gnome;
-} elsif ($cmd eq -module) { # not needed for sgml, inherits from calling
document
+} elsif ($cmd eq -module) { # not needed for XML, inherits from calling
document
$modulename = shift @ARGV;
} elsif ($cmd eq -function) { # to only output specific functions
$function_only = 1;
@@ -547,7 +547,7 @@
print hr\n;
}
-sub output_section_sgml(%) {
+sub output_section_xml(%) {
my %args = %{$_[0]};
my $section;
# print out each section
@@ -565,8 +565,8 @@
}
}
-# output function in sgml DocBook
-sub output_function_sgml(%) {
+# output function in XML DocBook
+sub output_function_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $count;
@@ -632,12 +632,12 @@
}
print /refsect1\n;
-output_section_sgml(@_);
+output_section_xml(@_);
print /refentry\n\n;
}
-# output struct in sgml DocBook
-sub output_struct_sgml(%) {
+# output struct in XML DocBook
+sub output_struct_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $id;
@@ -708,13 +708,13 @@
print /variablelist\n;
print /refsect1\n;
-output_section_sgml(@_);
+output_section_xml(@_);
print /refentry\n\n;
}
-# output enum in sgml DocBook
-sub output_enum_sgml(%) {
+# output enum in XML DocBook
+sub output_enum_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $count;
@@ -769,13 +769,13 @@
print /variablelist\n;
print /refsect1\n;
-output_section_sgml(@_);
+output_section_xml(@_);
print /refentry\n\n;
}
-# output typedef in sgml DocBook
-sub output_typedef_sgml(%) {
+# output typedef in XML DocBook
+sub output_typedef_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $id;
@@ -800,13 +800,13 @@
print synopsistypedef .$args{'typedef'}.;/synopsis\n;
print /refsynopsisdiv\n;
-output_section_sgml(@_);
+output_section_xml(@_);
print /refentry\n\n;
}
-# output in sgml DocBook
-sub output_intro_sgml(%) {
+# output in XML DocBook
+sub output_intro_xml(%) {
my %args = %{$_[0]};
my ($parameter, $section);
my $count;
@@ -831,7 +831,7 @@
print \n\n;
}
-# output in sgml DocBook
+# output in XML DocBook
sub output_function_gnome {
my %args = %{$_[0]};
my ($parameter, $section);
@@ -1799,7 +1799,7 @@
}
if ($initial_section_counter == $section_counter) {
print STDERR Warning(${file}): no structured comments found\n;
- if ($output_mode eq sgml) {
+ if ($output_mode eq xml) {
# The template wants at least one RefEntry here; make one.
print refentry\n;
print refnamediv\n;
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org
[PATCH 14/16] [DocBook] add kfifo to kernel-api docs
[DocBook] add kfifo to kernel-api docs Signed-off-by: Martin Waitz [EMAIL PROTECTED] # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2038 - 1.2039 # Documentation/DocBook/kernel-api.tmpl 1.34- 1.35 # # The following is the BitKeeper ChangeSet Log # # 05/03/02 [EMAIL PROTECTED] 1.2039 # [DocBook] add kfifo to kernel-api docs # # Signed-off-by: Martin Waitz [EMAIL PROTECTED] # # diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl --- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:43:12 2005 +++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:43:12 2005 @@ -100,6 +100,14 @@ /sect1 /chapter + chapter id=kfifo + titleFIFO Buffer/title + sect1titlekfifo interface/title +!Iinclude/linux/kfifo.h +!Ekernel/kfifo.c + /sect1 + /chapter + chapter id=proc titleThe proc filesystem/title - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 13/16] [DocBook] kernel-docify comments
[DocBook] kernel-docify comments Signed-off-by: Martin Waitz [EMAIL PROTECTED] # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2037 - 1.2038 # kernel/kfifo.c1.2 - 1.3 # include/linux/kfifo.h 1.1 - 1.2 # # The following is the BitKeeper ChangeSet Log # # 05/03/02 [EMAIL PROTECTED] 1.2038 # [DocBook] kernel-docify comments # # Signed-off-by: Martin Waitz [EMAIL PROTECTED] # # diff -Nru a/include/linux/kfifo.h b/include/linux/kfifo.h --- a/include/linux/kfifo.h Thu Mar 3 11:43:04 2005 +++ b/include/linux/kfifo.h Thu Mar 3 11:43:04 2005 @@ -44,7 +44,7 @@ extern unsigned int __kfifo_get(struct kfifo *fifo, unsigned char *buffer, unsigned int len); -/* +/** * __kfifo_reset - removes the entire FIFO contents, no locking version * @fifo: the fifo to be emptied. */ @@ -53,7 +53,7 @@ fifo-in = fifo-out = 0; } -/* +/** * kfifo_reset - removes the entire FIFO contents * @fifo: the fifo to be emptied. */ @@ -68,7 +68,7 @@ spin_unlock_irqrestore(fifo-lock, flags); } -/* +/** * kfifo_put - puts some data into the FIFO * @fifo: the fifo to be used. * @buffer: the data to be added. @@ -93,7 +93,7 @@ return ret; } -/* +/** * kfifo_get - gets some data from the FIFO * @fifo: the fifo to be used. * @buffer: where the data must be copied. @@ -124,7 +124,7 @@ return ret; } -/* +/** * __kfifo_len - returns the number of bytes available in the FIFO, no locking version * @fifo: the fifo to be used. */ @@ -133,7 +133,7 @@ return fifo-in - fifo-out; } -/* +/** * kfifo_len - returns the number of bytes available in the FIFO * @fifo: the fifo to be used. */ diff -Nru a/kernel/kfifo.c b/kernel/kfifo.c --- a/kernel/kfifo.cThu Mar 3 11:43:04 2005 +++ b/kernel/kfifo.cThu Mar 3 11:43:04 2005 @@ -25,7 +25,7 @@ #include linux/err.h #include linux/kfifo.h -/* +/** * kfifo_init - allocates a new FIFO using a preallocated buffer * @buffer: the preallocated buffer to be used. * @size: the size of the internal buffer, this have to be a power of 2. @@ -56,7 +56,7 @@ } EXPORT_SYMBOL(kfifo_init); -/* +/** * kfifo_alloc - allocates a new FIFO and its internal buffer * @size: the size of the internal buffer to be allocated. * @gfp_mask: get_free_pages mask, passed to kmalloc() @@ -91,7 +91,7 @@ } EXPORT_SYMBOL(kfifo_alloc); -/* +/** * kfifo_free - frees the FIFO * @fifo: the fifo to be freed. */ @@ -102,7 +102,7 @@ } EXPORT_SYMBOL(kfifo_free); -/* +/** * __kfifo_put - puts some data into the FIFO, no locking version * @fifo: the fifo to be used. * @buffer: the data to be added. @@ -135,7 +135,7 @@ } EXPORT_SYMBOL(__kfifo_put); -/* +/** * __kfifo_get - gets some data from the FIFO, no locking version * @fifo: the fifo to be used. * @buffer: where the data must be copied. - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function
DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz [EMAIL PROTECTED] - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 15/16] [DocBook] factor out escaping of XML special characters
[DocBook] factor out escaping of XML special characters
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2039 - 1.2040
# scripts/kernel-doc1.26- 1.27
#
# The following is the BitKeeper ChangeSet Log
#
# 05/03/03 [EMAIL PROTECTED] 1.2040
# [DocBook] factor out escaping of XML special characters
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:43:21 2005
+++ b/scripts/kernel-docThu Mar 3 11:43:21 2005
@@ -1624,6 +1624,15 @@
}
}
+# replace , , and
+sub xml_escape($) {
+ shift;
+ s/\/\\amp;/g;
+ s/\/\\lt;/g;
+ s/\/\\gt;/g;
+ return $_;
+}
+
sub process_file($) {
my ($file) = $ENV{'SRCTREE'[EMAIL PROTECTED];
my $identifier;
@@ -1695,10 +1704,7 @@
$newcontents = $2;
if ($contents ne ) {
- $contents =~ s/\/\\amp;/g;
- $contents =~ s/\/\\lt;/g;
- $contents =~ s/\/\\gt;/g;
- dump_section($section, $contents);
+ dump_section($section, xml_escape($contents));
$section = $section_default;
}
@@ -1710,10 +1716,7 @@
} elsif (/$doc_end/) {
if ($contents ne ) {
- $contents =~ s/\/\\amp;/g;
- $contents =~ s/\/\\lt;/g;
- $contents =~ s/\/\\gt;/g;
- dump_section($section, $contents);
+ dump_section($section, xml_escape($contents));
$section = $section_default;
$contents = ;
}
@@ -1727,10 +1730,7 @@
# @parameter line to signify start of description
if ($1 eq
($section =~ m/^@/ || $section eq $section_context)) {
- $contents =~ s/\/\\amp;/g;
- $contents =~ s/\/\\lt;/g;
- $contents =~ s/\/\\gt;/g;
- dump_section($section, $contents);
+ dump_section($section, xml_escape($contents));
$section = $section_default;
$contents = ;
} else {
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 3/16] DocBook: update function parameter description in network code
DocBook: update function parameter description in network code
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2027 - 1.2028
# drivers/net/8390.c1.27- 1.28
# net/core/skbuff.c1.41- 1.42
# include/linux/skbuff.h 1.59- 1.60
#
# The following is the BitKeeper ChangeSet Log
#
# 05/01/26 [EMAIL PROTECTED] 1.2028
# DocBook: update function parameter description in network code
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/drivers/net/8390.c b/drivers/net/8390.c
--- a/drivers/net/8390.cThu Mar 3 11:41:34 2005
+++ b/drivers/net/8390.cThu Mar 3 11:41:34 2005
@@ -999,6 +999,7 @@
/**
* alloc_ei_netdev - alloc_etherdev counterpart for 8390
+ * @size: extra bytes to allocate
*
* Allocate 8390-specific net_device.
*/
diff -Nru a/include/linux/skbuff.h b/include/linux/skbuff.h
--- a/include/linux/skbuff.hThu Mar 3 11:41:34 2005
+++ b/include/linux/skbuff.hThu Mar 3 11:41:34 2005
@@ -187,6 +187,8 @@
* @nf_bridge: Saved data about a bridged frame - see br_netfilter.c
* @private: Data which is private to the HIPPI implementation
* @tc_index: Traffic control index
+ * @tc_verd: traffic control verdict
+ * @tc_classid: traffic control classid
*/
struct sk_buff {
diff -Nru a/net/core/skbuff.c b/net/core/skbuff.c
--- a/net/core/skbuff.c Thu Mar 3 11:41:34 2005
+++ b/net/core/skbuff.c Thu Mar 3 11:41:34 2005
@@ -1444,7 +1444,7 @@
if (pos len) {
/* Split frag.
-* We have to variants in this case:
+* We have two variants in this case:
* 1. Move all the frag to the second
*part, if it is possible. F.e.
*this approach is mandatory for TUX,
@@ -1467,6 +1467,9 @@
/**
* skb_split - Split fragmented skb to two parts at length len.
+ * @skb: the buffer to split
+ * @skb1: the buffer to receive the second part
+ * @len: new length for skb
*/
void skb_split(struct sk_buff *skb, struct sk_buff *skb1, const u32 len)
{
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
[PATCH 2/16] DocBook: allow preprocessor directives between kernel-doc and function
DocBook: allow preprocessor directives between kernel-doc and function
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2026 - 1.2027
# scripts/kernel-doc1.24- 1.25
#
# The following is the BitKeeper ChangeSet Log
#
# 05/01/26 [EMAIL PROTECTED] 1.2027
# DocBook: allow preprocessor directives between kernel-doc and function
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/scripts/kernel-doc b/scripts/kernel-doc
--- a/scripts/kernel-docThu Mar 3 11:41:25 2005
+++ b/scripts/kernel-docThu Mar 3 11:41:25 2005
@@ -1578,13 +1578,13 @@
my $x = shift;
my $file = shift;
-if ($x =~ m#\s*/\*\s+MACDOC\s*#io) {
+if ($x =~ m#\s*/\*\s+MACDOC\s*#io || ($x =~ /^#/ $x !~ /^#define/)) {
# do nothing
}
elsif ($x =~ /([^\{]*)/) {
$prototype .= $1;
}
-if (($x =~ /\{/) || ($x =~ /\#/) || ($x =~ /;/)) {
+if (($x =~ /\{/) || ($x =~ /\#define/) || ($x =~ /;/)) {
$prototype =~ s@/\*.*?\*/@@gos;# strip comments.
$prototype =~ [EMAIL PROTECTED]@ @gos; # strip newlines/cr's.
$prototype =~ [EMAIL PROTECTED]@@gos; # strip leading spaces
-
To unsubscribe from this list: send the line unsubscribe linux-kernel in
the body of a message to [EMAIL PROTECTED]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
script to send changesets per mail
hoi :)
I just tested my little script that can send changesets per mail.
okok, it still had a bug when I first tested it but that should be
fixed now.
If anyone is interested (perhaps for Documentation/BK-usage), here it
is:
#!/usr/bin/perl -w
# after sending an announcement (created by Documentation/BK-usage/bk-make-sum)
# just pipe your mail through this script.
# It will create one new mail per Changeset, properly threaded.
# Copyright © 2005 Martin Waitz [EMAIL PROTECTED]
use strict;
my $from;
my $to;
my $cc;
my $references;
# all local repositories are in ~/src/.
# you have to adjust this function if you keep them elsewhere.
sub local_repository($) {
my $repo;
$repo= shift;
$repo =~ s,.*/,$ENV{HOME}/src/,e;
return $repo;
}
# this checks if we are allowed to send mails with this sender
# please modify the regexp to check for your adress!
sub check_from($) {
my $from = shift;
exit 1 unless $from =~ /insert-your-email-here/; #FIXME
}
# send one changeset.
# Parameters: the cset number, description prefix and the actual description.
sub send_cset() {
my ($cset, $serial, $desc, $longdesc) = @_;
open (MAIL, | /usr/sbin/sendmail -t) or die fork sendmail: $!;
print MAIL From: $from\n;
print MAIL To: $to\n;
print MAIL Cc: $cc\n if $cc;
print MAIL References: $references\n if $references;
print MAIL Subject: [PATCH $serial] $desc\n;
print MAIL \n;
print MAIL $desc\n;
print MAIL $longdesc\n;
print MAIL \n;
print MAIL `bk export -tpatch -du -r $cset`;
close (MAIL) or die could not send mail: error code $?;
}
# Parse header
while () {
chomp;
last if /^$/;
if (/^From:\s+(.+)$/i) {
$from = $1;
} elsif (/^To:\s+(.+)$/i) {
$to = $1;
} elsif (/^Cc:\s+(.+)$/i) {
$cc = $1;
} elsif (/^Message-Id:\s+(.+)$/i) {
$references = $1;
}
}
my @cset;
my @desc;
my @longdesc;
# Parse body
my $cset;
while () {
chomp;
if (/^\s+bk pull (\S+)$/) {
chdir local_repository($1) ||
die could not find local repository for $1\n;
} elsif (/^\S+ \(\S+ ([\d.]+)\)$/) {
# start of new ChangeSet
$cset = $1;
} elsif (/^ (.*)$/ $cset) {
# first line of a description
unshift @cset, $cset;
unshift @desc, $1;
unshift @longdesc, ;
$cset = ;
} elsif (/^ (.*)$/) {
# next lines of description
$longdesc[0] .= $1\n;
}
}
check_from($from);
my $i;
my $count;
$count = scalar @cset;
foreach $i (1 .. $count) {
print $desc[$i-1]\n;
send_cset($cset[$i-1], $i/$count, $desc[$i-1], $longdesc[$i-1]);
# let sendmail process the mail...
sleep 3;
}
exit(0);
--
Martin Waitz
signature.asc
Description: Digital signature
[PATCH 4/16] DocBook: update function parameter description in block/fs code
DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz [EMAIL PROTECTED] # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2028 - 1.2029 # drivers/block/ll_rw_blk.c 1.282 - 1.283 #kernel/sysctl.c1.96- 1.97 # fs/jbd/journal.c1.79- 1.81 # fs/jbd/transaction.c1.91- 1.92 # fs/super.c1.129 - 1.130 #include/linux/jbd.h1.48- 1.49 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2029 # DocBook: update function parameter description in block/fs code # # Signed-off-by: Martin Waitz [EMAIL PROTECTED] # # diff -Nru a/drivers/block/ll_rw_blk.c b/drivers/block/ll_rw_blk.c --- a/drivers/block/ll_rw_blk.c Thu Mar 3 11:41:42 2005 +++ b/drivers/block/ll_rw_blk.c Thu Mar 3 11:41:42 2005 @@ -618,6 +618,7 @@ * blk_queue_init_tags - initialize the queue tag info * @q: the request queue for the device * @depth: the maximum queue depth supported + * @tags: the tag to use **/ int blk_queue_init_tags(request_queue_t *q, int depth, struct blk_queue_tag *tags) @@ -1963,7 +1964,7 @@ /** * blk_rq_unmap_user - unmap a request with user data * @rq:request to be unmapped - * @ubuf: user buffer + * @bio: bio for the request * @ulen: length of user buffer * * Description: diff -Nru a/fs/jbd/journal.c b/fs/jbd/journal.c --- a/fs/jbd/journal.c Thu Mar 3 11:41:42 2005 +++ b/fs/jbd/journal.c Thu Mar 3 11:41:42 2005 @@ -1147,6 +1147,10 @@ /** *int journal_check_used_features () - Check if features specified are used. + * @journal: Journal to check. + * @compat: bitmask of compatible features + * @ro: bitmask of features that force read-only mount + * @incompat: bitmask of incompatible features * * Check whether the journal uses all of a given set of * features. Return true (non-zero) if it does. @@ -1174,6 +1178,10 @@ /** * int journal_check_available_features() - Check feature set in journalling layer + * @journal: Journal to check. + * @compat: bitmask of compatible features + * @ro: bitmask of features that force read-only mount + * @incompat: bitmask of incompatible features * * Check whether the journaling code supports the use of * all of a given set of features on this journal. Return true @@ -1206,6 +1214,10 @@ /** * int journal_set_features () - Mark a given journal feature in the superblock + * @journal: Journal to act on. + * @compat: bitmask of compatible features + * @ro: bitmask of features that force read-only mount + * @incompat: bitmask of incompatible features * * Mark a given journal feature as present on the * superblock. Returns true if the requested features could be set. @@ -1238,6 +1250,7 @@ /** * int journal_update_format () - Update on-disk journal structure. + * @journal: Journal to act on. * * Given an initialised but unloaded journal struct, poke about in the * on-disk structure to update it to the most recent supported version. @@ -1538,6 +1551,7 @@ /** * int journal_clear_err () - clears the journal's error state + * @journal: journal to act on. * * An error must be cleared or Acked to take a FS out of readonly * mode. @@ -1557,6 +1571,7 @@ /** * void journal_ack_err() - Ack journal err. + * @journal: journal to act on. * * An error must be cleared or Acked to take a FS out of readonly * mode. @@ -1574,10 +1589,6 @@ return 1 (PAGE_CACHE_SHIFT - inode-i_sb-s_blocksize_bits); } -/* - * Simple support for retying memory allocations. Introduced to help to - * debug different VM deadlock avoidance strategies. - */ /* * Simple support for retying memory allocations. Introduced to help to * debug different VM deadlock avoidance strategies. diff -Nru a/fs/jbd/transaction.c b/fs/jbd/transaction.c --- a/fs/jbd/transaction.c Thu Mar 3 11:41:43 2005 +++ b/fs/jbd/transaction.c Thu Mar 3 11:41:43 2005 @@ -742,6 +742,7 @@ * int journal_get_write_access() - notify intent to modify a buffer for metadata (not data) update. * @handle: transaction to add buffer modifications to * @bh: bh to be used for metadata writes + * @credits: variable that will receive credits for the buffer * * Returns an error code or 0 on success. * @@ -1578,7 +1579,7 @@ * int journal_try_to_free_buffers() - try to free page buffers. * @journal: journal for operation * @page: to try and free - * @gfp_mask: 'IO' mode for try_to_free_buffers() + * @unused_gfp_mask: unused * * * For all the buffers on this page, diff -Nru a/fs/super.c b/fs/super.c
[PATCH 1/16] DocBook: remove reference to drivers/net/net_init.c
DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz [EMAIL PROTECTED] # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2025 - 1.2026 # Documentation/DocBook/kernel-api.tmpl 1.32- 1.33 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2026 # DocBook: remove reference to drivers/net/net_init.c # # This file has been removed and is breaking documentation generation. # # Signed-off-by: Martin Waitz [EMAIL PROTECTED] # # diff -Nru a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl --- a/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:41:17 2005 +++ b/Documentation/DocBook/kernel-api.tmpl Thu Mar 3 11:41:17 2005 @@ -152,7 +152,6 @@ chapter id=netdev titleNetwork device support/title sect1titleDriver Support/title -!Edrivers/net/net_init.c !Enet/core/dev.c /sect1 sect1title8390 Based Network Cards/title - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 7/16] DocBook: new kernel-doc comments for might_sleep wait_event_*
DocBook: new kernel-doc comments for might_sleep wait_event_*
Signed-off-by: Martin Waitz [EMAIL PROTECTED]
# This is a BitKeeper generated patch for the following project:
# Project Name: Linux kernel tree
# This patch format is intended for GNU patch command version 2.5 or higher.
# This patch includes the following deltas:
# ChangeSet1.2031 - 1.2032
# include/linux/kernel.h 1.60- 1.61
# include/linux/wait.h1.28- 1.29
#
# The following is the BitKeeper ChangeSet Log
#
# 05/01/26 [EMAIL PROTECTED] 1.2032
# DocBook: new kernel-doc comments for might_sleep wait_event_*
#
# Signed-off-by: Martin Waitz [EMAIL PROTECTED]
#
#
diff -Nru a/include/linux/kernel.h b/include/linux/kernel.h
--- a/include/linux/kernel.hThu Mar 3 11:42:09 2005
+++ b/include/linux/kernel.hThu Mar 3 11:42:09 2005
@@ -48,10 +48,20 @@
struct completion;
+/**
+ * might_sleep - annotation for functions that can sleep
+ *
+ * this macro will print a stack trace if it is executed in an atomic
+ * context (spinlock, irq-handler, ...).
+ *
+ * This is a useful debugging help to be able to catch problems early and not
+ * be biten later when the calling function happens to sleep when it is not
+ * supposed to.
+ */
#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP
-void __might_sleep(char *file, int line);
#define might_sleep() __might_sleep(__FILE__, __LINE__)
#define might_sleep_if(cond) do { if (unlikely(cond)) might_sleep(); } while
(0)
+void __might_sleep(char *file, int line);
#else
#define might_sleep() do {} while(0)
#define might_sleep_if(cond) do {} while (0)
diff -Nru a/include/linux/wait.h b/include/linux/wait.h
--- a/include/linux/wait.h Thu Mar 3 11:42:09 2005
+++ b/include/linux/wait.h Thu Mar 3 11:42:09 2005
@@ -169,6 +169,18 @@
finish_wait(wq, __wait); \
} while (0)
+/**
+ * wait_event - sleep until a condition gets true
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ *
+ * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
+ * @condition evaluates to true. The @condition is checked each time
+ * the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ */
#define wait_event(wq, condition) \
do { \
if (condition) \
@@ -191,6 +203,22 @@
finish_wait(wq, __wait); \
} while (0)
+/**
+ * wait_event_timeout - sleep until a condition gets true or a timeout elapses
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ * @timeout: timeout, in jiffies
+ *
+ * The process is put to sleep (TASK_UNINTERRUPTIBLE) until the
+ * @condition evaluates to true. The @condition is checked each time
+ * the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function returns 0 if the @timeout elapsed, and the remaining
+ * jiffies if the condition evaluated to true before the timeout elapsed.
+ */
#define wait_event_timeout(wq, condition, timeout) \
({ \
long __ret = timeout; \
@@ -217,6 +245,21 @@
finish_wait(wq, __wait); \
} while (0)
+/**
+ * wait_event_interruptible - sleep until a condition gets true
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ *
+ * The process is put to sleep (TASK_INTERRUPTIBLE) until the
+ * @condition evaluates to true or a signal is received.
+ * The @condition is checked each time the waitqueue @wq is woken up.
+ *
+ * wake_up() has to be called after changing any variable that could
+ * change the result of the wait condition.
+ *
+ * The function will return -ERESTARTSYS if it was interrupted by a
+ * signal and 0 if @condition evaluated to true.
+ */
#define wait_event_interruptible(wq, condition)
\
({ \
int __ret = 0; \
@@ -245,6 +288,23 @@
finish_wait(wq, __wait); \
} while (0)
+/**
+ * wait_event_interruptible_timeout - sleep until a condition gets true or a
timeout elapses
+ * @wq: the waitqueue to wait on
+ * @condition: a C expression for the event to wait for
+ * @timeout: timeout, in jiffies
+ *
+ * The process is put to sleep (TASK_INTERRUPTIBLE) until
[PATCH 6/16] DocBook: fix function parameter descriptin in fbmem
DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz [EMAIL PROTECTED] # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2030 - 1.2031 # drivers/video/fbmem.c 1.150 - 1.151 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2031 # DocBook: fix function parameter descriptin in fbmem # # Signed-off-by: Martin Waitz [EMAIL PROTECTED] # # diff -Nru a/drivers/video/fbmem.c b/drivers/video/fbmem.c --- a/drivers/video/fbmem.c Thu Mar 3 11:42:00 2005 +++ b/drivers/video/fbmem.c Thu Mar 3 11:42:00 2005 @@ -1211,9 +1211,10 @@ /** * fb_get_options - get kernel boot parameters - * @name - framebuffer name as it would appear in - * the boot parameter line - * (video=name:options) + * @name: framebuffer name as it would appear in + * the boot parameter line + * (video=name:options) + * @option: the option will be stored here * * NOTE: Needed to maintain backwards compatibility */ - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH 5/16] DocBook: update function parameter description in USB code
DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz [EMAIL PROTECTED] # This is a BitKeeper generated patch for the following project: # Project Name: Linux kernel tree # This patch format is intended for GNU patch command version 2.5 or higher. # This patch includes the following deltas: # ChangeSet1.2029 - 1.2030 # drivers/usb/core/hub.c 1.160 - 1.161 # drivers/usb/core/hcd.c 1.115 - 1.116 # # The following is the BitKeeper ChangeSet Log # # 05/01/26 [EMAIL PROTECTED] 1.2030 # DocBook: update function parameter description in USB code # # Signed-off-by: Martin Waitz [EMAIL PROTECTED] # # diff -Nru a/drivers/usb/core/hcd.c b/drivers/usb/core/hcd.c --- a/drivers/usb/core/hcd.cThu Mar 3 11:41:51 2005 +++ b/drivers/usb/core/hcd.cThu Mar 3 11:41:51 2005 @@ -1394,7 +1394,7 @@ /** * usb_bus_start_enum - start immediate enumeration (for OTG) * @bus: the bus (must use hcd framework) - * @port: 1-based number of port; usually bus-otg_port + * @port_num: 1-based number of port; usually bus-otg_port * Context: in_interrupt() * * Starts enumeration, with an immediate reset followed later by diff -Nru a/drivers/usb/core/hub.c b/drivers/usb/core/hub.c --- a/drivers/usb/core/hub.cThu Mar 3 11:41:51 2005 +++ b/drivers/usb/core/hub.cThu Mar 3 11:41:51 2005 @@ -383,7 +383,7 @@ /** * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub - * @dev: the device whose split transaction failed + * @udev: the device whose split transaction failed * @pipe: identifies the endpoint of the failed transaction * * High speed HCDs use this to tell the hub driver that some split control or - To unsubscribe from this list: send the line unsubscribe linux-kernel in the body of a message to [EMAIL PROTECTED] More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
[PATCH] Convert Documentation/DocBook to XML
hoi :) I wanted to experiment with different docbook processors to speed up documentation generation. Well, I haven't found a better way yet but as a side-effect I now have a patch that moves all DocBook templates to valid XML DocBook. Please do a bk pull bk://tali.bkbits.net/linux-doc This will update the following files: Documentation/DocBook/Makefile| 77 +-- Documentation/DocBook/deviceiobook.tmpl |4 Documentation/DocBook/gadget.tmpl |5 Documentation/DocBook/journal-api.tmpl|5 Documentation/DocBook/kernel-api.tmpl |6 Documentation/DocBook/kernel-hacking.tmpl |4 Documentation/DocBook/kernel-locking.tmpl | 240 +-- Documentation/DocBook/libata.tmpl |4 Documentation/DocBook/librs.tmpl |6 Documentation/DocBook/lsm.tmpl| 11 Documentation/DocBook/mcabook.tmpl|4 Documentation/DocBook/mtdnand.tmpl| 14 Documentation/DocBook/procfs-guide.tmpl | 27 - Documentation/DocBook/scsidrivers.tmpl|5 Documentation/DocBook/sis900.tmpl | 556 +- Documentation/DocBook/tulip-user.tmpl |8 Documentation/DocBook/usb.tmpl|5 Documentation/DocBook/via-audio.tmpl |6 Documentation/DocBook/videobook.tmpl | 206 - Documentation/DocBook/wanbook.tmpl|4 Documentation/DocBook/writing_usb_driver.tmpl |4 Documentation/DocBook/z8530book.tmpl |4 drivers/block/ll_rw_blk.c |3 drivers/net/8390.c|1 drivers/usb/core/hcd.c|2 drivers/usb/core/hub.c|2 drivers/video/fbmem.c | 13 fs/jbd/journal.c | 19 fs/jbd/transaction.c |3 fs/super.c|2 include/linux/jbd.h |5 include/linux/kernel.h| 12 include/linux/skbuff.h|2 include/linux/wait.h | 60 ++ kernel/sysctl.c |7 net/core/skbuff.c |5 scripts/kernel-doc| 52 +- 37 files changed, 770 insertions(+), 623 deletions(-) through these ChangeSets: <[EMAIL PROTECTED]> (05/02/09 1.2037) DocBook: fix XML in templates Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2036) DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2035) DocBook: move kernel-doc comment next to function Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2034) DocBook: s/sgml/xml/ in scripts/kernel-doc Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/02/08 1.2033) DocBook: convert template files to XML Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2032) DocBook: new kernel-doc comments for might_sleep & wait_event_* Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2031) DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2030) DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2029) DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2028) DocBook: update function parameter description in network code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2027) DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2026) DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> -- Martin Waitz signature.asc Description: Digital signature
[PATCH] Convert Documentation/DocBook to XML
hoi :) I wanted to experiment with different docbook processors to speed up documentation generation. Well, I haven't found a better way yet but as a side-effect I now have a patch that moves all DocBook templates to valid XML DocBook. Please do a bk pull bk://tali.bkbits.net/linux-doc This will update the following files: Documentation/DocBook/Makefile| 77 +-- Documentation/DocBook/deviceiobook.tmpl |4 Documentation/DocBook/gadget.tmpl |5 Documentation/DocBook/journal-api.tmpl|5 Documentation/DocBook/kernel-api.tmpl |6 Documentation/DocBook/kernel-hacking.tmpl |4 Documentation/DocBook/kernel-locking.tmpl | 240 +-- Documentation/DocBook/libata.tmpl |4 Documentation/DocBook/librs.tmpl |6 Documentation/DocBook/lsm.tmpl| 11 Documentation/DocBook/mcabook.tmpl|4 Documentation/DocBook/mtdnand.tmpl| 14 Documentation/DocBook/procfs-guide.tmpl | 27 - Documentation/DocBook/scsidrivers.tmpl|5 Documentation/DocBook/sis900.tmpl | 556 +- Documentation/DocBook/tulip-user.tmpl |8 Documentation/DocBook/usb.tmpl|5 Documentation/DocBook/via-audio.tmpl |6 Documentation/DocBook/videobook.tmpl | 206 - Documentation/DocBook/wanbook.tmpl|4 Documentation/DocBook/writing_usb_driver.tmpl |4 Documentation/DocBook/z8530book.tmpl |4 drivers/block/ll_rw_blk.c |3 drivers/net/8390.c|1 drivers/usb/core/hcd.c|2 drivers/usb/core/hub.c|2 drivers/video/fbmem.c | 13 fs/jbd/journal.c | 19 fs/jbd/transaction.c |3 fs/super.c|2 include/linux/jbd.h |5 include/linux/kernel.h| 12 include/linux/skbuff.h|2 include/linux/wait.h | 60 ++ kernel/sysctl.c |7 net/core/skbuff.c |5 scripts/kernel-doc| 52 +- 37 files changed, 770 insertions(+), 623 deletions(-) through these ChangeSets: [EMAIL PROTECTED] (05/02/09 1.2037) DocBook: fix XML in templates Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2036) DocBook: s/sgml/xml/ in Documentation/DocBook/Makefile Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2035) DocBook: move kernel-doc comment next to function Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2034) DocBook: s/sgml/xml/ in scripts/kernel-doc Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/02/08 1.2033) DocBook: convert template files to XML Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2032) DocBook: new kernel-doc comments for might_sleep wait_event_* Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2031) DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2030) DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2029) DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2028) DocBook: update function parameter description in network code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2027) DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2026) DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz [EMAIL PROTECTED] -- Martin Waitz signature.asc Description: Digital signature
[PATCH] Documentation updates
hoi :) I have created some updates to the Linux documentation. This includes two important fixes that allow to generate DocBook documenation from kernel-doc comments again and some low-priority updates to the kernel-doc comments itself. All patches are available in my BK repository, it only contains documentation updates, no code changes. (The fixes have been reported here before but have not been merged yet.) Please do a bk pull bk://tali.bkbits.net/linux-doc This will update the following files: Documentation/DocBook/kernel-api.tmpl |1 drivers/block/ll_rw_blk.c |3 + drivers/net/8390.c|1 drivers/usb/core/hcd.c|2 - drivers/usb/core/hub.c|2 - drivers/video/fbmem.c |7 ++- fs/jbd/journal.c | 19 -- fs/jbd/transaction.c |3 + fs/super.c|2 - include/linux/jbd.h |5 ++ include/linux/kernel.h| 12 ++ include/linux/skbuff.h|2 + include/linux/wait.h | 60 ++ kernel/sysctl.c |7 +++ net/core/skbuff.c |5 ++ scripts/kernel-doc|4 +- 16 files changed, 118 insertions(+), 17 deletions(-) through these ChangeSets: <[EMAIL PROTECTED]> (05/01/26 1.2032) DocBook: new kernel-doc comments for might_sleep & wait_event_* Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2031) DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2030) DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2029) DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2028) DocBook: update function parameter description in network code Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2027) DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> <[EMAIL PROTECTED]> (05/01/26 1.2026) DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz <[EMAIL PROTECTED]> -- Martin Waitz signature.asc Description: Digital signature
[PATCH] Documentation updates
hoi :) I have created some updates to the Linux documentation. This includes two important fixes that allow to generate DocBook documenation from kernel-doc comments again and some low-priority updates to the kernel-doc comments itself. All patches are available in my BK repository, it only contains documentation updates, no code changes. (The fixes have been reported here before but have not been merged yet.) Please do a bk pull bk://tali.bkbits.net/linux-doc This will update the following files: Documentation/DocBook/kernel-api.tmpl |1 drivers/block/ll_rw_blk.c |3 + drivers/net/8390.c|1 drivers/usb/core/hcd.c|2 - drivers/usb/core/hub.c|2 - drivers/video/fbmem.c |7 ++- fs/jbd/journal.c | 19 -- fs/jbd/transaction.c |3 + fs/super.c|2 - include/linux/jbd.h |5 ++ include/linux/kernel.h| 12 ++ include/linux/skbuff.h|2 + include/linux/wait.h | 60 ++ kernel/sysctl.c |7 +++ net/core/skbuff.c |5 ++ scripts/kernel-doc|4 +- 16 files changed, 118 insertions(+), 17 deletions(-) through these ChangeSets: [EMAIL PROTECTED] (05/01/26 1.2032) DocBook: new kernel-doc comments for might_sleep wait_event_* Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2031) DocBook: fix function parameter descriptin in fbmem Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2030) DocBook: update function parameter description in USB code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2029) DocBook: update function parameter description in block/fs code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2028) DocBook: update function parameter description in network code Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2027) DocBook: allow preprocessor directives between kernel-doc and function Signed-off-by: Martin Waitz [EMAIL PROTECTED] [EMAIL PROTECTED] (05/01/26 1.2026) DocBook: remove reference to drivers/net/net_init.c This file has been removed and is breaking documentation generation. Signed-off-by: Martin Waitz [EMAIL PROTECTED] -- Martin Waitz signature.asc Description: Digital signature
