Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 13 Aug 2001 23:16:45 -0700
From:      Dima Dorfman <dima@unixfreak.org>
To:        doc@freebsd.org
Subject:   `make lint` broken for any document which uses -V option to jade
Message-ID:  <20010814061650.F3F883E28@bazooka.unixfreak.org>

next in thread | raw e-mail | index | archive | help
Any document which uses the -V option to jade via JADEFLAGS will not
pass `make lint` because JADEFLAGS is passed to nsgmls, which doesn't
understand -V.  I suspect this has always been the case, but now we
have more documents using variables (mainly to generate the table of
contents), so it's more apparent.

The patch below splits JADEFLAGS into itself and SGMLFLAGS.  The
former goes only to Jade, and should include stuff like -V which
nsgmls and other SGML processors have no use for.  The latter goes to
Jade and any other processors (e.g., nsgmls), which have a need for
things like entities (-i option).  The only place that actually needs
SGMLFLAGS is the Handbook, and the patch changes that as appropriate.

With this, all the documents except the Handbook[1] pass `make lint`.
Previously, the committers-guide, sold-state, contributers, and the
faq would fail.

Please review.  Thanks.

[1] The Handbook bombs at not being able to find index.sgml.  I
skimmed (and in some case deleted) most of the threads about indexes
(no offense intended; I like the work, but have no desire to work on
it), so I don't know what exactly is broken, or how to fix it.
Regardless, it bombs at the same place with my patch as before it, so
I have no reason to think I broke anything.

Index: share/mk/doc.docbook.mk
===================================================================
RCS file: /ref/cvsf/doc/share/mk/doc.docbook.mk,v
retrieving revision 1.42
diff -u -r1.42 doc.docbook.mk
--- share/mk/doc.docbook.mk	2001/07/28 03:00:03	1.42
+++ share/mk/doc.docbook.mk	2001/08/14 06:01:26
@@ -30,10 +30,15 @@
 #
 # Variables used by both users and documents:
 #
-#	JADEFLAGS	Additional options to pass to Jade.  Typically
+#	SGMLFLAGS	Additional options to pass to various SGML
+#			processors (e.g., jade, nsgmls).  Typically
 #			used to define "IGNORE" entities to "INCLUDE"
 #			 with "-i<entity-name>"
 #
+#	JADEFLAGS	Additional flags to pass to Jade.  Typically
+#			used to set additional variables, such as
+#			"%generate-article-toc%".
+#
 #	TIDYFLAGS	Additional flags to pass to Tidy.  Typically
 #			used to set "-raw" flag to handle 8bit characters.
 #
@@ -93,7 +98,7 @@
 
 IMAGES_LIB?=
 
-JADEOPTS=	${JADEFLAGS} -c ${LANGUAGECATALOG} -c ${FREEBSDCATALOG} -c ${DSSSLCATALOG} -c ${DOCBOOKCATALOG} -c ${JADECATALOG} ${EXTRA_CATALOGS:S/^/-c /g}
+JADEOPTS=	${JADEFLAGS} ${SGMLFLAGS} -c ${LANGUAGECATALOG} -c ${FREEBSDCATALOG} -c ${DSSSLCATALOG} -c ${DOCBOOKCATALOG} -c ${JADECATALOG} ${EXTRA_CATALOGS:S/^/-c /g}
 
 KNOWN_FORMATS=	html html.tar html-split html-split.tar txt rtf ps pdf tex dvi tar pdb
 
@@ -336,7 +341,7 @@
 #
 
 lint validate:
-	${NSGMLS} ${JADEFLAGS} -s -c ${LANGUAGECATALOG} -c ${FREEBSDCATALOG} -c ${DSSSLCATALOG} -c ${DOCBOOKCATALOG} -c ${JADECATALOG} ${EXTRA_CATALOGS:S/^/-c /g} ${MASTERDOC}
+	${NSGMLS} ${SGMLFLAGS} -s -c ${LANGUAGECATALOG} -c ${FREEBSDCATALOG} -c ${DSSSLCATALOG} -c ${DOCBOOKCATALOG} -c ${JADECATALOG} ${EXTRA_CATALOGS:S/^/-c /g} ${MASTERDOC}
 
 # ------------------------------------------------------------------------
 #
Index: en_US.ISO8859-1/books/handbook/Makefile
===================================================================
RCS file: /ref/cvsf/doc/en_US.ISO8859-1/books/handbook/Makefile,v
retrieving revision 1.42
diff -u -r1.42 Makefile
--- en_US.ISO8859-1/books/handbook/Makefile	2001/08/10 00:30:43	1.42
+++ en_US.ISO8859-1/books/handbook/Makefile	2001/08/14 06:01:04
@@ -72,7 +72,7 @@
 # Turn on all the chapters.
 CHAPTERS?= ${SRCS:M*chapter.sgml}
 
-JADEFLAGS+= ${CHAPTERS:S/\/chapter.sgml//:S/^/-i chap./}
+SGMLFLAGS+= ${CHAPTERS:S/\/chapter.sgml//:S/^/-i chap./}
 
 # XXX The Handbook build currently overflows some internal, hardcoded 
 # limits in pdftex.  Until we split the Handbook up, build the PDF 

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010814061650.F3F883E28>