From d0e8afbf5a6a5bc0226a2db52b719ac49fead983 Mon Sep 17 00:00:00 2001 From: "Bruce A. Mah" Date: Thu, 20 Jun 2002 21:19:49 +0000 Subject: [PATCH] Provide a way to keep out old ("historic") release notes from bloating the size of the rendered release notes. By default, any element with a role="historic" attribute won't get rendered in the output unless the INCLUDE_HISTORIC Makefile variable is defined. --- .../doc/en_US.ISO8859-1/relnotes/article.sgml | 39 ++++++++++++++----- .../en_US.ISO8859-1/relnotes/common/new.sgml | 39 ++++++++++++++----- .../relnotes/common/relnotes.ent | 3 ++ release/doc/share/mk/doc.relnotes.mk | 17 ++++++++ release/doc/share/sgml/release.dsl | 18 +++++++++ release/doc/share/sgml/release.ent | 4 ++ 6 files changed, 102 insertions(+), 18 deletions(-) diff --git a/release/doc/en_US.ISO8859-1/relnotes/article.sgml b/release/doc/en_US.ISO8859-1/relnotes/article.sgml index 96233befd67..adad49c5fd0 100644 --- a/release/doc/en_US.ISO8859-1/relnotes/article.sgml +++ b/release/doc/en_US.ISO8859-1/relnotes/article.sgml @@ -14,7 +14,14 @@ The release notes for &os; &release.current; contain a summary - of the changes made in the &os; base system since &release.prev;. + of + + Both changes for kernel and userland are listed, as well as applicable security advisories that were issued since the last release. Some brief remarks on upgrading are also presented. @@ -26,8 +33,8 @@ This document contains the release notes for &os; &release.current; on the &arch.print; hardware platform. It - describes new features of &os; that have been added (or changed) - since &release.prev;. It also provides some notes on upgrading + describes recently added, changed, or deleted features of &os;. + It also provides some notes on upgrading from previous versions of &os;. What's New - This section describes the most user-visible new or changed - features in &os; since &release.prev;. Typical release note items + This section describes + + + + + Typical release note items document new drivers or hardware support, new commands or options, - major bugfixes, or contributed software upgrades. Security - advisories issued after &release.prev; are also listed. In - general, changes described here are unique to the &release.branch; - branch unless specifically marked as &merged; features. + major bugfixes, or contributed software upgrades. Applicable security + advisories issued after &release.prev; are also listed. Many additional changes were made to &os; that are not listed here for lack of space. For example, documentation was corrected diff --git a/release/doc/en_US.ISO8859-1/relnotes/common/new.sgml b/release/doc/en_US.ISO8859-1/relnotes/common/new.sgml index 96233befd67..adad49c5fd0 100644 --- a/release/doc/en_US.ISO8859-1/relnotes/common/new.sgml +++ b/release/doc/en_US.ISO8859-1/relnotes/common/new.sgml @@ -14,7 +14,14 @@ The release notes for &os; &release.current; contain a summary - of the changes made in the &os; base system since &release.prev;. + of + + Both changes for kernel and userland are listed, as well as applicable security advisories that were issued since the last release. Some brief remarks on upgrading are also presented. @@ -26,8 +33,8 @@ This document contains the release notes for &os; &release.current; on the &arch.print; hardware platform. It - describes new features of &os; that have been added (or changed) - since &release.prev;. It also provides some notes on upgrading + describes recently added, changed, or deleted features of &os;. + It also provides some notes on upgrading from previous versions of &os;. What's New - This section describes the most user-visible new or changed - features in &os; since &release.prev;. Typical release note items + This section describes + + + + + Typical release note items document new drivers or hardware support, new commands or options, - major bugfixes, or contributed software upgrades. Security - advisories issued after &release.prev; are also listed. In - general, changes described here are unique to the &release.branch; - branch unless specifically marked as &merged; features. + major bugfixes, or contributed software upgrades. Applicable security + advisories issued after &release.prev; are also listed. Many additional changes were made to &os; that are not listed here for lack of space. For example, documentation was corrected diff --git a/release/doc/en_US.ISO8859-1/relnotes/common/relnotes.ent b/release/doc/en_US.ISO8859-1/relnotes/common/relnotes.ent index d52afeedcc0..12086150fed 100644 --- a/release/doc/en_US.ISO8859-1/relnotes/common/relnotes.ent +++ b/release/doc/en_US.ISO8859-1/relnotes/common/relnotes.ent @@ -7,6 +7,9 @@ + + + diff --git a/release/doc/share/mk/doc.relnotes.mk b/release/doc/share/mk/doc.relnotes.mk index 546ad9f2b73..0335640342c 100644 --- a/release/doc/share/mk/doc.relnotes.mk +++ b/release/doc/share/mk/doc.relnotes.mk @@ -9,3 +9,20 @@ EXTRA_CATALOGS+= ${RELN_ROOT}/share/sgml/catalog # Use the appropriate architecture-dependent RELNOTESng stylesheet DSLHTML?= ${RELN_ROOT}/share/sgml/default.dsl DSLPRINT?= ${RELN_ROOT}/share/sgml/default.dsl + +# +# Tweakable Makefile variables +# +# INCLUDE_HISTORIC Used by relnotes document only. When set, +# causes all release notes entries to be printed, +# even those marked as "historic". If not set +# (the default), only print "non-historic" +# release note entries. To designate a release +# note entry as "historic", add a role="historic" +# attribute to the applicable element(s). +# +.if defined(INCLUDE_HISTORIC) +JADEFLAGS+= -iinclude.historic +.else +JADEFLAGS+= -ino.include.historic +.endif diff --git a/release/doc/share/sgml/release.dsl b/release/doc/share/sgml/release.dsl index ee37005a9dd..6bb5026e9e5 100644 --- a/release/doc/share/sgml/release.dsl +++ b/release/doc/share/sgml/release.dsl @@ -3,6 +3,8 @@ + + ]> @@ -10,6 +12,14 @@ +; Configure behavior of this stylesheet + + + ; String manipulation functions (define (split-string-to-list STR) ;; return list of STR separated with char #\ or #\, @@ -45,9 +55,17 @@ ; Deal with conditional inclusion of text via entities. (default (let* ((arch (attribute-string (normalize "arch"))) + (role (attribute-string (normalize "role"))) (for-arch (entity-text "arch"))) (cond + ; If role=historic, and we're not printing historic things, then + ; don't output this element. + ((and (equal? role "historic") + (not %include-historic%)) + (empty-sosofo)) + + ; If arch= not specified, then print unconditionally. This clause ; handles the majority of cases. ((or (equal? arch #f) (equal? arch "")) diff --git a/release/doc/share/sgml/release.ent b/release/doc/share/sgml/release.ent index ca391727dd9..055643e9f66 100644 --- a/release/doc/share/sgml/release.ent +++ b/release/doc/share/sgml/release.ent @@ -18,6 +18,10 @@ edge. --> + + +