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/script
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/kern
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
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
vel 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
that are needed
to generate documentation.
Signed-off-by: Martin Waitz <[EMAIL PROTECTED]>
scripts/makeman| 185 -
scripts/split-man | 112
Documentation/Changes |8 -
Documentation/D
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
nked from index.html. IIRC, they were in jadetex
> days.
I'll take a look at the stylesheetes
--
Martin Waitz
signature.asc
Description: Digital signature
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:
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
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
k 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 file
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
les.
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
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
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
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.
1c710c896eb461895d3c399e15bb5f20
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 th
rd 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
;") || ($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
l-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)
ts 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
3/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
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
[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 fol
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 in
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
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 includ
[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 includ
[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 fol
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
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.kern
[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
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.
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
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/.
# yo
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.
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 for
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 high
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
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
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 @@
> }
> }
>
> +# repla
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/MAINTA
43 matches
Mail list logo