On Wed, 5 Apr 2000, Tigran Aivazian wrote:
> perhaps, while you are at it, you could drop a small comment in
> Documentation/Changes that describes what is required to make use of
> the Documentation/DocBook. Last time I checked (pre4-4) all the
> relevant targets in the top Makefile were broken and even after
> manually fixing them (chmod some scripts here and there), it still
> seemed to require some software that was not included in the tree.
Yes, it does. Here's the Changes patch, along with a bit in the Makefile
that chmods the various scripts you need to run.
> For now I assume that those make targets are broken on purpose so that
> one does not try to use Documentation/DocBook stuff until it is ready?
> Any corrections to this assumption are welcome.
Not really.
Tim.
*/
diff -durN linux-2.3.99-pre4-4/Documentation/Changes linux/Documentation/Changes
--- linux-2.3.99-pre4-4/Documentation/Changes Fri Mar 24 08:23:14 2000
+++ linux/Documentation/Changes Wed Apr 5 17:43:22 2000
@@ -525,6 +525,17 @@
you need to install the LVM tools. More information can be found at the home page
of the LVM project at http://linux.msede.com/lvm/.
+Inline Documentation
+====================
+Many of the functions available for modules to use are now documented
+with specially-formatted comments near their definitions. These
+comments can be combined with the SGML templates in the
+Documentation/DocBook directory to make DocBook files, which can then
+be combined with DocBook stylesheets to make PostScript documents,
+HTML pages, PDF files, and so on. In order to convert from DocBook
+format to a format of your choice, you'll need to install jade, as
+well as some stylesheets.
+
Where to get the files
**********************
@@ -817,6 +828,17 @@
The 0.7 release:
ftp://linux.msede.com/lvm/v0.7/lvm_0.7.tar.gz
+
+Jade
+====
+
+The 1.2.1 release:
+ftp://ftp.jclark.com/pub/jade/jade-1.2.1.tar.gz
+
+DSSSL Stylesheets for the DocBook DTD
+=====================================
+
+http://nwalsh.com/docbook/dsssl/
Other Info
diff -durN linux-2.3.99-pre4-4/Documentation/DocBook/Makefile linux/Documentation/DocBook/Makefile
--- linux-2.3.99-pre4-4/Documentation/DocBook/Makefile Wed Apr 5 16:45:32 2000
+++ linux/Documentation/DocBook/Makefile Wed Apr 5 17:28:49 2000
@@ -3,13 +3,22 @@
PS := $(patsubst %.sgml, %.ps, $(BOOKS))
PDF := $(patsubst %.sgml, %.pdf, $(BOOKS))
-books: docproc $(BOOKS)
+$(BOOKS): $(TOPDIR)/scripts/docproc
+
+.PHONY: books ps pdf clean mrproper db2ps db2pdf
+
+books: $(BOOKS)
ps: $(PS)
pdf: $(PDF)
-docproc:
+db2ps db2pdf:
+ @(which $@ > /dev/null 2>&1) || \
+ (echo "*** You need to install DocBook stylesheets ***"; \
+ exit 1)
+
+$(TOPDIR)/scripts/docproc:
$(MAKE) -C $(TOPDIR)/scripts docproc
wanbook.sgml: wanbook.tmpl
@@ -64,7 +73,7 @@
mrproper: clean
$(RM) $(PS) $(PDF)
-%.ps : %.sgml
+%.ps : %.sgml db2ps
db2ps $<
%.pdf : %.sgml
diff -durN linux-2.3.99-pre4-4/Makefile linux/Makefile
--- linux-2.3.99-pre4-4/Makefile Wed Apr 5 16:45:32 2000
+++ linux/Makefile Wed Apr 5 17:16:44 2000
@@ -410,14 +410,15 @@
sync
sgmldocs:
+ chmod 755 $(TOPDIR)/scripts/docgen
+ chmod 755 $(TOPDIR)/scripts/gen-all-syms
+ chmod 755 $(TOPDIR)/scripts/kernel-doc
$(MAKE) -C $(TOPDIR)/Documentation/DocBook books
psdocs: sgmldocs
- $(MAKE) -C scripts docproc
$(MAKE) -C Documentation/DocBook ps
pdfdocs: sgmldocs
- $(MAKE) -C scripts docproc
$(MAKE) -C Documentation/DocBook pdf
sums:
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.rutgers.edu
Please read the FAQ at http://www.tux.org/lkml/
This archive was generated by hypermail 2b29 : Fri Apr 07 2000 - 21:00:15 EST