Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 5 Nov 2001 17:58:20 +0200
From:      Peter Pentchev <roam@ringlet.net>
To:        doc@FreeBSD.org
Subject:   TIDYFLAGS fixes all around the tree
Message-ID:  <20011105175820.D77919@straylight.oblivion.bg>

next in thread | raw e-mail | index | archive | help
Hi,

Just today, I tried to build the ru_RU.KOI8-R version of the docs.
Looking at the build process, I noticed quite a lot of HTML scrolling
off the screen, which did not quite seem like normal output to me :)
A closer inspection revealed the issue at hand: all the places which
set TIDYFLAGS to, say, "-latin1" or "-raw", set them explicitly, while
doc.docbook.mk and doc.html.mk only add the rest of the flags conditionally.
Thus, when tidy is invoked in e.g. ru_RU.KOI8-R/articles/explaining-bsd/,
we have:

[roam@straylight:v4 ~/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd]$ make -n
/usr/bin/touch index.sgml
/bin/cp -p /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd/../../
../share/misc/docbook.css docbook.css
/usr/local/bin/jade -V nochunks -ioutput.html -d /usr/home/roam/fbsd/r/doc/ru_RU
.KOI8-R/articles/explaining-bsd/../../../share/sgml/default.dsl  -ioutput.html.i
mages   -D /usr/obj/usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bs
d -c /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd/../../../ru_
RU.KOI8-R/share/sgml/catalog -c /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/
explaining-bsd/../../../share/sgml/catalog  -c /usr/local/share/sgml/docbook/dss
sl/modular/catalog -c /usr/local/share/sgml/docbook/catalog  -c /usr/local/share
/sgml/jade/catalog  -t sgml /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/expl
aining-bsd/article.sgml > article.html ||  (/bin/rm -f article.html && false)
/usr/local/bin/tidy -latin1 article.html
[roam@straylight:v4 ~/fbsd/r/doc

Note the last line, and esp. the lack of -i -m -f /dev/null.  What really
fudges things up is the lack of -m, which means the tidied output goes
to stdout instead of replacing article.html.  Nothing breaks, but
the resulting files are not tidied at all :)

After applying the attached patch:


[roam@straylight:v4 ~/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd]$ make -n
/usr/bin/touch index.sgml
/bin/cp -p /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd/../../
../share/misc/docbook.css docbook.css
/usr/local/bin/jade -V nochunks -ioutput.html -d /usr/home/roam/fbsd/r/doc/ru_RU
.KOI8-R/articles/explaining-bsd/../../../share/sgml/default.dsl  -ioutput.html.i
mages   -D /usr/obj/usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bs
d -c /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd/../../../ru_
RU.KOI8-R/share/sgml/catalog -c /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/
explaining-bsd/../../../share/sgml/catalog  -c /usr/local/share/sgml/docbook/dss
sl/modular/catalog -c /usr/local/share/sgml/docbook/catalog  -c /usr/local/share
/sgml/jade/catalog  -t sgml /usr/home/roam/fbsd/r/doc/ru_RU.KOI8-R/articles/expl
aining-bsd/article.sgml > article.html ||  (/bin/rm -f article.html && false)
/usr/local/bin/tidy -i -m -f /dev/null -latin1 -latin1 article.html
[roam@straylight:v4 ~/fbsd/r/doc/ru_RU.KOI8-R/articles/explaining-bsd]$

Well, ok, so -latin1 is there twice, but I don't think that's a big deal :)

The other workaround would be changing the TIDYFLAGS?= in doc.docbook.mk
and doc.html.mk to TIDYFLAGS+=, but that would break any future/debugging
invocations where people might want their errors actually displayed.

G'luck,
Peter

-- 
Hey, out there - is it *you* reading me, or is it someone else?

Index: doc/de_DE.ISO8859-1/books/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/de_DE.ISO8859-1/books/Makefile.inc,v
retrieving revision 1.3
diff -u -r1.3 Makefile.inc
--- doc/de_DE.ISO8859-1/books/Makefile.inc	11 Jun 2001 01:16:24 -0000	1.3
+++ doc/de_DE.ISO8859-1/books/Makefile.inc	5 Nov 2001 15:47:18 -0000
@@ -6,6 +6,6 @@
 #    $FreeBSDde: de-docproj/books/Makefile.inc,v 1.4 2001/02/01 21:24:27 alex Exp $
 #
 
-TIDYFLAGS=	-latin1
+TIDYFLAGS+=	-latin1
 
 DESTDIR?=	${DOCDIR}/de_DE.ISO8859-1/books/${.CURDIR:T}
Index: doc/ja_JP.eucJP/articles/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/ja_JP.eucJP/articles/Makefile.inc,v
retrieving revision 1.2
diff -u -r1.2 Makefile.inc
--- doc/ja_JP.eucJP/articles/Makefile.inc	23 Mar 2000 09:00:10 -0000	1.2
+++ doc/ja_JP.eucJP/articles/Makefile.inc	5 Nov 2001 15:47:29 -0000
@@ -3,6 +3,6 @@
 #
 # Original revision: 1.3
 
-TIDYFLAGS=      -raw
+TIDYFLAGS+=	-raw
 
 DESTDIR?=	${DOCDIR}/ja/articles/${.CURDIR:T}
Index: doc/ja_JP.eucJP/books/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/ja_JP.eucJP/books/Makefile.inc,v
retrieving revision 1.5
diff -u -r1.5 Makefile.inc
--- doc/ja_JP.eucJP/books/Makefile.inc	23 Mar 2000 09:00:12 -0000	1.5
+++ doc/ja_JP.eucJP/books/Makefile.inc	5 Nov 2001 15:47:36 -0000
@@ -2,6 +2,6 @@
 # $FreeBSD$
 #
 
-TIDYFLAGS=      -raw
+TIDYFLAGS+=	-raw
 
 DESTDIR?=	${DOCDIR}/ja/books/${.CURDIR:T}
Index: doc/nl_NL.ISO8859-1/books/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/nl_NL.ISO8859-1/books/Makefile.inc,v
retrieving revision 1.1
diff -u -r1.1 Makefile.inc
--- doc/nl_NL.ISO8859-1/books/Makefile.inc	23 Sep 2001 09:15:52 -0000	1.1
+++ doc/nl_NL.ISO8859-1/books/Makefile.inc	5 Nov 2001 15:47:41 -0000
@@ -2,6 +2,6 @@
 # $FreeBSD$
 #
 
-TIDYFLAGS=	-latin1
+TIDYFLAGS+=	-latin1
 
 DESTDIR?=	${DOCDIR}/nl_NL.ISO8859-1/books/${.CURDIR:T}
Index: doc/ru_RU.KOI8-R/articles/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/ru_RU.KOI8-R/articles/Makefile.inc,v
retrieving revision 1.3
diff -u -r1.3 Makefile.inc
--- doc/ru_RU.KOI8-R/articles/Makefile.inc	25 Jul 2001 13:17:06 -0000	1.3
+++ doc/ru_RU.KOI8-R/articles/Makefile.inc	5 Nov 2001 15:45:05 -0000
@@ -5,5 +5,5 @@
 # Original revision: 1.3
 #
 
-TIDYFLAGS=	-latin1
+TIDYFLAGS+=	-latin1
 DESTDIR?=	${DOCDIR}/ru_RU.KOI8-R/articles/${.CURDIR:T}
Index: doc/ru_RU.KOI8-R/books/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/ru_RU.KOI8-R/books/Makefile.inc,v
retrieving revision 1.7
diff -u -r1.7 Makefile.inc
--- doc/ru_RU.KOI8-R/books/Makefile.inc	25 Jul 2001 15:29:02 -0000	1.7
+++ doc/ru_RU.KOI8-R/books/Makefile.inc	5 Nov 2001 15:47:48 -0000
@@ -4,6 +4,6 @@
 #
 # Original revision: 1.4
 
-TIDYFLAGS=	-latin1
+TIDYFLAGS+=	-latin1
 
 DESTDIR?=	${DOCDIR}/ru_RU.KOI8-R/books/${.CURDIR:T}
Index: doc/sr_YU.ISO8859-2/articles/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/sr_YU.ISO8859-2/articles/Makefile.inc,v
retrieving revision 1.2
diff -u -r1.2 Makefile.inc
--- doc/sr_YU.ISO8859-2/articles/Makefile.inc	11 Jun 2001 01:20:31 -0000	1.2
+++ doc/sr_YU.ISO8859-2/articles/Makefile.inc	5 Nov 2001 15:48:08 -0000
@@ -1,4 +1,4 @@
-TIDYFLAGS=   -raw
+TIDYFLAGS+=	-raw
 
 .if defined(OPENJADE)
 JADE=       SP_ENCODING=ISO-8859-2 ${PREFIX}/bin/openjade
Index: doc/sr_YU.ISO8859-2/books/Makefile.inc
===================================================================
RCS file: /home/ncvs/doc/sr_YU.ISO8859-2/books/Makefile.inc,v
retrieving revision 1.2
diff -u -r1.2 Makefile.inc
--- doc/sr_YU.ISO8859-2/books/Makefile.inc	11 Jun 2001 01:20:32 -0000	1.2
+++ doc/sr_YU.ISO8859-2/books/Makefile.inc	5 Nov 2001 15:48:04 -0000
@@ -1,4 +1,4 @@
-TIDYFLAGS=   -raw
+TIDYFLAGS+=	-raw
 
 .if defined(OPENJADE)
 JADE=       SP_ENCODING=ISO-8859-2 ${PREFIX}/bin/openjade
Index: doc/zh_TW.Big5/books/faq/Makefile
===================================================================
RCS file: /home/ncvs/doc/zh_TW.Big5/books/faq/Makefile,v
retrieving revision 1.4
diff -u -r1.4 Makefile
--- doc/zh_TW.Big5/books/faq/Makefile	6 Sep 1999 06:53:43 -0000	1.4
+++ doc/zh_TW.Big5/books/faq/Makefile	5 Nov 2001 15:48:18 -0000
@@ -6,7 +6,7 @@
 
 MAINTAINER=foxfair@FreeBSD.org
 
-TIDYFLAGS=      -raw
+TIDYFLAGS+=	-raw
 
 DOC?= book
 

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?20011105175820.D77919>