From owner-freebsd-doc Thu Nov 1 22:20:13 2001 Delivered-To: freebsd-doc@freebsd.org Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21]) by hub.freebsd.org (Postfix) with ESMTP id 7BD6837B403 for ; Thu, 1 Nov 2001 22:20:03 -0800 (PST) Received: (from gnats@localhost) by freefall.freebsd.org (8.11.4/8.11.4) id fA26K3T70018; Thu, 1 Nov 2001 22:20:03 -0800 (PST) (envelope-from gnats) Received: from misao.kuicr.kyoto-u.ac.jp (misao.kuicr.kyoto-u.ac.jp [133.3.28.70]) by hub.freebsd.org (Postfix) with SMTP id 4F21737B401 for ; Thu, 1 Nov 2001 22:18:49 -0800 (PST) Received: (qmail 76755 invoked by uid 1000); 2 Nov 2001 15:18:42 +0900 Message-Id: <20011102061842.76722.qmail@misao.kuicr.kyoto-u.ac.jp> Date: 2 Nov 2001 15:18:42 +0900 From: Akio Morita Reply-To: Akio Morita To: FreeBSD-gnats-submit@freebsd.org X-Send-Pr-Version: 3.113 Subject: docs/31703: TIDYFLAGS cann't work correctly Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org >Number: 31703 >Category: docs >Synopsis: TIDYFLAGS cann't work correctly >Confidential: no >Severity: serious >Priority: medium >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: sw-bug >Submitter-Id: current-users >Arrival-Date: Thu Nov 01 22:20:03 PST 2001 >Closed-Date: >Last-Modified: >Originator: Akio Morita >Release: FreeBSD 4.4-STABLE i386 >Organization: Department of Physics, Kyoto University, Japan >Environment: System: FreeBSD sasami.jyurai 4.4-STABLE FreeBSD 4.4-STABLE #1: Mon Oct 29 04:41:39 JST 2001 amorita@sasami.jyurai:/usr/SRC/src/sys/compile/SASAMI i386 >Description: In comment of doc module, TIDYFLAGS is `Additional flags to pass to Tidy'. Before import of Cryrille's patch, action of TIDYFLAGS accorded its comment, and TIDYFLAGS is used in some language sub-directory. In old make template, tidy called by following style. tidy -i -m -f /dev/null ${TIDYFLAGS} `xargs < HTML.manifest`. -- list of Makefiles using TIDYFLAGS -- % find /usr/doc -name Makefile\* -exec grep TIDYFLAGS /dev/null {} \; /usr/doc/ja_JP.eucJP/articles/Makefile.inc:TIDYFLAGS= -raw /usr/doc/ja_JP.eucJP/books/Makefile.inc:TIDYFLAGS= -raw /usr/doc/ru_RU.KOI8-R/books/Makefile.inc:TIDYFLAGS= -latin1 /usr/doc/ru_RU.KOI8-R/articles/Makefile.inc:TIDYFLAGS= -latin1 /usr/doc/zh_TW.Big5/books/faq/Makefile:TIDYFLAGS= -raw /usr/doc/de_DE.ISO8859-1/books/Makefile.inc:TIDYFLAGS= -latin1 /usr/doc/nl_NL.ISO8859-1/books/Makefile.inc:TIDYFLAGS= -latin1 /usr/doc/sr_YU.ISO8859-2/articles/Makefile.inc:TIDYFLAGS= -raw /usr/doc/sr_YU.ISO8859-2/books/Makefile.inc:TIDYFLAGS= -raw -- list of Makefiles using TIDYFLAGS -- After import of Cryrille's patch, TIDYFLAGS defines at doc.docbook.mk and doc.html.mk as following style. TIDYFLAGS?= -i -m -f /dev/null Therefore, in building html document using TIDYFLAGS, tidy option `-i -m -f /dev/null' is forgot. Thus TIDY outputs revised html doeucment to stdout and html documents on disk are not revised. >How-To-Repeat: Checkout doc module and build html document using TIDYFLAGS. --- example --- % cd /usr/doc/de_DE.ISO8859-1/books/faq % make /usr/bin/touch index.sgml /bin/cp -p /usr/doc/de_DE.ISO8859-1/books/faq/../../../share/misc/docbook.css docbook.css /usr/local/bin/jade -V html-manifest -ioutput.html -d /usr/doc/de_DE.ISO8859-1/books/faq/../../../share/sgml/default.dsl -ioutput.html.images -Vbiblio-xref-title -D /usr/obj/usr/doc/de_DE.ISO8859-1/books/faq -c /usr/doc/de_DE.ISO8859-1/books/faq/../../../de_DE.ISO8859-1/share/sgml/catalog -c /usr/doc/de_DE.ISO8859-1/books/faq/../../../share/sgml/catalog -c /usr/local/share/sgml/docbook/dsssl/modular/catalog -c /usr/local/share/sgml/docbook/catalog -c /usr/local/share/sgml/jade/catalog -t sgml /usr/doc/de_DE.ISO8859-1/books/faq/book.sgml /usr/local/bin/tidy -latin1 $(/usr/bin/xargs < HTML.manifest) Tidy (vers 4th August 2000) Parsing "index.html" line 71 column 2 - Warning: trimming empty

line 111 column 2 - Warning: trimming empty

index.html: Document content looks like HTML 4.01 Transitional 2 warnings/errors were found! Tidy (vers 4th August 2000) Parsing "introduction.html" line 334 column 2 - Warning: missing before

  • line 334 column 2 - Warning: inserting implicit
      line 356 column 2 - Warning: discarding unexpected

      line 357 column 2 - Warning: missing
    • line 373 column 2 - Warning: missing
    before line 528 column 2 - Warning: trimming empty

    line 787 column 2 - Warning: trimming empty

    line 940 column 2 - Warning: trimming empty

    line 1148 column 2 - Warning: trimming empty

    line 1179 column 2 - Warning: trimming empty

    line 1180 column 2 - Warning: lacks "summary" attribute line 1290 column 2 - Warning: trimming empty

    line 1317 column 2 - Warning: trimming empty

    line 1318 column 2 - Warning:

    lacks "summary" attribute line 1473 column 2 - Warning: trimming empty

    line 1482 column 2 - Warning: trimming empty

    line 1515 column 8 - Warning: nested emphasis line 1540 column 2 - Warning: trimming empty

    line 1541 column 2 - Warning:

    lacks "summary" attribute line 1626 column 2 - Warning: trimming empty

    line 1694 column 2 - Warning: nested emphasis line 1871 column 2 - Warning: trimming empty

    line 1932 column 2 - Warning: trimming empty

    line 1963 column 2 - Warning: trimming empty

    introduction.html: Document content looks like HTML 4.01 Transitional 24 warnings/errors were found! --- example --- >Fix: Apply following patch. --- patch --- Index: share/mk/doc.docbook.mk =================================================================== RCS file: /CVSrepository/FreeBSD/doc/share/mk/doc.docbook.mk,v retrieving revision 1.53 diff -d -u -r1.53 doc.docbook.mk --- share/mk/doc.docbook.mk 2001/10/30 21:37:31 1.53 +++ share/mk/doc.docbook.mk 2001/11/02 05:08:00 @@ -174,7 +174,6 @@ TEX?= ${PREFIX}/bin/tex PDFTEX?= ${PREFIX}/bin/pdftex TIDY?= ${PREFIX}/bin/tidy -TIDYFLAGS?= -i -m -f /dev/null HTML2TXT?= ${PREFIX}/bin/links HTML2TXTFLAGS?= -dump HTML2PDB?= ${PREFIX}/bin/iSiloBSD @@ -342,7 +341,7 @@ ${JADE} -V html-manifest ${HTMLOPTS} -ioutput.html.images \ ${JADEOPTS} -t sgml ${MASTERDOC} .if !defined(NO_TIDY) - -${TIDY} ${TIDYFLAGS} $$(${XARGS} < HTML.manifest) + -${TIDY} -i -m -f /dev/null ${TIDYFLAGS} $$(${XARGS} < HTML.manifest) .endif ${DOC}.html: ${SRCS} ${LOCAL_IMAGES_LIB} ${LOCAL_IMAGES_PNG} \ @@ -351,7 +350,7 @@ ${JADEOPTS} -t sgml ${MASTERDOC} > ${.TARGET} || \ (${RM} -f ${.TARGET} && false) .if !defined(NO_TIDY) - -${TIDY} ${TIDYFLAGS} ${.TARGET} + -${TIDY} -i -m -f /dev/null ${TIDYFLAGS} ${.TARGET} .endif # Special target to produce HTML with no images in it. Index: share/mk/doc.html.mk =================================================================== RCS file: /CVSrepository/FreeBSD/doc/share/mk/doc.html.mk,v retrieving revision 1.9 diff -d -u -r1.9 doc.html.mk --- share/mk/doc.html.mk 2001/10/29 09:21:31 1.9 +++ share/mk/doc.html.mk 2001/11/02 05:08:00 @@ -62,13 +62,12 @@ NSGMLS?= ${PREFIX}/bin/nsgmls SGMLNORM?= ${PREFIX}/bin/sgmlnorm .endif - + PKG_CREATE?= /usr/sbin/pkg_create TAR?= /usr/bin/tar XARGS?= /usr/bin/xargs TIDY?= ${PREFIX}/bin/tidy -TIDYFLAGS?= -i -m -f /dev/null HTML2TXT?= ${PREFIX}/bin/links HTML2TXTFLAGS?= -dump HTML2PDB?= ${PREFIX}/bin/iSiloBSD @@ -150,7 +149,7 @@ ${DOC}.html: ${SRCS} ${LOCAL_IMAGES_LIB} ${LOCAL_IMAGES_PNG} ${LOCAL_CSS_SHEET} ${SGMLNORM} -c ${HTMLCATALOG} ${SRCS:S|^|${.CURDIR}/|} > ${.TARGET} .if !defined(NO_TIDY) - -${TIDY} ${TIDYFLAGS} ${.TARGET} + -${TIDY} -i -m -f /dev/null ${TIDYFLAGS} ${.TARGET} .endif ${DOC}.txt: ${DOC}.html --- patch --- >Release-Note: >Audit-Trail: >Unformatted: To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message